Get Driver Endpoints: GetDriver

API endpoints for retrieving driver data

GetDriver

Allows you to extract details for a driver

Permissions

If you want to use this API in your system, enable Drivers:Get.

  1. Go to System Roles and select the 'web_services' role
  2. Navigate to the Roles / APIs tab
  3. Find the Drivers:Get permission and check its check box

Authenticate to api using this method Authenticate with the API, Please refer this link for login information.

HTTP Method

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

Input Fields (Body)

JSON FieldFormatNotesMandatory
driver_idStringClient IDYes

Input Fields (JSON)

{ "driver_id":"101140"}

Successful Response Example

Extracted Driver details can be minimised by selecting only the required data points from the full list of placeholders shown below.

{ "accountant_contact_name": "", "accountant_contact_phone": "", "accountant_firm_name": "", "address_id_home": "100381", "address_id_post": "100380", "addresses": { "home": { "address_1": "", "address_2": "", "area": "", "state": "", "postcode": "", "country_id": null }, "post": { "address_1": "", "address_2": "", "area": "", "state": "", "postcode": "", "country_id": null } }, "allowances": 0, "annual_salary": 0, "asset_bank_accounts": null, "asset_bank_accounts_description": "", "asset_furniture": null, "asset_furniture_description": "", "asset_investment_properties": null, "asset_investment_properties_description": "", "asset_motor_vehicle": null, "asset_motor_vehicle_description": "", "asset_other_investments": null, "asset_other_investments_description": "", "asset_resident_property": null, "asset_resident_property_description": "", "asset_shares": null, "asset_shares_description": "", "asset_super": null, "asset_super_description": "", "ato_loan_flag": "no", "australian_resident": "yes", "card_account_number": "", "client_cost_centre_id": null, "client_id": "100209", "contact_note": "", "corporate_type_id_previous_employer": "0", "created": "2018-04-16 03:22:59", "credit_check_authorised_flag": "", "date_of_birth": "0000-00-00", "driver_claims_flag": "yes", "driver_employment_type_id": "0", "driver_id": "101140", "driver_id_external": "0", "driver_lic_exp": "", "driver_licence": "", "driver_licence_state": "", "driver_occupation_code_id": "0", "employee_alias": "", "employee_area": "", "employee_end": "0000-00-00", "employee_group": "", "employee_no": "", "employee_pay_office": "", "employee_sl_acc": "", "employee_start": "0000-00-00", "employee_super": 0, "employer_address_1": "", "employer_address_2": "", "employer_address_3": "", "employer_address_postcode": "", "employer_address_state": "", "employer_super": 0, "expense_credit_card": null, "expense_household": null, "expense_mortgage": null, "expense_other": null, "expense_private_education_childcare": null, "expense_rent": null, "expense_vehicle": null, "external_code": "", "fbt_type": "", "financier_applicant_reference": "", "gender": "", "generated_password": "LAPORTAL", "given_name": "Kylie", "home_car_postcode": "", "home_email": "demo@catch-e.com.au", "home_fax": "", "home_phone": "", "home_postcode": "", "home_state": "", "home_street": "", "home_street_no": "", "home_street_type": "", "home_suburb": "", "home_unit_no": "", "income_government_benefits": null, "income_gross": null, "income_investment": null, "income_net": null, "income_other": null, "income_rental_net": null, "income_spouse_gross": null, "income_spouse_net": null, "income_superannuation": null, "insurance_broker_fee_exempt_flag": "yes", "kyc_verified_flag": "no", "landlord_name": "", "landlord_telephone": "", "last_edit": "2018-04-30 23:36:19", "liability_credit_card_limit": null, "liability_credit_card_limit_description": "", "liability_investment_mortgages": null, "liability_investment_mortgages_description": "", "liability_loans": null, "liability_loans_description": "", "liability_mortgages": null, "liability_mortgages_description": "", "liability_other": null, "liability_other_description": "", "liability_overdraft": null, "liability_overdraft_description": "", "liability_rent": null, "liability_rent_description": "", "licence_class": "", "marital_status": "", "middle_name": "", "mobile": "", "name_on_account": "", "no_of_dependents": 0, "pay_cycle_id": "0", "preferred_name": "", "previous_address_1": "", "previous_address_2": "", "previous_address_3": "", "previous_address_country_id": null, "previous_address_postcode": "", "previous_address_state": "", "previous_address_years_at_address": 0, "previous_employer_name": "", "previous_employer_phone": "", "previous_years_employed": 0, "report_delivery_type": "email", "residency_status": "", "residential_status": "", "salutation": "", "start_at_address": "0000-00-00", "stop_becs_flag": "no", "supplier_id_etag": "0", "supplier_id_financier": "0", "surname": "Lower", "tag_account_number": "", "tag_number": "", "user_id_assigned": null, "user_id_create": null, "user_id_edit": "10824", "user_id_package_advisor": "0", "work_contact_given": "", "work_contact_position": "", "work_contact_surname": "", "work_fax": "", "work_name": "", "work_phone": "", "work_phone_ext": "", "work_position": "", "work_postcode": "", "work_state": "", "work_street": "", "work_street_no": "", "work_street_type": "", "work_suburb": "", "work_type": "", "work_unit_no": "", "years_at_address": 0, "years_with_employer": 0, "_links": { "self": { "href": "https://api.staging.catch-e.com/fm/drivers/101140" } }}

