ProWorkflow API Center http://api.proworkflow.com Mon, 05 Sep 2011 22:41:40 +0000 http://wordpress.org/?v=2.8.6 en hourly 1 Add Message http://api.proworkflow.com/message-manager/add-message/ http://api.proworkflow.com/message-manager/add-message/#comments Tue, 30 Aug 2011 22:47:53 +0000 admin http://api.proworkflow.com/?p=427
Function: Inserts a Message into the database
Web service call: https://proworkflow2.net/pwfaccountname/api/v2/messages.cfm?customerkey=84DC6CF8-BF78-D79D-B25B-0C0D20229F17&api_call=addmessage
Method: POST
XML Request Data:
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <addmessage>
  3. <messagetitle>Sample Message</messagetitle> REQUIRED FIELD
  4. <messagecontent>Message Content</messagecontent>
  5. <messagejobid>5</messagejobid>
  6. <messagetaskid>554</messagetaskid>
  7. <messagereplytoid>8</messagereplytoid>
  8. <messagesenderid>4</messagesenderid>
  9. <messagerecipients>x326×329x151×359x143x</messagerecipients>
  10. <messagepublic>no</messagepublic>
  11. <messagesendemail>yes</messagesendemail>
  12. </addmessage>
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. <addmessage>
  3. <status>Success</status>
  4. <details>
  5. <message>Message Added Successfully</message>
  6. <messageid>7</messageid>
  7. </details>
  8. </addmessage>
]]> http://api.proworkflow.com/message-manager/add-message/feed/ 0 Get All Active Messages http://api.proworkflow.com/message-manager/get-all-active-messages/ http://api.proworkflow.com/message-manager/get-all-active-messages/#comments Tue, 30 Aug 2011 22:38:30 +0000 admin http://api.proworkflow.com/?p=423  

Function: Gets all the active messages.
Web service call: https://proworkflow2.net/pwfaccountname/api/v2/messages.cfm?customerkey=84DC6CF8-BF78-D79D-B25B-0C0D20229F17&api_call=activemessages&userid=xxx&jobid=xxx&taskid=xxx&startdate=xx-xx-xxxx&enddate=xx-xx-xxxx
Method: GET
URL Parameters: Userid, Jobid, Taskid, Startdate and Enddate are not mandatory.
Return Data: XML data packet of activemessages detail 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. <activemessages>
  3. <status>OK</status>
  4. <messagecount>1</messagecount>
  5. <messages>
  6. <message>
  7. <messageid>121</messageid>
  8. <messagetitle>Sample Message</messagetitle>
  9. <messagecontent>Message Content</messagecontent>
  10. <messagejobid>74</messagejobid>
  11. <messagetaskid>12</messagetaskid>
  12. <messagereplytoid>5</messagereplytoid>
  13. <messagereplies>1</messagereplies>
  14. <messagesenderid>7</messagesenderid>
  15. <messagesendername>Aubrey Apple</messagesendername>
  16. <messagerecipients>x326×329x151×359x143×5x</messagerecipients>
  17. <messagerecipientnames>Alan Barlow,Alan Smith,Amanda Durand,Angus Adams,Brad Haynes,Julian Stone</messagerecipientnames>
  18. <messagedatesent>11-Feb-2009</messagedatesent>
  19. <messagepublic>yes</messagepublic>
  20. <messageattachedfiles>
  21. <messageattachedfilecount>1</messageattachedfilecount>
  22. <messageattachedfileslist>
  23. <file>
  24. <filename>sample_file.jpg</filename>
  25. <filesize>40kb</filesize>
  26. <datemodified>11-Feb-2009</datemodified>
  27. <filepath></filepath>
  28. </file>
  29. </messageattachedfileslist>
  30. </messageattachedfiles>
  31. </message>
  32. </messages>
  33. </activemessages>
]]> http://api.proworkflow.com/message-manager/get-all-active-messages/feed/ 0 Get All Active Quotes http://api.proworkflow.com/quote-manager/get-all-active-quotes/ http://api.proworkflow.com/quote-manager/get-all-active-quotes/#comments Tue, 30 Aug 2011 22:15:42 +0000 admin http://api.proworkflow.com/?p=420  

