Resource URL Summary

Pass Through Call to ServiceClaims's "Get Claims Data" API

POST /up/v5/claims/_query

HTTP Headers

This API uses the standard ServiceBroker HTTP Headers.

API Specifics

Pass Through Call to ServiceClaims's "Get Claims Data" API

This RESTified API will perform a pass-through call to the ServiceClaims sub-system's "Get Claims Data" API (when configured).

URL

POST /up/v5/claims/_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 ServiceClaims "Get Claims Data" API.

GetClaimsData Object Format

{
	"ManufacturerName": "INSINKERATOR",
	"ServiceCenterNumber": "",
	"ClaimIdentifier": "",
	"ClaimBatchNumber": 0,
	"ClaimSequenceNumber": 0,
	"ClaimNumber": "ISL5ZRD9K",
	"CallNumber": ""
}

GetClaimsData Object Properties

Property	Type	Required?	Description	ServiceClaims Field Mapping
`ManufacturerName`	`string`	No	Pass through parameter to the ServiceClaims "Get Claims Data" API.	`manufacturerName`
`ServiceCenterNumber`	`string`	No	Pass through parameter to the ServiceClaims "Get Claims Data" API.	`serviceCenterNumber`
`ClaimIdentifier`	`string`	No	Pass through parameter to the ServiceClaims "Get Claims Data" API.	`claimIdentifier`
`ClaimBatchNumber`	`integer`	No	Pass through parameter to the ServiceClaims "Get Claims Data" API.	`claimBatchNumber`
`ClaimSequenceNumber`	`integer`	No	Pass through parameter to the ServiceClaims "Get Claims Data" API.	`claimSequenceNumber`
`ClaimNumber`	`string`	No	Pass through parameter to the ServiceClaims "Get Claims Data" API.	`claimNumber`
`CallNumber`	`string`	No	Pass through parameter to the ServiceClaims "Get Claims Data" API.	`callNumber`

HTTP Response

Success

On success, a JSON-formatted version of the ServiceClaims "Get Claims Data" API response will be returned.

GetClaimsData Response Object Format

{
    "Success": true,
    "Code": 0,
    "Message": "OK",
    "Payload": {
        "TransactionId": "0044794809INSNKWS001",
        "ResponseCode": "OK",
        "Claims": [
            {
                "PeriodEndingDate": 20180501,
                "PaidStateTaxAmount": 0,
                "PaidIncentiveAmount": 0,
                "ServicerNumber": "54789",
                "PaidTravelAmount": 0,
                "PaymentAmount": 0,
                "ClaimBatchNumber": 100,
                "ProductName": "",
                "PaymentType": "",
                "PaidOtherAmount": 0,
                "PaidPartsHandlingAmount": 0,
                "PaidFederalTaxAmount": 0,
                "ClaimSequenceNumber": 6813,
                "ReceivedDate": 20180501,
                "ClaimNumber": "ISL5ZRD9K",
                "PaidLaborAmount": 93,
                "BrandName": "B01",
                "ClaimStatusDescription": "Paid",
                "SerialNumber": "DI999887795",
                "EditedDate": 0,
                "ClaimIdentifier": "000100006813",
                "PaidShippingAmount": 0,
                "PaidPartsAmount": 0,
                "PaidTotal": 93,
                "AuthorizationNumber": "",
                "CallNumber": "",
                "PaidMileageAmount": 0,
                "ServicerName": "DAVE'S APPLIANCE",
                "PaymentMethod": "",
                "ModelNumber": "76039H",
                "PaidFreightAmount": 0,
                "ClaimStatusCode": "P",
                "PaymentDate": 20180501,
                "PaymentTransactionNumber": "0"
            },
            // ...
        ]
    }
}

GetClaimsData Response Object Properties

