Api doc


SDK's


Api Modules

schedule.schedule

Management of individual schedules.



Supported Methods:

GET
Params
  • token (Required): valid token
  • id (Required): integer


CREATE
Params
  • token (Required): valid token
  • name (Required): varchar
  • active: enum (1, -1)
  • start_time: time
  • end_time: time
  • color: integer
  • location: integer
  • visible: enum (0, 1)


UPDATE
Params
  • token (Required): valid token
  • id (Required): integer
  • active: enum (1, -1)
  • job_code: varchar
  • name: varchar
  • start_time: time
  • end_time: time
  • color: integer
  • location: integer
  • visible: enum (0, 1)


DELETE
Params
  • token (Required): valid token
  • id (Required): integer


Documentation

GET
Retrieves an individual schedule.
Level 5 is required (all users can fetch this module)

--

Parameters:

  1. "id": required //Schedule id (integer)
  2. "token": "xxxxxxx" //Valid token is required

Example Request:

  1. {
  2. "module":"schedule.schedule",
  3. "method":"GET",
  4. "request":{
  5. "id":"1433"
  6. }
  7. }

Example Response:

  1. {
  2. "status":1,
  3. "data":{
  4. "id":"32408",
  5. "name":"Admin\/meetings",
  6. "start_time":{
  7. "id":"1",
  8. "time":"12 am"
  9. },
  10. "end_time":{
  11. "id":"97",
  12. "time":"midnight"
  13. },
  14. "color":"1",
  15. "ical":"http:\/\/www.shiftplanning.com\/ical\/-044.ics"
  16. },
  17. "token":"xxxxxxx"
  18. }

---

CREATE
Creates an individual schedule.
Level 3 is required.

--

Parameters:

  1. "name": required //Schedule name (varchar)
  2. "active": accepted //Active (enum[-1,1])
  3. /* -1: inactive
  4.   * 1: active */
  5. "start_time": accepted //Start time (time)
  6. "end_time": accepted //End time (time)
  7. "color": accepted //Color (integer)
  8. "location": accepted //Location id (integer)
  9. "token": "xxxxxxx" //Valid token is required

Example Request:

  1. {
  2. "module":"schedule.schedule",
  3. "method":"CREATE",
  4. "request":{
  5. "name":"NewSchedule"
  6. }
  7. }

Example Response:

  1. {
  2. "status":1,
  3. "data":{
  4. "id":"32412",
  5. "name":"NewSchedule",
  6. "start_time":{
  7. "id":"1",
  8. "time":"12 am"
  9. },
  10. "end_time":{
  11. "id":"97",
  12. "time":"midnight"
  13. },
  14. "color":"1",
  15. "ical":"http:\/\/www.shiftplanning.com\/ical\/-044.ics"
  16. },
  17. "token":"xxxxxxx"
  18. }

---

UPDATE
Updates an individual schedule.
Level 3 is required.

--

Parameters:

  1. "id": required //Schedule id (integer)
  2. "active": accepted //Active (enum[-1,1])
  3. /* -1: inactive
  4.   * 1: active */
  5. "name": accepted //Name (varchar)
  6. "start_time": accepted //Start time (time)
  7. "end_time": accepted //End time (time)
  8. "color": accepted //Color (integer)
  9. "location": accepted //Location id (integer)
  10. "token": "xxxxxxx" //Valid token is required

Example Request:

  1. {
  2. "module":"schedule.schedule",
  3. "method":"UPDATE",
  4. "request":{
  5. "id":"32408",
  6. "name":"Updated"
  7. }
  8. }

Example Response:

  1. {
  2. "status":1,
  3. "data":{
  4. "id":"32408",
  5. "name":"Updated",
  6. "start_time":{
  7. "id":"1",
  8. "time":"12 am"
  9. },
  10. "end_time":{
  11. "id":"97",
  12. "time":"midnight"
  13. },
  14. "color":"1",
  15. "ical":"http:\/\/www.shiftplanning.com\/ical\/-044.ics"
  16. },
  17. "token":"xxxxxxx"
  18. }

---

DELETE
Deletes an individual schedule.
Level 3 is required.

--

Parameters:

  1. "id": required //Schedule id (integer)
  2. "token": "xxxxxxx" //Valid token is required

Example request:

  1. {
  2. "module":"schedule.schedule",
  3. "method":"DELETE",
  4. "request":{
  5. "id":"683"
  6. }
  7. }

Example Response:

  1. {
  2. "status":1,
  3. "data":"",
  4. "token":"xxxxxxx"
  5. }

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