schedule.schedule

Management of individual schedules.

SUPPORTED METHODS:

GET

Parameters	Type	Description
token (required)		Valid token
id (required)	integer	Schedule id

CREATE

Parameters	Type	Description
token (required)		Valid token
name (required)	varchar	Schedule name
active (accepted)	enum (-1,1)	-1: inactive 1: active
start_time (accepted)	time	Start time
end_time (accepted)	time	End time
color (accepted)	integer	Color
location (accepted)	integer	Location id
visible (accepted)	enum (0,1)	0: visible 1: unvisible

UPDATE

Parameters	Type	Description
token (required)		Valid token
id (required)	integer	Schedule id
active (accepted)	enum (-1,1)	-1: inactive 1: active
job_code (accepted)	varchar	Job code
name (accepted)	varchar	Name
start_time (accepted)	time	Start time
end_time (accepted)	time	End time
color (accepted)	integer	Color
location (accepted)	integer	Location
visible (accepted)	enum (0,1)	0: visible 1: unvisible

DELETE

Parameters	Type	Description
token (required)		Valid token
id (required)	integer	Schedule id

DOCUMENTATION

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

Example Request:

{
   "module":"schedule.schedule",
   "method":"GET",
   "request":{
      "id":"1433"
   }
}

Example Response:

{
   "status":1,
   "data":{
      "id":"32408",
      "name":"Admin\/meetings",
      "start_time":{
         "id":"1",
         "time":"12 am"
      },
      "end_time":{
         "id":"97",
         "time":"midnight"
      },
      "color":"1",
      "ical":"http:\/\/www.humanity.com\/ical\/-044.ics"
   },
   "token":"xxxxxxx"
}

CREATE
Creates an individual schedule.
Level 3 is required.

Example Request:

{
   "module":"schedule.schedule",
   "method":"CREATE",
   "request":{
      "name":"NewSchedule"
   }
}

Example Response:

{
   "status":1,
   "data":{
      "id":"32412",
      "name":"NewSchedule",
      "start_time":{
         "id":"1",
         "time":"12 am"
      },
      "end_time":{
         "id":"97",
         "time":"midnight"
      },
      "color":"1",
      "ical":"http:\/\/www.humanity.com\/ical\/-044.ics"
   },
   "token":"xxxxxxx"
}

UPDATE
Updates an individual schedule.
Level 3 is required.

Example Request:

{
   "module":"schedule.schedule",
   "method":"UPDATE",
   "request":{
      "id":"32408",
      "name":"Updated"
   }
}

Example Response:

{
   "status":1,
   "data":{
      "id":"32408",
      "name":"Updated",
      "start_time":{
         "id":"1",
         "time":"12 am"
      },
      "end_time":{
         "id":"97",
         "time":"midnight"
      },
      "color":"1",
      "ical":"http:\/\/www.humanity.com\/ical\/-044.ics"
   },
   "token":"xxxxxxx"
}

DELETE
Deletes an individual schedule.
Level 3 is required.

Example request:

{
   "module":"schedule.schedule",
   "method":"DELETE",
   "request":{
      "id":"683"
   }
}

Example Response:

{
   "status":1,
   "data":"",
   "token":"xxxxxxx"
}