Skip to content

Dangerous Goods API

Master data

Dangerous goods and radionuclides, packagings and packing instructions, codes, countries and locations that consignments, products and consolidation refer to

Get the simplified dangerous goods list

Returns the simplified master data list of dangerous goods: identifier, UN number, name, packing group, classification code, labels and the regulatory status of the entry under ADR, IMDG and IATA. When the authenticated user does not hold the ApiUserFullMasterData role, the response is limited to a sample of the catalogue, the entries whose UN number ends in 4. For the complete row of each entry in the dangerous goods list of every regulation, use the detailedDangerousGood resource. The list can be narrowed by UN number, by a text of the name and by class, and paged with page and pageSize; the paging data is returned only when a page is requested.

Authorizations:

basicAuth or bearerAuth
HTTP: basicAuth
HTTP Authorization Scheme: basic
HTTP: bearerAuth

OAuth2 access token obtained from POST /oauth2/token using the client_credentials grant. Send it as Authorization: Bearer <access_token>. The token is opaque: it must not be parsed by the client. It is an alternative transport for the same identity as HTTP Basic, with the same roles and the same licensing, so any operation accepts either scheme.

HTTP Authorization Scheme: bearer

query Parameters

requestGuid
required
string

Identifier of the request, up to 36 characters, used to trace it.

unNumber
string

Optional filter by identification number. Accepts one to four digits, with an optional UN, ID or NA prefix (1203, UN1203, ID8000), and is completed with leading zeros (6 is read as 0006). NA numbers (49 CFR) are not in the catalogue yet, so a filter with the NA prefix returns no entries. When it is omitted, the whole accessible catalogue is returned.

search
string

Optional text searched in the name of the dangerous good, without distinguishing upper and lower case or accents. At most 100 characters.

class
string

Optional filter by class or division, with the code published in the list, such as 3, 4.1 or 6.1. An unknown code is rejected with 400.

page
integer <int32> >= 1

Optional page number, starting at 1. Without page and pageSize the whole list is returned; when only pageSize is sent, the first page is returned.

pageSize
integer <int32> [ 1 .. 200 ]

Optional number of items per page, between 1 and 200. When only page is sent, pages of 50 items are returned.

Responses

200

Successful request

Response Schema: application/json

Array of objects (SimpleDangerousGood)

Simplified master data entries of dangerous goods.

Array [
dangerousGoodId
integer

Identifier of the dangerous good entry in master data.

unNumber
string

Four digits of the identification number, without prefix; use identificationNumber, which states whether it is a UN or an ID number.

identificationNumber
string <= 6 characters ^(UN|NA|ID)[0-9]{4}$

Identification number with its prefix: UN for UN numbers, NA for North American numbers (49 CFR only) and ID for ID 8000. Four digits, without spaces.

name
string

Proper shipping name of the substance.

packingGroup
string

Packing group of the substance.

classificationCode
string

Classification code of the substance.

labels
string

Hazard labels applicable to the substance.

statusIATA
string

IATA regulatory status of the substance.

statusIMDG
string

IMDG regulatory status of the substance.

statusADR
string

ADR regulatory status of the substance.

]
page
integer

Page returned, starting at 1.

pageSize
integer

Number of items per page applied to the search.

total
integer

Total number of items that match the filters, across all pages.

success
boolean

Indicates whether the operation completed successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the operation result.

messageType
string
Enum: "Information" "Warning"

Severity classification of the message.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order, each one with its stable code. A warning does not prevent the operation. Omitted when there is no warning.

Array [
code
required
string
Enum: "ACCOUNT_0001" "ACCOUNT_0002" "ACCOUNT_0003" "ACCOUNT_LICENSE_EXPIRED" "AMBIGUOUS_URL" "AUTHENTICATION_FAILED" "CONSIGNMENT_0001" "CONSIGNMENT_0002" "CONSIGNMENT_0003" "CONSIGNMENT_0004" "CONSIGNMENT_0005" "CONSIGNMENT_0006" "CONSIGNMENT_0007" "CONSIGNMENT_0008" "CONSIGNMENT_0009" "CONSIGNMENT_0010" "CONSIGNMENT_0011" "CONSIGNMENT_0012" "CONSIGNMENT_0013" "CONSIGNMENT_0014" "CONSIGNMENT_0015" "CONSIGNMENT_0016" "CONSIGNMENT_0017" "CONSIGNMENT_0018" "CONSIGNMENT_0019" "CONSIGNMENT_0020" "CONSIGNMENT_0021" "CONSIGNMENT_0022" "CONSIGNMENT_0023" "CONSIGNMENT_0024" "CONSIGNMENT_0025" "CONSIGNMENT_0026" "CONSIGNMENT_0027" "CONSIGNMENT_0028" "CONSIGNMENT_0029" "CONSIGNMENT_0030" "CONSIGNMENT_0031" "CONSIGNMENT_0032" "CONSIGNMENT_0033" "CONSIGNMENT_0034" "CONSIGNMENT_NOTE_0001" "CONSIGNMENT_NOTE_0002" "CONSIGNMENT_NOTE_0003" "CONSIGNMENT_NOTE_0004" "CONSIGNMENT_NOTE_0005" "CONSIGNMENT_NOTE_0006" "CONSIGNMENT_NOTE_0007" "CONSIGNMENT_NOTE_0008" "CONSIGNMENT_NOTE_0009" "CONSIGNMENT_NOTE_0010" "CONSIGNMENT_NOTE_0011" "CONSIGNMENT_NOTE_0012" "CONSIGNMENT_NOTE_0013" "CONSIGNMENT_NOTE_0014" "CONSIGNMENT_NOTE_0015" "CONSIGNMENT_NOTE_0016" "CONSIGNMENT_NOTE_0017" "CONSIGNMENT_NOTE_0018" "CONSIGNMENT_NOTE_0019" "CONSIGNMENT_NOTE_0020" "CONSIGNMENT_NOTE_0021" "CONSIGNMENT_NOTE_0022" "CONSIGNMENT_NOTE_0023" "CONSIGNMENT_NOTE_0024" "CONSIGNMENT_NOTE_0025" "CONSIGNMENT_NOTE_0026" "CONSIGNMENT_NOTE_0027" "CONSIGNMENT_NOTE_0028" "CONSIGNMENT_NOTE_0029" "CONSIGNMENT_NOTE_0030" "CONSIGNMENT_NOTE_0031" "CONSIGNMENT_NOTE_0032" "CONSIGNMENT_NOTE_0033" "CONSIGNMENT_NOTE_0034" "CONSIGNMENT_NOTE_0035" "CONSIGNMENT_NOTE_0036" "CONSIGNMENT_NOTE_0037" "CONSIGNMENT_NOTE_0038" "CONSIGNMENT_NOTE_0039" "CONSIGNMENT_NOTE_0040" "CONSIGNMENT_NOTE_0041" "CONSIGNMENT_NOTE_0042" "CONSIGNMENT_NOTE_0043" "CONSOLIDATION_0001" "CONSOLIDATION_0002" "CONSOLIDATION_0003" "CONSOLIDATION_0004" "CONSOLIDATION_0005" "CONSOLIDATION_0006" "CONSOLIDATION_0007" "CONSOLIDATION_0008" "CONSOLIDATION_0009" "CONSOLIDATION_0010" "CONSOLIDATION_0011" "CONSOLIDATION_0012" "CONSOLIDATION_0013" "CONSOLIDATION_0014" "CONSOLIDATION_0015" "CONSOLIDATION_0016" "CONSOLIDATION_0017" "CONSOLIDATION_0018" "CONSOLIDATION_0019" "CONSOLIDATION_0020" "CONSOLIDATION_0021" "CONSOLIDATION_0022" "CONSOLIDATION_0023" "CONSOLIDATION_0024" "CONSOLIDATION_0025" "CONSOLIDATION_0026" "CONSOLIDATION_0027" "CONSOLIDATION_0028" "CONSOLIDATION_0029" "CONSOLIDATION_0030" "CONSOLIDATION_0031" "CONSOLIDATION_0032" "CONSOLIDATION_0033" "CONSOLIDATION_0034" "CONSOLIDATION_0035" "CONSOLIDATION_0036" "CONSOLIDATION_0037" "CONSOLIDATION_0038" "CONSOLIDATION_0039" "CONSOLIDATION_0040" "CONSOLIDATION_0041" "CONSOLIDATION_0042" "CONSOLIDATION_0043" "CONSOLIDATION_0044" "CONSOLIDATION_0045" "CONSOLIDATION_0046" "CONSOLIDATION_0047" "CONSOLIDATION_0048" "CONSOLIDATION_0049" "CONSOLIDATION_0050" "CONSOLIDATION_0051" "CONSOLIDATION_0052" "CONSOLIDATION_0053" "CONSOLIDATION_0054" "CONSOLIDATION_0055" "CONSOLIDATION_0056" "CONSOLIDATION_0057" "CONSOLIDATION_0058" "CONSOLIDATION_0059" "CONSOLIDATION_0060" "CONSOLIDATION_0061" "CONSOLIDATION_0062" "CONSOLIDATION_0063" "CONSOLIDATION_0064" "CONSOLIDATION_0065" "CONSOLIDATION_0066" "CONSOLIDATION_0067" "CONSOLIDATION_0068" "CONSOLIDATION_0069" "CONSOLIDATION_0070" "CONSOLIDATION_0071" "CONSOLIDATION_0072" "CONSOLIDATION_0073" "CONSOLIDATION_0074" "CONSOLIDATION_0075" "CONSOLIDATION_0076" "CONSOLIDATION_0077" "CONSOLIDATION_0078" "CONSOLIDATION_0079" "CONSOLIDATION_0080" "CONSOLIDATION_0081" "CONSOLIDATION_0082" "CONSOLIDATION_0083" "CONSOLIDATION_0084" "CONSOLIDATION_0085" "CONSOLIDATION_0086" "CONSOLIDATION_0087" "CONSOLIDATION_0088" "CONSOLIDATION_0089" "CONSOLIDATION_0090" "CONSOLIDATION_0091" "CONSOLIDATION_0092" "CONSOLIDATION_0093" "CONSOLIDATION_0094" "CONSOLIDATION_0095" "CONSOLIDATION_0096" "CONSOLIDATION_0097" "CONSOLIDATION_0098" "CONSOLIDATION_0099" "CONSOLIDATION_0100" "CONSOLIDATION_0101" "CONSOLIDATION_0102" "CONSOLIDATION_0103" "CONSOLIDATION_0104" "CONSOLIDATION_0105" "CONSOLIDATION_0106" "CONSOLIDATION_0107" "CONSOLIDATION_0108" "CONSOLIDATION_0109" "CONSOLIDATION_0110" "CONSOLIDATION_0111" "CONSOLIDATION_0112" "CONSOLIDATION_0113" "CONSOLIDATION_0114" "CONSOLIDATION_0115" "CONSOLIDATION_0116" "CONSOLIDATION_0117" "CONSOLIDATION_0118" "CONSOLIDATION_0119" "CONSOLIDATION_0120" "CONSOLIDATION_0121" "CONSOLIDATION_0122" "CONSOLIDATION_0123" "CONSOLIDATION_0124" "CONSOLIDATION_0125" "CONSOLIDATION_0126" "DOCUMENT_0001" "DOCUMENT_0002" "DOCUMENT_0003" "DOCUMENT_0004" "DOCUMENT_0005" "DOCUMENT_0006" "DOCUMENT_0007" "DOCUMENT_0008" "FIELDS_HAVE_INVALID_VALUE" "GOOD_0001" "GOOD_0002" "GOOD_0003" "GOOD_0004" "GOOD_0005" "GOOD_0006" "GOOD_0007" "GOOD_0008" "GOOD_0009" "GOOD_0010" "GOOD_0011" "INVALID_CONTENT_TYPE" "INVALID_DATA" "INVALID_NAME" "INVALID_NUMBER_OF_IDENTIFIERS" "INVALID_REQUEST_GUID" "MORE_THAN_ONE_ITEM_FOUND" "NAME_CAN_NOT_CONTAIN" "NAME_IS_TOO_LONG" "NOT_ALLOWED_TO_PERFORM_OPERATION" "NOT_AUTHENTICATED" "NOT_AVAILABLE_FOR_REGULATION" "NOT_DEFINED_OR_NOT_GRANTED_DATA" "NOT_VALID_VALUE_FOR_PARAMETER" "NO_ONE_ITEM_SELECTED" "NUMBER_OF_ITEMS_EXCEED" "OPERATION_NOT_ACCOMPLISHED" "PACKAGE_0001" "PACKAGE_0002" "PACKAGE_0003" "PACKAGE_0004" "PACKAGE_0005" "PACKAGE_0006" "PACKAGE_0007" "PACKAGE_0008" "PARTICIPANT_0001" "PARTICIPANT_0002" "PARTICIPANT_0003" "PARTICIPANT_0004" "PARTICIPANT_0005" "PARTICIPANT_0006" "PARTICIPANT_0007" "PARTICIPANT_0008" "PARTICIPANT_0009" "PARTICIPANT_0010" "PARTICIPANT_0011" "PARTICIPANT_0012" "PRODUCT_0001" "PRODUCT_0002" "PRODUCT_0003" "PRODUCT_0004" "PRODUCT_0005" "PRODUCT_0006" "PRODUCT_0007" "PRODUCT_0008" "PRODUCT_0009" "PRODUCT_0010" "PRODUCT_0011" "PRODUCT_0012" "PRODUCT_0013" "PRODUCT_0014" "PRODUCT_0015" "PRODUCT_0016" "PRODUCT_0017" "PRODUCT_0018" "PRODUCT_0019" "PRODUCT_0020" "PRODUCT_0021" "PRODUCT_0022" "PRODUCT_0023" "PRODUCT_0024" "PRODUCT_0025" "PRODUCT_0026" "PRODUCT_0027" "PRODUCT_0028" "PRODUCT_0029" "PRODUCT_0030" "PRODUCT_0031" "PRODUCT_0032" "PRODUCT_0033" "PRODUCT_0034" "PRODUCT_0035" "PRODUCT_0036" "PRODUCT_0037" "PRODUCT_0038" "RADIOLOGICAL_0001" "RADIOLOGICAL_0002" "REGULATION_LICENSE_REQUIRED" "REGULATION_NO_ONE_REGULATION" "REQUEST_NOT_AUTHORIZED" "REQUEST_VALUE_NOT_VALID" "REQUIRED_FIELDS_ARE_EMPTY_OR_NOT_VALID" "ROLE_NOT_ALLOWED" "UNEXPECTED_ERROR" "UNSUPPORTED_MEDIA_TYPE" "WASTE_0001" "WASTE_0002" "WEBHOOK_0001" "WEBHOOK_0002" "WEBHOOK_0003" "WEBHOOK_0004"

Stable machine-readable code of the error or the warning. General errors have a descriptive code; the errors and warnings of the rules of each functional area have the name of the area, an underscore and four digits, and message describes the problem. New values may be added; clients must accept unknown values.

message
required
string

Text of the error or the warning, in the language of the user.

parameter
string

Element of the request that the entry refers to, with the JSON names of its path joined by dots and without list positions. Absent when the entry does not refer to an element of the request.

parameterValue
string

Value received for the element that the entry refers to, when it is known.

parameterPosition
string

Position of the element in the innermost list of its path, starting at 0. Absent when the element is not inside a list.

pointer
string

JSON Pointer (RFC 6901) to the element of the request body, with every list position starting at 0. An empty string refers to the whole body. Absent for path, query and header parameters and when the entry does not refer to the body.

ruleReference
string

Paragraph of the regulation or packing instruction on which the finding is based, when the rule has one.

object

Pair of items, required separation and verdict, only for the entries of a segregation check.

leftConsignmentId
required
integer

Identifier of the consignment of the first item.

rightConsignmentId
required
integer

Identifier of the consignment of the second item.

requiredSeparation
required
string
Enum: "NotRequired" "AwayFrom" "SeparatedFrom" "SeparatedByCompleteCompartmentOrHold" "SeparatedLongitudinallyByInterveningCompleteCompartmentOrHold" "MixedLoadingProhibited"

Separation required by the rule.

verdict
required
string
Enum: "Allowed" "AllowedWithConditions" "Forbidden"

Verdict for the pair.

leftConsignmentItemCode
string

Code of the first item in its consignment.

leftEquipmentId
integer

Identifier of the transport equipment of the first item, for the movement scope.

rightConsignmentItemCode
string

Code of the second item in its consignment.

rightEquipmentId
integer

Identifier of the transport equipment of the second item, for the movement scope.

ruleReference
string

Rule applied: IMDG 7.2.4, a segregation code (SG), IMDG 7.4.2.2, ADR 7.5.2.1 or the name of a rule of the account.

remarks
string

Regulatory text, condition or recommended action, such as moving the item to other transport equipment.

]
400

Bad Request

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the validation error.

messageType
string
Enum: "Error" "Warning" "Information"

Severity classification of the message.

parameter
string

Aggregated list of the parameter of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without parameter. Absent when no entry has a parameter.

parameterValue
string

Aggregated list of the parameterValue of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without value. Absent when no entry has a value.

parameterPosition
string

Aggregated list of the parameterPosition of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry outside a list. Positions start at 0. Absent when no entry is inside a list.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every error that made the request fail, in detection order, each one with its stable code and, when it refers to an element of the request, its parameter, value, position and JSON Pointer. Present on every error response, with at least one entry.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order. Omitted when there is no warning.

401

Unauthorized

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the authorization error.

messageType
string
Enum: "Error" "Warning" "Information"

Severity classification of the message.

parameter
string

Aggregated list of the parameter of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without parameter. Absent when no entry has a parameter.

parameterValue
string

Aggregated list of the parameterValue of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without value. Absent when no entry has a value.

parameterPosition
string

Aggregated list of the parameterPosition of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry outside a list. Positions start at 0. Absent when no entry is inside a list.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

The authentication error, with its stable code.

403

Forbidden

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing why the request is forbidden.

messageType
string
Enum: "Error" "Warning" "Information"

Severity classification of the message.

parameter
string

Aggregated list of the parameter of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without parameter. Absent when no entry has a parameter.

parameterValue
string

Aggregated list of the parameterValue of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without value. Absent when no entry has a value.

parameterPosition
string

Aggregated list of the parameterPosition of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry outside a list. Positions start at 0. Absent when no entry is inside a list.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every error that made the request fail, in detection order, each one with its stable code and, when it refers to an element of the request, its parameter, value, position and JSON Pointer. Present on every error response, with at least one entry.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order. Omitted when there is no warning.

500

Unexpected Error

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the unexpected server error.

messageType
string
Value: "Error"

Severity classification of the message.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every error that made the request fail, in detection order, each one with its stable code and, when it refers to an element of the request, its parameter, value, position and JSON Pointer. Present on every error response, with at least one entry.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order. Omitted when there is no warning.

get/masterdata/simpleDangerousGood
https://emea.dgassistant.com/api/v2/rest/masterdata/simpleDangerousGood
https://amer.dgassistant.com/api/v2/rest/masterdata/simpleDangerousGood
https://apac.dgassistant.com/api/v2/rest/masterdata/simpleDangerousGood

Response samples

Content type
application/json
{
  • "simpleDangerousGoods": [
    • {
      • "dangerousGoodId": 588,
      • "unNumber": "1203",
      • "identificationNumber": "UN1203",
      • "name": "MOTOR SPIRIT",
      • "packingGroup": "II",
      • "classificationCode": "F1 (class 3)",
      • "labels": "3",
      • "statusIATA": "Subject",
      • "statusIMDG": "Subject",
      • "statusADR": "Subject"
      }
    ],
  • "page": 1,
  • "pageSize": 50,
  • "total": 137,
  • "success": true,
  • "httpStatusCode": 200,
  • "message": "Operation Completed OK",
  • "messageType": "Information",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 400,
  • "message": "Good not valid",
  • "messageType": "Error",
  • "parameter": "goods",
  • "parameterValue": "GoodX",
  • "parameterPosition": "3",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ],
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 401,
  • "message": "Unauthorized",
  • "messageType": "Error",
  • "parameter": "user",
  • "parameterValue": "Value ABC",
  • "parameterPosition": "3",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 403,
  • "message": "Licensing Regulations Error",
  • "messageType": "Error",
  • "parameter": "Regulation Licenses",
  • "parameterValue": "string",
  • "parameterPosition": "string",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ],
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 500,
  • "message": "Unexpected Error",
  • "messageType": "Error",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ],
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}

Get the detailed dangerous goods list

Returns the detailed dangerous goods list: for each entry of the catalogue, its row in the dangerous goods list of every regulation for which the authenticated user holds the corresponding role: Table A of Chapter 3.2 of ADR, the Dangerous Goods List of Chapter 3.2 of the IMDG Code, and the List of Dangerous Goods of Section 4.2 of the IATA Dangerous Goods Regulations. Each regulation block is included only when the user holds its role (ApiUserDangerousGoodsADR, ApiUserDangerousGoodsIMDG or ApiUserDangerousGoodsIATA). When the user holds none of the four dangerous goods roles, the response is limited to a sample of the catalogue, the entries whose UN number ends in 4, and that sample does carry the three regulation blocks: what the roles grant is the whole catalogue, not the detail. Packing instructions are reported by name only; their details are not included. For the simplified list, with identification and regulatory status only, use the simpleDangerousGood resource. The catalogue is the same one served by simpleDangerousGood and by the application: entries excluded for the road regulation configured for the user are not returned. The four dangerous goods roles only decide which regulation blocks travel; without any of them the response is the sample of UN numbers ending in 4, with the three blocks. Quantities travel separated from their unit: limitedQuantity, exceptedQuantity and transportCategory are objects with the code of the table, the numeric quantity and its measure unit. The response carries an ETag header (weak validator): send it back in If-None-Match and the service answers 304 Not Modified without body while the published content of the catalogue, the application version, the language, the roles and the filters are unchanged, so the client keeps its copy; the same value is returned, without the list, by getDetailedDangerousGoodVersion; the response is private (Cache-Control: private, no-cache) and must be revalidated before reuse. The list can be narrowed by UN number, by a text of the name and by class, and paged with page and pageSize; the paging data is returned only when a page is requested.

Authorizations:

basicAuth or bearerAuth
HTTP: basicAuth
HTTP Authorization Scheme: basic
HTTP: bearerAuth

OAuth2 access token obtained from POST /oauth2/token using the client_credentials grant. Send it as Authorization: Bearer <access_token>. The token is opaque: it must not be parsed by the client. It is an alternative transport for the same identity as HTTP Basic, with the same roles and the same licensing, so any operation accepts either scheme.

HTTP Authorization Scheme: bearer

query Parameters

requestGuid
required
string

Identifier of the request, up to 36 characters, used to trace it.

unNumber
string

Optional filter by identification number. Accepts one to four digits, with an optional UN, ID or NA prefix (1203, UN1203, ID8000), and is completed with leading zeros (6 is read as 0006). NA numbers (49 CFR) are not in the catalogue yet, so a filter with the NA prefix returns no entries. When it is omitted, the whole accessible catalogue is returned.

search
string

Optional text searched in the name of the dangerous good, without distinguishing upper and lower case or accents. At most 100 characters.

class
string

Optional filter by class or division, with the code published in the list, such as 3, 4.1 or 6.1. An unknown code is rejected with 400.

page
integer <int32> >= 1

Optional page number, starting at 1. Without page and pageSize the whole list is returned; when only pageSize is sent, the first page is returned.

pageSize
integer <int32> [ 1 .. 200 ]

Optional number of items per page, between 1 and 200. When only page is sent, pages of 50 items are returned.

Responses

200

Successful request

Response Headers
ETag
string

Weak validator of the response. Send it back in If-None-Match to receive 304 Not Modified while the published content of the catalogue, the application version, the language, the roles and the filters are unchanged.

Response Schema: application/json

Array of objects (DetailedDangerousGood)

Detailed dangerous goods list entries.

Array [
dangerousGoodId
integer

Identifier of the dangerous good entry in master data.

unNumber
string

Four digits of the identification number, without prefix; use identificationNumber, which states whether it is a UN or an ID number.

identificationNumber
string <= 6 characters ^(UN|NA|ID)[0-9]{4}$

Identification number with its prefix: UN for UN numbers, NA for North American numbers (49 CFR only) and ID for ID 8000. Four digits, without spaces.

name
string

Name of the substance or article in the language of the account.

class
string

Class or division of the substance or article.

classificationCode
string

Classification code of the substance or article.

packingGroup
string

Packing group of the substance or article.

labels
Array of strings

Hazard labels applicable to the substance or article.

statusADR
string

ADR regulatory status of the substance or article.

statusIMDG
string

IMDG regulatory status of the substance or article.

statusIATA
string

IATA regulatory status of the substance or article.

statusCFR49
string

49 CFR regulatory status of the substance or article.

object (DetailedDangerousGoodAdrData)

Row of Table A of Chapter 3.2 of ADR. Present only when the user holds the ApiUserDangerousGoodsADR role.

properShippingName
string

Column 2. Proper shipping name under ADR.

specialProvisions
Array of strings

Column 6. Special provisions assigned to this entry in Table A of ADR; only the provisions of this regulation are listed, sorted by number.

object (DetailedDangerousGoodLimitedQuantity)

Limited quantity of the entry (column 7a of Table A of ADR and of the Dangerous Goods List of the IMDG Code): the code as published by the table and, separately, the maximum quantity per inner packaging with its measure unit. For LQ0 maxQuantity is 0 and no unit is reported. When the table gives the unit by physical state (kg for solids, l for liquids) the unit is resolved from the physical state of the entry; when it cannot be deduced, measureUnit carries the dual text of the table.

code
string

Code published by the table.

maxQuantity
number

Maximum quantity per inner packaging.

measureUnit
string

Measure unit of the maximum quantity: l or kg.

object (DetailedDangerousGoodExceptedQuantity)

Excepted quantity of the entry (column 7b of ADR and of the IMDG Code, column F of Table 4.2 of the IATA Dangerous Goods Regulations): the E code and, separately, the maximum quantity per inner packaging and per outer packaging with their measure unit, g for solids and ml for liquids and gases (3.5.1.2). For E0 both quantities are 0 and no unit is reported; when the physical state cannot be deduced, measureUnit is g/ml.

code
string

Code published by the table.

maxInnerQuantity
number

Maximum quantity per inner packaging.

maxOuterQuantity
number

Maximum quantity per outer packaging.

measureUnit
string

Measure unit of both quantities: g or ml.

packingInstructions
Array of strings

Column 8. Packing instructions, by name only.

packingProvisions
Array of strings

Column 9a. Special packing provisions.

mixedPackingProvisions
Array of strings

Column 9b. Mixed packing provisions.

portableTankInstructions
Array of strings

Column 10. Portable tank and bulk container instructions.

portableTankProvisions
Array of strings

Column 11. Portable tank and bulk container special provisions.

tankCodes
Array of strings

Column 12. ADR tank code.

tankProvisions
Array of strings

Column 13. Special provisions for ADR tanks.

vehicleForTankCarriage
string

Column 14. Vehicle for tank carriage.

object (DetailedDangerousGoodTransportCategory)

Transport category of the entry (column 15 of Table A of ADR) and the maximum total quantity per transport unit of ADR 1.1.3.6, separated from its unit: kg NEM for Class 1, l for Class 2, liquids and gases, kg for solids; kg/l when the physical state cannot be deduced. Category 4 has no limit: quantity and unit are omitted.

code
string

Code published by the catalogue.

category
integer

Transport category, from 0 to 4.

maxTotalQuantityPerTransportUnit
number

Maximum total quantity per transport unit.

measureUnit
string

Measure unit of the maximum total quantity.

tunnelRestrictionCode
string

Column 15. Tunnel restriction code.

carriageProvisionsPackages
Array of strings

Column 16. Special provisions for carriage of packages.

carriageProvisionsBulk
Array of strings

Column 17. Special provisions for carriage in bulk.

carriageProvisionsHandling
Array of strings

Column 18. Special provisions for loading and unloading.

carriageProvisionsOperation
Array of strings

Column 19. Special provisions concerning operation.

hazardIdentificationNumber
string

Column 20. Hazard identification number.

object (DetailedDangerousGoodImdgData)

Row of the Dangerous Goods List of Chapter 3.2 of the IMDG Code. Present only when the user holds the ApiUserDangerousGoodsIMDG role.

properShippingName
string

Column 2. Proper shipping name under the IMDG Code.

specialProvisions
Array of strings

Column 6. Special provisions assigned to this entry in the Dangerous Goods List of the IMDG Code; only the provisions of this regulation are listed, sorted by number.

object (DetailedDangerousGoodLimitedQuantity)

Limited quantity of the entry (column 7a of Table A of ADR and of the Dangerous Goods List of the IMDG Code): the code as published by the table and, separately, the maximum quantity per inner packaging with its measure unit. For LQ0 maxQuantity is 0 and no unit is reported. When the table gives the unit by physical state (kg for solids, l for liquids) the unit is resolved from the physical state of the entry; when it cannot be deduced, measureUnit carries the dual text of the table.

object (DetailedDangerousGoodExceptedQuantity)

Excepted quantity of the entry (column 7b of ADR and of the IMDG Code, column F of Table 4.2 of the IATA Dangerous Goods Regulations): the E code and, separately, the maximum quantity per inner packaging and per outer packaging with their measure unit, g for solids and ml for liquids and gases (3.5.1.2). For E0 both quantities are 0 and no unit is reported; when the physical state cannot be deduced, measureUnit is g/ml.

packingInstructions
Array of strings

Column 8. Packing instructions, by name only.

packingProvisions
Array of strings

Column 9. Special packing provisions.

ibcInstructions
Array of strings

Column 10. Instructions for intermediate bulk containers, by name only.

ibcProvisions
Array of strings

Column 11. Special provisions for intermediate bulk containers.

portableTankInstructions
Array of strings

Column 13. Portable tank and bulk container instructions.

portableTankProvisions
Array of strings

Column 14. Portable tank and bulk container special provisions.

isMarinePollutant
boolean

Column 4. Indicates whether the substance is a marine pollutant.

emergencyScheduleFire
string

Column 15. Emergency schedule for fire.

emergencyScheduleSpillage
string

Column 15. Emergency schedule for spillage.

stowageCategory
string

Column 16a. Stowage category.

stowageProvisions
Array of strings

Column 16a. Stowage special provisions.

handlingProvisions
Array of strings

Column 16a. Handling special provisions.

segregationProvisions
Array of strings

Column 16b. Segregation special provisions.

segregationGroups
Array of strings

Column 16b. Segregation groups to which the substance belongs.

object (DetailedDangerousGoodIataData)

Row of Table 4.2 of the IATA Dangerous Goods Regulations. Present only when the user holds the ApiUserDangerousGoodsIATA role.

properShippingName
string

Column B. Proper shipping name under the IATA Dangerous Goods Regulations.

specialProvisions
Array of strings

Column M. Special provisions assigned to this entry in Table 4.2 of the IATA Dangerous Goods Regulations, sorted by number (A1, A2, A20, A130).

object (DetailedDangerousGoodExceptedQuantity)

Excepted quantity of the entry (column 7b of ADR and of the IMDG Code, column F of Table 4.2 of the IATA Dangerous Goods Regulations): the E code and, separately, the maximum quantity per inner packaging and per outer packaging with their measure unit, g for solids and ml for liquids and gases (3.5.1.2). For E0 both quantities are 0 and no unit is reported; when the physical state cannot be deduced, measureUnit is g/ml.

Array of objects (DetailedDangerousGoodIataPackingInstruction)

Columns G and H. Limited quantity packing instructions of the Y series, with their maximum net quantity per package.

Array [
name
string

Name of the packing instruction.

maxQuantity
number

Maximum quantity per package.

measureUnit
string

Measure unit of the maximum quantity.

isGrossWeight
boolean

Indicates whether the maximum quantity is expressed as gross mass.

]
Array of objects (DetailedDangerousGoodIataPackingInstruction)

Columns I and J. Packing instructions for passenger and cargo aircraft, with their maximum net quantity per package.

Array of objects (DetailedDangerousGoodIataPackingInstruction)

Columns K and L. Packing instructions for cargo aircraft only, with their maximum net quantity per package.

emergencyResponseGuideCode
string

Column N. Emergency response guide code.

stateVariations
Array of strings

State variations applicable to the substance or article.

]
page
integer

Page returned, starting at 1.

pageSize
integer

Number of items per page applied to the search.

total
integer

Total number of items that match the filters, across all pages.

success
boolean

Indicates whether the operation completed successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the operation result.

messageType
string
Enum: "Information" "Warning"

Severity classification of the message.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order, each one with its stable code. A warning does not prevent the operation. Omitted when there is no warning.

304

Not Modified: the catalogue has not changed since the ETag sent in If-None-Match. The response has no body and repeats the ETag; the client keeps its copy.

400

Bad Request

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the validation error.

messageType
string
Enum: "Error" "Warning" "Information"

Severity classification of the message.

parameter
string

Aggregated list of the parameter of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without parameter. Absent when no entry has a parameter.

parameterValue
string

Aggregated list of the parameterValue of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without value. Absent when no entry has a value.

parameterPosition
string

Aggregated list of the parameterPosition of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry outside a list. Positions start at 0. Absent when no entry is inside a list.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every error that made the request fail, in detection order, each one with its stable code and, when it refers to an element of the request, its parameter, value, position and JSON Pointer. Present on every error response, with at least one entry.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order. Omitted when there is no warning.

401

Unauthorized

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the authorization error.

messageType
string
Enum: "Error" "Warning" "Information"

Severity classification of the message.

parameter
string

Aggregated list of the parameter of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without parameter. Absent when no entry has a parameter.

parameterValue
string

Aggregated list of the parameterValue of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without value. Absent when no entry has a value.

parameterPosition
string

Aggregated list of the parameterPosition of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry outside a list. Positions start at 0. Absent when no entry is inside a list.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

The authentication error, with its stable code.

403

Forbidden

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing why the request is forbidden.

messageType
string
Enum: "Error" "Warning" "Information"

Severity classification of the message.

parameter
string

Aggregated list of the parameter of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without parameter. Absent when no entry has a parameter.

parameterValue
string

Aggregated list of the parameterValue of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without value. Absent when no entry has a value.

parameterPosition
string

Aggregated list of the parameterPosition of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry outside a list. Positions start at 0. Absent when no entry is inside a list.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every error that made the request fail, in detection order, each one with its stable code and, when it refers to an element of the request, its parameter, value, position and JSON Pointer. Present on every error response, with at least one entry.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order. Omitted when there is no warning.

500

Unexpected Error

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the unexpected server error.

messageType
string
Value: "Error"

Severity classification of the message.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every error that made the request fail, in detection order, each one with its stable code and, when it refers to an element of the request, its parameter, value, position and JSON Pointer. Present on every error response, with at least one entry.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order. Omitted when there is no warning.

get/masterdata/detailedDangerousGood
https://emea.dgassistant.com/api/v2/rest/masterdata/detailedDangerousGood
https://amer.dgassistant.com/api/v2/rest/masterdata/detailedDangerousGood
https://apac.dgassistant.com/api/v2/rest/masterdata/detailedDangerousGood

Response samples

Content type
application/json
{
  • "detailedDangerousGoods": [
    • {
      • "dangerousGoodId": 613,
      • "unNumber": "1219",
      • "identificationNumber": "UN1219",
      • "name": "ISOPROPANOL",
      • "class": "3",
      • "classificationCode": "F1 (class 3)",
      • "packingGroup": "II",
      • "labels": [
        • "3"
        ],
      • "statusADR": "Subject",
      • "statusIMDG": "Subject",
      • "statusIATA": "Subject",
      • "statusCFR49": "Subject",
      • "adrData": {
        • "properShippingName": "ISOPROPANOL",
        • "specialProvisions": [
          • "601"
          ],
        • "limitedQuantity": {
          • "code": "1 l",
          • "maxQuantity": 1,
          • "measureUnit": "l"
          },
        • "exceptedQuantity": {
          • "code": "E2",
          • "maxInnerQuantity": 30,
          • "maxOuterQuantity": 500,
          • "measureUnit": "ml"
          },
        • "packingInstructions": [
          • "P001",
          • "R001"
          ],
        • "packingProvisions": [
          • "PP1"
          ],
        • "mixedPackingProvisions": [
          • "MP19"
          ],
        • "portableTankInstructions": [
          • "T4"
          ],
        • "portableTankProvisions": [
          • "TP1"
          ],
        • "tankCodes": [
          • "LGBF"
          ],
        • "tankProvisions": [
          • "TU1"
          ],
        • "vehicleForTankCarriage": "FL",
        • "transportCategory": {
          • "code": "2-333",
          • "category": 2,
          • "maxTotalQuantityPerTransportUnit": 333,
          • "measureUnit": "l"
          },
        • "tunnelRestrictionCode": "D/E",
        • "carriageProvisionsPackages": [
          • "V1"
          ],
        • "carriageProvisionsBulk": [
          • "VC1"
          ],
        • "carriageProvisionsHandling": [
          • "CV13"
          ],
        • "carriageProvisionsOperation": [
          • "S2",
          • "S20"
          ],
        • "hazardIdentificationNumber": "33"
        },
      • "imdgData": {
        • "properShippingName": "ISOPROPANOL",
        • "specialProvisions": [
          • "601"
          ],
        • "limitedQuantity": {
          • "code": "1 l",
          • "maxQuantity": 1,
          • "measureUnit": "l"
          },
        • "exceptedQuantity": {
          • "code": "E2",
          • "maxInnerQuantity": 30,
          • "maxOuterQuantity": 500,
          • "measureUnit": "ml"
          },
        • "packingInstructions": [
          • "P001",
          • "R001"
          ],
        • "packingProvisions": [
          • "PP1"
          ],
        • "ibcInstructions": [
          • "IBC02"
          ],
        • "ibcProvisions": [
          • "B1"
          ],
        • "portableTankInstructions": [
          • "T4"
          ],
        • "portableTankProvisions": [
          • "TP1"
          ],
        • "isMarinePollutant": true,
        • "emergencyScheduleFire": "F-E",
        • "emergencyScheduleSpillage": "S-D",
        • "stowageCategory": "B",
        • "stowageProvisions": [
          • "SW1"
          ],
        • "handlingProvisions": [
          • "H1"
          ],
        • "segregationProvisions": [
          • "SG35"
          ],
        • "segregationGroups": [
          • "Acids"
          ]
        },
      • "iataData": {
        • "properShippingName": "ISOPROPANOL",
        • "specialProvisions": [
          • "A180"
          ],
        • "exceptedQuantity": {
          • "code": "E2",
          • "maxInnerQuantity": 30,
          • "maxOuterQuantity": 500,
          • "measureUnit": "ml"
          },
        • "limitedQuantityPackingInstructions": [
          • {
            • "name": "Y341",
            • "maxQuantity": 1,
            • "measureUnit": "L",
            • "isGrossWeight": true
            }
          ],
        • "passengerPackingInstructions": [
          • {
            • "name": "Y341",
            • "maxQuantity": 1,
            • "measureUnit": "L",
            • "isGrossWeight": true
            }
          ],
        • "cargoPackingInstructions": [
          • {
            • "name": "Y341",
            • "maxQuantity": 1,
            • "measureUnit": "L",
            • "isGrossWeight": true
            }
          ],
        • "emergencyResponseGuideCode": "3L",
        • "stateVariations": [
          • "AEG-01"
          ]
        }
      }
    ],
  • "page": 1,
  • "pageSize": 50,
  • "total": 137,
  • "success": true,
  • "httpStatusCode": 200,
  • "message": "Operation Completed OK",
  • "messageType": "Information",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 400,
  • "message": "Good not valid",
  • "messageType": "Error",
  • "parameter": "goods",
  • "parameterValue": "GoodX",
  • "parameterPosition": "3",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ],
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 401,
  • "message": "Unauthorized",
  • "messageType": "Error",
  • "parameter": "user",
  • "parameterValue": "Value ABC",
  • "parameterPosition": "3",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 403,
  • "message": "Licensing Regulations Error",
  • "messageType": "Error",
  • "parameter": "Regulation Licenses",
  • "parameterValue": "string",
  • "parameterPosition": "string",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ],
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 500,
  • "message": "Unexpected Error",
  • "messageType": "Error",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ],
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}

Get the version of the detailed dangerous goods list

Returns the version of the detailed dangerous goods list for the given filters, without the list: the same value as the ETag header that getDetailedDangerousGoods returns with the same filters and language. It only changes when the published content of the catalogue, the application version, the language, the roles or the filters change, so a client can compare it with the version of its copy and download the list again only when it differs. The value is also returned in the ETag header. Invalid filters are rejected with 400, as in the list.

Authorizations:

basicAuth or bearerAuth
HTTP: basicAuth
HTTP Authorization Scheme: basic
HTTP: bearerAuth

OAuth2 access token obtained from POST /oauth2/token using the client_credentials grant. Send it as Authorization: Bearer <access_token>. The token is opaque: it must not be parsed by the client. It is an alternative transport for the same identity as HTTP Basic, with the same roles and the same licensing, so any operation accepts either scheme.

HTTP Authorization Scheme: bearer

query Parameters

requestGuid
required
string

Identifier of the request, up to 36 characters, used to trace it.

unNumber
string

Optional filter by identification number. Accepts one to four digits, with an optional UN, ID or NA prefix (1203, UN1203, ID8000), and is completed with leading zeros (6 is read as 0006). NA numbers (49 CFR) are not in the catalogue yet, so a filter with the NA prefix returns no entries. When it is omitted, the whole accessible catalogue is returned.

search
string

Optional text searched in the name of the dangerous good, without distinguishing upper and lower case or accents. At most 100 characters.

class
string

Optional filter by class or division, with the code published in the list, such as 3, 4.1 or 6.1. An unknown code is rejected with 400.

page
integer <int32> >= 1

Optional page number, starting at 1. Without page and pageSize the whole list is returned; when only pageSize is sent, the first page is returned.

pageSize
integer <int32> [ 1 .. 200 ]

Optional number of items per page, between 1 and 200. When only page is sent, pages of 50 items are returned.

Responses

200

Successful request

Response Headers
ETag
string

Version of the catalogue, the same value as catalogueVersion.

Response Schema: application/json

object (DetailedDangerousGoodVersion)

Version of the detailed dangerous goods list.

catalogueVersion
required
string or null

Version of the detailed dangerous goods list for the filters of the request: the same value as the ETag header of getDetailedDangerousGoods with the same filters. It changes when the published content of the list changes.

success
boolean

Indicates whether the operation completed successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the operation result.

messageType
string
Enum: "Information" "Warning"

Severity classification of the message.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order, each one with its stable code. A warning does not prevent the operation. Omitted when there is no warning.

400

Bad Request

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the validation error.

messageType
string
Enum: "Error" "Warning" "Information"

Severity classification of the message.

parameter
string

Aggregated list of the parameter of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without parameter. Absent when no entry has a parameter.

parameterValue
string

Aggregated list of the parameterValue of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without value. Absent when no entry has a value.

parameterPosition
string

Aggregated list of the parameterPosition of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry outside a list. Positions start at 0. Absent when no entry is inside a list.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every error that made the request fail, in detection order, each one with its stable code and, when it refers to an element of the request, its parameter, value, position and JSON Pointer. Present on every error response, with at least one entry.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order. Omitted when there is no warning.

401

Unauthorized

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the authorization error.

messageType
string
Enum: "Error" "Warning" "Information"

Severity classification of the message.

parameter
string

Aggregated list of the parameter of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without parameter. Absent when no entry has a parameter.

parameterValue
string

Aggregated list of the parameterValue of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without value. Absent when no entry has a value.

parameterPosition
string

Aggregated list of the parameterPosition of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry outside a list. Positions start at 0. Absent when no entry is inside a list.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

The authentication error, with its stable code.

403

Forbidden

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing why the request is forbidden.

messageType
string
Enum: "Error" "Warning" "Information"

Severity classification of the message.

parameter
string

Aggregated list of the parameter of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without parameter. Absent when no entry has a parameter.

parameterValue
string

Aggregated list of the parameterValue of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without value. Absent when no entry has a value.

parameterPosition
string

Aggregated list of the parameterPosition of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry outside a list. Positions start at 0. Absent when no entry is inside a list.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every error that made the request fail, in detection order, each one with its stable code and, when it refers to an element of the request, its parameter, value, position and JSON Pointer. Present on every error response, with at least one entry.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order. Omitted when there is no warning.

500

Unexpected Error

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the unexpected server error.

messageType
string
Value: "Error"

Severity classification of the message.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every error that made the request fail, in detection order, each one with its stable code and, when it refers to an element of the request, its parameter, value, position and JSON Pointer. Present on every error response, with at least one entry.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order. Omitted when there is no warning.

get/masterdata/detailedDangerousGood/version
https://emea.dgassistant.com/api/v2/rest/masterdata/detailedDangerousGood/version
https://amer.dgassistant.com/api/v2/rest/masterdata/detailedDangerousGood/version
https://apac.dgassistant.com/api/v2/rest/masterdata/detailedDangerousGood/version

Response samples

Content type
application/json
{
  • "detailedDangerousGoodVersionResponse": {
    • "catalogueVersion": "W/\"ddg-v2026.18.11-3f9a1c07be52-1-30-1-all\""
    },
  • "success": true,
  • "httpStatusCode": 200,
  • "message": "Operation Completed OK",
  • "messageType": "Information",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 400,
  • "message": "Good not valid",
  • "messageType": "Error",
  • "parameter": "goods",
  • "parameterValue": "GoodX",
  • "parameterPosition": "3",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ],
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 401,
  • "message": "Unauthorized",
  • "messageType": "Error",
  • "parameter": "user",
  • "parameterValue": "Value ABC",
  • "parameterPosition": "3",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 403,
  • "message": "Licensing Regulations Error",
  • "messageType": "Error",
  • "parameter": "Regulation Licenses",
  • "parameterValue": "string",
  • "parameterPosition": "string",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ],
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 500,
  • "message": "Unexpected Error",
  • "messageType": "Error",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ],
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}

Get the radionuclides

Returns the master data list of radionuclides available for Class 7 (radioactive material) products and consignments.

Authorizations:

basicAuth or bearerAuth
HTTP: basicAuth
HTTP Authorization Scheme: basic
HTTP: bearerAuth

OAuth2 access token obtained from POST /oauth2/token using the client_credentials grant. Send it as Authorization: Bearer <access_token>. The token is opaque: it must not be parsed by the client. It is an alternative transport for the same identity as HTTP Basic, with the same roles and the same licensing, so any operation accepts either scheme.

HTTP Authorization Scheme: bearer

query Parameters

requestGuid
required
string

Identifier of the request, up to 36 characters, used to trace it.

Responses

200

Successful request

Response Schema: application/json

Array of objects (Radionuclide)

List of radionuclide master data entries.

Array [
radionuclideId
integer

Identifier of the radionuclide.

code
string

Standard code of the radionuclide as referenced in ADR Table 2.2.7.2.2.1.

name
string

Localized name of the radionuclide in the language of the authenticated user.

]
success
boolean

Indicates whether the operation completed successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the operation result.

messageType
string
Enum: "Information" "Warning"

Severity classification of the message.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order, each one with its stable code. A warning does not prevent the operation. Omitted when there is no warning.

401

Unauthorized

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the authorization error.

messageType
string
Enum: "Error" "Warning" "Information"

Severity classification of the message.

parameter
string

Aggregated list of the parameter of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without parameter. Absent when no entry has a parameter.

parameterValue
string

Aggregated list of the parameterValue of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without value. Absent when no entry has a value.

parameterPosition
string

Aggregated list of the parameterPosition of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry outside a list. Positions start at 0. Absent when no entry is inside a list.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

The authentication error, with its stable code.

403

Forbidden

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing why the request is forbidden.

messageType
string
Enum: "Error" "Warning" "Information"

Severity classification of the message.

parameter
string

Aggregated list of the parameter of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without parameter. Absent when no entry has a parameter.

parameterValue
string

Aggregated list of the parameterValue of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without value. Absent when no entry has a value.

parameterPosition
string

Aggregated list of the parameterPosition of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry outside a list. Positions start at 0. Absent when no entry is inside a list.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every error that made the request fail, in detection order, each one with its stable code and, when it refers to an element of the request, its parameter, value, position and JSON Pointer. Present on every error response, with at least one entry.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order. Omitted when there is no warning.

500

Unexpected Error

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the unexpected server error.

messageType
string
Value: "Error"

Severity classification of the message.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every error that made the request fail, in detection order, each one with its stable code and, when it refers to an element of the request, its parameter, value, position and JSON Pointer. Present on every error response, with at least one entry.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order. Omitted when there is no warning.

get/masterdata/radionuclide
https://emea.dgassistant.com/api/v2/rest/masterdata/radionuclide
https://amer.dgassistant.com/api/v2/rest/masterdata/radionuclide
https://apac.dgassistant.com/api/v2/rest/masterdata/radionuclide

Response samples

Content type
application/json
{
  • "radionuclides": [
    • {
      • "radionuclideId": 7,
      • "code": "Co-60",
      • "name": "Cobalt-60"
      }
    ],
  • "success": true,
  • "httpStatusCode": 200,
  • "message": "Operation Completed OK",
  • "messageType": "Information",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 401,
  • "message": "Unauthorized",
  • "messageType": "Error",
  • "parameter": "user",
  • "parameterValue": "Value ABC",
  • "parameterPosition": "3",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 403,
  • "message": "Licensing Regulations Error",
  • "messageType": "Error",
  • "parameter": "Regulation Licenses",
  • "parameterValue": "string",
  • "parameterPosition": "string",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ],
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 500,
  • "message": "Unexpected Error",
  • "messageType": "Error",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ],
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}

Get the types of outer packaging

Returns the master data list of available outer package types.

Authorizations:

basicAuth or bearerAuth
HTTP: basicAuth
HTTP Authorization Scheme: basic
HTTP: bearerAuth

OAuth2 access token obtained from POST /oauth2/token using the client_credentials grant. Send it as Authorization: Bearer <access_token>. The token is opaque: it must not be parsed by the client. It is an alternative transport for the same identity as HTTP Basic, with the same roles and the same licensing, so any operation accepts either scheme.

HTTP Authorization Scheme: bearer

query Parameters

requestGuid
required
string

Identifier of the request, up to 36 characters, used to trace it.

Responses

200

Successful request

Response Schema: application/json

Array of objects (Package)

List of outer package type master data entries.

Array [
packageId
integer

Identifier of the package type.

name
string

Descriptive name of the package type.

]
success
boolean

Indicates whether the operation completed successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the operation result.

messageType
string
Enum: "Information" "Warning"

Severity classification of the message.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order, each one with its stable code. A warning does not prevent the operation. Omitted when there is no warning.

401

Unauthorized

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the authorization error.

messageType
string
Enum: "Error" "Warning" "Information"

Severity classification of the message.

parameter
string

Aggregated list of the parameter of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without parameter. Absent when no entry has a parameter.

parameterValue
string

Aggregated list of the parameterValue of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without value. Absent when no entry has a value.

parameterPosition
string

Aggregated list of the parameterPosition of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry outside a list. Positions start at 0. Absent when no entry is inside a list.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

The authentication error, with its stable code.

403

Forbidden

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing why the request is forbidden.

messageType
string
Enum: "Error" "Warning" "Information"

Severity classification of the message.

parameter
string

Aggregated list of the parameter of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without parameter. Absent when no entry has a parameter.

parameterValue
string

Aggregated list of the parameterValue of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without value. Absent when no entry has a value.

parameterPosition
string

Aggregated list of the parameterPosition of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry outside a list. Positions start at 0. Absent when no entry is inside a list.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every error that made the request fail, in detection order, each one with its stable code and, when it refers to an element of the request, its parameter, value, position and JSON Pointer. Present on every error response, with at least one entry.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order. Omitted when there is no warning.

500

Unexpected Error

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the unexpected server error.

messageType
string
Value: "Error"

Severity classification of the message.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every error that made the request fail, in detection order, each one with its stable code and, when it refers to an element of the request, its parameter, value, position and JSON Pointer. Present on every error response, with at least one entry.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order. Omitted when there is no warning.

get/masterdata/package
https://emea.dgassistant.com/api/v2/rest/masterdata/package
https://amer.dgassistant.com/api/v2/rest/masterdata/package
https://apac.dgassistant.com/api/v2/rest/masterdata/package

Response samples

Content type
application/json
{
  • "packages": [
    • {
      • "packageId": 18,
      • "name": "Box"
      }
    ],
  • "success": true,
  • "httpStatusCode": 200,
  • "message": "Operation Completed OK",
  • "messageType": "Information",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 401,
  • "message": "Unauthorized",
  • "messageType": "Error",
  • "parameter": "user",
  • "parameterValue": "Value ABC",
  • "parameterPosition": "3",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 403,
  • "message": "Licensing Regulations Error",
  • "messageType": "Error",
  • "parameter": "Regulation Licenses",
  • "parameterValue": "string",
  • "parameterPosition": "string",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ],
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 500,
  • "message": "Unexpected Error",
  • "messageType": "Error",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ],
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}

Get the UN homologation codes of outer packagings

Returns the master data list of UN homologation codes for outer packages.

Authorizations:

basicAuth or bearerAuth
HTTP: basicAuth
HTTP Authorization Scheme: basic
HTTP: bearerAuth

OAuth2 access token obtained from POST /oauth2/token using the client_credentials grant. Send it as Authorization: Bearer <access_token>. The token is opaque: it must not be parsed by the client. It is an alternative transport for the same identity as HTTP Basic, with the same roles and the same licensing, so any operation accepts either scheme.

HTTP Authorization Scheme: bearer

query Parameters

requestGuid
required
string

Identifier of the request, up to 36 characters, used to trace it.

Responses

200

Successful request

Response Schema: application/json

Array of objects (PackageHomologation)

List of package UN homologation master data entries.

Array [
packageHomologationId
integer

Identifier of the package homologation entry.

name
string

Descriptive name of the homologated package.

code
string

UN homologation code of the package.

packageId
integer

Identifier of the related package type.

]
success
boolean

Indicates whether the operation completed successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the operation result.

messageType
string
Enum: "Information" "Warning"

Severity classification of the message.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order, each one with its stable code. A warning does not prevent the operation. Omitted when there is no warning.

401

Unauthorized

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the authorization error.

messageType
string
Enum: "Error" "Warning" "Information"

Severity classification of the message.

parameter
string

Aggregated list of the parameter of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without parameter. Absent when no entry has a parameter.

parameterValue
string

Aggregated list of the parameterValue of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without value. Absent when no entry has a value.

parameterPosition
string

Aggregated list of the parameterPosition of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry outside a list. Positions start at 0. Absent when no entry is inside a list.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

The authentication error, with its stable code.

403

Forbidden

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing why the request is forbidden.

messageType
string
Enum: "Error" "Warning" "Information"

Severity classification of the message.

parameter
string

Aggregated list of the parameter of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without parameter. Absent when no entry has a parameter.

parameterValue
string

Aggregated list of the parameterValue of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without value. Absent when no entry has a value.

parameterPosition
string

Aggregated list of the parameterPosition of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry outside a list. Positions start at 0. Absent when no entry is inside a list.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every error that made the request fail, in detection order, each one with its stable code and, when it refers to an element of the request, its parameter, value, position and JSON Pointer. Present on every error response, with at least one entry.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order. Omitted when there is no warning.

500

Unexpected Error

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the unexpected server error.

messageType
string
Value: "Error"

Severity classification of the message.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every error that made the request fail, in detection order, each one with its stable code and, when it refers to an element of the request, its parameter, value, position and JSON Pointer. Present on every error response, with at least one entry.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order. Omitted when there is no warning.

get/masterdata/packageHomologation
https://emea.dgassistant.com/api/v2/rest/masterdata/packageHomologation
https://amer.dgassistant.com/api/v2/rest/masterdata/packageHomologation
https://apac.dgassistant.com/api/v2/rest/masterdata/packageHomologation

Response samples

Content type
application/json
{
  • "packageHomologations": [
    • {
      • "packageHomologationId": 116,
      • "name": "Fibreboard box",
      • "code": "4G",
      • "packageId": 5
      }
    ],
  • "success": true,
  • "httpStatusCode": 200,
  • "message": "Operation Completed OK",
  • "messageType": "Information",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 401,
  • "message": "Unauthorized",
  • "messageType": "Error",
  • "parameter": "user",
  • "parameterValue": "Value ABC",
  • "parameterPosition": "3",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 403,
  • "message": "Licensing Regulations Error",
  • "messageType": "Error",
  • "parameter": "Regulation Licenses",
  • "parameterValue": "string",
  • "parameterPosition": "string",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ],
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 500,
  • "message": "Unexpected Error",
  • "messageType": "Error",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ],
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}

Get the materials of inner packagings

Returns the master data list of materials available for inner packages.

Authorizations:

basicAuth or bearerAuth
HTTP: basicAuth
HTTP Authorization Scheme: basic
HTTP: bearerAuth

OAuth2 access token obtained from POST /oauth2/token using the client_credentials grant. Send it as Authorization: Bearer <access_token>. The token is opaque: it must not be parsed by the client. It is an alternative transport for the same identity as HTTP Basic, with the same roles and the same licensing, so any operation accepts either scheme.

HTTP Authorization Scheme: bearer

query Parameters

requestGuid
required
string

Identifier of the request, up to 36 characters, used to trace it.

Responses

