Pass Through Call to ServiceSchedulingScheduling's "Fix Break Times" APIThis RESTified API will perform a pass-through call to the ServiceScheduling Scheduling sub-system's "Fix Break Times" API (when configured). URL| Panel |
|---|
| borderColor | grey |
|---|
| bgColor | whitesmoke |
|---|
| borderStyle | solid |
|---|
| PUT /up/v5/rest/scheduling/FixBreakTimes
|
HTTP Request BodyThis request requires a JSON object supplied in the HTTP request body, which defines the parameters that will be passed through to the ServiceScheduling the Scheduling "Fix Break Times" APi. | Code Block |
|---|
| language | js |
|---|
| title | FixBreakTimes JSON |
|---|
| collapse | true |
|---|
| {
"Tech": "EmpID",
"Breaks": [
{
"Name": "",
"Type": "",
"Start": "",
"Duration": 0
}
],
"Options": {
"Started": false,
"Finished": false
}
} |
FixBreakTimes Object Properties| Property | Type | Length | Description | Req? | Mapping Field Mapping: ServiceScheduling Service Scheduling |
|---|
Tech | string
SS: EmpID (string)
|
| Pass through parameter to the ServiceScheduling "the Scheduling Fix Break Times" APITimes API. The identifier of the employee to whom the break is assigned. | Yes | empID
| Breaks | array | max 5 | Pass through parameter to the ServiceScheduling "the Scheduling Fix Break Times" API API. Up to 5 break structures can be supplied if multiple breaks are to be updated. See Breaks.objects | | Property | Type | Length | Description | Req? |
|---|
Name | string
SS: BreakName (string)
SS: 20 | Pass through parameter to the ServiceScheduling "Fix Break Times" API. The name of the break. SS Field: breaks.BreakName Yes | Type | string
SS: BreakType
Pass through parameter to the ServiceScheduling "Fix Break Times" API. The type of the break. SS Field: breaks.BreakType SS Valid Values: "Default", "Overridden", "Fixed"
| Yes | Start | string
SS: spDateTime
SS: 16 | Pass through parameter to the ServiceScheduling "Fix Break Times" API. The date and time at which the break will start/has started SS Field: breaks.BreakStart | Yes | Duration | integer | Pass through parameter to the ServiceScheduling "Fix Break Times" API. The length of the break in minutes. The length of the break can be 0 to 999 minutes. SS Field: breaks.BreakDuration | Yes | Yes | breaks
| Options | object | Pass through parameter to the ServiceScheduling "Fix Break Times" API. | Property | Type | Description | Req? |
|---|
Started | Boolean | Pass through parameter to the ServiceScheduling "Fix Break Times" API. When supplied and true, all named breaks supplied will be updated to have a status of Started. If the options value of Finished is also supplied, SP_OPTION_COMBINATION_INVALID (159) is returned. If not supplied, and the options value of Finished is also not supplied, then any of the breaks being updated that have previously been set to have a status of either Started or Finished will be set to the Fixed state and SP_OK_BREAK_STATUS_LOST (695) is returned SS Field: options.Started | No | Finished | Boolean | Pass through parameter to the ServiceScheduling "Fix Break Times" API. When supplied and true, all named breaks supplied will be updated to have a status of Finished. If the options value of Started is also supplied, SP_OPTION_COMBINATION_INVALID (159) is returned. If not supplied, and the options value of Started is also not supplied, then any of the breaks being updated that have previously been set to have a status of either Started or Finished will be set to the Fixed state and SP_OK_BREAK_STATUS_LOST (695) is returned SS Field: options.Finished | No | No | Yes | See the FixBreakTimes.Breaks.objects |
HTTP Response SuccessOn success, a JSON-formatted version of the ServiceScheduling Scheduling "Fix Break Times" API response will be returned. | Code Block |
|---|
| {
"Success": true,
"Code": "0",
"Message": "",
"Payload": {
"result": {
"type": "OK",
"code": "0"
}
}
} |
Error On error, a JSON-formatted version of the ServiceScheduling Scheduling "Fix Break Times" API response will be returned. | Code Block |
|---|
| {
"Success": false,
"Code": 9,
"Payload": {
"returnCode": {
"type": "Error",
"code": "SCH Error Code"
}
}
} |
Return CodesIn addition to to the Standard Return Codes, and the general ServiceScheduling Return Codes, the specfic ones for Scheduling Error codes, individual API calls from this API are: | Expand |
|---|
SP_OK (0)SP_DATE_INVALID (14)SP_OPTIONS_INVALID (80)SP_OPTION_COMBINATION_INVALID (159)SP_EMPID_DOES_NOT_EXIST (231)SP_BREAK_DURATION_INVALID (323)SP_BREAK_EARLIEST_BEFORE_SHIFT_START (353)SP_BREAK_LATEST_AFTER_SHIFT_END (354)SP_OK_WITH_OVERLAPS (373)SP_SO_BREAK_OUTSIDE (557)SP_BREAKSEQ_DUPLICATE_BREAKNAMES (653)SP_BREAKSEQ_OVERLAPS (654)SP_BREAKNAME_INVALID (655)SP_BREAKTYPE_NOT_FIXED (656)SP_BREAKTIME_EARLIEST_INVALID (657)SP_OK_BREAK_STATUS_LOST (695)
|
| 