Skip to content
background-image background-image

EdiNation - EDIFACT to JSON Converter

[ | version 3.3]

Connector

The connector is permitted for use of the platform background agent.

Connector processing type: Both (Row by row & Bulk), Default type: Row by row!

Reads an EDIFACT file and returns its contents translated to JSON as an array of EdifactInterchange objects.

For comprehensive details and additional configuration options, please refer to the EdiNation API documentation.


Configuration

EdiNation - Edifact Connection

Base URL: The base URL for connecting to the EdiNation service.

Authorization token: A token for authorizing access to the EdiNation

EdiNation - Edifact to JSON settings

Error behavior: The available values are:

  • Fail and return response: The connector fails at the specified line but generates output with error details.

  • Fail without response: The connector fails - the error will be displayed only in the log.

  • Do not fail and return response: The connector does not fail but generates output records that may be marked with an error and detailed information.

Continue on error: Whether to continue reading if a corrupt interchange is encountered. The default is false.

Ignore null values: Whether to ignore all null values in the response. The default is false.

Use eancom 3: The default syntax for EANCOM transactions. By default all EANCOM transactions will be translated and validated according to the rules of Syntax 4. Set this flag to true if you need Syntax 3 to be used. The default value is false.

Model: The model to use. By default, the API will infer the model based on the transaction and version identifiers.


Input & Output Schema

Input

EdiNation - Convert EDIFACT To JSON Request

Column Data type Allow null Description
EDIFACT String No The EDIFACT message to be converted into JSON format.

Output

EdiNation - EDIFACT Response

Column Data type Allow null Description
StatusCode Integer No A numerical response from the server to an HTTP request sent to an API (see below).
JSON JSON Yes The resulting JSON object produced from the API call
Message String Yes If the Status is "error," the error message is displayed.
Status String Yes The result of the EDIFACT to JSON conversion process

Status Code

  • 200 Success
  • 400 Bad request - When the file stream is invalid or the form-data is not set properly.
  • 500 Server error - Something went wrong on EdiNation's side.

Note

The API will respond with HTTP 200 OK even if the contents of the file can't be translated.

Example response

200: [

{

"UNA": null,

"UNB": {

"SYNTAXIDENTIFIER_1": {

"SyntaxIdentifier_1": "UNOA",

"SyntaxVersionNumber_2": "1",

"ServiceCodeListDirectoryVersionNumber_3": null,

"CharacterEncoding_4": null

},

"INTERCHANGESENDER_2": {

"InterchangeSenderIdentification_1": "US",

"IdentificationCodeQualifier_2": null,

"InterchangeSenderInternalIdentification_3": "US",

"InterchangeSenderInternalSubIdentification_4": null

},

"INTERCHANGERECIPIENT_3": {

"InterchangeRecipientIdentification_1": "50138",

"IdentificationCodeQualifier_2": null,

"InterchangeRecipientInternalIdentification_3": "THEM",

"InterchangeRecipientInternalSubIdentification_4": null

},

"DATEANDTIMEOFPREPARATION_4": {

"Date_1": "140531",

"Time_2": "0305"

},

"InterchangeControlReference_5": "001934",

"RECIPIENTSREFERENCEPASSWORDDETAILS_6": null,

"ApplicationReference_7": "ORDERS",

"ProcessingPriorityCode_8": null,

"AcknowledgementRequest_9": null,

"InterchangeAgreementIdentifier_10": null,

"TestIndicator_11": null

},

"Groups": null,

"UNZTrailers": null,

"Result": {

"LastIndex": 1,

"Details": [

{

"Index": 1,

"TransactionIndex": 0,

"TransactionRef": null,

"SpecRef": "ef",

"SegmentId": null,

"DataElementId": null,

"DataElementIndex": 0,

"CompositeIndex": 0,

"RepIndex": 0,

"Value": null,

"Message": "Transaction set is not supported. One or more errors occurred. (Model EdiNation.Edifact.UN.912 was not found.)",

"Status": "error"

}

],

"Status": "error"

}

}

]

Release notes

3.3.1

  • First release