Get ride by ID
GET {{AppUrl}}/api/v1/agency/ride/{{Ride ID}}
Introduction
Get detailed information for a ride by ID. Only rides submitted by the authenticated agency can be retrieved.
Structure
| Item | Type | Plurality | Options | Required | Description | ||
|---|---|---|---|---|---|---|---|
| id | integer | 1 | yes | Ride identifier. | |||
| transport_type | varchar(255) | 1 | llv omd wmo | yes | The transport type of the ride. | ||
| distance_km | decimal(8,2) | 1 | yes | Distance in kilometers (up to two decimals). | |||
| distance_zone | integer | 1 | yes | Distance in zones. | |||
| rbs_number | integer | 1 | yes | RBS number (agency ride ID). | |||
| remark | varchar(255) | 1 | no | An optional remark that can be supplied by the agency. | |||
| callcentre_employee | varchar(255) | 1 | yes | The call centre employee responsible for booking the ride. | |||
| payment_method | varchar(255) | 1 | yes | The payment method for the ride. | |||
| customer | object | 1 | yes | Customer information. | |||
| id | integer | 1 | yes | The customer identifier. | |||
| first_name | varchar(255) | 1 | yes | The first name of the customer. | |||
| initials | varchar(255) | 1 | yes | The initials of the customer. | |||
| infix | varchar(255) | 1 | no | The infix of the customer. | |||
| last_name | varchar(255) | 1 | yes | The last name of the customer. | |||
| gender | varchar(1) | 1 | m f | yes | The gender of the customer (Male or female). | ||
| phone_number | varchar(255) | 1 | yes | Phone number of the customer. | |||
| mobilephonenumber | varchar(255) | 1 | no | Mobile phone number of the customer. | |||
| restrictions | array | N | intellectual visual auditory motoric psychological | yes* | Is only required for contract_type of wmo. | ||
| indications | array | N | assistance scootmobile guide-dog solo rollator sit-in-front room low-entrance family push-wheelchair foldable-wheelchair electric-wheelchair assistance extra-high-wheelchair extra-wide-wheelchair leg-support extra-large-entrance extra-large-seat sms-service call-service type-1 type-2 type-3 child pet free-counselor social-counselor | no | The indications for the customer. | ||
| card_number | varchar(255) | 1 | no | The active card number for the customer. | |||
| locations | array | 2 | yes | Exactly two locations must be supplied, one with action 'pickup' and one with action 'dropoff'. | |||
| type | varchar(255) | 1 | coordinate address | yes | Indicates whether the location is a coordinate or address. Either a coordinate or address must be supplied for a location. | ||
| action | varchar(255) | 1 | pickup dropoff | yes | The action of the location. | ||
| description | varchar(255) | 1 | no | An optional description that can be supplied by the agency. | |||
| ideal | DateTime | 1 | yes* | Ideal time to arrive. Is required once for action 'pickup' or 'dropoff', not both. | |||
| coordinate | object | 1 | no | The coordinates of the location. | |||
| latitude | decimal(8,6) | 1 | yes | Latitudinal coordinate of the location. | |||
| longitude | decimal(9,6) | 1 | yes | Longitudinal coordinate of the location. | |||
| address | object | 1 | no | The address of the location. | |||
| street | varchar(255) | 1 | yes | Street name of the location. | |||
| number | varchar(255) | 1 | yes | Number of the location. | |||
| addition | varchar(255) | 1 | no | Addition to the number of the location. | |||
| postcode | varchar(255) | 1 | yes | Postal code of the location. | |||
| place | varchar(255) | 1 | yes | Place of the location. | |||
| passengers | array | N | yes | Defines the passengers for the ride. | |||
| type | varchar(255) | 1 | customer assistance guide-dog companion | yes | The type of passenger. | ||
| tariff | varchar(255) | 1 | normal reduced free | yes | The tariff of the passenger. | ||
| description | varchar(255) | 1 | yes | The passenger description supplied by the agency. | |||
| quantity | integer | 1 | yes | The quantity of passengers of this type and tariff. | |||
| indications | array | N | no | Defines the indications for the ride. | |||
| type | varchar(255) | 1 | assistance scootmobile guide-dog solo rollator sit-in-front room low-entrance family push-wheelchair foldable-wheelchair electric-wheelchair assistance extra-high-wheelchair extra-wide-wheelchair leg-support extra-large-entrance extra-large-seat sms-service call-service type-1 type-2 type-3 child pet free-counselor social-counselor | yes | The type of indication. | ||
| quantity | integer | 1 | yes | The number of times this indication is required / requested. | |||
| contributions | array | N | yes | Contribution the customer will pay for the ride. | |||
| type | varchar(255) | 1 | personal-contribution social-mentor inner-zones outer-zones late-booking | yes | Eigen bijdrage Eigen bijdrage sociaal begeleider Eigen bijdrage boven 5e zone Eigen bijdrage zone 1 t/m 5 Laatboek toeslag | ||
| amount | integer | 1 | yes | The amount of contribution the customer will pay in cents. | |||
| statuses | array | N | no | The statuses for the ride. | |||
| type | varchar(255) | 1 | accepted start pick-up drop-off eta call not-picked-up | yes | The type of status. | ||
| timestamp | DateTime | 1 | yes | Date/time of the status. | |||
| coordinate | object | 1 | yes* | Location of the vehicle at the time of the status update. *Required for all statuses except 'accept'. | |||
| latitude | decimal(8,6) | 1 | yes | Latitude of the coordinate. | |||
| longitude | decimal(9,6) | 1 | yes | Longitude of the coordinate. | |||
| vehicle | object | 1 | yes* | Details of the vehicle that updated the status. *Required on statuses of type 'start'. | |||
| id | integer | 1 | yes | Vehicle ID as supplied by the carrier. | |||
| license | varchar(255) | 1 | yes | Vehicle license plate number. | |||
| fuel_type | varchar(255) | 1 | unknown petrol diesel electricity hydrogen | yes | The vehicle's fuel type. | ||
| eta | object | 1 | yes* | Estimated time of arrival. *Required on statuses of type 'eta' | |||
| eta | DateTime | 1 | yes | Estimated time of arrival. | |||
| eta_type | varchar(255) | 1 | pick-up drop-off | yes | Whether the eta is for pick-up or drop-off location. | ||
| result | varchar(255) | 1 | success not-picked-up | yes* | Result of the call. *Required on statuses of type 'call'. | ||
| reason | varchar(255) | 1 | unknown too-late client-not-there | yes* | Reason for the call. *Required on statuses of type 'call'. | ||
| odometer | integer | 1 | yes* | The odometer at the time of the status update. *Required on statuses of type 'pick-up' and 'drop-off'. | |||
| distance | decimal(8,2) | 1 | yes* | The actual distance in km traveled between pick-up and drop-off. *Required on statuses of type 'drop-off'. | |||
| card_number | varchar(255) | 1 | yes* | The card number used by the customer. *Required on statuses of type 'pick-up' and 'drop-off'. | |||
| created_at | DateTime | 1 | yes | Date/time the ride was created. | |||
| updated_at | DateTime | 1 | yes | Date/time the ride was last modified. | |||
| deleted_at | DateTime | 1 | no | Date/time the ride was canceled. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"data":{"id":122,"transport_type":"wmo","distance_km":60.56,"distance_zones":7,"rbs_number":"4060882513","remark":"Itaque labore est laudantium debitis.","callcentre_employee":"Adam van Wallaert","customer":{"id":26,"first_name":"Thijn","initials":"T","infix":"","last_name":"Ramaker","gender":"f","phone":"+3177 1364761","mobile":"0643438998","municipality_name":"Katwoude","bankaccount":"NL27YBGI2209095944","bankaccount_name":"D Blewanus","restrictions":["auditory","intellectual","motoric"],"indications":["call-service","child","electric-wheelchair","extra-high-wheelchair","extra-large-seat","family","push-wheelchair","rollator","sit-in-front","type-3"],"card_number":709018899},"locations":[{"type":"address","action":"pickup","description":"Quis corporis sed voluptas perspiciatis et quia nisi fuga.","ideal":"2018-02-04T11:14:35+01:00","address":{"street":"Mulderbaan","number":"3076","addition":"a","zipcode":"3075AH","place":"Hoogeveen"}},{"type":"address","action":"dropoff","description":"Recusandae distinctio eius et dignissimos.","ideal":"2016-04-05T16:15:48+02:00","address":{"street":"Kuitdreef","number":"1993","addition":null,"zipcode":"9752BK","place":"Gemonde"}}],"passengers":[{"type":"guide-dog","tariff":"normal","description":"Voluptates et blanditiis fuga et qui et.","quantity":3}],"indications":[{"type":"assistance","quantity":1},{"type":"call-service","quantity":1},{"type":"child","quantity":1},{"type":"extra-wide-wheelchair","quantity":1},{"type":"foldable-wheelchair","quantity":1},{"type":"scootmobile","quantity":1},{"type":"sms-service","quantity":1},{"type":"social-counselor","quantity":1},{"type":"type-2","quantity":1},{"type":"type-3","quantity":1}],"contributions":[{"type":"late-booking","amount":1100},{"type":"social-mentor","amount":1100}],"statuses":[],"created_at":"2018-12-10T15:23:29+01:00","updated_at":"2019-01-22T11:04:25+01:00","deleted_at":"2019-01-22T11:04:25+01:00"}}