Resource URL Summary

Pass Through Call to Dispatch's "Get Network Attributes" API

GET /up/v5/job/${WorkItemId}/networkAttributes

API Specific Parameters

Parameter	Type	Required?	Description
`${WorkItemId}`	`string`	Yes	The unique string ID value for the Work Item.

Network Attributes

The following table lists the predefined pairs of network attributes that can be passed.

Parameter	Datatype (length)	Desc ription
`AddCoverage`	String	This call tells the requestor to add the supplied coverage to the servicer while force booking a call. According to value (Yes or No) the system will decide whether it should add the coverage to that servicer or not while booking the call.
`JobDuration`	Number(5)	While booking the Call, the user can specify the Job Duration (in minutes) that will be displayed on the call detail page. (If the servicer is using the Scheduling then this Job duration will be passed to the service scheduling engine.)
`LADuration`	Number(5)	This is contract B/W servicer and network this Job should be done in a specific duration between now and duration supplied days. This is applicable only with Scheduling servicers.
`ClientCode`	String(25)	This is a special rule set up in Dispatch, applied at ranking and servicer level, determining restrictions on what servicers are returned.
`ClientProgram`	String(25)	This is a special rule set up in Dispatch, applied at service type, warranty type, or service site level that determines restrictions on what servicers are returned.
`ProcID`	String(8)	This call attributes are specific to the A&E SPI API If user sends the Proc Id & description. Description is sent to A&E in the Special Instructions.
`AddCoverage`	String(150)	Proc Description: This is sent to A&E in the special instructions. The length should not be more that 150 characters.

To pass in other attributes, place the name of the attribute in the name field and its value in the value field. These additional attributes are for display purposes only and have no functionality in Dispatch. They will be displayed in the Call Details screen and the print-out of the call details.

HTTP Headers

This API uses the standard ServiceBroker HTTP Headers.

API Specifics

Pass Through Call to Dispatch's "Get Network Attributes" API

This RESTified API will perform a pass-through call to the Dispatch sub-system's "Get Network Attributes" API (when configured).

URL

GET /up/v5/job/${WorkItemId}/networkAttributes

HTTP Request Body

This request does not require a request body.

HTTP Response

Success

On success, a JSON-formatted version of the Dispatch "Get Network Attributes" API response will be returned, consisting of an array of zero or more attribute label name/value pairs.

GetNetworkAttributes Response Object Format

[
	{
		"attributeLabel": "Attribute Label Example #1",
		"attributeValue": "Attribute Label Value #1"
	},
	{
		"attributeLabel": "Attribute Label Example #2",
		"attributeValue": "Attribute Label Value #2"
	},
	// ...
]

Error

On error, a JSON-formatted version of the Dispatch "Get Network Attributes" API response will be returned.

{
    "Success": false,
    "Code": 9,
    "Payload": {
        "returnCode": {
            "type": "Error",
            "message": "Dispatch Error Code"
        }
    }
}

Return Codes

In addition to the Standard Return Codes, and the Dispatch Error codes, individual API calls made have unique codes found on their individual pages.

ServiceBroker 5

GetNetworkAttributes RESTified API

Analytics