Skip to main content

Allows you to retrieve a Drivers' Liabilities for use in the updateDriverLiabilities() web services.

HTTP Method

Use the HTTP Method 'GET' for consuming this web service.

Input Head (Header)

Header should contain the 'Content-Type' Key with the Value = 'application/json' or 'application/hjson'.

Input Fields (Body)

JSON Field

Format

Notes

Mandatory

driver_id

Int

Driver ID

Yes

page

string

Optional page number. Defaults to 1

No

page_size

string

Optional Page size. Defaults to 25 records per page.

No

Input URL Examples

For a list of a Drivers' Liabilities:

https://api.test.catch-e.com/fm/driver/liabilities?driver_id={{driver_id}}&page=1&page_size=25

(Successful) Output Example (sample)

{ "_links": { "self": { "href": "https://api.test.catch-e.com/fm/driver/liabilities/?driver_id=101211&page=1" }, "first": { "href": "https://api.test.catch-e.com/fm/driver/liabilities/?driver_id=101211" }, "last": { "href": "https://api.test.catch-e.com/fm/driver/liabilities/?driver_id=101211&page=1" } }, "_embedded": { "driver_liabilities": [ { "driver_liability_id": 3196434310060049470, "driver_id": 101211, "finance_liability_type_id": 3196195708503852473, "finance_liability_financier_id": 3196195708503852519, "driver_asset_id": null, "amount": 3456.78, "monthly_payment_amount": 45.67, "liability_payout_flag": null, "liability_end_date": null, "liability_limit_amount": 3333.33, "finance_liability_type_name": "Credit Card Limit", "finance_liability_financier_name": "NAB", "_links": { "self": { "href": "https://api.test.catch-e.com/fm/driver/liabilities/3196434310060049470" } } }, { "driver_liability_id": 3196434310060049494, "driver_id": 101211, "finance_liability_type_id": 3196195708503852473, "finance_liability_financier_id": 3196195708503852478, "driver_asset_id": null, "amount": 1000.77, "monthly_payment_amount": 12.34, "liability_payout_flag": "no", "liability_end_date": null, "liability_limit_amount": 2000.88, "finance_liability_type_name": "Credit Card Limit", "finance_liability_financier_name": "ANZ Banking", "_links": { "self": { "href": "https://api.test.catch-e.com/fm/driver/liabilities/3196434310060049494" } } } ] }, "page_count": 1, "page_size": 25, "total_items": 2, "page": 1 }

Error Codes

Example error output

{ "validation_messages": { "driver_id": { "noRecordFound": "No record matching the input was found" } }, "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unprocessable Entity", "status": 422, "detail": "Failed Validation" }

Was this helpful?

Still need help? Ask the team