State Update
Use this endpoint to report trip progress to VectorCare.
POST
https://api.vectorcare.com/openapi/v1.0/requests/{request_id}/state/
Note: URLs must include the trailing slash.
Request Body
Section titled “Request Body”{ "name": "en_route", "timestamp": "2025-01-15T14:30:00Z"}| Field | Type | Description |
|---|---|---|
name | string | State value (see table below) |
timestamp | string | ISO 8601 UTC timestamp |
Available States
Section titled “Available States”| State Name | Value | Description |
|---|---|---|
| En Route | en_route | En route to pickup location |
| Arrived | arrived | Arrived at pickup location |
| On Board | on_board | Patient on board |
| Arrived at Destination | arrived_at_destination | Arrived at destination |
| Completed | completed | Trip complete |
| Canceled | canceled | Trip canceled |
| Dry Run | dry_run | Trip canceled at pickup |
Responses
Section titled “Responses”Success (201 Created)
Section titled “Success (201 Created)”{ "name": "en_route", "timestamp": "2025-01-15T14:30:00Z"}Invalid State (400)
Section titled “Invalid State (400)”{ "name": [{"message": "\"invalid_state\" is not a valid choice.", "code": "common:choice_invalid"}]}Invalid Timestamp (400)
Section titled “Invalid Timestamp (400)”Timestamp must be within 7 days of current time and not in the future.
Timestamp Rules
Section titled “Timestamp Rules”- ISO 8601 format with UTC timezone
- Cannot be in the future
- Must be within 7 days of current time