Resource URL Summary

Pass Through Call to Dispatch's "Update Request for Authorization" API

PUT /up/v5/serviceAuthorizations/status/${id}

HTTP Headers

This API uses the standard ServiceBroker HTTP Headers.

API Specific Parameters

Parameter	Type	Required?	Description
`${id}`	`integer`	Yes	The Request for Authorization ID to be updated.

API Specifics

Pass Through Call to Dispatch's "Update Request for Authorization" API

This RESTified API will perform a pass-through call to the Dispatch sub-system's "Update Request for Authorization" API (when configured).

URL

POST /up/v5/serviceAuthorizations/status/${id}

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 Dispatch "Update Request for Authorization" API.

UpdateRequestForAuthorization Object Format

{
    "ApprovedAmounts": {
        "AuthorizedLabor": 250,
        "AuthorizedLaborTax": 0,
        "AuthorizedMiles": 75,
        "AuthorizedMileage": 41.25,
        "AuthorizedOther": 0,
        "AuthorizedOtherTax": 0,
        "AuthorizedParts": 5.50,
        "AuthorizedPartsTax": 0,
        "AuthorizedShipping": 0,
        "AuthorizedFreight": 0,
        "AuthorizedTax": 0,
        "AuthorizedTravel": 0
    },
    "Notes": {
        "NotesOnly": "Y",
        "InternalNotes": "INTERNAL NOTES",
        "InternalNotesReason": "OTH",
        "ServicerNotes": "SERVICERNOTES",
        "ServicerNotesReason": "OTH"
    },
    "StatusInfo": {
        "NewStatus": "WAI",
        "StatusChangeReason": ""
    },
    "RequiredParts": [
        {
            "Qty": 1,
            "ProdAttrs": {
                "SequenceNumber": 1,
                "SubRequestNumber": "8999290-01"
            }
        }
    ],
    "ApproveOrRejectInfo": {
        "ApprovedOrAdditionalInformationRequestNotes": "TEST INFO X",
        "ChangedBy": "AUSERID",
        "ReasonCode": ""
    }
}

UpdateRequestForAuthorization Object Properties

Property			Type	Required?	Description	Dispatch Field Mapping
`ApprovedAmounts`			`object`	No	Pass through parameter to the Dispatch "Update Request for Authorization" API.	`ApprovedAmounts`
	`AuthorizedLabor`		`integer`	No	Pass through parameter to the Dispatch "Update Request for Authorization" API.	`AuthorizedLabor`
	`AuthorizedLaborTax`		`integer`	No	Pass through parameter to the Dispatch "Update Request for Authorization" API.	`AuthorizedLaborTax`
	`AuthorizedMiles`		`integer`	No	Pass through parameter to the Dispatch "Update Request for Authorization" API.	`AuthorizedMiles`
	`AuthorizedMileage`		`float`	No	Pass through parameter to the Dispatch "Update Request for Authorization" API.	`AuthorizedMileage`
	`AuthorizedOther`		`integer`	No	Pass through parameter to the Dispatch "Update Request for Authorization" API.	`AuthorizedOther`
	`AuthorizedOtherTax`		`integer`	No	Pass through parameter to the Dispatch "Update Request for Authorization" API.	`AuthorizedOtherTax`
	`AuthorizedParts`		`float`	No	Pass through parameter to the Dispatch "Update Request for Authorization" API.	`AuthorizedParts`
	`AuthorizedPartsTax`		`integer`	No	Pass through parameter to the Dispatch "Update Request for Authorization" API.	`AuthorizedPartsTax`
	`AuthorizedShipping`		`integer`	No	Pass through parameter to the Dispatch "Update Request for Authorization" API.	`AuthorizedShipping`
	`AuthorizedFreight`		`integer`	No	Pass through parameter to the Dispatch "Update Request for Authorization" API.	`AuthorizedFreight`
	`AuthorizedTax`		`integer`	No	Pass through parameter to the Dispatch "Update Request for Authorization" API.	`AuthorizedTax`
	`AuthorizedTravel`		`integer`	No	Pass through parameter to the Dispatch "Update Request for Authorization" API.	`AuthorizedTravel`
`Notes`			object	No	Pass through parameter to the Dispatch "Update Request for Authorization" API.	`Notes`
	`NotesOnly`		`string`	No	Pass through parameter to the Dispatch "Update Request for Authorization" API.	`NotesOnly`
	`InternalNotes`		`string`	No	Pass through parameter to the Dispatch "Update Request for Authorization" API.	`InternalNotes`
	`InternalNotesReason`		`string`	No	Pass through parameter to the Dispatch "Update Request for Authorization" API.	`InternalNotesReason`
	`ServicerNotes`		`string`	No	Pass through parameter to the Dispatch "Update Request for Authorization" API.	`ServicerNotes`
	`ServicerNotesReason`		`string`	No	Pass through parameter to the Dispatch "Update Request for Authorization" API.	`ServicerNotesReason`
`StatusInfo`			`object`	No	Pass through parameter to the Dispatch "Update Request for Authorization" API.	`StatusInfo`
	`NewStatus`		`string`	No	Pass through parameter to the Dispatch "Update Request for Authorization" API.	`NewStatus`
	`StatusChangeReason`		`string`	No	Pass through parameter to the Dispatch "Update Request for Authorization" API.	`StatusChangeReason`
`RequiredParts`			`array`	No	Pass through parameter to the Dispatch "Update Request for Authorization" API.	`RequiredParts`
	`Qty`		`integer`	No	Pass through parameter to the Dispatch "Update Request for Authorization" API.	`Qty`
	`ProdAttrs`		`object`	No	Pass through parameter to the Dispatch "Update Request for Authorization" API.	`ProdAttrs`
		`SequenceNumber`	`integer`	No	Pass through parameter to the Dispatch "Update Request for Authorization" API.	`SequenceNumber`
		`SubRequestNumber`	`string`	No	Pass through parameter to the Dispatch "Update Request for Authorization" API.	`SubRequestNumber`
`ApproveOrRejectInfo`			`object`	No	Pass through parameter to the Dispatch "Update Request for Authorization" API.	`ApproveOrRejectInfo`
	`ApprovedOrAdditionalInformationRequestNotes`		`string`	No	Pass through parameter to the Dispatch "Update Request for Authorization" API.	`ApprovedOrAdditionalInformationRequestNotes`
	`ChangedBy`		`string`	No	Pass through parameter to the Dispatch "Update Request for Authorization" API.	`ChangedBy`
	`ReasonCode`		`string`	No	Pass through parameter to the Dispatch "Update Request for Authorization" API.	`ReasonCode`

HTTP Response

Success

On success, a JSON-formatted version of the Dispatch "Update Request for Authorization" API response will be returned.

{
    "Success": true,
    "Code": 0,
    "Message": "OK"
}

Error

On error, a JSON-formatted version of the Dispatch "Update Request for Authorization" 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, there are Dispatch Error codes.

ServiceBroker 5

UpdateRequestForAuthorizationStatus RESTified API

Analytics