OpenAPI EDI Extensions

  View the full OpenApi example here:

EdiNation X12 837P OpenAPI example

All EDI items such as message, loop, segment or composite/data element must include their corresponding extension property:

  • x-edination-message-id

    The transaction set ID. Required for message objects.

  • x-edination-message-standard

    The transaction set standard, either X12 or EDIFACT. Required for message objects.

  • x-edination-message-version

    The transaction edition and release. Required for message objects only if multiple messages with the same transaction ID are included in the same definition.

Example:

mceclip1.png

  • x-edination-loop-id

    The loop ID. Required for loop objects.

Example:

mceclip5.png

  • x-edination-segment-id

    The segment ID. Required for segment objects.

Example:

mceclip6.png

  • x-edination-composite-id

    The composite data element ID. Required for composite element objects.

Example:

mceclip3.png

  • x-edination-element-id

    The simple data element ID. Required for simple element properties.

Example:

mceclip4.png

  • x-edination-syntax

    The array of syntax items for data element conditions. Optional for segments and composite elements.

    The format of each array item must be:

    {condition designator}{start position}[other positions]{end position}

    {start position}, {end position} and all other positions in-between must be two-digit numeric values, 0 to 9 must be padded with a leading zero.

    {condition designator} must be any of the following values:

    • P- Paired
    • R- Required
    • E- Exclusion
    • C- Conditional
    • L- List Conditional

Example:

mceclip2.png

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