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

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

URL

POST /up/v5/serviceAuthorizations/_query

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

GetRequestForAuthorization Object Format

js

GetRequestForAuthorization Object Properties

Property	Type	Required?	Description	Dispatch Field Mapping
`ManufacturerName`	`string`	No	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`ManufacturerName`
`Id`	`string`	No	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`Id`
`FromChangedOn`	`integer`	No	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`FromChangedOn`
`ToChangedOn`	`integer`	No	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`ToChangedOn`

HTTP Response

Success

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

GetRequestForAuthorization Response Object Format

js

GetRequestForAuthorization Response Object Properties

Property				Type	Description
`Success`				`boolean`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`Success`
`Code`				`integer`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`Code`
`Message`				`string`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`Message`
`Payload`				`object`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`Payload`
	`MoreCallsExist`			`string`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`MoreCallsExist`
	`Requests`			`array`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`Requests`
		`OtherInfo`		`object`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`OtherInfo`
			`DaysOwned`	`integer`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`DaysOwned`
			`CostEffectiveToRepair`	`string`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`CostEffectiveToRepair`
			`AdditionalManRequired`	`string`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`AdditionalManRequired`
			`LaborInWarranty`	`string`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`LaborInWarranty`
			`OemAuthorizedWithManufacturer`	`string`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`OemAuthorizedWithManufacturer`
			`EstimatedHoursOnJob`	`integer`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`EstimatedHoursOnJob`
			`IsProductRepaired`	`string`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`IsProductRepaired`
			`EstimatedMinutesOnJob`	`integer`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`EstimatedMinutesOnJob`
			`WhyHigherRate`	`string`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`WhyHigherRate`
			`PickUpUnitRequired`	`string`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`PickUpUnitRequired`
			`ModificationsOccurred`	`string`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`ModificationsOccurred`
		`ServicerInfo`		`object`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`ServicerInfo`
			`ServicerZipInProfile`	`string`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`ServicerZipInProfile`
			`ServicerOemAuthorized`	`string`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`ServicerOemAuthorized`
			`ServicerProductInProfile`	`string`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`ServicerProductInProfile`
			`ServicerOnSite`	`string`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`ServicerOnSite`
			`AssignedServicerId`	`string`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`AssignedServicerId`
		`ManufacturerName`		`string`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`ManufacturerName`
		`CustomerInfo`		`object`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`CustomerInfo`
			`Zip`	`string`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`Zip`
			`LastName`	`string`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`LastName`
			`Address`	`string`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`Address`
			`City`	`string`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`City`
			`FirstName`	`string`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`FirstName`
			`Phone`	`integer`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`Phone`
			`WorkPhone`	`integer`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`WorkPhone`
			`State`	`string`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`State`
			`CellPhone`	`integer`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`CellPhone`
		`ProductInfo`		`object`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`ProductInfo`
			`PurchaseDate`	`integer`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`PurchaseDate`
			`Product`	`string`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`Product`
			`DealerName`	`string`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`DealerName`
			`SerialNumber`	`string`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`SerialNumber`
			`NewSerialNumber`	`string`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`NewSerialNumber`
			`NewModel`	`string`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`NewModel`
			`NewBrand`	`string`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`NewBrand`
			`Model`	`string`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`Model`
			`Brand`	`string`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`Brand`
		`CoreInfo`		`object`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`CoreInfo`
			`AdditionalDaysToFileClaim`	`integer`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`AdditionalDaysToFileClaim`
			`JobCode`	`string`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`JobCode`
			`RepeatCall`	`string`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`RepeatCall`
			`AgreementNumber`	`string`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`AgreementNumber`
			`RfaStatusCode`	`string`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`RfaStatusCode`
			`RfaStatus`	`string`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`RfaStatus`
		`AuditInfo`		`object`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`AuditInfo`
			`ApprovedBy`	`string`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`ApprovedBy`
			`CreatedOn`	`integer`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`CreatedOn`
			`ChangedOn`	`integer`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`ChangedOn`
			`ApprovedOn`	`integer`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`ApprovedOn`
			`CreatedBy`	`string`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`CreatedBy`
			`ChangedBy`	`string`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`ChangedBy`
		`ProblemInfo`		`object`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`ProblemInfo`
			`CustomerNotes`	`string`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`CustomerNotes`
			`FaultCode`	`string`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`FaultCode`
			`FaultDescription`	`string`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`FaultDescription`
			`RepairDescription`	`string`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`RepairDescription`
		`Amounts`		`object`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`Amounts`
			`RequestedOtherTax`	`integer`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`RequestedOtherTax`
			`RequestedPartsTax`	`integer`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`RequestedPartsTax`
			`RequestedTotal`	`integer`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`RequestedTotal`
			`PreAuthorizedAmount`	`integer`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`PreAuthorizedAmount`
			`AuthorizedLabor`	`integer`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`AuthorizedLabor`
			`AuthorizedTax`	`integer`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`AuthorizedTax`
			`AuthorizedLaborTax`	`integer`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`AuthorizedLaborTax`
			`AuthorizedFreight`	`integer`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`AuthorizedFreight`
			`AuthorizedMiles`	`integer`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`AuthorizedMiles`
			`AuthorizedPartsTax`	`integer`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`AuthorizedPartsTax`
			`RequestedMileage`	`integer`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`RequestedMileage`
			`RequestedLabor`	`integer`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`RequestedLabor`
			`AuthorizedParts`	`integer`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`AuthorizedParts`
			`RequestedTravel`	`integer`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`RequestedTravel`
			`AuthorizedShipping`	`integer`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`AuthorizedShipping`
			`AuthorizedMileage`	`integer`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`AuthorizedMileage`
			`RequestedParts`	`integer`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`RequestedParts`
			`RequestedTax`	`integer`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`RequestedTax`
			`AuthorizedOther`	`integer`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`AuthorizedOther`
			`AuthorizedTravel`	`integer`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`AuthorizedTravel`
			`RequestedOther`	`integer`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`RequestedOther`
			`RequestedRatePerMile`	`integer`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`RequestedRatePerMile`
			`RequestedShipping`	`integer`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`RequestedShipping`
			`RequestedFreight`	`integer`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`RequestedFreight`
			`AuthorizedOtherTax`	`integer`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`AuthorizedOtherTax`
			`RequestedLaborTax`	`integer`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`RequestedLaborTax`
			`RequestedMiles`	`integer`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`RequestedMiles`
			`AuthorizedTotal`	`integer`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`AuthorizedTotal`
		`CallNumber`		`string`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`CallNumber`
		`ApprovalRejectInfo`		`object`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`ApprovalRejectInfo`
			`ReasonDescription`	`string`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`ReasonDescription`
			`ReasonCode`	`string`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`ReasonCode`
			`ApprovedOrAdditionalInformationRequestNotes`	`string`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`ApprovedOrAdditionalInformationRequestNotes`
		`ParentRequestNumber`		`string`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`ParentRequestNumber`
	`ResponseCode`			`string`	Pass through parameter to the Dispatch "Get Request for Authorization" API.	`ResponseCode`

Error

On error, a JSON-formatted version of the Dispatch "Get 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