Function: Retrieves the Upcoming Items for a given timeframe
Web service call: https://proworkflow2.net/pwfaccountname/api/v2/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. <itemcount>3</itemcount>
  5. <itemlist>
  6. <events>
  7. <eventcount>1</eventcount>
  8. <event>
  9. <eventid>1</eventid>
  10. <eventtitle>Email Campaign</eventtitle>
  11. <eventdatestart>01-Jun-2009</eventdatestart>
  12. <eventdatedue>27-Jun-2009</eventdatedue>
  13. <eventtimestart>12.05</eventtimestart>
  14. <eventtimeend>13.50</eventtimeend>
  15. <eventstatus>start event</eventstatus>
  16. <type>event</type>
  17. </event>
  18. </events>
  19. <jobs>
  20. <jobcount>1</jobcount>
  21. <joblist>
  22. <job>
  23. <jobid>1</jobid>
  24. <jobtitle>Email Campaign</jobtitle>
  25. <jobnumber>BC0001</jobnumber>
  26. <jobclient>Big Company</jobclient>
  27. <jobclientid>23</jobclientid>
  28. <jobmanager>5</jobmanager>
  29. <jobmanagername>Aubrey Apple</jobmanagername>
  30. <jobmanagerdetails>
  31. <contactid>5/contactid>
  32. <contactcategoryid>1</contactcategoryid>
  33. <contacttypeid>3</contacttypeid>
  34. <contactcompanyid>Big Company</contactcompanyid>
  35. <contactfullname>Aubrey Apple</contactfullname>
  36. <contactjobtitle>Manager</contactjobtitle>
  37. <contactaddressline1>328 Two Chain Road</contactaddressline1>
  38. <contactaddressline2>Rolleston</contactaddressline2>
  39. <contactaddressline3></contactaddressline3>
  40. <contactworkphone>+643 347 3221</contactworkphone>
  41. <contacthomephone>+643 347 3221</contacthomephone>
  42. <contactmobilephone>+6421 347 3223</contactmobilephone>
  43. <contactfax>+6421 347 3223</contactfax>
  44. <contactallowlogin>1</contactallowlogin>
  45. <contactloginname>demo</contactloginname>
  46. <contactpassword>demo</contactpassword>
  47. <contactprimarycontact>0</contactprimarycontact>
  48. <contactphoneextension>ext234</contactphoneextension>
  49. <contactemailaddress>noreply@proworkflow.com</contactemailaddress>
  50. <contactcity>Christchurch</contactcity>
  51. <contactstate>CC</contactstate>
  52. <contactzipcode>7675</contactzipcode>
  53. <contactcountry>New Zealand</contactcountry>
  54. </jobmanagerdetails>
  55. <jobassignedtostaff>x326×329x151×359x143×5x</jobassignedtostaff>
  56. <jobassignedtostaffnames>Alan Barlow,Alan Smith,Amanda Durand,Angus Adams,Brad Haynes,Julian Stone</jobassignedtostaffnames>
  57. <jobassignedtoclientcontacts>277</jobassignedtoclientcontacts>
  58. <jobassignedtoclientcontactnames>Sufiana Syed</jobassignedtoclientcontactnames>
  59. <jobassignedtocontractorcontacts>x429×358x</jobassignedtocontractorcontacts>
  60. <jobassignedtocontractorcontactnames>John Seagull,Lazy Suzy</jobassignedtocontractorcontactnames>
  61. <jobdatestart>01-Jun-2009</jobdatestart>
  62. <jobdatedue>27-Jun-2009</jobdatedue>
  63. <jobdatecompleted>27-Jun-2009</jobdatecompleted>
  64. <jobdaysuntildue>2</jobdaysuntildue>
  65. <jobcategory>Production</jobcategory>
  66. <jobcategoryid>2</jobcategoryid>
  67. <jobpriority>3 – Medium</jobpriority>
  68. <jobstatus>14</jobstatus>
  69. <jobtotaltimespent></jobtotaltimespent>
  70. <jobtotaltimeallocated>426</jobtotaltimeallocated>
  71. <jobquotedamount>5234.625</ jobquotedamount>
  72. <jobinvoicedamount>798.75</jobinvoicedamount>
  73. <jobinvoiced>no</jobinvoiced>
  74. <jobpaid>no</jobpaid>
  75. <jobaccountedfor>no</jobaccountedfor>
  76. <jobdependent>no</jobdependent>
  77. <jobdescription>Time limited project for our favorite clients!</jobdescription>
  78. <jobnotes></jobnotes>
  79. <jobclientlogin>1</jobclientlogin>
  80. <jobdeleted>no</jobdeleted>
  81. </job>
  82. </joblist>
  83. </jobs>
  84. <tasks>
  85. <taskcount>1</taskcount>
  86. <tasklist>
  87. <task>
  88. <taskid>7911</taskid>
  89. <jobid>37</jobid> (Empty for General tasks)
  90. <jobtitle>Sample Job</jobtitle> (Empty for General tasks)
  91. <jobnumber>BC001</jobnumber> (Empty for General tasks)
  92. <jobclient>BC001</jobclient> (Empty for General tasks)
  93. <jobclientid>7</jobclientid> (Empty for General tasks)
  94. <tasktitle>Sample Task</tasktitle>
  95. <taskstatus>active</taskstatus>
  96. <taskdatestart>11-Feb-2009</taskdatestart>
  97. <taskdatedue>15-Feb-2009</taskdatedue>
  98. <taskdatecompleted>15-Feb-2009</taskdatecompleted>
  99. <taskcreatedby>5</taskcreatedby>
  100. <taskassignedto>x53×1x</taskassignedto>
  101. <taskcreatedby_name>Bob</taskcreatedby_name>
  102. <taskassignedto_names>Bob,Peter</taskassignedto_names>
  103. <taskpriority>3</taskpriority>
  104. <taskdeleted>0</taskdeleted>
  105. <taskorder>9.0</taskorder>
  106. <taskbillable>yes</taskbillable>
  107. <taskdescription>Sample task description</taskdescription>
  108. <tasktimeallocated>0</tasktimeallocated>
  109. <tasktotaltimespent>3:12</tasktotaltimespent>
  110. <tasktype>normal</tasktype>
  111. <taskactive>yes</taskactive>
  112. <tasktimetracking>yes</tasktimetracking>
  113. <timetrackerid>157</timetrackerid>
  114. </task>
  115. </tasklist>
  116. </tasks>
  117. </itemlist>
  118. </upcomingitems>
VN:F [1.7.5_995]
Was this article useful?