Reference data

The company’s own lists. Rides and payments refer to their codes and ids, so read these to show them by name. They change rarely: cache them for an hour.

List services

GET/v1/services

Requires the scope reference:read.

Available from phase 1

The company's services (diensten): the price list a payment's lines come from.

Request

curl "https://api.ambula.nl/v1/services" \
  -H "Authorization: Bearer amb_live_<key>"

Response · 200

{
  "data": [
    {
      "id": "sv_1",
      "code": "OPH",
      "name": "Ophalen dier",
      "price": {
        "value": "45.00",
        "currency": "EUR"
      },
      "vat_rate": "21"
    }
  ],
  "next_cursor": null
}

List outcomes

GET/v1/outcomes

Requires the scope reference:read.

Available from phase 1

The company's outcomes (afhandeling): the codes a closed ride's result refers to.

Request

curl "https://api.ambula.nl/v1/outcomes" \
  -H "Authorization: Bearer amb_live_<key>"

Response · 200

{
  "data": [
    {
      "id": "oc_1",
      "code": "OPV",
      "name": "Naar opvang",
      "order": 1
    }
  ],
  "next_cursor": null
}

List species

GET/v1/species

Requires the scope reference:read.

Available from phase 1

The company's species (diersoorten), each with its own list of breeds or kinds.

Request

curl "https://api.ambula.nl/v1/species" \
  -H "Authorization: Bearer amb_live_<key>"

Response · 200

{
  "data": [
    {
      "id": "sp_1",
      "name": "Hond",
      "choice_label": "Ras",
      "options": [
        {
          "id": "br_1",
          "name": "Labrador"
        }
      ]
    }
  ],
  "next_cursor": null
}

List ride types

GET/v1/ride-types

Requires the scope reference:read.

Available from phase 1

The company's ride types, with their urgency. Codes the company defines are returned as stored.

Request

curl "https://api.ambula.nl/v1/ride-types" \
  -H "Authorization: Bearer amb_live_<key>"

Response · 200

{
  "data": [
    {
      "code": "A1",
      "description": "Spoed",
      "urgency": "red"
    },
    {
      "code": "A2",
      "description": "Normaal",
      "urgency": "green",
      "default": true
    }
  ],
  "next_cursor": null
}

List vehicles

GET/v1/vehicles

Requires the scope reference:read.

Available from phase 1

The company's vehicles (ambulances). Assign one to a ride by its id.

Request

curl "https://api.ambula.nl/v1/vehicles" \
  -H "Authorization: Bearer amb_live_<key>"

Response · 200

{
  "data": [
    {
      "id": "v_amb2",
      "label": "Ambu 2",
      "description": "Bus met brancard"
    }
  ],
  "next_cursor": null
}