Pass Through Call to ServiceScheduling's "Book Dependency Group Jobs" APIThis RESTified API will perform a pass-through call to the ServiceScheduling sub-system's "Book Dependency Group Jobs" API (when configured). URL| Panel |
|---|
| borderColor | grey |
|---|
| bgColor | whitesmoke |
|---|
| borderStyle | solid |
|---|
| PUT /up/v5/rest/scheduling/BookDependencyGroup
|
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 "Book Dependency Group Jobs" APi. | Code Block |
|---|
| language | js |
|---|
| title | BookDependencyGroupJobs JSON |
|---|
| collapse | true |
|---|
| {
"Id": "DepGroup1306",
"BookOptions": {
"AllowRebookAll": false,
"DontCancelCleared": false,
"DontCancelLoggedOff": false,
"DontCancelLoggedOn": false
},
"DepGroup": {
"DepId": "Dep-1306",
"DepTime": "ETA",
"TargetId": "Dep-1307",
"TargJobsTime": "ETA",
"DepEmpType": "none",
"targJobsTime": "ETA",
"earliestTime": "30",
"earliestTimeUnits": "mins",
"latestTime": "30",
"latestTimeUnits": "mins",
"targetTime": "0",
"targetTimeUnits": "mins",
"costID": "diff"
},
"WorkItems": [
{
"Id": "Dep-1306",
"Priority": "50",
"WorkType": {
"Name": "M60",
"Skills": [
{
"Id": "SK001",
"Comp": "1"
},
// ...
]
},
"Location": {
"Address": {
"PostalCode": "DE3 9",
"latitude": "46.335395",
"Longitude": "5.122205"
},
"SiteId": "site 11"
},
"Flags": {
"AllowRebook": true,
"IsPrimary": "true"
},
"BookOptions": {
"AllowEmpOT": true,
"SpareIgnVanStock": false,
"ServAsAccHours": true,
"FixToEmp": false,
"CallToFix": false,
"ReqConfirm": false,
"NonConsecShift": false,
"ConsecShift": false,
"ContigShift": false
},
"ExtraDuration": 10,
"ReqProvider": [
{
"Id": "DE7_4_01",
"MPX": "Mandatory"
}
],
"Booking": {
"ContractLatest": "2006-03-31T23:59",
"Offer": {
"GroupId": "group2006"
}
},
"ForceOptions": {
"InTray": false,
"InTrayWithSkill": false,
"InTrayAfterAll": true,
"SpareForceGo": false,
"Reassign": false,
"IgnoreCapacity": false,
"NoTravel": false,
"NoLocalKnowledge": true
},
"ServHoursPreDefPatts": {
"servHoursPreDef": {
"dateRange": {
"start": "2006-01-01",
"end": "2007-01-01"
},
"servHoursPattID": "1"
}
},
// ...
]
} |
BookDependencyGroupJobs Object Properties| Property | Type | Length | Description | Req? | Field Mapping: ServiceScheduling |
|---|
Id | string
| 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 | multiJobID
| BookOptions | object |
| Pass through parameter to the ServiceScheduling Book Dependency Group Jobs API. | Yes | see BookOptions.objects |
HTTP Response SuccessOn success, a JSON-formatted version of the ServiceScheduling "Book Dependency Group Jobs" API response will be returned. | Code Block |
|---|
| {
"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. | 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 possible Return Codes from ServiceScheduling Error codes, individual API calls from this API are: |