200

Successful request

Response Schema: application/json

Array of objects (InnerPackageMaterial)

List of inner package material master data entries.

Array [
innerPackageMaterialId
integer

Identifier of the inner package material.

name
string

Descriptive name of the inner package material.

]
success
boolean

Indicates whether the operation completed successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the operation result.

messageType
string
Enum: "Information" "Warning"

Severity classification of the message.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order, each one with its stable code. A warning does not prevent the operation. Omitted when there is no warning.

401

Unauthorized

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the authorization error.

messageType
string
Enum: "Error" "Warning" "Information"

Severity classification of the message.

parameter
string

Aggregated list of the parameter of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without parameter. Absent when no entry has a parameter.

parameterValue
string

Aggregated list of the parameterValue of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without value. Absent when no entry has a value.

parameterPosition
string

Aggregated list of the parameterPosition of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry outside a list. Positions start at 0. Absent when no entry is inside a list.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

The authentication error, with its stable code.

403

Forbidden

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing why the request is forbidden.

messageType
string
Enum: "Error" "Warning" "Information"

Severity classification of the message.

parameter
string

Aggregated list of the parameter of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without parameter. Absent when no entry has a parameter.

parameterValue
string

Aggregated list of the parameterValue of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without value. Absent when no entry has a value.

parameterPosition
string

Aggregated list of the parameterPosition of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry outside a list. Positions start at 0. Absent when no entry is inside a list.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every error that made the request fail, in detection order, each one with its stable code and, when it refers to an element of the request, its parameter, value, position and JSON Pointer. Present on every error response, with at least one entry.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order. Omitted when there is no warning.

500

Unexpected Error

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the unexpected server error.

messageType
string
Value: "Error"

Severity classification of the message.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every error that made the request fail, in detection order, each one with its stable code and, when it refers to an element of the request, its parameter, value, position and JSON Pointer. Present on every error response, with at least one entry.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order. Omitted when there is no warning.

get/masterdata/innerPackageMaterial
https://emea.dgassistant.com/api/v2/rest/masterdata/innerPackageMaterial
https://amer.dgassistant.com/api/v2/rest/masterdata/innerPackageMaterial
https://apac.dgassistant.com/api/v2/rest/masterdata/innerPackageMaterial

Response samples

Content type
application/json
{
  • "innerPackageMaterials": [
    • {
      • "innerPackageMaterialId": 3,
      • "name": "Plastic"
      }
    ],
  • "success": true,
  • "httpStatusCode": 200,
  • "message": "Operation Completed OK",
  • "messageType": "Information",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 401,
  • "message": "Unauthorized",
  • "messageType": "Error",
  • "parameter": "user",
  • "parameterValue": "Value ABC",
  • "parameterPosition": "3",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 403,
  • "message": "Licensing Regulations Error",
  • "messageType": "Error",
  • "parameter": "Regulation Licenses",
  • "parameterValue": "string",
  • "parameterPosition": "string",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ],
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 500,
  • "message": "Unexpected Error",
  • "messageType": "Error",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ],
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}

Get the IATA packing instructions

Returns the master data list of IATA packing instructions.

Authorizations:

basicAuth or bearerAuth
HTTP: basicAuth
HTTP Authorization Scheme: basic
HTTP: bearerAuth

OAuth2 access token obtained from POST /oauth2/token using the client_credentials grant. Send it as Authorization: Bearer <access_token>. The token is opaque: it must not be parsed by the client. It is an alternative transport for the same identity as HTTP Basic, with the same roles and the same licensing, so any operation accepts either scheme.

HTTP Authorization Scheme: bearer

query Parameters

requestGuid
required
string

Identifier of the request, up to 36 characters, used to trace it.

Responses

200

Successful request

Response Schema: application/json

Array of objects (PackingInstruction)

List of IATA packing instruction master data entries.

Array [
packingInstructionId
integer

Identifier of the packing instruction.

name
string

Code of the packing instruction.

]
success
boolean

Indicates whether the operation completed successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the operation result.

messageType
string
Enum: "Information" "Warning"

Severity classification of the message.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order, each one with its stable code. A warning does not prevent the operation. Omitted when there is no warning.

401

Unauthorized

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the authorization error.

messageType
string
Enum: "Error" "Warning" "Information"

Severity classification of the message.

parameter
string

Aggregated list of the parameter of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without parameter. Absent when no entry has a parameter.

parameterValue
string

Aggregated list of the parameterValue of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without value. Absent when no entry has a value.

parameterPosition
string

Aggregated list of the parameterPosition of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry outside a list. Positions start at 0. Absent when no entry is inside a list.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

The authentication error, with its stable code.

403

Forbidden

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing why the request is forbidden.

messageType
string
Enum: "Error" "Warning" "Information"

Severity classification of the message.

parameter
string

Aggregated list of the parameter of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without parameter. Absent when no entry has a parameter.

parameterValue
string

Aggregated list of the parameterValue of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without value. Absent when no entry has a value.

parameterPosition
string

Aggregated list of the parameterPosition of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry outside a list. Positions start at 0. Absent when no entry is inside a list.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every error that made the request fail, in detection order, each one with its stable code and, when it refers to an element of the request, its parameter, value, position and JSON Pointer. Present on every error response, with at least one entry.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order. Omitted when there is no warning.

500

Unexpected Error

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the unexpected server error.

messageType
string
Value: "Error"

Severity classification of the message.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every error that made the request fail, in detection order, each one with its stable code and, when it refers to an element of the request, its parameter, value, position and JSON Pointer. Present on every error response, with at least one entry.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order. Omitted when there is no warning.

get/masterdata/packingInstruction
https://emea.dgassistant.com/api/v2/rest/masterdata/packingInstruction
https://amer.dgassistant.com/api/v2/rest/masterdata/packingInstruction
https://apac.dgassistant.com/api/v2/rest/masterdata/packingInstruction

Response samples

Content type
application/json
{
  • "packingInstructions": [
    • {
      • "packingInstructionId": 1024,
      • "name": "962"
      }
    ],
  • "success": true,
  • "httpStatusCode": 200,
  • "message": "Operation Completed OK",
  • "messageType": "Information",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 401,
  • "message": "Unauthorized",
  • "messageType": "Error",
  • "parameter": "user",
  • "parameterValue": "Value ABC",
  • "parameterPosition": "3",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 403,
  • "message": "Licensing Regulations Error",
  • "messageType": "Error",
  • "parameter": "Regulation Licenses",
  • "parameterValue": "string",
  • "parameterPosition": "string",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ],
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 500,
  • "message": "Unexpected Error",
  • "messageType": "Error",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ],
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}

Get the IMDG segregation groups

Returns the master data list of IMDG segregation groups.

Authorizations:

basicAuth or bearerAuth
HTTP: basicAuth
HTTP Authorization Scheme: basic
HTTP: bearerAuth

OAuth2 access token obtained from POST /oauth2/token using the client_credentials grant. Send it as Authorization: Bearer <access_token>. The token is opaque: it must not be parsed by the client. It is an alternative transport for the same identity as HTTP Basic, with the same roles and the same licensing, so any operation accepts either scheme.

HTTP Authorization Scheme: bearer

query Parameters

requestGuid
required
string

Identifier of the request, up to 36 characters, used to trace it.

Responses

200

Successful request

Response Schema: application/json

Array of objects (ImdgSegregationGroup)

List of IMDG segregation group master data entries.

Array [
imdgSegregationGroupId
integer

Identifier of the IMDG segregation group.

name
string

Descriptive name of the IMDG segregation group.

]
success
boolean

Indicates whether the operation completed successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the operation result.

messageType
string
Enum: "Information" "Warning"

Severity classification of the message.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order, each one with its stable code. A warning does not prevent the operation. Omitted when there is no warning.

401

Unauthorized

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the authorization error.

messageType
string
Enum: "Error" "Warning" "Information"

Severity classification of the message.

parameter
string

Aggregated list of the parameter of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without parameter. Absent when no entry has a parameter.

parameterValue
string

Aggregated list of the parameterValue of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without value. Absent when no entry has a value.

parameterPosition
string

Aggregated list of the parameterPosition of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry outside a list. Positions start at 0. Absent when no entry is inside a list.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

The authentication error, with its stable code.

403

Forbidden

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing why the request is forbidden.

messageType
string
Enum: "Error" "Warning" "Information"

Severity classification of the message.

parameter
string

Aggregated list of the parameter of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without parameter. Absent when no entry has a parameter.

parameterValue
string

Aggregated list of the parameterValue of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without value. Absent when no entry has a value.

parameterPosition
string

Aggregated list of the parameterPosition of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry outside a list. Positions start at 0. Absent when no entry is inside a list.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every error that made the request fail, in detection order, each one with its stable code and, when it refers to an element of the request, its parameter, value, position and JSON Pointer. Present on every error response, with at least one entry.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order. Omitted when there is no warning.

500

Unexpected Error

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the unexpected server error.

messageType
string
Value: "Error"

Severity classification of the message.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every error that made the request fail, in detection order, each one with its stable code and, when it refers to an element of the request, its parameter, value, position and JSON Pointer. Present on every error response, with at least one entry.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order. Omitted when there is no warning.

get/masterdata/imdgSegregationGroup
https://emea.dgassistant.com/api/v2/rest/masterdata/imdgSegregationGroup
https://amer.dgassistant.com/api/v2/rest/masterdata/imdgSegregationGroup
https://apac.dgassistant.com/api/v2/rest/masterdata/imdgSegregationGroup

Response samples

Content type
application/json
{
  • "imdgSegregationGroups": [
    • {
      • "imdgSegregationGroupId": 1,
      • "name": "Acids"
      }
    ],
  • "success": true,
  • "httpStatusCode": 200,
  • "message": "Operation Completed OK",
  • "messageType": "Information",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 401,
  • "message": "Unauthorized",
  • "messageType": "Error",
  • "parameter": "user",
  • "parameterValue": "Value ABC",
  • "parameterPosition": "3",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 403,
  • "message": "Licensing Regulations Error",
  • "messageType": "Error",
  • "parameter": "Regulation Licenses",
  • "parameterValue": "string",
  • "parameterPosition": "string",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ],
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 500,
  • "message": "Unexpected Error",
  • "messageType": "Error",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ],
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}

Get the IMDG stowage categories

Returns the stowage categories of the IMDG Code: A to E for packaged goods and 01 to 05 for goods of class 1. Each entry gives its regulation; a regulation other than Imdg is rejected with 400.

Authorizations:

basicAuth or bearerAuth
HTTP: basicAuth
HTTP Authorization Scheme: basic
HTTP: bearerAuth

OAuth2 access token obtained from POST /oauth2/token using the client_credentials grant. Send it as Authorization: Bearer <access_token>. The token is opaque: it must not be parsed by the client. It is an alternative transport for the same identity as HTTP Basic, with the same roles and the same licensing, so any operation accepts either scheme.

HTTP Authorization Scheme: bearer

query Parameters

requestGuid
required
string

Identifier of the request, up to 36 characters, used to trace it.

regulation
string (DangerousGoodsRegulation)
Enum: "Adr" "Imdg" "Iata" "Cfr49"

Regulation of the stowage data. Optional; Imdg when omitted, the only regulation with these data today. Any other value is rejected with 400.

Responses

200

Successful request

Response Schema: application/json

Array of objects (StowageCategory)

IMDG stowage categories.

Array [
regulation
required
string
Enum: "Adr" "Imdg" "Iata" "Cfr49"

Regulation of the category: Imdg, the only one with stowage categories.

code
string

Stowage category: A to E for packaged goods and 01 to 05 for goods of class 1.

name
string

Meaning of the category (IMDG 7.1.3).

]
success
boolean

