Ack Edifact

  • Path: /edifact/ack
  • HTTP Verb: POST
  • Required API Key: Ocp-Apim-Subscription-Key (Get API Key)
  • Request Content-Type: application/json
  • Request limit: 28.6 MB
  • Response Content-Type: application/json

 

Description

Generates an EdifactInterchange object that contains the functional and/or technical CONTRL acknowledment(s) for the requested EdifactInterchange. The resulting EdifactInterchange uses the UNB and UNG (optional) of the request, with the sender and receiver id/qualifier exchanged. The interchange reference number is set to 1.

 

Errors

  • 200: Success
  • 400: When the EdifactInterchange has an invalid JSON structure.
  • 500: Something went wrong on our end. Please report at support@edination.com

 

Parameters


syntaxSet string

In case you need to validate against a syntax set, different than UNOA and UNOB, populate this filed with all of the allowed symbols, url-escaped.

All data elements with alpha (A) or alphanumeric (AN) data types are validated against a syntax set of allowed characters. The supported syntax sets are UNOA and UNOB. The validator infers the correct syntax set from EdifactInterchange.UNB.SYNTAXIDENTIFIER_1.SyntaxIdentifier_1. The symbols added to this field will override the corresponding sets in both UNOA and UNOB.

UNOA UNOB
ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789 .,-()/='+:?!\"%&*;<>

detectDuplicates boolean

If you need to detect duplicates as in functional groups or transactions with the same reference number, set this flag to true. The default is false.


tranRefNumber integer

The default is 1. Set this to whatever the CONTRL UNH.MessageReferenceNumber_01 needs to be.


interchangeRefNumber integer

The default is 1. Set this to whatever the CONTRL EdifactInterchange.UNB.InterchangeControlReference_5 needs to be.


ackForValidTrans boolean

The default is false. Set this to true if you need UCM loops included for all valid transaction as well. By default UCM loops are generated only for invalid transactions.


batchAcks boolean

The default is true. Set this to false if you need to generate separate EdifactInterchange for each acknowledgment. By default all acknowledgments are batched in the same EdifactInterchange.


technicalAck enumeration

The default technical acknowledgment CONTRL is generated according to EdifactInterchange.UNB.AcknowledgementRequest_9. You can either enforce it to always generate technical CONTRLs or supress it to never generate any technical CONTRLs. This will override the flag in EdifactInterchange.UNB.AcknowledgementRequest_9.

The available values are:

Value Description
enforce Always generate technical CONTRL
suppress Never generate technical CONTRL
default Generate technical CONTRL according to AcknowledgementRequest_9

eancomS3 boolean

The default syntax for EANCOM transactions. By default all EANCOM transactions will be validated according to the rules of Syntax 4. Set this flag to true if you need Syntax 3 to be used.

 

Example

Go to examples and Swagger test

Was this article helpful?
0 out of 0 found this helpful