Resource URL Summary
Pass Through Call to ServiceScheduling's "Book Dependency Group Jobs" API
PUT /up/v5/rest/scheduling/BookDependencyGroup
HTTP Headers
This API uses the standard ServiceBroker HTTP Headers.
API Specifics
Pass Through Call to ServiceScheduling's "Book Dependency Group Jobs" API
This RESTified API will perform a pass-through call to the ServiceScheduling sub-system's "Book Dependency Group Jobs" API (when configured).
URL
PUT /up/v5/rest/scheduling/BookDependencyGroup
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 "Book Dependency Group Jobs" APi.
BookDependencyGroupJobs Object Format
BookDependencyGroupJobs Object Properties
| Property | Type | Length | Description | Req? | Field Mapping: ServiceScheduling | |||||
|---|---|---|---|---|---|---|---|---|---|---|
Id |
| SS: 50 | Pass through parameter to the ServiceScheduling Book Dependency Group Jobs API. Is the identifier (ID) of the dependency group as a whole. Dependency group IDs have a separate name space from regular job IDs. | Yes |
| |||||
BookOptions | object | Pass through parameter to the ServiceScheduling Book Dependency Group Jobs API. | Yes | see BookOptions.objects | ||||||
HTTP Response
Success
On success, a JSON-formatted version of the ServiceScheduling "Book Dependency Group Jobs" API response will be returned.
{
"Success" : true,
"Code" : 0,
"Message" : "OK",
"Payload" : {
"result" : {
"type" : "OK",
"code" : "0"
},
"TravelTime" : "3",
"WorkItems" : [
{
"Id" : "Dep-1306",
"Tech" : "DE3_9_01",
"ETA" : "2006-01-03T08:01",
"IRU" : "EMID_I01",
"FRU" : "EMIDLAND"
},
{
"Id" : "Dep-1307",
"Tech" : "DE3_9_01",
"ETA" : "2006-01-03T09:02",
"IRU" : "EMID_I01",
"FRU" : "EMIDLAND"
}
]
}
}
Error
On error, a JSON-formatted version of the ServiceScheduling "Book Dependency Group Jobs" 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: