Api referential list

Filter dangerous codes.

GET /dangerous-codes/{type}

Sample request:

GET /dangerous-codes?type=IMDG&code=1.2,1.1&offset=0&limit=5

The possible types of dangerous code are :

  • IMDG : International Maritime Dangerous Goods codes.
  • UNDG : United Nations Dangerous Goods codes.

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 dangerous codes that have a code of 1.2 or 1.1.

Path parameters

  • type string Required

    Dangerous code type.

    Values are IMDG or UNDG.

Query parameters

  • code string

    Search characters.

    Default value is empty.

  • description string

    Dangerous code description.

    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

      Dangerous Code which is based on Dangerous Goods List of UNECE

      Dangerous Code which is based on Dangerous Goods List of UNECE

      Hide items attributes Show items attributes object
      • type string

        Values are IMDG or UNDG.

      • code string | null

        Dangerous Code

        Minimum length is 0, maximum length is 11.

      • description string | null

        Description of Dangerous Code

        Minimum length is 0, maximum length is 256.

      • Additional properties are NOT allowed
    • 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 /dangerous-codes/{type} 
curl \
 -X GET https://soget-api-integration.azure-api.net/api-referential-list/v1/dangerous-codes/{type} \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Ocp-Apim-Subscription-Key: $API_KEY"
Response examples (200) 
{
  "total": 11,
  "first": 3,
  "items": [
    {
      "type": "IMDG",
      "code": "1.1",
      "description": "Substances and articles which have a mass explosion hazard"
    }
  ]
}
Response examples (400) 
{
  "status": "400",
  "timestamp": "2022-10-18T14:53:52.239Z",
  "code": "R001",
  "message": "Information not found."
}