Function: Gets all the active quotes.
Web service call: https://proworkflow2.net/pwfaccountname/api/v2/quotes.cfm?customerkey=84DC6CF8-BF78-D79D-B25B-0C0D20229F17&api_call=getactivequotes&jobid=xxx&startdate=xx-xx-xxxx&enddate=xx-xx-xxxx
Method: GET
URL Parameters: Jobid, Startdate and Enddate are not mandatory.
Return Data: XML data packet of allactivequotes detail 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. <allactivequotes>
  3. <status>OK</status>
  4. <quotecount>1</quotecount>
  5. <quotes>
  6. <quote>
  7. <quoteid>121</quoteid>
  8. <quotetitle>Sample Quote</quotetitle>
  9. <quotenumber>456</quotenumber>
  10. <quotedbyname>Aubrey Apple</quotedbyname>
  11. <quotejobid>74</quotejobid>
  12. <quoteclientcompanyid>12</quoteclientcompanyid>
  13. <quoteclientcompanyname>Big Company</quoteclientcompanyname>
  14. <quoteclientname>Brad Haynes</quoteclientname>
  15. <quotestatus>Current</quotestatus>
  16. <quotetype>Quoted</quotetype>
  17. <quoteddate>21-Feb-2009</quoteddate>
  18. <quotevalidtodate>25-Feb-2009</quotevalidtodate>
  19. <quotetotalgrossprice>115.00</quotetotalgrossprice>
  20. <quotetotaltax>15.00</quotetotaltax>
  21. <quotetotalnetprice>100</quotetotalnetprice>
  22. </quote>
  23. </quotes>
  24. <quotestotalgrossprice>115.00</quotestotalgrossprice>
  25. <quotestotaltax>15.00</quotestotaltax>
  26. <quotestotalnetprice>100.00</quotestotalnetprice>
  27. </allactivequotes>
]]> http://api.proworkflow.com/quote-manager/get-all-active-quotes/feed/ 0 Get All Active Invoices http://api.proworkflow.com/invoice-manager/get-all-active-invoices/ http://api.proworkflow.com/invoice-manager/get-all-active-invoices/#comments Tue, 30 Aug 2011 22:10:04 +0000 admin http://api.proworkflow.com/?p=417  

Function: Gets all the active invoices.
Web service call: https://proworkflow2.net/pwfaccountname/api/v2/invoicing.cfm?customerkey=84DC6CF8-BF78-D79D-B25B-0C0D20229F17&api_call=getactiveinvoices&jobid=xxx&startdate=xx-xx-xxxx&enddate=xx-xx-xxxx
Method: GET
URL Parameters: Jobid, Startdate and Enddate are not mandatory.
Return Data: XML data packet of allactiveinvoices detail 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. <allactiveinvoices>
  3. <status>OK</status>
  4. <invoicecount>1</invoicecount>
  5. <invoices>
  6. <invoice>
  7. <invoiceid>121</invoiceid>
  8. <invoicetitle>Sample Invoice</invoicetitle>
  9. <invoicenumber>456</invoicenumber>
  10. <invoicedbyname>Aubrey Apple</invoicedbyname>
  11. <invoicejobid>74</invoicejobid>
  12. <invoiceclientcompanyid>12</invoiceclientcompanyid>
  13. <invoiceclientcompanyname>Big Company</invoiceclientcompanyname>
  14. <invoiceclientname>Brad Haynes</invoiceclientname>
  15. <invoicestatus>Archived</invoicestatus>
  16. <invoiceddate>21-Feb-2009</invoiceddate>
  17. <invoiceduedate>20-Feb-2009</invoiceduedate>
  18. <invoicetotalgrossprice>115.00</invoicetotalgrossprice>
  19. <invoicetotaltax>15.00</invoicetotaltax>
  20. <invoicetotalnetprice>100</invoicetotalnetprice>
  21. </invoice>
  22. </invoices>
  23. <invoicestotalgrossprice>115.00</invoicestotalgrossprice>
  24. <invoicestotaltax>15.00</invoicestotaltax>
  25. <invoicestotalnetprice>100.00</invoicestotalnetprice>
  26. </allactiveinvoices>
]]> http://api.proworkflow.com/invoice-manager/get-all-active-invoices/feed/ 0 Upload File http://api.proworkflow.com/file-manager/upload-file/ http://api.proworkflow.com/file-manager/upload-file/#comments Tue, 30 Aug 2011 03:15:59 +0000 admin http://api.proworkflow.com/?p=413
Function: Upload a file
Web service call: https://proworkflow2.net/pwfaccountname/api/v2/files.cfm?customerkey=84DC6CF8-BF78-D79D-B25B-0C0D20229F17&api_call=uploadfile&UserID=xxx
Method: POST
XML Request Data:
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <uploadfile>
  3. <jobid>9</jobid>
  4. <filename>sample_file.jpg</filename>
  5. <folderid>1</folderid>
  6. <filedata></filedata>
  7. <taskid>23</taskid>
  8. </uploadfile>
