Skip to content

Retrieve a driver by property

Returns an array of drivers objects matching a specified property.

For example, to return a driver by cell phone number, query the property cellPhone to filter responses.

Assumption: to return the correct driver, you must know the property to query.

URL

{server_url}/drivers/?{property}={value}

Method

{GET}

Query parameters

Optionally, you can specify driver properties asKey/Value query parameters. For example: driverIdentity/Neighbor. Note that property titles are case sensitive.

Property Description Type Required Notes
driverName The driver's full name. string Required
driverIdentity The driver's primary role in relationship to the family. string Optional Examples: Mom, Dad, Neighbor.
cellPhone The driver's cell phone number. string Required
email The driver's email address. string Required A unique email is required.

Request headers

Header name Description Required Values
Basic Auth A security checkpoint that requires transmission of a username and password with every request. Required Basic authentication is a simple authentication scheme that's built into the HTTP protocol. See the Quickstart > Security section.

Request body

None

Sample request

The API call should look something like this. You can change the values of each property as you’d like.

{GET}{base_url}/drivers?driverIdentity=Neighbor

Return body

The sample response returns a driver matching the specified driverIdentity.

[
    {
        "driverName": "Melanie Griffiths",
        "driverIdentity": "Neighbor",
        "cellPhone": "(555)794-4321",
        "email": "m.griffiths@gmail.com",
        "id": "3"
    }
    ...
]

Return status

Status value Return status Description
200 Success Requested data returned successfully
ECONNREFUSED N/A Service is offline. Start the service and try again.