Indicates whether the operation completed successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the operation result.

messageType
string
Enum: "Information" "Warning"

Severity classification of the message.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order, each one with its stable code. A warning does not prevent the operation. Omitted when there is no warning.

400

Bad Request

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the validation error.

messageType
string
Enum: "Error" "Warning" "Information"

Severity classification of the message.

parameter
string

Aggregated list of the parameter of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without parameter. Absent when no entry has a parameter.

parameterValue
string

Aggregated list of the parameterValue of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without value. Absent when no entry has a value.

parameterPosition
string

Aggregated list of the parameterPosition of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry outside a list. Positions start at 0. Absent when no entry is inside a list.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every error that made the request fail, in detection order, each one with its stable code and, when it refers to an element of the request, its parameter, value, position and JSON Pointer. Present on every error response, with at least one entry.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order. Omitted when there is no warning.

401

Unauthorized

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the authorization error.

messageType
string
Enum: "Error" "Warning" "Information"

Severity classification of the message.

parameter
string

Aggregated list of the parameter of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without parameter. Absent when no entry has a parameter.

parameterValue
string

Aggregated list of the parameterValue of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without value. Absent when no entry has a value.

parameterPosition
string

Aggregated list of the parameterPosition of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry outside a list. Positions start at 0. Absent when no entry is inside a list.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

The authentication error, with its stable code.

403

Forbidden

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing why the request is forbidden.

messageType
string
Enum: "Error" "Warning" "Information"

Severity classification of the message.

parameter
string

Aggregated list of the parameter of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without parameter. Absent when no entry has a parameter.

parameterValue
string

Aggregated list of the parameterValue of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without value. Absent when no entry has a value.

parameterPosition
string

Aggregated list of the parameterPosition of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry outside a list. Positions start at 0. Absent when no entry is inside a list.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every error that made the request fail, in detection order, each one with its stable code and, when it refers to an element of the request, its parameter, value, position and JSON Pointer. Present on every error response, with at least one entry.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order. Omitted when there is no warning.

500

Unexpected Error

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the unexpected server error.

messageType
string
Value: "Error"

Severity classification of the message.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every error that made the request fail, in detection order, each one with its stable code and, when it refers to an element of the request, its parameter, value, position and JSON Pointer. Present on every error response, with at least one entry.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order. Omitted when there is no warning.

get/masterdata/stowageCategory
https://emea.dgassistant.com/api/v2/rest/masterdata/stowageCategory
https://amer.dgassistant.com/api/v2/rest/masterdata/stowageCategory
https://apac.dgassistant.com/api/v2/rest/masterdata/stowageCategory

Response samples

Content type
application/json
{
  • "stowageCategories": [
    • {
      • "regulation": "Adr",
      • "code": "A",
      • "name": "On deck or under deck"
      }
    ],
  • "success": true,
  • "httpStatusCode": 200,
  • "message": "Operation Completed OK",
  • "messageType": "Information",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 400,
  • "message": "Good not valid",
  • "messageType": "Error",
  • "parameter": "goods",
  • "parameterValue": "GoodX",
  • "parameterPosition": "3",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ],
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 401,
  • "message": "Unauthorized",
  • "messageType": "Error",
  • "parameter": "user",
  • "parameterValue": "Value ABC",
  • "parameterPosition": "3",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 403,
  • "message": "Licensing Regulations Error",
  • "messageType": "Error",
  • "parameter": "Regulation Licenses",
  • "parameterValue": "string",
  • "parameterPosition": "string",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ],
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 500,
  • "message": "Unexpected Error",
  • "messageType": "Error",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ],
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}

Get the IMDG stowage, handling and segregation codes

Returns the stowage (SW), handling (H) and segregation (SG) codes of the IMDG Code, with their texts in the language of the API user, or in English when no translation exists. Each entry gives its regulation; a regulation other than Imdg is rejected with 400.

Authorizations:

basicAuth or bearerAuth
HTTP: basicAuth
HTTP Authorization Scheme: basic
HTTP: bearerAuth

OAuth2 access token obtained from POST /oauth2/token using the client_credentials grant. Send it as Authorization: Bearer <access_token>. The token is opaque: it must not be parsed by the client. It is an alternative transport for the same identity as HTTP Basic, with the same roles and the same licensing, so any operation accepts either scheme.

HTTP Authorization Scheme: bearer

query Parameters

requestGuid
required
string

Identifier of the request, up to 36 characters, used to trace it.

regulation
string (DangerousGoodsRegulation)
Enum: "Adr" "Imdg" "Iata" "Cfr49"

Regulation of the stowage data. Optional; Imdg when omitted, the only regulation with these data today. Any other value is rejected with 400.

Responses

200

Successful request

Response Schema: application/json

Array of objects (StowageCode)

IMDG stowage, handling and segregation codes.

Array [
regulation
required
string
Enum: "Adr" "Imdg" "Iata" "Cfr49"

Regulation of the code: Imdg, the only one with these codes.

code
string

Stowage (SW), handling (H) or segregation (SG) code.

stowageCodeType
string
Enum: "Stowage" "Handling" "Segregation"

Kind of code: stowage, handling or segregation.

name
string

Text of the code in the language of the API user, or in English when no translation exists.

]
success
boolean

Indicates whether the operation completed successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the operation result.

messageType
string
Enum: "Information" "Warning"

Severity classification of the message.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order, each one with its stable code. A warning does not prevent the operation. Omitted when there is no warning.

400

Bad Request

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the validation error.

messageType
string
Enum: "Error" "Warning" "Information"

Severity classification of the message.

parameter
string

Aggregated list of the parameter of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without parameter. Absent when no entry has a parameter.

parameterValue
string

Aggregated list of the parameterValue of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without value. Absent when no entry has a value.

parameterPosition
string

Aggregated list of the parameterPosition of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry outside a list. Positions start at 0. Absent when no entry is inside a list.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every error that made the request fail, in detection order, each one with its stable code and, when it refers to an element of the request, its parameter, value, position and JSON Pointer. Present on every error response, with at least one entry.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order. Omitted when there is no warning.

401

Unauthorized

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the authorization error.

messageType
string
Enum: "Error" "Warning" "Information"

Severity classification of the message.

parameter
string

Aggregated list of the parameter of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without parameter. Absent when no entry has a parameter.

parameterValue
string

Aggregated list of the parameterValue of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without value. Absent when no entry has a value.

parameterPosition
string

Aggregated list of the parameterPosition of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry outside a list. Positions start at 0. Absent when no entry is inside a list.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

The authentication error, with its stable code.

403

Forbidden

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing why the request is forbidden.

messageType
string
Enum: "Error" "Warning" "Information"

Severity classification of the message.

parameter
string

Aggregated list of the parameter of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without parameter. Absent when no entry has a parameter.

parameterValue
string

Aggregated list of the parameterValue of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without value. Absent when no entry has a value.

parameterPosition
string

Aggregated list of the parameterPosition of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry outside a list. Positions start at 0. Absent when no entry is inside a list.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every error that made the request fail, in detection order, each one with its stable code and, when it refers to an element of the request, its parameter, value, position and JSON Pointer. Present on every error response, with at least one entry.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order. Omitted when there is no warning.

500

Unexpected Error

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the unexpected server error.

messageType
string
Value: "Error"

Severity classification of the message.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every error that made the request fail, in detection order, each one with its stable code and, when it refers to an element of the request, its parameter, value, position and JSON Pointer. Present on every error response, with at least one entry.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order. Omitted when there is no warning.

get/masterdata/stowageCode
https://emea.dgassistant.com/api/v2/rest/masterdata/stowageCode
https://amer.dgassistant.com/api/v2/rest/masterdata/stowageCode
https://apac.dgassistant.com/api/v2/rest/masterdata/stowageCode

Response samples

Content type
application/json
{
  • "stowageCodes": [
    • {
      • "regulation": "Adr",
      • "code": "SW1",
      • "stowageCodeType": "Stowage",
      • "name": "Protected from sources of heat."
      }
    ],
  • "success": true,
  • "httpStatusCode": 200,
  • "message": "Operation Completed OK",
  • "messageType": "Information",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 400,
  • "message": "Good not valid",
  • "messageType": "Error",
  • "parameter": "goods",
  • "parameterValue": "GoodX",
  • "parameterPosition": "3",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ],
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 401,
  • "message": "Unauthorized",
  • "messageType": "Error",
  • "parameter": "user",
  • "parameterValue": "Value ABC",
  • "parameterPosition": "3",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 403,
  • "message": "Licensing Regulations Error",
  • "messageType": "Error",
  • "parameter": "Regulation Licenses",
  • "parameterValue": "string",
  • "parameterPosition": "string",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ],
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 500,
  • "message": "Unexpected Error",
  • "messageType": "Error",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ],
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}

Get the ISO 6346 container size and type codes

Returns the ISO 6346 container size and type codes, common to every account.

Authorizations:

basicAuth or bearerAuth
HTTP: basicAuth
HTTP Authorization Scheme: basic
HTTP: bearerAuth

OAuth2 access token obtained from POST /oauth2/token using the client_credentials grant. Send it as Authorization: Bearer <access_token>. The token is opaque: it must not be parsed by the client. It is an alternative transport for the same identity as HTTP Basic, with the same roles and the same licensing, so any operation accepts either scheme.

HTTP Authorization Scheme: bearer

query Parameters

requestGuid
required
string

Identifier of the request, up to 36 characters, used to trace it.

Responses

200

Successful request

Response Schema: application/json

Array of objects (IsoContainerType)

ISO 6346 container size and type codes.

Array [
nominalLength
required
integer

Nominal length in feet: 20, 40 or 45.

isTank
required
boolean

True when the code designates a tank container.

isReefer
required
boolean

True when the code designates a refrigerated container.

isOpen
required
boolean

True when the container is open (open top, flat rack or platform) rather than closed, which matters for the segregation between containers of IMDG 7.4.2.

code
string <= 4 characters

ISO 6346 size and type code.

name
string

Description of the size and type code.

typeGroup
string

Type group of the code: GP general purpose, HC high cube, RF reefer, TK tank, OT open top, FR flat rack, PF platform or BU bulk.

]
success
boolean

Indicates whether the operation completed successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the operation result.

messageType
string
Enum: "Information" "Warning"

Severity classification of the message.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order, each one with its stable code. A warning does not prevent the operation. Omitted when there is no warning.

401

Unauthorized

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the authorization error.

messageType
string
Enum: "Error" "Warning" "Information"

Severity classification of the message.

parameter
string

Aggregated list of the parameter of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without parameter. Absent when no entry has a parameter.

parameterValue
string

Aggregated list of the parameterValue of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without value. Absent when no entry has a value.

parameterPosition
string

Aggregated list of the parameterPosition of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry outside a list. Positions start at 0. Absent when no entry is inside a list.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

The authentication error, with its stable code.

403

Forbidden

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing why the request is forbidden.

messageType
string
Enum: "Error" "Warning" "Information"

Severity classification of the message.

parameter
string

Aggregated list of the parameter of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without parameter. Absent when no entry has a parameter.

parameterValue
string

Aggregated list of the parameterValue of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without value. Absent when no entry has a value.

parameterPosition
string

Aggregated list of the parameterPosition of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry outside a list. Positions start at 0. Absent when no entry is inside a list.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every error that made the request fail, in detection order, each one with its stable code and, when it refers to an element of the request, its parameter, value, position and JSON Pointer. Present on every error response, with at least one entry.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order. Omitted when there is no warning.

500

Unexpected Error

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the unexpected server error.

messageType
string
Value: "Error"