URL Parameters: UserID is mandatory.
Notes: File data should be in base64 format.
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. <uploadfile>
  3. <status>Success</status>
  4. <details>
  5. <message>File Uploaded</message>
  6. <fileid>7</fileid>
  7. </details>
  8. </uploadfile>
  9.  
  10. OR
  11.  
  12. <?xml version="1.0" encoding="UTF-8"?>
  13. <uploadfile>
  14. <status>Failure</status>
  15. <details>
  16. <message>Error: Folder does not exists. Please check the FolderID submitted is valid.</message>
  17. </details>
  18. </uploadfile>
]]> http://api.proworkflow.com/file-manager/upload-file/feed/ 0 Create Folder http://api.proworkflow.com/file-manager/create-folder/ http://api.proworkflow.com/file-manager/create-folder/#comments Tue, 30 Aug 2011 01:35:46 +0000 admin http://api.proworkflow.com/?p=410
Function: Creates a new folder
Web service call: https://proworkflow2.net/pwfaccountname/api/v2/files.cfm?customerkey=84DC6CF8-BF78-D79D-B25B-0C0D20229F17&api_call=createfolder&UserID=xxx
Method: POST
XML Request Data:
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <addfolder>
  3. <jobid>9</jobid> REQUIRED FIELD
  4. <foldername>Sample Folder</foldername> REQUIRED FIELD
  5. <publicfolder>1</publicfolder>
  6. <folderassginedto>x54x</folderassginedto>
  7. </addfolder>
URL Parameters: UserID is mandatory.
Notes: Required fields must be included, other fields can be omitted.
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. <addfolder>
  3. <status>Success</status>
  4. <details>
  5. <message>Folder Created</message>
  6. <folderid>7</folderid>
  7. </details>
  8. </addfolder>
  9.  
  10. OR
  11.  
  12. <?xml version="1.0" encoding="UTF-8"?>
  13. <addfolder>
  14. <status>Failure</status>
  15. <details>
  16. <message>Error: You don't have permission to perform this action.</message>
  17. </details>
  18. </addfolder>
]]> http://api.proworkflow.com/file-manager/create-folder/feed/ 0 Get All Job Folders http://api.proworkflow.com/file-manager/get-all-job-folders/ http://api.proworkflow.com/file-manager/get-all-job-folders/#comments Tue, 30 Aug 2011 00:18:02 +0000 admin http://api.proworkflow.com/?p=407  

Function: Retrieves all folders for a specific job
Web service call: https://proworkflow2.net/pwfaccountname/api/v2/files.cfm?customerkey=84DC6CF8-BF78-D79D-B25B-0C0D20229F17&api_call=getalljobfolders&jobid=xxx&sortby=filename&sortorder=desc
Method: GET
URL Parameters: Jobid is mandatory. Sortby is not mandatory but if used the value should be either filename or foldername. Sortorder is not mandatory but if used the value should be either asc or desc.
Return Data: XML data packet of alljobfolders detail 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. <alljobfolders>
  3. <status>OK</status>
  4. <foldercount>1</foldercount>
  5. <folders>
  6. <folder>
  7. <folderid>12</folderid>
  8. <foldername>Sample Folder</foldername>
  9. <foldersize>40kb</foldersize>
  10. <publicfolder>no</publicfolder>
  11. <folderpath></folderpath>
  12. <foldertype>root</foldertype>
  13. </folder>
  14. </folders>
  15. </alljobfolders>
]]> http://api.proworkflow.com/file-manager/get-all-job-folders/feed/ 0 Get All Job Files http://api.proworkflow.com/file-manager/get-all-job-files/ http://api.proworkflow.com/file-manager/get-all-job-files/#comments Mon, 29 Aug 2011 23:54:10 +0000 admin http://api.proworkflow.com/?p=403  

