POST api/Schedule/Add
Add a single schedule to your Team Road Warrior account
Request Information
URI Parameters
None.
Body Parameters
AddScheduleModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Name |
Display name of schedule |
string |
Required String length: inclusive between 1 and 50 |
| StartTime |
Starting time of schedule in milliseconds since midnight (0: 00:00, 86399999: 23:59.999) |
integer |
Required Range: inclusive between 0 and 86399999 |
| EndTime |
Ending time of schedule in milliseconds since midnight (0: 00:00, 86399999: 23:59.999) |
integer |
Required Range: inclusive between 0 and 86399999 |
| Priority |
Priority value for schedule |
decimal number |
Required Range: inclusive between 0 and 1 |
Request Formats
application/json, text/json
Sample:
{
"Name": "My new schedule",
"StartTime": 25200000,
"EndTime": 39600000,
"Priority": 0.5
}
Response Information
Resource Description
AddScheduleResponseModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Schedule |
Schedule created |
ScheduleResponseModel |
None. |
| IsSuccess |
Did the operation succeed or not |
boolean |
None. |
| ErrorMessage |
If there was an error, contains description of the error |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Schedule": {
"Name": "My new schedule",
"ScheduleId": "e983f977-dbe4-4410-9481-1861de49b7b1",
"StartTime": 25200000,
"EndTime": 39600000,
"Priority": 0.5
},
"IsSuccess": true,
"ErrorMessage": "Error message would go here"
}