Api doc


SDK's


Api Modules

reports.custom



Supported Methods:

GET
Params
  • token (Required): valid token
  • fields (Required): varchar
  • start_date (Required): date
  • end_date (Required): date
  • type (Required): enum (timesheets, confirmedtimesheets, shifts, confirmedshifts, openshifts)
  • schedule: varchar
  • employee: varchar
  • location: integer
  • skill: varchar
  • deduct_breaks: min length 1
  • remote_site: integer
  • options: varchar


Documentation

GET
Retrieves a list of custom reports.
Level 3 is required.

--

Parameters:

  1. "fields": required //Fields (varchar)
  2. /* Allowed fields:
  3.  
  4.   * type = 'timesheets':
  5.   * 'employee', 'eid', 'user', 'location',
  6.   * 'schedule_id', 'schedule_name','start_day',
  7.   * 'end_day', 'start_time', 'end_time',
  8.   * 'total_time', 'notes'
  9.  
  10.   * type = 'confirmedtimesheets':
  11.   * 'employee', 'eid', 'user', 'location',
  12.   * 'schedule_id', 'schedule_name', 'start_day',
  13.   * 'end_day', 'start_time', 'end_time', 'total_time',
  14.   * 'rate', 'ratecard', 'special', 'overtime',
  15.   * 'cost', 'notes'
  16.  
  17.   * type = 'shifts':
  18.   * 'employee', 'eid', 'user', 'location',
  19.   * 'schedule_id', 'schedule_name', 'start_day',
  20.   * 'end_day', 'start_time', 'end_time',
  21.   * 'total_time','title','notes'
  22.  
  23.   * type = 'confirmedshifts':
  24.   * 'employee', 'eid', 'user', 'location',
  25.   * 'schedule_id', 'schedule_name', 'start_day',
  26.   * 'end_day', 'start_time', 'end_time',
  27.   *'total_time','title','notes'
  28.  
  29.   * type = 'openshifts':
  30.   * 'employees', 'slots', 'location', 'schedule_id',
  31.   * 'schedule_name', 'start_day', 'end_day',
  32.   * 'start_time', 'end_time', 'total_time',
  33.   * 'title','notes', 'published' */
  34.  
  35. "start_date": required //Start date (date)
  36. "end_date": required //End date (date)
  37. "type": required //Type (enum)
  38.  
  39. /* timesheets,
  40.   * confirmedtimesheets,
  41.   * shifts,
  42.   * confirmedshifts
  43.   * openshifts */
  44.  
  45. "schedule": accepted //Schedule id (integer)
  46. "employee": accepted //Employee (varchar)
  47.  
  48. /* Array of employees ids (eg."234,563,770")*/
  49. "location": accepted //Location id (integer)
  50. "skill": accepted //Skill id (integer)
  51. "deduct_breaks": accepted //Deduct breaks (enum)
  52. /* isset: Deduct breaks */
  53.  
  54. "token": "xxxxxxx" //Valid token is required

Example Request:

  1. {
  2. "module":"reports.custom",
  3. "method":"GET",
  4. "request":{
  5. "fields":"employee",
  6. "start_date":"May 19, 2012",
  7. "end_date":"May 20, 2012",
  8. "type":"confirmedshifts"
  9. }
  10. }

Example Response:

  1. {
  2. "status":"1",
  3. "data":[
  4. {
  5. "employee":"Alan"
  6. },
  7. {
  8. "employee":"Bond"
  9. },
  10. {
  11. "employee":"Brian"
  12. },
  13. {
  14. "employee":"Peter"
  15. },
  16. {
  17. "employee":"stewie "
  18. }
  19. ],
  20. "token":"xxxxxxx"
  21. }

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