Api doc


SDK's


Api Modules

reports.schedule



Supported Methods:

GET
Params
  • token (Required): valid token
  • start_date (Required): date
  • end_date (Required): date
  • type (Required): enum (schedule_summary, shift_confirmed, crib_sheet, shift_exchanges, open_shifts, position_summary, shift_acknowledgement)
  • location: integer
  • schedule: varchar
  • employee: varchar
  • skill: varchar
  • with_statuses: integer
  • options: integer
  • deductbreaks: integer
  • remote_site: integer
  • include_emp_per_pos: integer
  • acknowledgement_status: varchar


Documentation

GET
Retrives a list of schedule reports betwen selected dates.
Level 5 is required (all users can fetch this module)

--

Parameters:

  1. "start_date": required //Start date (date)
  2. "end_date": required //End date (date)
  3. "type": required //Type (enum[schedule_summary,shift_confirmed,crib_sheet,
  4. // shift_exchanges,open_shifts,position_summary])
  5. /* schedule_summary: Schedule summary
  6.   * shift_confirmed: Confirmed shifts
  7.   * crib_sheet: Crib sheet
  8.   * shift_exchanges: Shift exchanges
  9.   * open_shifts: Open shifts
  10.   * position_summary: Position summary */
  11. "location": accepted //Location id (integer)
  12. "schedule": accepted //Schedule id (integer)
  13. "employee": accepted //Employees (varchar)
  14. /* Array of employees ids (eg. "234,563,770") */
  15. "skill": accepted //Skill id (integer)
  16. "with_statuses": accepted //With or without statuses (integer)
  17. /* null : without statuses
  18.   * isset: with statuses */
  19. "options": accepted //Options (integer)
  20. /* 1: Order by name */
  21. "token": "xxxxxxx" //Valid token is required

Example Request:

  1. {
  2. "method":"GET",
  3. "module":"reports.schedule",
  4. "request":{
  5. "start_date":"May 19, 2012",
  6. "end_date":"May 21, 2012",
  7. "type":"open_shifts"
  8. }
  9. }

Example Response:

  1. {
  2. "status":1,
  3. "data":{
  4. "82185":{
  5. "id":"82185",
  6. "series":"82015",
  7. "created":"1311728514",
  8. "published":"1339668653",
  9. "edited":"1311728514",
  10. "deleted":"0",
  11. "recurs":"1",
  12. "recur_rule":"2",
  13. "schedule":"866",
  14. "store":"11",
  15. "type":"1",
  16. "needed":"1",
  17. "have":"0",
  18. "working":"0",
  19. "user":"2",
  20. "start_date":{
  21. "id":"1116",
  22. "month":"5",
  23. "day":"19",
  24. "year":"2012",
  25. "weekday":"Sat",
  26. "mname":"May",
  27. "week":"20",
  28. "dayid":7,
  29. "formatted":"May 19, 2012"
  30. },
  31. "end_date":{
  32. "id":"1116",
  33. "month":"5",
  34. "day":"19",
  35. "year":"2012",
  36. "weekday":"Sat",
  37. "mname":"May",
  38. "week":"20",
  39. "dayid":7,
  40. "formatted":"May 19, 2012"
  41. },
  42. "start":"11 am",
  43. "end":"5 pm",
  44. "length":"0",
  45. "title":"",
  46. "location":"0",
  47. "notes":"",
  48. "confirmed":"0",
  49. "schedule_name":"Development",
  50. "schedule_color":"657050",
  51. "employee":[
  52. null
  53. ]
  54. },
  55. "93829":{
  56. "id":"93829",
  57. "series":"0",
  58. "created":"1337631224",
  59. "published":"1339668653",
  60. "edited":"1337631231",
  61. "deleted":"0",
  62. "recurs":"0",
  63. "recur_rule":"0",
  64. "schedule":"32410",
  65. "store":"11",
  66. "type":"1",
  67. "needed":"3",
  68. "have":"0",
  69. "working":"0",
  70. "user":"5148",
  71. "start_date":{
  72. "id":"1117",
  73. "month":"5",
  74. "day":"20",
  75. "year":"2012",
  76. "weekday":"Sun",
  77. "mname":"May",
  78. "week":"20",
  79. "dayid":1,
  80. "formatted":"May 20, 2012"
  81. },
  82. "end_date":{
  83. "id":"1117",
  84. "month":"5",
  85. "day":"20",
  86. "year":"2012",
  87. "weekday":"Sun",
  88. "mname":"May",
  89. "week":"20",
  90. "dayid":1,
  91. "formatted":"May 20, 2012"
  92. },
  93. "start":"8 am",
  94. "end":"4 pm",
  95. "length":"0",
  96. "title":"",
  97. "location":"0",
  98. "notes":"",
  99. "confirmed":"0",
  100. "schedule_name":"Cash",
  101. "schedule_color":"570026",
  102. "employee":[
  103. null
  104. ]
  105. },
  106. "93901":{
  107. "id":"93901",
  108. "series":"0",
  109. "created":"1337632834",
  110. "published":"1339668653",
  111. "edited":"1337934987",
  112. "deleted":"0",
  113. "recurs":"0",
  114. "recur_rule":"0",
  115. "schedule":"32408",
  116. "store":"11",
  117. "type":"1",
  118. "needed":"5",
  119. "have":"0",
  120. "working":"0",
  121. "user":"4910",
  122. "start_date":{
  123. "id":"1119",
  124. "month":"5",
  125. "day":"22",
  126. "year":"2012",
  127. "weekday":"Tue",
  128. "mname":"May",
  129. "week":"21",
  130. "dayid":3,
  131. "formatted":"May 22, 2012"
  132. },
  133. "end_date":{
  134. "id":"1119",
  135. "month":"5",
  136. "day":"22",
  137. "year":"2012",
  138. "weekday":"Tue",
  139. "mname":"May",
  140. "week":"21",
  141. "dayid":3,
  142. "formatted":"May 22, 2012"
  143. },
  144. "start":"8 am",
  145. "end":"5 pm",
  146. "length":"0",
  147. "title":"",
  148. "location":"0",
  149. "notes":"",
  150. "confirmed":"0",
  151. "schedule_name":"Admin\/meetings",
  152. "schedule_color":"484948",
  153. "employee":[
  154. null
  155. ]
  156. }
  157. },
  158. "token":"xxxxxxx"
  159. }

GET STARTED NOW

Free Trial. No Credit Card Required.

close
(e.g.+14158675309 or +1415-8675-309)

By clicking "Create my ShiftPlanning Account" you agree to the Terms of Service and Privacy Policy.

Have a promotional code?Click Here


LIVE CHAT DEMO REQUEST!

Please provide information below.

close
INSTANT DEMOSCHEDULED DEMO
Connect with a ShiftPlanning Team Member for a live demo right now!
 

RESELLER REQUEST!

Please provide information below.

close