Resource URL Summary
Pass Through Call to ServiceScheduling's "Fix Break Times" API
PUT /up/v5/rest/scheduling/FixBreakTimes
HTTP Headers
This API uses the standard ServiceBroker HTTP Headers.
API Specifics
Pass Through Call to ServiceScheduling's "Fix Break Times" API
This RESTified API will perform a pass-through call to the ServiceScheduling sub-system's "Fix Break Times" API (when configured).
URL
PUT /up/v5/rest/scheduling/FixBreakTimes
HTTP Request Body
This request requires a JSON object supplied in the HTTP request body, which defines the parameters that will be passed through to the ServiceScheduling "Fix Break Times" APi.
FixBreakTimes Object Format
FixBreakTimes Object Properties
| Property | Type | Length | Description | Req? | Field Mapping: ServiceScheduling | |
|---|---|---|---|---|---|---|
Tech |
| Pass through parameter to the ServiceScheduling "Fix Break Times" API. The identifier of the employee to whom the break is assigned. | Yes |
| ||
Breaks | array | max 5 | Pass through parameter to the ServiceScheduling "Fix Break Times" API. Up to 5 break structures can be supplied if multiple breaks are to be updated. See Breaks.objects
| Yes |
| |
Options | object | Pass through parameter to the ServiceScheduling "Fix Break Times" API. | No | |||
HTTP Response
Success
On success, a JSON-formatted version of the ServiceScheduling "Fix Break Times" API response will be returned.
{
"Success": true,
"Code": "0",
"Message": "",
"Payload": {
"result": {
"type": "OK",
"code": "0"
}
}
}
Error
On error, a JSON-formatted version of the ServiceScheduling "Fix Break Times" API response will be returned.
{
"Success": false,
"Code": 9,
"Payload": {
"returnCode": {
"type": "Error",
"code": "SCH Error Code"
}
}
}
Return Codes
In addition to the Standard Return Codes, and the general ServiceScheduling Return Codes, the specfic ones for this API are: