ProWorkflow API Center http://api.proworkflow.com Sun, 25 Apr 2010 22:25:42 +0000 http://wordpress.org/?v=2.8.6 en hourly 1 Create Job Number http://api.proworkflow.com/projects-manager/create-job-number/ http://api.proworkflow.com/projects-manager/create-job-number/#comments Sun, 14 Mar 2010 22:40:43 +0000 admin http://api.proworkflow.com/?p=246  

Function: Checks whether AutoNumber is turned on and returns the next available JobNumber
Web service call: https://proworkflow2.net/pwfaccountname/api/projects.cfm?customerkey=84DC6CF8-BF78-D79D-B25B-0C0D20229F17&api_call=createjobnumber
Method: GET
Notes: The returned jobnumber format may use variables or text as defined in the Application Settings.
Return Data: XML data packet of JobNumber detail is constructed by the web service and sent to the user.
Status messages: OK, OFF or Error.

 

 

 

Example of return data where AutoNumber enabled:
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <CreateJobNumber>
  3. <Status>OK</Status>
  4. <autonumber>1234</autonumber>
  5. <jobnumber>ABCD-1234</jobnumber>
  6. </CreateJobNumber>
Example of return data where AutoNumber is OFF:
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <CreateJobNumber>
  3. <Status>OFF</Status>
  4. </CreateJobNumber>
]]> http://api.proworkflow.com/projects-manager/create-job-number/feed/ 0 Get Time Summary http://api.proworkflow.com/time-manager/get-time-summary/ http://api.proworkflow.com/time-manager/get-time-summary/#comments Tue, 29 Dec 2009 03:04:31 +0000 admin http://api.proworkflow.com/?p=240  

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>
]]> http://api.proworkflow.com/time-manager/get-time-summary/feed/ 0 Get All Overtime Jobs http://api.proworkflow.com/projects-manager/get-all-overtime-jobs/ http://api.proworkflow.com/projects-manager/get-all-overtime-jobs/#comments Tue, 29 Dec 2009 01:42:08 +0000 admin http://api.proworkflow.com/?p=236
Function: Retrieves all the overtime jobs
Web service call: https://proworkflow2.net/pwfaccountname/api/projects.cfm?customerkey=84DC6CF8-BF78-D79D-B25B-0C0D20229F17&api_call=overtimejobs&UserID=xxx
Method: GET
URL Parameters: UserID is not mandatory. If no id is provided then all jobs will be returned
Return Data: XML data packet of AllOverTimeJobs is constructed by the web service and sent to the user.
Status messages: OK or Error.

 

Example of return data:
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <AllOverTimeJobs>
  3. <Status>OK</Status>
  4. <Job_Count>1</Job_Count>
  5. <Jobs>
  6. <Job>
  7. <id>1</id>
  8. <title>Big Company Email</title>
  9. <client>Big Company</client>
  10. <number>BC0001</number>
  11. <StartDate>11-Feb-2009</StartDate>
  12. <DueDate>21-Feb-2009</DueDate>
  13. <Completedate>21-Feb-2009</Completedate>
  14. <JobCategory>Current</JobCategory>
  15. <AllocatedTime>1:00</AllocatedTime>
  16. <TotalTimeSpent>1:10</TotalTimeSpent>
  17. </Job>
  18. </Jobs>
  19. </AllOverTimeJobs>
]]> http://api.proworkflow.com/projects-manager/get-all-overtime-jobs/feed/ 0 Get All Overtime Tasks http://api.proworkflow.com/tasks-manager/get-all-overtime-tasks/ http://api.proworkflow.com/tasks-manager/get-all-overtime-tasks/#comments Tue, 29 Dec 2009 00:52:03 +0000 admin http://api.proworkflow.com/?p=215
Function: Retrieves all the overtime Job Tasks
Web service call: https://proworkflow2.net/pwfaccountname/api/tasks.cfm?customerkey=84DC6CF8-BF78-D79D-B25B-0C0D20229F17&api_call=overtimetasks&UserID=xxx
Method: GET
URL Parameters: UserID is not mandatory. If no id is provided then all tasks will be returned
Return Data: XML data packet of AllOverTimeTasks is constructed by the web service and sent to the user.
Status messages: OK or Error.

 

