DELTA H7 API 0.3.0

H7/Operators API

Servers

https://{URL_OPERATEUR_EDI}/dh7 http
URL_OPERATEUR_EDI: This value is the url of the operator.

Operations

Pub declarations/erreurs

H7/operators interface for a Error_H7 message

Accepts the following message:

Error_H7

Payload
object
header
required
object
messageDateTime
required
string
date-time must match [0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}[+,-][0-9]{2}:[0-9]{2}.+

AAAA-MM-DDThh:mm:ss[offset][ZoneID]

messageId
required
string
length <= 291

Additional properties are NOT allowed.

declaration
object
lrn
required
string
length <= 22
customsDeclarationReference
string
length <= 22

Not filled if the declaration is not registrated in the system

mrn
string
must match [0-9a-zA-Z]{18}

Not filled for pre-lodged declaration

Additional properties are NOT allowed.

request
object
operatorRequestReference
required
string
length <= 35

Additional properties are NOT allowed.

error
required
array<object>
<= 999 items

Items:

0
object
errorType
integer
int32 must match [0-9]{2}

Not used if technical error

errorCode
string
length <= 10

Used only for functional errors

errorPointer
string
length <= 210

Not used if technical error; In case of request error, this tag is filled with customs declaration reference

errorDescription
string
length <= 350

Additional properties are NOT allowed.

Additional items are allowed.

Additional properties are NOT allowed.

Examples

Error_H7
Payload
{
  "header": {
    "messageDateTime": "2020-06-12T05:36:30-05:00[US/Central]",
    "messageId": "b6c9f124-4a83-4003-bcc9-1bce1798c2ab1591712615"
  },
  "declaration": {
    "lrn": "TEST123456",
    "customsDeclarationReference": "228231995374",
    "mrn": "15FR9876AB889012B5"
  },
  "request": {
    "operatorRequestReference": "TEST123456"
  },
  "error": [
    {
      "errorType": 15,
      "errorCode": "H7_NAT_000",
      "errorPointer": "lrn",
      "errorDescription": "Le LRN saisi ne doit pas correspondre à celui d'une déclaration déjà déposée."
    }
  ]
}
This example has been generated automatically.

Messages

#1 Error_H7

Payload
object
header
required
object
messageDateTime
required
string
date-time must match [0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}[+,-][0-9]{2}:[0-9]{2}.+

AAAA-MM-DDThh:mm:ss[offset][ZoneID]

messageId
required
string
length <= 291

Additional properties are NOT allowed.

declaration
object
lrn
required
string
length <= 22
customsDeclarationReference
string
length <= 22

Not filled if the declaration is not registrated in the system

mrn
string
must match [0-9a-zA-Z]{18}

Not filled for pre-lodged declaration

Additional properties are NOT allowed.

request
object
operatorRequestReference
required
string
length <= 35

Additional properties are NOT allowed.

error
required
array<object>
<= 999 items

Items:

0
object
errorType
integer
int32 must match [0-9]{2}

Not used if technical error

errorCode
string
length <= 10

Used only for functional errors

errorPointer
string
length <= 210

Not used if technical error; In case of request error, this tag is filled with customs declaration reference

errorDescription
string
length <= 350

Additional properties are NOT allowed.

Additional items are allowed.

Additional properties are NOT allowed.