Api doc


SDK's


Api Modules

schedule.wizard

Auto-Generated a schedule using the wizard schedule wizard.



Supported Methods:

GET
Params
  • token (Required): valid token
  • from_start (Required): date
  • from_end (Required): date
  • to_start (Required): date
  • to_end (Required): date
  • schedule: varchar
  • mode: varchar
  • rule: enum (1, 2, 3)
  • clear: min length 1
  • force: min length 1
  • shifts: varchar


Documentation

GET
Auto-Generated a schedule using the wizard schedule wizard.
Level 4 is required

--

Parameters:

  1. "from_start": required //From start (date)
  2. "from_end": required //From end (date)
  3. "to_start": required //To start (date)
  4. "to_end": required //To end (date)
  5. "schedule": accepted //Schedule id (integer)
  6. "mode": accepted //Mode (varchar)
  7. /* manage
  8.   * requested
  9.   * upcoming */
  10. "rule": accepted //Rule (enum[1,2,3])
  11. /* 1 : FILL METHOD 1: REPLACE ALL STAFF OBEY CONFLICTS
  12.   * 2 : FILL METHOD 2: KEEP ALL STAFF ONLY REPLACE CONFLICTS
  13.   * 3 : FILL METHOD 3: RANDOMIZE ALL STAFF */
  14. "clear": accepted //Clear (integer) - min length 1
  15. /* null : Do not clear current timeline
  16.   * isset: Clear current timeline */
  17. "force": accepted //Force (integer) - min length 1
  18. /* null : Do not force fill
  19.   * isset: Force fill */
  20. "shifts": accepted //Shifts (varchar)
  21. /* Array of shifts ids (eg: "458,547,1001") */
  22. "token": "xxxxxxx" //Valid token is required

Example Request:

  1. {
  2. "module":"schedule.wizard",
  3. "method":"GET",
  4. "request":{
  5. "from_start":"May 15, 2012",
  6. "from_end":"May 16, 2012",
  7. "to_start":"May 15, 2012",
  8. "to_end":"May 16, 2012"
  9. }
  10. }

Example Response:

  1. {
  2. "status":1,
  3. "data":"1 shifts automagically filled!",
  4. "token":"xxxxxxx"
  5. }