Example of return data:
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <AllOverTimeTasks>
  3. <Status>OK</Status>
  4. <Task_Count>1</Task_Count>
  5. <Tasks>
  6. <Task>
  7. <taskid>7911</taskid>
  8. <jobid>37</jobid> (Empty for General tasks)
  9. <jobtitle>Sample Job</jobtitle> (Empty for General tasks)
  10. <jobnumber>BC001</jobnumber> (Empty for General tasks)
  11. <client>BC001</client> (Empty for General tasks)
  12. <title>Sample Task</title>
  13. <taskstatus>A</taskstatus>
  14. <datetostart>11-Feb-2009</datetostart>
  15. <datedue>15-Feb-2009</datedue>
  16. <taskcreatedby>5</taskcreatedby>
  17. <taskassignedto>x5x</taskassignedto>
  18. <taskcreatedby_name>Bob</taskcreatedby_name>
  19. <taskassignedto_names>Bob</taskassignedto_names>
  20. <allocatedtime>1:00</allocatedtime>
  21. <totaltimespent>1:10</totaltimespent>
  22. </Task>
  23. </Tasks>
  24. </AllOverTimeTasks>
]]> http://api.proworkflow.com/tasks-manager/get-all-overtime-tasks/feed/ 0 Appendix http://api.proworkflow.com/getting-started/appendix/ http://api.proworkflow.com/getting-started/appendix/#comments Wed, 23 Dec 2009 02:35:31 +0000 admin http://api.proworkflow.com/?p=178 • Date format: dd-mmm-yyyy

 

• Time format: hh:mm

 

• Contact ID Type:
1 = Client
2 = Contractor
3 = Staff
4 = Other

 

• Variables:
1 = Yes, 0 = No
Y = Yes, N = No
Task Status: A = Archived, C = Current
Job Complete: A = Active, C = Complete

 

• JobStatus is the ID of the Job Category

 

• JobClient ID, if the cIient is a company then append COM in front of the id or if a person then PER in front of the id

 

• Deleted Contacts are deleted but retain the company, historic data is shown in reports.
Delete Company:
DeleteCompany the company is deleted but retains any linked people.
DeleteAll deletes the company and any linked people.

 

• Upcoming Items statuses:
Job Overdue
Job Due
Start Job
Task Overdue
Task Due
Start Task
Start Event

 

For (Get) method status = OK or Error
For (Post) method status = Success, Failure or Error

]]> http://api.proworkflow.com/getting-started/appendix/feed/ 0 API Key Request http://api.proworkflow.com/getting-started/api-key-request/ http://api.proworkflow.com/getting-started/api-key-request/#comments Wed, 23 Dec 2009 02:30:32 +0000 admin http://api.proworkflow.com/?p=183 To request an API key either contact us or login to the Client Area and use the API link in the Software Center section.

]]> http://api.proworkflow.com/getting-started/api-key-request/feed/ 1 API Introduction http://api.proworkflow.com/getting-started/api-introduction/ http://api.proworkflow.com/getting-started/api-introduction/#comments Wed, 23 Dec 2009 02:27:56 +0000 admin http://api.proworkflow.com/?p=181 This is the fourth major release of the ProWorkflow API, all API calls are grouped by category and can be found in the navigation menu to the left.

 

An API key is available in the Client Area of the ProWorkflow website, visit this article for more details.

 

For beta testing we strongly recommend that you contact us to set up a development version of your live subscription account.

 

The minimum required version of ProWorkflow for API key acceptance is v.7.6

]]> http://api.proworkflow.com/getting-started/api-introduction/feed/ 0 Get Upcoming Items http://api.proworkflow.com/upcoming-items/get-upcoming-items/ http://api.proworkflow.com/upcoming-items/get-upcoming-items/#comments Tue, 08 Dec 2009 01:59:26 +0000 admin http://api.proworkflow.com/?p=176
Function: Retrieves the Upcoming Items for a given timeframe
Web service call: https://proworkflow2.net/pwfaccountname/api/upcoming.cfm?customerkey=84DC6CF8-BF78-D79D-B25B-0C0D20229F17&api_call=upcomingitems&startdate=xxx&enddate =xxx&UserID=xxx
Method: GET
URL Parameters: Userid, startdate and enddate are not mandatory.
URL Parameters: If no userid is specified then show information for all is used as a default. If no startdate is specified then the current date will be used. If no enddate is specified then it is set to 2 weeks from the startdate.
Return Data: XML data packet of Upcoming Items is constructed by the web service and sent to the user.
Status messages: OK or Error.

 

