View all general schedules
Available in 14 starting with 14.10
Resource URI: /schedules/general
Default Resource Properties:
The resource is represented by the following properties when the GET request is performed:
Property | Description |
Specific Response Codes: N/A
HTTP Method: GET
Retrieve all general schedules.
Example: XML format
"<Schedules><Schedule><id>%s</id><name>Schedule1</name><description>Description1</description><userId>-1</userId><groupId>-1</groupId><type>general</type>"
"<workingTime><workingHours><enabled>false</enabled><start>1970-01-01T11:00:00+02:00</start><stop>1970-01-01T20:00:00+02:00</stop><scheduledDay>THURSDAY</scheduledDay>"
"</workingHours></workingTime></Schedule></Schedules>", schedule.getId()), schedules);
JSON format
"{\"schedules\":[{\"id\":%s,\"name\":\"Schedule1\",\"description\":\"Description1\",\"userId\":-1,\"groupId\":-1,\"type\":\"G\","\"workingTime\":{\"workingHours\":[{\"enabled\":false,\"start\":32400000,\"stop\":64800000,\"scheduledDay\":\"Thursday\"}]}}]}", schedule.getId()), schedules);
Unsupported HTTP Method: POST, PUT, DELETE
View all schedules for a group ID
Available in 14 starting with 14.10
Resource URI: /schedules/group/{groupId}
Default Resource Properties:
The resource is represented by the following properties when the GET request is performed:
Property | Description |
Specific Response Codes: N/A
HTTP Method: GET
Retrieve schedules for the specified group ID.
Example: XML format
JSON format
Unsupported HTTP Method: POST, PUT, DELETE
View all schedules for a user ID
Available in 14 starting with 14.10
Resource URI: /schedules/user/{userId}/all
Default Resource Properties:
The resource is represented by the following properties when the GET request is performed:
Property | Description |
Specific Response Codes: N/A
HTTP Method: GET
Retrieve schedules for the specified user ID.
Example: XML format
<Schedules>
<Schedule>
<id>2</id>
<name>User200</name>
<description>desc</description>
<userId>10</userId>
<groupId>-1</groupId>
<type>user</type>
<workingTime>
<workingHours>
<enabled>false</enabled>
<start>1970-01-01T11:00:00+02:00</start>
<stop>1970-01-01T20:00:00+02:00</stop>
<scheduledDay>WEEKEND</scheduledDay>
</workingHours>
</workingTime>
</Schedule>
<Schedule>
<id>3</id>
<name>Cust</name>
<description>desc</description>
<userId>-1</userId>
<groupId>13</groupId>
<type>group</type>
<workingTime>
<workingHours>
<enabled>false</enabled>
<start>1970-01-01T02:00:00+02:00</start>
<stop>1970-01-01T20:00:00+02:00</stop>
<scheduledDay>FRIDAY</scheduledDay>
</workingHours>
</workingTime>
</Schedule>
</Schedules>
JSON format
{
schedules: [2]
0: {
id: 2
name: "User200"
description: "desc"
userId: 10
groupId: -1
type: "S"
workingTime: {
workingHours: [1]
0: {
enabled: false
start: 32400000
stop: 64800000
scheduledDay: "Weekend"
}-
-
}-
}-
1: {
id: 3
name: "Cust"
description: "desc"
userId: -1
groupId: 13
type: "U"
workingTime: {
workingHours: [1]
0: {
enabled: false
start: 0
stop: 64800000
scheduledDay: "Friday"
}-
-
}-
}-
-
}
Unsupported HTTP Method: POST, PUT, DELETE
View personal schedules for a user ID
Available in 14 starting with 14.10
Resource URI: /schedules/user/{userId}/personal
Default Resource Properties:
The resource is represented by the following properties when the GET request is performed:
Property | Description |
Specific Response Codes: N/A
HTTP Method: GET
Retrieve personal schedules for the specified user ID.
Example: XML format
<Schedules>
<Schedule>
<id>2</id>
<name>User200</name>
<description>desc</description>
<userId>10</userId>
<groupId>-1</groupId>
<type>user</type>
<workingTime>
<workingHours>
<enabled>false</enabled>
<start>1970-01-01T11:00:00+02:00</start>
<stop>1970-01-01T20:00:00+02:00</stop>
<scheduledDay>WEEKEND</scheduledDay>
</workingHours>
</workingTime>
</Schedule>
</Schedules>
JSON format
{
schedules: [1]
0: {
id: 2
name: "User200"
description: "desc"
userId: 10
groupId: -1
type: "S"
workingTime: {
workingHours: [1]
0: {
enabled: false
start: 32400000
stop: 64800000
scheduledDay: "Weekend"
}-
-
}-
}-
-
}
HTTP Method: POST
Create a personal schedule for the specified user ID.
Unsupported HTTP Method: PUT, DELETE
View description for a schedule ID
Available in 14 starting with 14.10
Resource URI: /schedules/{scheduleId}
Default Resource Properties:
The resource is represented by the following properties when the GET request is performed:
Property | Description |
Specific Response Codes: N/A
HTTP Method: GET
View the description for the specified schedule ID.
Example: XML format
"<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>"
"<Schedule><id>%s</id><name>Schedule1</name><description>Description1</description><userId>-1</userId><groupId>-1</groupId><type>general</type>"
"<workingTime><workingHours><enabled>false</enabled><start>1970-01-01T11:00:00+02:00</start><stop>1970-01-01T20:00:00+02:00</stop><scheduledDay>THURSDAY</scheduledDay>"
"</workingHours></workingTime></Schedule>",
schedule.getId()), scheduleXml);
JSON format
"{\"id\":%s,\"name\":\"Schedule1\",\"description\":\"Description1\",\"userId\":-1,\"groupId\":-1,\"type\":\"G\",\"workingTime\":"
+ "{\"workingHours\":[{\"enabled\":false,\"start\":32400000,\"stop\":64800000,\"scheduledDay\":\"Thursday\"}]}}",
HTTP Method: PUT
Update the description for the specified schedule ID.
HTTP Method: DELETE
Delete the description for the specified schedule ID.
Unsupported HTTP Method: POST
Add periods to a schedule ID
Available in 14 starting with 14.10
Resource URI: /schedules/{scheduleId}/period
Default Resource Properties: N/A
Specific Response Codes: N/A
HTTP Method: POST
Create a personal schedule for the specified user ID.
{\"enabled\":false,\"start\":34400000,\"stop\":64800000,\"scheduledDay\":\"Monday\"}"
Unsupported HTTP Method: GET, PUT, DELETE
Delete index periods from a schedule ID?
Available in 14 starting with 14.10
Resource URI: /schedules/{scheduleId}/period/{index}
Default Resource Properties: N/A
Specific Response Codes: N/A
HTTP Method: DELETE
Create a personal schedule for the specified user ID.
Unsupported HTTP Method: GET, PUT, DELETE