Error Response Details

Validation MessagesComments
400 - Bad Request
{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Bad Request", "status": 400, "detail": "JSON decoding error: Syntax error, malformed JSON"}

| The JSON payload content is not formatted correctly. |
| 401 - Unauthorized | | |

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unauthorized", "status": 401, "detail": "Unauthorized"}

| You have not authenticated before running this API or The token_timeout of the current session has passed. You need to authenticate again. |
| 403 - Forbidden | | |

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Forbidden", "status": 403, "detail": "Forbidden"}

| You do not have permissions for this request. Go to System Roles and enter 'web_services' Navigate to the Roles / APIs tab to make sure the permission you need to run this API is checked. |
| 422 - Failed Validation | | |

{ "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"}

| Invalid Driver ID provided |

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 FieldFormatNotesMandatory
driver_idIntDriver IDYes
pagestringOptional page number. Defaults to 1No
page_sizestringOptional 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=&page=1&page_size=25

For a single Drivers' Assets:

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

(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"}

GetDriverBankAccount

Allows you to get Driver bank accounts.

Permissions

To run this API, the nominated 'web-services' role needs to be given permission.

If you are not actively using the API, leave the permission off for better security.

Go to Roles / Apis and check on DriverBankAccounts:Get

Note: This API is not configured for external use.
Contact your Account Manager to discuss access to this API.

HTTP Method

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

URL Examples

https://api.catch-e.com/bank/accounts/{driver_bank_account_id}

Parameters - Path

KeyFormatNotesDefault ValueMandatory
driverbankaccount_idstringPass the driverbankaccount_id to retrieve details of bank account.yes

Sample Response (200 - Successful)

{ "driver_bank_account_id": "string", "driver_id": "string", "account_name": "string", "bsb": "string", "account_number": "string", "claims_access_flag": "no", "claims_default_flag": "no", "status_flag": "active"}

GetDriverBankAccounts

Allows you to get Driver bank accounts.

Permissions

To run this API, the nominated 'web-services' role needs to be given permission.

If you are not actively using the API, leave the permission off for better security.

Go to Roles / Apis and check on DriverBankAccounts:Get

Note: This API is not configured for external use.
Contact your Account Manager to discuss access to this API.

HTTP Method

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

URL Examples

https://api.catch-e.com/bank/accounts

Parameters - Path

KeyFormatNotesDefault ValueMandatory
driver_idstringPass the driver_id to retrieve details of bank accounts.yes
claimaccessflagstringAvailable values:yes,nono
claimdefaultflagstringAvailable values:yes,nono
status_flagstringAvailable values:active,inactiveno
pageintegerOptional page numberno
page _sizeintegerOptional page sizeno

Sample Response (200 - Successful)

{ "driver_bank_account_id": "string", "driver_id": "string", "supplier_id": "string", "account_name": "string", "bsb": "string", "account_number": "string", "claims_default_flag": "no", "status_flag": "active"}

GetDriverEvent

This API returns details for a single drivereventid.

Supplementary SWAGGER documentation is available here: https://api.catch-e.com/docs/#/Drivers%20%2F%20Events/getDriverEvent

Permissions

To run this API, the nominated 'web-services' role needs to be given permission.

If you are not actively using the API, leave the permission off for better security.

Go to Roles / Apis and check on DriverEvents:Get.

Note: This API is not configured for external use.
Contact your Account Manager to discuss access to this API.

Authentication

Authenticate with the API before running this API.

HTTP Method

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

URL Examples

https://api.test.catch-e.com/fm/driver-events/{driver_event_id}

Path Variables

KeyFormatNotesMandatory
drivereventidstringdriver Event ID.Required

Response Details

Validation MessagesComments
200 OK
{ "driver_event_id": "100002", "driver_id": "100100", "driver_event_code_id": "100006", "event_date": "2006-10-10", "event_value": null, "description": "Signed docs received", "driver_event_value_id": null, "driver_event_description_id": null, "driver_event_action_id": "100000", "due_date": "0000-00-00", "completed_flag": "yes", "attachment_id": null, "user_id_edit": "10003", "last_edit": "2006-10-23 06:35:20", "status_flag": "active", "_links": { "self": { "href": "https://api.test.catch-e.com/fm/driver-events/100002" } }}

| Success. |
| 403 - Forbidden | | |

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Forbidden", "status": 403, "detail": "Forbidden"}

| You do not have permissions for this request. Go to System Roles and enter 'web_services' Navigate to the Roles / APIs tab to make sure the permission you need to run this API is checked. |
| 422 - Unprocessable Content | | |

{ "validation_messages": { "driver_event_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"}

| driver event id not found. |

GetDriverEventActions

This method returns a list of Driver event actions.

Use this information to find and populate the required action for events in the API createDriverEvents.

Supplementary SWAGGER documentation is available here: https://api.test.catch-e.com/docs/#/Driver%20%2F%20Events/getDriverEventActions(https://api.test.catch-e.com/docs/#/Driver%20%2F%20Events/getDriverEventActions)

Permissions

To run this API, the nominated 'web-services' role needs to be given permission.

If you are not actively using the API, leave the permission off for better security.

Go to Roles / Apis and check on DriverEventActions:Get

Note: This API is not configured for external use.
Contact your Account Manager to discuss access to this API.

HTTP Method

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

URL Examples

https://api.demo.catch-e.com/authenticate
https://api..catch-e.com/authenticate
https://api.test.catch-e.com/fm/Driver-event-actions

Parameters - Path Variables

KeyFormatNotesMandatory
namestringName of Action. This field supports the wildcard % operator (See Wildcard % operator notes below).No
pageinteger($int32)Page number. Default value : 1No
page_sizeinteger($int32)Page size. Default value : 25No

Wildcard % operator notes:

If you are using "Postman" app, with the wildcard operator, the search string of either %ab% or %ba%, will give this response:

"field_name": {"isEmpty": "Value is required and can't be empty"}.

If you need to search either %ab% or %ba%, please use %25ab%25 or %25ba%25 as required to return results as expected.

Successful Response Example

{ "_links": { "self": { "href": "https://api.test.catch-e.com/fm/driver-event-actions/?page=1" }, "first": { "href": "https://api.test.catch-e.com/fm/driver-event-actions/" }, "last": { "href": "https://api.test.catch-e.com/fm/driver-event-actions/?page=1" } }, "_embedded": { "fm_driver_event_actions": [ { "driver_event_action_id": "100000", "name": "Closed", "_links": { "self": { "href": "https://api.test.catch-e.com/fm/driver-event-actions/100000" } } }, { "driver_event_action_id": "100001", "name": "Follow Up", "_links": { "self": { "href": "https://api.test.catch-e.com/fm/driver-event-actions/100001" } } }, { "driver_event_action_id": "100002", "name": "None", "_links": { "self": { "href": "https://api.test.catch-e.com/fm/driver-event-actions/100002" } } }, { "driver_event_action_id": "100003", "name": "Urgent", "_links": { "self": { "href": "https://api.test.catch-e.com/fm/driver-event-actions/100003" } } } ] }, "page_count": 1, "page_size": 25, "total_items": 4, "page": 1}

Error Response Details

Validation MessagesComments
404 Not Found
"detail": "API endpoint not found"
422 Unprocessable Entity
{"name":{"noRecordFound": "No record matching the input was found"}}

| The name passed is not stored in the database. |
| 423 Failed Validation | |
| "detail": "Locked" | Either the Driver is being edited or Billing is being processed. Try again once the Driver is no longer in use or the Billing process has completed. |
| 403 - Forbidden | |
| "detail": "Forbidden" | You do not have permissions for this request. |