Example of return data:
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <UpcomingItems>
  3. <Status>OK</Status>
  4. <Item_Count>3</Item_Count>
  5. <ItemList>
  6. <Item>
  7. <id>1</id>
  8. <title>Email Campaign</title>
  9. <number>BC0001</number>
  10. <startdate>01-Jun-2009</startdate>
  11. <duedate>27-Jun-2009</duedate>
  12. <status>Job Overdue</status>
  13. <projectname>Email Campaign</projectname>
  14. <clientname>Big Company</clientname>
  15. <type>Job</type>
  16. <Job>
  17. <id>1</id>
  18. <title>Email Campaign</title>
  19. <client>Big Company</client>
  20. <number>BC0001</number>
  21. <Startdate>01-Jun-2009</Startdate>
  22. <Duedate>27-Jun-2009</Duedate>
  23. <Completedate>27-Jun-2009</Completedate>
  24. <Invoiced>N</Invoiced>
  25. <Paid>N</Paid>
  26. <AccountedFor>N</AccountedFor>
  27. <AllocatedTime>426</AllocatedTime>
  28. <TotalTimeSpent></TotalTimeSpent>
  29. <JobComplete>0</JobComplete>
  30. <JobDescription>Time limited project for our favorite clients!</JobDescription>
  31. <Notes></Notes>
  32. <JobStatus>14</JobStatus>
  33. <JobAssignedTo>x5x</JobAssignedTo>
  34. <JobAllocatedhours>7</JobAllocatedhours>
  35. <JobAllocatedminutes>6</JobAllocatedminutes>
  36. <Quotedprice>5234.625</Quotedprice>
  37. <ClientLogin>1</ClientLogin>
  38. <InvoicedPrice>798.75</InvoicedPrice>
  39. <JobCreatedBy>5</JobCreatedBy>
  40. <JobCategory>Production</JobCategory>
  41. <JobManager>5</JobManager>
  42. <JobManagerDetails>
  43. <ContactId>5/ContactId>
  44. <ContactCategoryID>1</ContactCategoryID>
  45. <ContactTypeID>3</ContactTypeID>
  46. <CompanyId>Big Company</CompanyId>
  47. <FullName>Aubrey Apple</FullName>
  48. <AddressLine1>328 Two Chain Road</AddressLine1>
  49. <AddressLine2>Rolleston</AddressLine2>
  50. <AddressLine3></AddressLine3>
  51. <WorkPhone>+643 347 3221</WorkPhone>
  52. <MobilePhone>+6421 347 3223</MobilePhone>
  53. <EmailAddress/>
  54. <City>Christchurch</City>
  55. <State/>
  56. <ZipCode>7675</ZipCode>
  57. <Country>New Zealand</Country>
  58. </JobManagerDetails>
  59. </Job>
  60. </Item>
  61. <Item>
  62. <id>1567</id>
  63. <title>Sample Task</title>
  64. <number></number>
  65. <startdate>01-Jun-2009</startdate>
  66. <duedate>27-Jun-2009</duedate>
  67. <status>Task Overdue</status>
  68. <projectname>Email Campaign</projectname>
  69. <clientname>Big Company</clientname>
  70. <type>Task</type>
  71. <Task>
  72. <taskid>7911</taskid>
  73. <jobid>37</jobid> (Empty for General tasks)
  74. <title>Sample Task</title>
  75. <taskstatus>A</taskstatus>
  76. <datetostart>11-Feb-2009</datetostart>
  77. <datedue>15-Feb-2009</datedue>
  78. <taskcreatedby>5</taskcreatedby>
  79. <taskassignedto>x53×1x</taskassignedto>
  80. <TaskPriority>3</TaskPriority>
  81. <allocatedtime>0</allocatedtime>
  82. <deleted>0</deleted>
  83. <compdate> </compdate>
  84. <taskorder>9.0</taskorder>
  85. <taskbilling>1</taskbilling>
  86. <taskdescription>Sample task description</taskdescription>
  87. <allocatedtime_hours>3</allocatedtime_hours>
  88. <allocatedtime_minutes>0</allocatedtime_minutes>
  89. <totaltimespent>3:12</totaltimespent>
  90. <taskstyle_bh>1</taskstyle_bh>
  91. <taskstyle_b>0</taskstyle_b>
  92. <tracking>1</tracking>
  93. <trackerid>157</trackerid> (only provided f tracking is 1)
  94. </Task>
  95. </Item>
  96. <Item>
  97. <id>56</id>
  98. <title>Sample Event</title>
  99. <number></number>
  100. <startdate>01-Jun-2009</startdate>
  101. <duedate></duedate>
  102. <status>Start Event</status>
  103. <projectname></projectname>
  104. <clientname></clientname>
  105. <type>Event</type>
  106. </Item>
  107. </ItemList>
  108. </UpcomingItems>
]]> http://api.proworkflow.com/upcoming-items/get-upcoming-items/feed/ 0 Stop Timer http://api.proworkflow.com/time-manager/stop-timer/ http://api.proworkflow.com/time-manager/stop-timer/#comments Tue, 08 Dec 2009 01:45:00 +0000 admin http://api.proworkflow.com/?p=174
Function: Stops the Timer
Web service call: https://proworkflow2.net/pwfaccountname/api/time.cfm?customerkey=84DC6CF8-BF78-D79D-B25B-0C0D20229F17&api_call=stoptimer&TrackerID=xxx&UserID=xxx
Method: GET
URL Parameters: TrackerID and Userid are mandatory.
Notes: User Permissions are also checked.
Return Data: XML data packet is constructed by the web service and sent to the user. It contains the success or failure message.
Status messages: Success, Failure or Error.

 

