From the Integration Assistance page:
- For a JSON transaction payload, you can access the guideline requirements of:
- A property - the equivalent of an X12 element
A property has a value. - An array - the equivalent of an X12 segment or loop
An array has children arrays and objects, that contain properties with values.
- A property - the equivalent of an X12 element
- For an X12 transaction payload, you can access the guideline requirements of:
- An element, represented by their X12 short name composed of the concatenation of the segment name they belong to and their relative position in the segment.
- A segment, represented by the first alphanumeric characters available at each new line.
A segment contains at least 1 element. - A loop represented by vertical square brackets on the left side of the transaction payload.
A loop contains at least 1 segment or 1 loop.
- An element, represented by their X12 short name composed of the concatenation of the segment name they belong to and their relative position in the segment.
Note #1: This documentation uses JSON terminology throughout. If you are trading X12, note that X12 elements are "properties" in JSON, and X12 segments and loops are "arrays" in JSON.
Note #2:
- To access the leaders' guideline requirements, you must generate a transaction payload.
More details on this article: Generate a Transaction Payload.
- You can access the leaders' guideline requirements of a property or array using different methods.
More details on this article: Access the Leaders' Guideline Requirements.
The leaders' guideline requirements for a specific property or array are always organized in 4 different sections:
- Name: Displays the user friendly name, the JSON name, and the X12 name of the selected property or array.
- Description: Displays the description given by the leaders.
- Usage: Indicates if a property or array is Mandatory, Conditional, Optional, Recommended, Not Recommended.
- Details: Provides more requirement details. The requirements can vary if you selected a property or an array.
When viewing the guideline requirement of a property:
- The usage section will display the condition(s) to respect if the usage is Conditional.
- The detail section will show:
- The type of the property and the allowed values.
OR - The type and the min/max length of the property.
- The type of the property and the allowed values.
Example 1
Example 2:
When viewing the guideline requirement of an array, the detail section will show the maximum number of times this array can be repeated.
Understand the guideline requirements from different leaders
If you generate a transaction payload for several relationships that have distinct leaders' guidelines, some leaders may share some requirements or have divergent requirements for the same property or array.
When viewing the guideline requirement of a property or array, you can identify:
- Divergent requirements: Requirement marked with a blue tag.
A divergent requirement is applicable to specific leaders only. You can see the name of the leaders applying this requirement in the blue tag. If the name of a leader is too long or if several partners apply the divergent requirement, you can click on the blue tag for more details. - Shared requirements: Requirement without any tag.
A shared requirement is always applicable, regardless of the leader.