Severity classification of the message.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every error that made the request fail, in detection order, each one with its stable code and, when it refers to an element of the request, its parameter, value, position and JSON Pointer. Present on every error response, with at least one entry.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order. Omitted when there is no warning.

get/masterdata/isoContainerType
https://emea.dgassistant.com/api/v2/rest/masterdata/isoContainerType
https://amer.dgassistant.com/api/v2/rest/masterdata/isoContainerType
https://apac.dgassistant.com/api/v2/rest/masterdata/isoContainerType

Response samples

Content type
application/json
{
  • "isoContainerTypes": [
    • {
      • "code": "22G1",
      • "name": "General purpose container, 20 ft",
      • "nominalLength": 20,
      • "typeGroup": "GP",
      • "isTank": true,
      • "isReefer": true,
      • "isOpen": true
      }
    ],
  • "success": true,
  • "httpStatusCode": 200,
  • "message": "Operation Completed OK",
  • "messageType": "Information",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 401,
  • "message": "Unauthorized",
  • "messageType": "Error",
  • "parameter": "user",
  • "parameterValue": "Value ABC",
  • "parameterPosition": "3",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 403,
  • "message": "Licensing Regulations Error",
  • "messageType": "Error",
  • "parameter": "Regulation Licenses",
  • "parameterValue": "string",
  • "parameterPosition": "string",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ],
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 500,
  • "message": "Unexpected Error",
  • "messageType": "Error",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ],
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}

Get the countries

Returns the master data list of countries used for participants and addresses.

Authorizations:

basicAuth or bearerAuth
HTTP: basicAuth
HTTP Authorization Scheme: basic
HTTP: bearerAuth

OAuth2 access token obtained from POST /oauth2/token using the client_credentials grant. Send it as Authorization: Bearer <access_token>. The token is opaque: it must not be parsed by the client. It is an alternative transport for the same identity as HTTP Basic, with the same roles and the same licensing, so any operation accepts either scheme.

HTTP Authorization Scheme: bearer

query Parameters

requestGuid
required
string

Identifier of the request, up to 36 characters, used to trace it.

Responses

200

Successful request

Response Schema: application/json

Array of objects (Country)

List of country master data entries.

Array [
countryId
integer

Identifier of the country.

name
string

Name of the country in English.

countryCode
string

ISO 3166-1 alpha-2 code of the country.

]
success
boolean

Indicates whether the operation completed successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the operation result.

messageType
string
Enum: "Information" "Warning"

Severity classification of the message.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order, each one with its stable code. A warning does not prevent the operation. Omitted when there is no warning.

401

Unauthorized

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the authorization error.

messageType
string
Enum: "Error" "Warning" "Information"

Severity classification of the message.

parameter
string

Aggregated list of the parameter of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without parameter. Absent when no entry has a parameter.

parameterValue
string

Aggregated list of the parameterValue of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without value. Absent when no entry has a value.

parameterPosition
string

Aggregated list of the parameterPosition of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry outside a list. Positions start at 0. Absent when no entry is inside a list.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

The authentication error, with its stable code.

403

Forbidden

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing why the request is forbidden.

messageType
string
Enum: "Error" "Warning" "Information"

Severity classification of the message.

parameter
string

Aggregated list of the parameter of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without parameter. Absent when no entry has a parameter.

parameterValue
string

Aggregated list of the parameterValue of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without value. Absent when no entry has a value.

parameterPosition
string

Aggregated list of the parameterPosition of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry outside a list. Positions start at 0. Absent when no entry is inside a list.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every error that made the request fail, in detection order, each one with its stable code and, when it refers to an element of the request, its parameter, value, position and JSON Pointer. Present on every error response, with at least one entry.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order. Omitted when there is no warning.

500

Unexpected Error

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the unexpected server error.

messageType
string
Value: "Error"

Severity classification of the message.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every error that made the request fail, in detection order, each one with its stable code and, when it refers to an element of the request, its parameter, value, position and JSON Pointer. Present on every error response, with at least one entry.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order. Omitted when there is no warning.

get/masterdata/country
https://emea.dgassistant.com/api/v2/rest/masterdata/country
https://amer.dgassistant.com/api/v2/rest/masterdata/country
https://apac.dgassistant.com/api/v2/rest/masterdata/country

Response samples

Content type
application/json
{
  • "countries": [
    • {
      • "countryId": 180,
      • "name": "Qatar",
      • "countryCode": "QA"
      }
    ],
  • "success": true,
  • "httpStatusCode": 200,
  • "message": "Operation Completed OK",
  • "messageType": "Information",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 401,
  • "message": "Unauthorized",
  • "messageType": "Error",
  • "parameter": "user",
  • "parameterValue": "Value ABC",
  • "parameterPosition": "3",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 403,
  • "message": "Licensing Regulations Error",
  • "messageType": "Error",
  • "parameter": "Regulation Licenses",
  • "parameterValue": "string",
  • "parameterPosition": "string",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ],
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 500,
  • "message": "Unexpected Error",
  • "messageType": "Error",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ],
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}

Search ports, airports and terminals

Returns a page of the ports, airports and terminals of the UN/LOCODE catalogue and of the locations of the account given in accountCode (by default, the account of the user), of its company and of its group.

Authorizations:

basicAuth or bearerAuth
HTTP: basicAuth
HTTP Authorization Scheme: basic
HTTP: bearerAuth

OAuth2 access token obtained from POST /oauth2/token using the client_credentials grant. Send it as Authorization: Bearer <access_token>. The token is opaque: it must not be parsed by the client. It is an alternative transport for the same identity as HTTP Basic, with the same roles and the same licensing, so any operation accepts either scheme.

HTTP Authorization Scheme: bearer

query Parameters

requestGuid
required
string

Identifier of the request, up to 36 characters, used to trace it.

search
string
Example: search=ESV

Beginning of the code or of the name of the location.

countryCode
string <= 2 characters
Example: countryCode=ES

ISO 3166-1 alpha-2 code of the country, to return only its locations.

isPort
boolean

True to return only sea ports.

isAirport
boolean

True to return only airports.

accountListOnly
boolean

True to return only the locations among the locations of those accounts.

accountCode
string
Example: accountCode=WP001

Code of a customer account the user can read: the search covers the lists of that account, of its company and of its group. Without it, the account of the user.

page
integer
Default: 1
Example: page=1

Page number, starting at 1.

pageSize
integer [ 1 .. 200 ]
Default: 50
Example: pageSize=50

Number of items per page, between 1 and 200.

Responses

200

Successful request

Response Schema: application/json

Array of objects (Location)

Locations found on the page.

Array [
countryId
required
integer

Country identifier of the master data (GET /masterdata/country).

isPort
required
boolean

True when the location is a sea port.

isAirport
required
boolean

True when the location is an airport.

isRoadTerminal
required
boolean

True when the location is a road terminal.

isRailTerminal
required
boolean

True when the location is a rail terminal.

isAccountSpecific
required
boolean

True when the location was created by the account; false for a location of the global UN/LOCODE catalogue.

locationCode
string <= 20 characters

Code of the location: the UN/LOCODE for catalogue locations, or the code given by the account to a location of its own.

unlocode
string <= 5 characters

Official UN/LOCODE; empty for a location of the account that has none.

name
string

Name of the port, airport or terminal.

countryCode
string <= 2 characters

ISO 3166-1 alpha-2 code of the country.

iataCode
string <= 3 characters

Three-letter IATA code of the airport, when the location is an airport.

alias
string

Short name given to the location by the account. In the search of locations, when the location is among the locations of several accounts, the alias is the one of the most specific account: the work place, then the company, then the group.

accountCode
string

Code of the customer account whose locations include the location and whose alias is returned. Omitted when the location is not among the locations of the accounts or when the account has no code.

]
page
integer

Page returned, starting at 1.

pageSize
integer

Number of items per page applied to the search.

total
integer

Total number of items that match the filters, across all pages.

success
boolean

Indicates whether the operation completed successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the operation result.

messageType
string
Enum: "Information" "Warning"

Severity classification of the message.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order, each one with its stable code. A warning does not prevent the operation. Omitted when there is no warning.

400

Bad Request

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the validation error.

messageType
string
Enum: "Error" "Warning" "Information"

Severity classification of the message.

parameter
string

Aggregated list of the parameter of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without parameter. Absent when no entry has a parameter.

parameterValue
string

Aggregated list of the parameterValue of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without value. Absent when no entry has a value.

parameterPosition
string

Aggregated list of the parameterPosition of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry outside a list. Positions start at 0. Absent when no entry is inside a list.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every error that made the request fail, in detection order, each one with its stable code and, when it refers to an element of the request, its parameter, value, position and JSON Pointer. Present on every error response, with at least one entry.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order. Omitted when there is no warning.

401

Unauthorized

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the authorization error.

messageType
string
Enum: "Error" "Warning" "Information"

Severity classification of the message.

parameter
string

Aggregated list of the parameter of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without parameter. Absent when no entry has a parameter.

parameterValue
string

Aggregated list of the parameterValue of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without value. Absent when no entry has a value.

parameterPosition
string

Aggregated list of the parameterPosition of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry outside a list. Positions start at 0. Absent when no entry is inside a list.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

The authentication error, with its stable code.

403

Forbidden

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing why the request is forbidden.

messageType
string
Enum: "Error" "Warning" "Information"

Severity classification of the message.

parameter
string

Aggregated list of the parameter of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without parameter. Absent when no entry has a parameter.

parameterValue
string

Aggregated list of the parameterValue of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without value. Absent when no entry has a value.

parameterPosition
string

Aggregated list of the parameterPosition of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry outside a list. Positions start at 0. Absent when no entry is inside a list.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every error that made the request fail, in detection order, each one with its stable code and, when it refers to an element of the request, its parameter, value, position and JSON Pointer. Present on every error response, with at least one entry.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order. Omitted when there is no warning.

500

Unexpected Error

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the unexpected server error.

messageType
string
Value: "Error"

Severity classification of the message.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every error that made the request fail, in detection order, each one with its stable code and, when it refers to an element of the request, its parameter, value, position and JSON Pointer. Present on every error response, with at least one entry.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order. Omitted when there is no warning.

get/masterdata/location
https://emea.dgassistant.com/api/v2/rest/masterdata/location
https://amer.dgassistant.com/api/v2/rest/masterdata/location
https://apac.dgassistant.com/api/v2/rest/masterdata/location

Response samples

Content type
application/json
{
  • "locations": [
    • {
      • "locationCode": "ESVLC",
      • "unlocode": "ESVLC",
      • "name": "Valencia",
      • "countryId": 208,
      • "countryCode": "ES",
      • "iataCode": "VLC",
      • "isPort": true,
      • "isAirport": true,
      • "isRoadTerminal": true,
      • "isRailTerminal": true,
      • "isAccountSpecific": true,
      • "alias": "Valencia terminal",
      • "accountCode": "WP001"
      }
    ],
  • "page": 1,
  • "pageSize": 50,
  • "total": 137,
  • "success": true,
  • "httpStatusCode": 200,
  • "message": "Operation Completed OK",
  • "messageType": "Information",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 400,
  • "message": "Good not valid",
  • "messageType": "Error",
  • "parameter": "goods",
  • "parameterValue": "GoodX",
  • "parameterPosition": "3",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ],
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 401,
  • "message": "Unauthorized",
  • "messageType": "Error",
  • "parameter": "user",
  • "parameterValue": "Value ABC",
  • "parameterPosition": "3",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 403,
  • "message": "Licensing Regulations Error",
  • "messageType": "Error",
  • "parameter": "Regulation Licenses",
  • "parameterValue": "string",
  • "parameterPosition": "string",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ],
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 500,
  • "message": "Unexpected Error",
  • "messageType": "Error",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ],
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}