Pass Through Call to Dispatch's "Submit Claim" API

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

URL

POST /up/v5/claims

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 "Submit Claim" APi.

SubmitClaim Object Format

js

SubmitClaim Object Properties

HTTP Response

Success

On success, a JSON-formatted version of the Dispatch "Submit Claim" API response will be returned.

SubmitClaim Response Object Format

js

SubmitClaim Response Object Properties

Property				Type	Description	Dispatch Field Mapping
`Success`				`boolean`	Pass through parameter from the Dispatch "Submit Claim" API.	`Success`
`Code`				`integer`	Pass through parameter from the Dispatch "Submit Claim" API.	`Code`
`Message`				`string`	Pass through parameter from the Dispatch "Submit Claim" API.	`Message`
`Payload`				`object`	Pass through parameter from the Dispatch "Submit Claim" API.	`Payload`
	`TotalClaimsReceived`			`integer`	Pass through parameter from the Dispatch "Submit Claim" API.	`TotalClaimsReceived`
	`TransactionId`			`string`	Pass through parameter from the Dispatch "Submit Claim" API.	`TransactionId`
	`ResponseCode`			`string`	Pass through parameter from the Dispatch "Submit Claim" API.	`ResponseCode`
	`TotalClaimsProcessedSuccessfully`			`integer`	Pass through parameter from the Dispatch "Submit Claim" API.	`TotalClaimsProcessedSuccessfully`
	`Claims`			`array`	Pass through parameter from the Dispatch "Submit Claim" API.	`Claims`
		`ClaimTransactionId`		`string`	Pass through parameter from the Dispatch "Submit Claim" API.	`ClaimTransactionId`
		`ClaimResponseCode`		`string`	Pass through parameter from the Dispatch "Submit Claim" API.	`ClaimResponseCode`
		`ServiceCenterNumber`		`string`	Pass through parameter from the Dispatch "Submit Claim" API.	`ServiceCenterNumber`
		`ClaimStatusDescription`		`string`	Pass through parameter from the Dispatch "Submit Claim" API.	`ClaimStatusDescription`
		`ManufacturerName`		`string`	Pass through parameter from the Dispatch "Submit Claim" API.	`ManufacturerName`
		`ServiceCenterLocationCode`		`string`	Pass through parameter from the Dispatch "Submit Claim" API.	`ServiceCenterLocationCode`
		`Type`		`string`	Pass through parameter from the Dispatch "Submit Claim" API.	`Type`
		`ClaimBatchNumber`		`integer`	Pass through parameter from the Dispatch "Submit Claim" API.	`ClaimBatchNumber`
		`ClaimSequenceNumber`		`integer`	Pass through parameter from the Dispatch "Submit Claim" API.	`ClaimSequenceNumber`
		`ClaimStatusCode`		`string`	Pass through parameter from the Dispatch "Submit Claim" API.	`ClaimStatusCode`
		`ClaimNumber`		`string`	Pass through parameter from the Dispatch "Submit Claim" API.	`ClaimNumber`
		`Errors`		`array`	Pass through parameter from the Dispatch "Submit Claim" API.	`Errors`
			`ErrorDescription`	`string`	Pass through parameter from the Dispatch "Submit Claim" API.	`ErrorDescription`
			`PartNumber`	`string`	Pass through parameter from the Dispatch "Submit Claim" API.	`PartNumber`
	`TotalClaimsNotProcessedSuccessfully`			`integer`	Pass through parameter from the Dispatch "Submit Claim" API.	`TotalClaimsNotProcessedSuccessfully`

Error

On error, a JSON-formatted version of the Dispatch "Submit Claim" API response will be returned.

js

Return Codes

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

Browser not supported