Property		Type	Description
`Claims`		`array`	Pass through parameter from the ServiceClaims "Get Claims Data" API.
		`object`	Pass through parameter from the ServiceClaims "Get Claims Data" API.
	`PeriodEndingDate`	`integer`	Pass through parameter from the ServiceClaims "Get Claims Data" API.
	`PaidStateTaxAmount`	`integer`	Pass through parameter from the ServiceClaims "Get Claims Data" API.
	`PaidIncentiveAmount`	`integer`	Pass through parameter from the ServiceClaims "Get Claims Data" API.
	`ServicerNumber`	`string`	Pass through parameter from the ServiceClaims "Get Claims Data" API.
	`PaidTravelAmount`	`integer`	Pass through parameter from the ServiceClaims "Get Claims Data" API.
	`PaymentAmount`	`integer`	Pass through parameter from the ServiceClaims "Get Claims Data" API.
	`ClaimBatchNumber`	`integer`	Pass through parameter from the ServiceClaims "Get Claims Data" API.
	`ProductName`	`string`	Pass through parameter from the ServiceClaims "Get Claims Data" API.
	`PaymentType`	`string`	Pass through parameter from the ServiceClaims "Get Claims Data" API.
	`PaidOtherAmount`	`integer`	Pass through parameter from the ServiceClaims "Get Claims Data" API.
	`PaidPartsHandlingAmount`	`integer`	Pass through parameter from the ServiceClaims "Get Claims Data" API.
	`PaidFederalTaxAmount`	`integer`	Pass through parameter from the ServiceClaims "Get Claims Data" API.
	`ClaimSequenceNumber`	`integer`	Pass through parameter from the ServiceClaims "Get Claims Data" API.
	`ReceivedDate`	`integer`	Pass through parameter from the ServiceClaims "Get Claims Data" API.
	`ClaimNumber`	`string`	Pass through parameter from the ServiceClaims "Get Claims Data" API.
	`PaidLaborAmount`	`integer`	Pass through parameter from the ServiceClaims "Get Claims Data" API.
	`BrandName`	`string`	Pass through parameter from the ServiceClaims "Get Claims Data" API.
	`ClaimStatusDescription`	`string`	Pass through parameter from the ServiceClaims "Get Claims Data" API.
	`SerialNumber`	`string`	Pass through parameter from the ServiceClaims "Get Claims Data" API.
	`EditedDate`	`integer`	Pass through parameter from the ServiceClaims "Get Claims Data" API.
	`ClaimIdentifier`	`string`	Pass through parameter from the ServiceClaims "Get Claims Data" API.
	`PaidShippingAmount`	`integer`	Pass through parameter from the ServiceClaims "Get Claims Data" API.
	`PaidPartsAmount`	`integer`	Pass through parameter from the ServiceClaims "Get Claims Data" API.
	`PaidTotal`	`integer`	Pass through parameter from the ServiceClaims "Get Claims Data" API.
	`AuthorizationNumber`	`string`	Pass through parameter from the ServiceClaims "Get Claims Data" API.
	`CallNumber`	`string`	Pass through parameter from the ServiceClaims "Get Claims Data" API.
	`PaidMileageAmount`	`integer`	Pass through parameter from the ServiceClaims "Get Claims Data" API.
	`ServicerName`	`string`	Pass through parameter from the ServiceClaims "Get Claims Data" API.
	`PaymentMethod`	`string`	Pass through parameter from the ServiceClaims "Get Claims Data" API.
	`ModelNumber`	`string`	Pass through parameter from the ServiceClaims "Get Claims Data" API.
	`PaidFreightAmount`	`integer`	Pass through parameter from the ServiceClaims "Get Claims Data" API.
	`ClaimStatusCode`	`string`	Pass through parameter from the ServiceClaims "Get Claims Data" API.
	`PaymentDate`	`integer`	Pass through parameter from the ServiceClaims "Get Claims Data" API.
	`PaymentTransactionNumber`	`string`	Pass through parameter from the ServiceClaims "Get Claims Data" API.

Error

On error, a JSON-formatted version of the ServiceClaims "Get Claims Data" API response will be returned.

{
    "Success": false,
    "Code": 8,
    "Message": {
        "name": "BadRequest",
        "message": "Error occurred while querying the Claim!",
        "code": 400,
        "className": "bad-request",
        "data": {
            "transactionId": "0008019566INSNKWS001",
            "responseCode": "ER",
            "messages": [
                {
                    "message": "Invalid manufacturerName"
                }
            ]
        },
        "errors": {}
    }
}

GetClaimsData RESTified API