Api referential list
GET /locations
Bearer token & Api key

Sample request:

GET /locations?type=164&offset=0&limit=10

or

GET /locations?type=164,248&offset=0&limit=10

If you want to search for multiple values for a given parameter, enter :

param=val1,val2

For example, the query shown above would return the locations that have a type of either 164 or 248.

Query parameters

  • code string

    Location code.

    Default value is empty.

  • name string

    Location name.

    Default value is empty.

  • type string

    Location type.

    Default value is empty.

  • country string

    Location country.

    Default value is empty.

  • parent string

    Parent location code (eg. Parent of MTDF-Terminal de France is FRLEH-Le Havre).

    Default value is empty.

  • desc boolean

    Boolean that indicates the sort order. If it is set to true, results will be sorted by descending order.

    Default value is false.

  • offset integer(int32)

    Index of the first returned result.

    Default value is 0.

  • limit integer(int32)

    Number of results to be returned. Max value is 10.

    Default value is 10.

Responses

  • 200 application/json

    Successful operation

    Hide response attributes Show response attributes object
    • total integer(int32)

      Total number of items found by the query

    • first integer(int32)

      Index of the first returned object

    • items array[object] | null

      Items returned by the query

      Locations represented ports, airports, warehouse, berth, ... referenced in the S)ONE application.

      Hide items attributes Show items 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.
  • 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
GET /locations 
curl \
 --request GET 'https://soget-api-integration.azure-api.net/api-referential-list/v1/locations' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Ocp-Apim-Subscription-Key: $API_KEY"
Response examples (200) 
{
  "total": 11,
  "first": 3,
  "items": [
    {
      "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."
}