With EDI API you can translate VDA files to JSON (read VDA), translate JSON to VDAfile (write VDA), or validate a VDA transaction (validate VDA).
Read VDA
Reads a VDA file and returns its contents translated to JSON as an array of FlatMessage objects.
- Path:
/vda/read
- HTTP Verb:
POST
- Required API Key:
Ocp-Apim-Subscription-Key
- Request Content-Type:
application/octet-stream
ormultipart/form-data
- Request limit: 28.6 MB
- Response Content-Type:
application/json
Errors
- 200: Success
- 400: When the file stream is invalid or the form-data is not set properly.
- 500: Something went wrong on our end. Please report at support@edination.com
The API will respond with HTTP 200 OK even if the contents of the file can't be translated. Error details will be included in the Result section of FlatMessage.
Parameters
- ignoreNullValues
boolean
Whether to ignore all null values in the response. The default is false.
- continueOnError
boolean
Whether to continue reading if a corrupt interchange is encountered. The default is false.
- charSet
enumeration
The encoding of the file contents. The default is utf-8.
The available values are:
Value Description utf-16 Unicode unicodeFFFE Unicode (Big endian) utf-32 Unicode (UTF-32) utf-32BE Unicode (UTF-32 Big endian) us-ascii US-ASCII iso-8859-1 Western European (ISO) utf-7 Unicode (UTF-7) utf-8 Unicode (UTF-8) - model
string
The model to use. By default, the API will infer the model based on the transaction and version identifiers.
Write VDA
Translates a FlatMessage object to a raw VDA and returns it as a stream.
- Path:
/vda/write
- HTTP Verb:
POST
- Required API Key:
Ocp-Apim-Subscription-Key
- Request Content-Type:
application/json
- Request limit: 28.6 MB
- Response Content-Type:
application/octet-stream
Errors
- 200: Success
- 400: When the FlatMessage has an invalid JSON structure.
- 500: Something went wrong on our end. Please report at support@edination.com
Parameters
- charSet
string
The encoding of the resulting stream. The default is utf-8.
The available values are:
Value Description utf-16 Unicode unicodeFFFE Unicode (Big endian) utf-32 Unicode (UTF-32) utf-32BE Unicode (UTF-32 Big endian) us-ascii US-ASCII iso-8859-1 Western European (ISO) utf-7 Unicode (UTF-7) utf-8 Unicode (UTF-8) - postfix
string
The postfix to be applied at the end of each segment, just after the segment separator.
Validate VDA
Validates a FlatMessage object according to the VDA standard rules for each transaction. Returns an OperationResult object with a status field and an array of error details if any.
- Path:
/vda/validate
- HTTP Verb:
POST
- Required API Key:
Ocp-Apim-Subscription-Key
- Request Content-Type:
application/json
- Request limit: 28.6 MB
- Response Content-Type:
application/json
Errors
- 200: Success
- 400: When the FlatMessage has an invalid JSON structure.
- 500: Something went wrong on our end. Please report at support@edination.com
Parameters
There are no parameters available for this operation.
API Tutorials
To learn more about how to translate and validate EDI files with EDI API try these tutorials:
Comments
0 comments
Please sign in to leave a comment.