Function: Retrieves all files for a specific job
Web service call: https://proworkflow2.net/pwfaccountname/api/v2/files.cfm?customerkey=84DC6CF8-BF78-D79D-B25B-0C0D20229F17&api_call=getalljobfiles&jobid=xxx&sortby=filename&sortorder=desc
Method: GET
URL Parameters: Jobid is mandatory. Sortby is not mandatory but if used the value should be either filename or foldername. Sortorder is not mandatory but if used the value should be either asc or desc.
Return Data: XML data packet of alljobfiles detail 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. <alljobfiles>
  3. <status>OK</status>
  4. <filecount>1</filecount>
  5. <files>
  6. <file>
  7. <filename>sample_file.jpg</filename>
  8. <filesize>40kb</filesize>
  9. <datemodified>11-Feb-2009</datemodified>
  10. <filepath></filepath>
  11. </file>
  12. </files>
  13. </alljobfiles>
]]> http://api.proworkflow.com/file-manager/get-all-job-files/feed/ 0 Specific Time Record http://api.proworkflow.com/time-manager/specific-time-record/ http://api.proworkflow.com/time-manager/specific-time-record/#comments Mon, 29 Aug 2011 03:31:39 +0000 admin http://api.proworkflow.com/?p=400
Function: Retrieves a specific time record
Web service call: https://proworkflow2.net/pwfaccountname/api/v2/time.cfm?customerkey=84DC6CF8-BF78-D79D-B25B-0C0D20229F17&api_call=specifictimerecordcall&Trackerid=xxx
Method: GET
URL Parameters: Trackerid is mandatory.
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: OK or Error.

 

Example of return data:
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <getspecifictimerecord>
  3. <status>OK</status>
  4. <timerecordcount>1</timerecordcount>
  5. <timerecord>
  6. <trackerid>21847</trackerid>
  7. <trackertaskid>547</trackertaskid>
  8. <trackernotes>test</trackernotes>
  9. <trackercontactid>27</trackercontactid>
  10. <trackerdate>20-Jul-2009</trackerdate>
  11. <trackeractive>0</trackeractive>
  12. <trackertimestarted>15:27</trackertimestarted>
  13. <trackertimefinished>15:47</trackertimefinished>
  14. <trackertimespent>20</trackertimespent>
  15. <trackerdeleted>no</trackerdeleted>
  16. <trackerpaused>no</trackerpaused>
  17. </timerecord>
  18. </getspecifictimerecord>
]]> http://api.proworkflow.com/time-manager/specific-time-record/feed/ 0 Get Tasks In Category http://api.proworkflow.com/tasks-manager/get-specific-gen-tasks/ http://api.proworkflow.com/tasks-manager/get-specific-gen-tasks/#comments Mon, 29 Aug 2011 03:16:59 +0000 admin http://api.proworkflow.com/?p=397  

Function: Retrieves all general tasks for a specific category
Web service call: https://proworkflow2.net/pwfaccountname/api/v2/tasks.cfm?customerkey=84DC6CF8-BF78-D79D-B25B-0C0D20229F17&api_call=specificgentasks&TaskCatID=xxx&UserID=xxx
Method: GET
URL Parameters: TaskCatID is mandatory. UserID is not mandatory but if it is passed it will filter the time tracked by that user else it will display the total time tracked on that task
Return Data: XML data packet of allgentasks detail 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. <allgentasks>
  3. <status>OK</status>
  4. <taskcount>1</taskcount>
  5. <tasks>
  6. <task>
  7. <taskid>7911</taskid>
  8. <taskcatid>3</taskcatid>
  9. <taskorder>1.2</taskorder>
  10. <tasktitle>Sample Task</tasktitle>
  11. <taskstatus>active</taskstatus>
  12. <taskpriority>3</taskpriority>
  13. <taskdatestart>11-Feb-2009</taskdatestart>
  14. <taskdatedue>15-Feb-2009</taskdatedue>
  15. <taskdatecompleted>15-Feb-2009</taskdatecompleted>
  16. <taskcreatedby>5</taskcreatedby>
  17. <taskassignedto>x53×1x</taskassignedto>
  18. <taskcreatedby_name>Bob</taskcreatedby_name>
  19. <taskassignedto_names>Bob,Peter</taskassignedto_names>
  20. <taskbillable>yes</taskbillable>
  21. <taskdescription>Sample task description</taskdescription>
  22. <tasktimeallocated>0</tasktimeallocated>
  23. <tasktotaltimespent>3:12</tasktotaltimespent>
  24. <taskdeleted>0</taskdeleted>
  25. <tasktimetracking>yes</tasktimetracking>
  26. <timetrackerid>1547</timetrackerid>
  27. <tasktype>normal</tasktype>
  28. <taskactive>yes</taskactive>
  29. <taskdependent>no</taskdependent>
  30. </task>
  31. </tasks>
  32. </allgentasks>
]]> http://api.proworkflow.com/tasks-manager/get-specific-gen-tasks/feed/ 0