Get a specific Location by its UUID

Request

Security

BearerToken

Path

UUIDstring, (uuid)required

The unique UUID of this Location

curl -i -X GET \
  'https://otm-api-spec.redocly.app/_mock/api/5.9/otm/api/v5/locations/{UUID}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Returned the entity with the provided UUID

Bodyapplication/json

entityTypestring

Value:"location"

Example:"location"

idstring

Uniquely identifies this entity. A URI can be assigned by the client to indicate where more information can be retrieved. Note that every entity always has a unique EntityId. However since, OTM5.2 it is not required to send it in the request. One can be generated for you by the server.

Example:"11c11d75-e114-4b5f-9751-b3a4afa23ecf"

namestring

Name of the entity. For display purposes and search only.

Example:"Main warehouse"

creationDatestring, (date-time)

The creation date of this entity.

lastModifiedstring, (date-time)

The last modified date of this entity. If none is given the creation date is used instead.

contextEventsArray of any(event)

The context events provides some optional information about the events that can provide additional information on the current state of this entity.

For example: your system might send ETA information for the arrival of a vehicle on a location. To make it clear what caused this ETA to be updated, we can include some information about what caused this ETA update by including an event as context. If your ETA update was caused by a location update, this event can be included as context. If the ETA was caused by a traffic accident on the route of the vehicle, you can include that event in the context.

geoReferenceany(geoReference)required

Example:

{
  "lat": 52.1956251,
  "lon": 5.4126792,
  "type": "latLonPointGeoReference"
}

externalAttributesobject

externalIdentifiersArray of objects(externalIdentifiers)

Standardized identifiers of this entity as known in external systems. Use this to exchange repeatable partner or system specific identifiers without overloading externalAttributes.

Example:

[
  {
    "id": "AAA",
    "scheme": "CAS"
  }
]

unCodestring

the United Nations Code for Trade and Transport Locations, is a geographic coding scheme developed and maintained by United Nations Economic Commission for Europe (UNECE) to uniquely identify locations. See this Wikipedia page.

glnstring

The Global Location Number (GLN) is part of the GS1 systems of standards to uniquely identify a location. See also this Wikipedia page

typestring

The type of location.

Enum:"warehouse""store""environmentalZone""restrictedArea""customer""operationalBase""fuelStation""serviceStation""other"

Example:"warehouse"

otherLocationTypestring

Description of the location in case type of location is set to 'other'.

administrativeReferenceobject(address)

Address information that is used as an administrative reference. For example: when the actual load location is different from the officially registered location, this holds the latter

Example:

{
  "name": "Supermarket warehouse",
  "street": "Valutaboulevard",
  "houseNumber": "16",
  "houseNumberAddition": "C",
  "postalCode": "1825BT",
  "city": "Amersfoort",
  "country": "NL"
}

contactDetailsArray of any(contactDetails)

Contact details

Example:

[
  {
    "value": "+312012345678",
    "remark": "private cellphone of the CEO",
    "language": "nld",
    "type": "phone"
  }
]

remarkstring

Remark about the location. Please don't misuse this field for external references, use the externalAttributes field instead.

Example:"The cafe around the corner has the best coffee in town."

subLocationsArray of any

The locations that are can be identified on their own, but are also part of this location. For example a dock at a large distribution area. Sub-locations can also be seen as 'points of interest' on a larger location.

actorsArray of any

Locations can be associated with actors in multiple ways, though the most common one is the owner of the location, either a person or a legal entity.

constraintany

Response

{
  "id": "11c11d75-e114-4b5f-9751-b3a4afa23ecf",
  "name": "Main warehouse",
  "geoReference": {
    "lat": 52.1956251,
    "lon": 5.4126792,
    "type": "latLonPointGeoReference"
  },
  "type": "warehouse",
  "administrativeReference": {
    "name": "Supermarket warehouse",
    "street": "Valutaboulevard",
    "houseNumber": "16",
    "houseNumberAddition": "C",
    "postalCode": "1825BT",
    "city": "Amersfoort",
    "country": "NL"
  },
  "contactDetails": [
    { … }
  ],
  "remark": "The cafe around the corner has the best coffee in town."
}