[EXPERIMENTAL] Get Home Base by id

Request

Get a single HomeBase.

Security

clientCredentials

Path

idstring^[a-zA-Z0-9.~\-_]{1,512}$required

A unique identifier of an entity instance. Should only contain characters which do not need URL encoding.

Payload

// No request payload

Responses

HomeBase retrieved

Headers

ETagstring

A weak Etag (ex W/"<etag_value>") which contains the current version of the entity

Example:"W/\"25\""

Bodyapplication/json

idstring^[a-zA-Z0-9.~\-_]+$read-only

Unique identifier for this HomeBase.

Example:"HB-GHENT-01"

namestring

Name of the home base

Example:"Ghent - Headquarters"

addressobject(GeoAddress)

Either address information should be present, or otherwise the geo point. The resolved information will be read only and be filled out after resolving.

plan_groupstring

the plan group to which this HomeBase belongs

Example:"cargo planning"

business_idstring^[a-zA-Z0-9.~\-_]+$read-onlydeprecated

Unique identifier for this HomeBase. Deprecated in favor of id.

Example:"HB-GHENT-01"

Response

{
  "business_id": "HB-GHENT-01",
  "id": "HB-GHENT-01",
  "name": "Ghent - Headquarters",
  "address": {
    "address_line": "Voordries 41b",
    "city": "Oosterzele",
    "zip_code": "9860",
    "country_code": "BE",
    "geo_point": { … }
  },
  "plan_group": "cargo planning"
}