Skip to main content

GetDriverAssets

Overview

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

HTTP Method

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

Input Fields (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' Assets:

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

For a single Drivers' Assets:

https://api.test.catch-e.com/fm/driver/assets?{{driverAssetId}} 

(Successful) Output Example (sample)

{ "_links": { "self": { "href": "https://api.test.catch-e.com/fm/driver/assets/?driver_id=101211&page=1&page_size=25" }, "first": { "href": "https://api.test.catch-e.com/fm/driver/assets/?driver_id=101211&page_size=25" }, "last": { "href": "https://api.test.catch-e.com/fm/driver/assets/?driver_id=101211&page=1&page_size=25" } }, "_embedded": { "driver_assets": [ { "driver_asset_id": 3196434310060077777, "driver_id": 100000, "finance_asset_type_id": 3196195708503877777, "amount": 77777, "ownership": "debt_free", "description": "Test Asset 1", "finance_asset_type_name": "Resident Property", "_links": { "self": { "href": "https://api.test.catch-e.com/fm/driver/assets/3196434310060077777" } } } ] }, "page_count": 1, "page_size": 25, "total_items": 1, "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