Function: Retrieves the time tracked for a particular period of time. This can be viewed by Jobs or Companies
Web service call: https://proworkflow2.net/pwfaccountname/api/time.cfm?customerkey=84DC6CF8-BF78-D79D-B25B-0C0D20229F17&api_call=timesummary&viewby=projects&startdate=01-sep-2009&enddate=01-oct-2009&UserID=xxx
Method: GET
URL Parameters: viewby, startdate and endate are mandatory. UserID should be passed if viewing information for a particular user. Default is set to ALL.
Notes: 1.    Viewby parameter can be set to either projects or companies. Depending on the viewby parameter the API will return the XML packet containing the data necessary for that display.
2.    Startdate and enddate should be passed with the date format specified in the documentation which is dd-mmm-yyyy.
Return Data: XML data packet of ContactsList detail is constructed by the web service and sent to the user.
Status messages: OK or Error.

 

 

 

Example of Project View return data:
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <TimeRecords>
  3. <Status>OK</Status>
  4. <TimeRecords_Count>1</TimeRecords_Count>
  5. <TimeRecordList>
  6. <Job>
  7. <JobDetails>
  8. <JobId>1</JobId>
  9. <JobNumber>BC001</JobNumber>
  10. <JobTitle>Sample Job</JobTitle>
  11. <JobAllocatedTime>10:10</JobAllocatedTime>
  12. <TotalJobTimeSpent>10:10</TotalJobTimeSpent>
  13. <JobClientID>167</JobClientID>
  14. <ClientName>Sample Client</ClientName>
  15. <ContactTypeID>1</ContactTypeID>
  16. </JobDetails>
  17. <JobTasks>
  18. <Task>
  19. <TaskID>1</TaskID>
  20. <TaskTitle>Sample Task</TaskTitle>
  21. <TaskAllocatedTime>5:10</TaskAllocatedTime>
  22. <TotalTaskTimeSpent>10:10</TotalTaskTimeSpent>
  23. </Task>
  24. </JobTasks>
  25. </Job>
  26. </TimeRecordList>
  27. <TotalDateRangeTime>10.10</TotalDateRangeTime>
  28. </TimeRecords>
 
Example of Company View return data:
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <TimeRecords>
  3. <Status>OK</Status>
  4. <TimeRecords_Count>1</TimeRecords_Count>
  5. <TimeRecordList>
  6. <Client>
  7. <ClientName>Sample Client</ClientName>
  8. <ClientID>1</ClientID>
  9. <ContactTypeID>1</ContactTypeID>
  10. <Job>
  11. <JobDetails>
  12. <JobId>1</JobId>
  13. <JobNumber>BC001</JobNumber>
  14. <JobTitle>Sample Job</JobTitle>
  15. <JobAllocatedTime>10:10</JobAllocatedTime>
  16. <TotalJobTimeSpent>10:10</TotalJobTimeSpent>
  17. </JobDetails>
  18. <JobTasks>
  19. <Task>
  20. <TaskID>1</TaskID>
  21. <TaskTitle>Sample Task</TaskTitle>
  22. <TaskAllocatedTime>5:10</TaskAllocatedTime>
  23. <TotalTaskTimeSpent>10:10</TotalTaskTimeSpent>
  24. </Task>
  25. </JobTasks>
  26. </Job>
  27. </Client>
  28. </TimeRecordList>
  29. <TotalDateRangeTime>10.10</TotalDateRangeTime>
  30. </TimeRecords>
VN:F [1.7.5_995]
Was this article useful?