Api doc


SDK's


Api Modules

schedule.breakrule

Management of break rules.



Supported Methods:

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


CREATE
Params
  • token (Required): valid token
  • id (Required): integer
  • break (Required): integer
  • paid (Required): enum (0, 1)
  • min: varchar
  • max: varchar
  • exact: varchar


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


Documentation

GET
Retrieves all break rules for 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.breakrule",
  3. "method":"GET",
  4. "request":{
  5. "id":138641
  6. }
  7. }

Example Response:

  1. {
  2. "status":1,
  3. "data":[
  4. {
  5. "id":"31733",
  6. "store":"17949",
  7. "schedule":"138641",
  8. "user":"247525",
  9. "min":"1",
  10. "max":"9",
  11. "break":"15",
  12. "paid":"1",
  13. "date":"1352377163"
  14. }

---

CREATE
Creates a new break rule.
Level 3 is required.

--

Parameters:

  1. "id": required //Schedule id (integer)
  2. "break": required // break length in minutes (integer)
  3. "paid": required // enum (0, 1)
  4. /* 0: Not paid
  5.   1: Paid */
  6. "min": accepted //Minimum shift time(varchar)
  7. "max": accepted //Maximum shift time(varchar)
  8.  
  9. "token": "xxxxxxx" //Valid token is required

Example request:

  1. {
  2. "module":"schedule.breakrule",
  3. "method":"CREATE",
  4. "request":{
  5. "id":31733,
  6. "break":15,
  7. "paid":1,
  8. "min":"1",
  9. "max":"9"
  10. }
  11. }

Example Response:

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

---

DELETE
Deletes break rule.
Level 3 is required.

--

Parameters:

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

Example Request:

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

Example Response:

  1. {
  2. "status":1,
  3. "data":"Breakrule Removed",
  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