Request List (Full Details)

Returns a paginated list of requests with full details.

GET https://api.vectorcare.com/openapi/v1.0/request-details/

Note: URLs must include the trailing slash.

Query Parameters

Parameter	Type	Description
`date__gte`	integer	Unix epoch timestamp, filter requests on or after. Default: Now - 24h
`date__lte`	integer	Unix epoch timestamp, filter requests on or before. Default: Now + 24h
`request__state`	string	Filter by state: `awaiting`, `accepted`, `completed`, `canceled`. Default: `accepted`
`page`	integer	Page number for pagination. Default: `1`

Response

Success (200 OK)

{
  "page": 1,
  "pages": 3,
  "results": [
    {
      "request_id": "EE5A6YZL",
      "patient_first_name": "Angela",
      "patient_last_name": "Graves",
      "patient_dob": "1931-03-31",
      "pickup_location": {
        "lat": 37.8623,
        "lng": -122.4911,
        "zip": "94965",
        "city": "Sausalito",
        "name": "28 Liberty Ship Way",
        "state": "CA",
        "street": "28 Liberty Ship Way",
        "address": "28 Liberty Ship Way, Sausalito, California 94965, United States",
        "country": "United States"
      },
      "destination_location": {
        "lat": 37.80119,
        "lng": -122.43935,
        "zip": "94123",
        "city": "San Francisco",
        "name": "96 Toledo Way",
        "state": "CA",
        "street": "96 Toledo Way",
        "address": "96 Toledo Way, San Francisco, California 94123, United States",
        "country": "United States"
      },
      "transport_pickup_time": "2022-04-28T14:00:00Z",
      "transport_agreed_for_time": "2022-04-28T14:00:00Z",
      "service_level_type": "BLS",
      "service_type": "standing_order_dispatcher",
      "account": {
        "id": "2UVAGY7O",
        "name": "Cool Company",
        "service_levels": ["ALS", "BLS", "CCT", "WC"],
        "facilities": null
      },
      "facility": {
        "id": "2UVAGY7O",
        "name": "Helpful Hospital #0"
      },
      "user": {
        "first_name": "Nicole",
        "last_name": "Montoya",
        "email": "requester@example.com"
      },
      "enabled_patient_fields": {
        "gender": "m"
      },
      "enabled_request_fields": {},
      "request_current_state": "accepted",
      "is_round_trip_first_trip": false,
      "is_round_trip_return_trip": false,
      "collection_id": "2UVAGY7O"
    }
  ]
}

Pagination Fields

Field	Type	Description
`page`	number	Current page number
`pages`	number	Total number of pages
`results`	array	Array of request objects

Request Fields

See Request Detail for full field descriptions.

Error (401 Unauthorized)

{
  "message": "Authentication credentials were not provided.",
  "code": "members:not_authenticated"
}

Pagination

Use the page and pages fields to iterate through all results. Results are returned in descending order by event_dt_utc.