Validate Edifact

  • Path: /edifact/validate
  • 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

Validates an EdifactInterchange object according to the EDIFACT standard rules for each version and transaction. Returns an OperationResult object with status field and an array of error details if any.

 

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 .,-()/='+:?!\"%&*;<>

skipTrailer boolean

You are allowed to validate an EdifactInterchange with missing interchange, functional group or transaction trailers (UNZ, UNE, UNT). This is because these will be automatically applied during the Write oprtaion so you don't have to worry about counting the items. By default it is expected that all trailers are present when you validate the EdifactInterchange and by default, this is set to false. To skip all trailer validation, set this to true.


structureOnly boolean

This is equivalent to HIPAA Snip level 1, where only the structure and control segments are validated. By default, this is set to false, however if you want to not validate things such as data types, number of repeteitions or dates, set this to true.


decimalPoint string

This could be either point "." (default) or comma ",".


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