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

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

URL

POST /up/v5/serviceAuthorizations/${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 "Create or Update Request for Authorization" APi.

CreateOrUpdateRequestForAuthorization Object Format

js

CreateOrUpdateRequestForAuthorization Object Properties

Property			Type	Required?	Description	Dispatch Field Mapping
`CoreInfo`			`object`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`CoreInfo`
	`JobCode`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`JobCode`
`WhyAdditionalManOnTheJobQuestions`			`array`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`WhyAdditionalManOnTheJobQuestions`
	`ChoiceId`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	ChoiceId
	`ResponseText`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	ResponseText
`Notes`			`object`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`Notes`
	`NotesOnly`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`NotesOnly`
	`InternalNotes`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`InternalNotes`
	`InternalNotesReason`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`InternalNotesReason`
	`ServicerNotes`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`ServicerNotes`
	`ServicerNotesReason`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`ServicerNotesReason`
`ShippingInfo`			`object`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`ShippingInfo`
	`AdditionalManRequired`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`AdditionalManRequired`
	`Recipient`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`Recipient`
	`ShippingOption`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`ShippingOption`
	`CompanyName`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`CompanyName`
	`FirstName`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`FirstName`
	`LastName`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`LastName`
	`Phone`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`Phone`
	`Email`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`Email`
	`Address1`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`Address1`
	`Address2`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`Address2`
	`City`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`City`
	`Region`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`Region`
	`PostalCode`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`PostalCode`
`ApproveOrRejectInfo`			`object`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`ApproveOrRejectInfo`
	`approvedOrAdditionalInformationRequestNotes`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`approvedOrAdditionalInformationRequestNotes`
	`ChangedBy`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`ChangedBy`
	`ReasonCode`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`ReasonCode`
`OtherInfo`			`object`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`OtherInfo`
	`AdditionalManRequired`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`AdditionalManRequired`
	`CostEffectiveToRepair`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`CostEffectiveToRepair`
	`EstimatedHoursOnJob`		`integer`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`EstimatedHoursOnJob`
	`EstimatedMinutesOnJob`		`integer`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`EstimatedMinutesOnJob`
	`IsProductRepaired`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`IsProductRepaired`
	`LaborInWarranty`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`LaborInWarranty`
	`OemAuthorizedWithManufacturer`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`OemAuthorizedWithManufacturer`
	`PartsInWarranty`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`PartsInWarranty`
	`PickUpUnitRequired`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`PickUpUnitRequired`
	`WhyHigherRate`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`WhyHigherRate`
`ProblemInfo`			`object`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`ProblemInfo`
	`RepairDescription`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`RepairDescription`
	`FaultCode`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`FaultCode`
`Asset`			`object`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`Asset`
	`Mfg`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`Mfg`
	`Model`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`Model`
	`SerialNum`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`SerialNum`
`ServicerInfo`			`object`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`ServicerInfo`
	`ServicerOnSite`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`ServicerOnSite`
`Amounts`			`object`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`Amounts`
	`RequestedLabor`		`integer`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`RequestedLabor`
	`RequestedLaborTax`		`integer`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`RequestedLaborTax`
	`RequestedMiles`		`integer`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`RequestedMiles`
	`RequestedRatePerMile`		`float`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`RequestedRatePerMile`
	`RequestedOther`		`integer`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`RequestedOther`
	`RequestedOtherTax`		`integer`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`RequestedOtherTax`
	`RequestedPartsTax`		`integer`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`RequestedPartsTax`
	`RequestedShipping`		`integer`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`RequestedShipping`
	`RequestedFreight`		`integer`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`RequestedFreight`
	`RequestedTax`		`integer`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`RequestedTax`
	`RequestedTravel`		`integer`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`RequestedTravel`
`RequiredParts`			`array`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`RequiredParts`
	`ProdNum`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`ProdNum`
	`Qty`		`integer`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`Qty`
	`ProdAttrs`		`object`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`ProdAttrs`
		`SerialNo`	`integer`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`SerialNo`
		`Desc`	`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`Desc`
		`UnitCost`	`float`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`UnitCost`
		`NlaFlag`	`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`NlaFlag`
		`UnderWarranty`	`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`UnderWarranty`
		`SelfSourced`	`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`SelfSourced`
`StatusInfo`			`object`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`StatusInfo`
	`NewStatus`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`NewStatus`
	`StatusChangeReason`		`string`	No	Pass through parameter to the Dispatch "Create or Update Request for Authorization" API.	`StatusChangeReason`

HTTP Response

Success

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

js

Error

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

js

Return Codes

In addition to the Standard Return Codes, there are Dispatch Error codes.

Browser not supported