Request Detail

Returns all details for a specific service request.

GET https://api.vectorcare.com/openapi/v1.0/requests/{request_id}/

Note: URLs must include the trailing slash.

Query Parameters

Parameter	Type	Description
`exclude_facilities`	boolean	If `true`, omit `account.facilities` from response. Default: `false`

Response

Success (200 OK)

{
  "request_id": "EE5A6YZL",
  "patient_first_name": "Angela",
  "patient_last_name": "Graves",
  "patient_dob": "1931-03-31",
  "pickup_location": {
    "id": "address.2900060502936820",
    "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": {
    "id": "address.6571326868700452",
    "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", "Ambulatory Van", "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"
}

Primary Fields

These fields are standard for all requests:

Field	Type	Description
`request_id`	string	Unique request identifier
`patient_first_name`	string	Patient’s first name
`patient_last_name`	string	Patient’s last name
`patient_dob`	string	Patient’s date of birth
`pickup_location`	object	Pickup address (see Location Object)
`destination_location`	object	Destination address (see Location Object)
`transport_pickup_time`	string	Originally requested pickup time. Use `transport_agreed_for_time` as the authoritative pickup time when it is present.
`transport_agreed_for_time`	string	Confirmed pickup time. When present, this is the authoritative pickup time and may differ from `transport_pickup_time`. `null` until both parties have agreed on the pickup time.
`service_level_type`	string	Service level (ALS, BLS, CCT, etc.)
`service_type`	string	Service type name
`account`	object	Account that created the request
`facility`	object	Origin facility
`user`	object	User who accepted the request
`request_current_state`	string	Internal VectorCare state
`is_round_trip_first_trip`	boolean	Is this the first leg of a round trip?
`is_round_trip_return_trip`	boolean	Is this the return leg?
`collection_id`	string	ID for grouped requests (standing orders, round trips)

Location Object

Field	Type	Description
`id`	string	Location identifier. Nullable
`lat`	number	Latitude. Nullable
`lng`	number	Longitude. Nullable
`zip`	string	ZIP code. Nullable
`city`	string	City. Nullable
`name`	string	Raw address string. Nullable
`state`	string	State. Nullable
`street`	string	Street address. Nullable
`address`	string	Full formatted address. Nullable
`country`	string	Country. Nullable

Account Object

Field	Type	Description
`id`	string	Account ID
`name`	string	Account name
`service_levels`	array	List of configured service levels
`facilities`	array	List of facilities (null if `exclude_facilities=true`). Nullable

Dynamic Fields

The enabled_patient_fields and enabled_request_fields objects contain configurable fields that vary by service. Treat all fields in these objects as nullable.

Error Responses

Request Not Found (403 Forbidden)

{
  "message": "You do not have permission to perform this action.",
  "code": "members:permission_denied"
}

Unauthorized (401)

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