Get location information.

GET /locations/{code}

Sample request:

GET /locations/FRLEH

Path parameters

code string Required

Location code

Responses

200 application/json

Successful operation
Hide response attributes Show response attributes object
- code string | null
  
  Code of the location
  
  Minimum length is 0, maximum length is 20.
- name string | null
  
  Name of the location
  
  Minimum length is 0, maximum length is 256.
- type integer(int32)
  
  Type of location
- country string | null
  
  Three letter code of country
  
  Minimum length is 0, maximum length is 3.
- parent string | null
  
  Code of the parent location
  eg. Parent of MTDF (Terminal de France) is FRLEH (Le Havre)
  
  Minimum length is 0, maximum length is 20.
- Additional properties are NOT allowed
400 application/json

Unexpected error
Hide response attributes Show response attributes object
- status string | null
  
  Error status
- timestamp string(date-time)
  
  Error date
- code string | null
  
  Error code
  - R101 : The container size type is unfound.
  - R102 : The country code is unfound.
  - R103 : The document type is unfound.
  - R104 : The location code is unfound.
  - R105 : The location type is unfound.
  - R106 : The packaging code is unfound.
  - R107 : The transport mode is unfound.
  - R108 : The transport mean type is unfound.
  - R109 : The event type is unfound.
  - R110 : The UN/LOCODE is unfound.
  - R111 : The actor is unfound.
  - R112 : The dangerous code is unfound.
- message string | null
  
  Error message
- Additional properties are NOT allowed

GET /locations/{code}

curl \
 -X GET https://soget-api-integration.azure-api.net/api-referential-unitary/v1/locations/{code} \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Ocp-Apim-Subscription-Key: $API_KEY"

Response examples (200)

{
  "code": "FRLEH",
  "name": "Le Havre",
  "type": 248,
  "country": "FRA",
  "parent": "FRLEH"
}

Response examples (400)

{
  "status": "400",
  "timestamp": "2022-10-18T14:53:52.239Z",
  "code": "R001",
  "message": "Information not found."
}