Standard Error Codes

7000-7999: Technical error codes

Technical error codes indicate that it is not possible for the application to correctly parse or process the request.All errors whereby the schema of the JSON document does not conform to the API schema are, by definition, technical errors.Furthermore -Technical error codes are typically syntax errors or integrity constraint errors.Technical error codes typically result from a single property, or during an attempt to parse a single property.For example -
  • The JSON document is not correctly encoded as UTF-8. (syntax error)
  • A supplied DateTime does not include a time zone, so it is ambiguous. (syntax error)
  • A supplied Reference cannot be matched to a resource. (integrity constraint)
  • A String is too long. (syntax error)
  • A null value is supplied. (syntax error)

8000-8999: Functional error codes

Functional error codes indicate that the request is technically valid but there is a functional reason that it cannot be completed.Functional error codes are typically semantic errors or business rule constraints.Functional error codes MAY be errors that result from parsing or processing of multiple properties.For example -
  • A supplied DateTime cannot be met due to the voyage schedule. (business rule constraint)
  • A supplied TaxReference does not match to the locationOfRegistration. (business rule constraint)
  • A DateTime for arrival is earlier than the DateTime for departure. (semantic error)
  • A reefer temperature is outside the range of possible values. (business rule constraint)

9000-9999: API provider-specific error codes

This section refers to error codes that are independently defined and used by each specific API provider.These codes will not be maintained by DCSA but MUST be documented by individual API providers.