Example of return data:
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <StopTimer>
  3. <Status>Success</Status>
  4. <Details>
  5. <Messsage>Timer Stopped</Message>
  6. <TrackerID>3679</TrackerID>
  7. </Details>
  8. </StopTimer>
  9.  
  10. OR
  11.  
  12. <?xml version="1.0" encoding="UTF-8"?>
  13. <StopTimer>
  14. <Status>Failure</Status>
  15. <Details>
  16. <Messsage>Error: You don't have permission to perform this action.</Message>
  17. </Details>
  18. </StopTimer>
]]> http://api.proworkflow.com/time-manager/stop-timer/feed/ 0 Start Timer http://api.proworkflow.com/time-manager/start-timer/ http://api.proworkflow.com/time-manager/start-timer/#comments Tue, 08 Dec 2009 01:42:08 +0000 admin http://api.proworkflow.com/?p=170
Function: Starts a Timer for a Task
Web service call: https://proworkflow2.net/pwfaccountname/api/time.cfm?customerkey=84DC6CF8-BF78-D79D-B25B-0C0D20229F17&api_call=starttimer&TaskID=xxx&UserID=xxx
Method: GET
URL Parameters: TaskID and Userid are mandatory.
Notes: User Permissions are also checked.
Return Data: XML data packet is constructed by the web service and sent to the user. It contains the success or failure message.
Status messages: Success, Failure or Error.

 

Example of return data:
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <StartTimer>
  3. <Status>Success</Status>
  4. <Details>
  5. <Messsage>Timer Started</Message>
  6. <TrackerID>3679</TrackerID>
  7. </Details>
  8. </StartTimer>
  9.  
  10. OR
  11.  
  12. <?xml version="1.0" encoding="UTF-8"?>
  13. <StartTimer>
  14. <Status>Failure</Status>
  15. <Details>
  16. <Messsage>Error: You don't have permission to perform this action.</Message>
  17. </Details>
  18. </StartTimer>
]]> http://api.proworkflow.com/time-manager/start-timer/feed/ 0