OperationDetail

The OperationDetail object represents the validation or translation context of an EDI item. It reports the error state of either a data element or segment and is used only as part of the OperationResult object.

 

Example

{
  "Index": 10,
  "TransactionIndex": 2,
  "TransactionRef": "0001",
  "SegmentId": "PO1",
  "Value": "P",
  "Message": "Invalid EDI code P - permitted codes are: AA,AB,AP",
  "Status": "error"   
}

 

Attributes


Index integer

The index of the reported segment, starting from the ISA. When multiple interchanges are present, the index starts from the first ISA of the first interchange. It is 0 based.


TransactionIndex integer

The index of the transaction which contains the failed segment. Starting from the ISA. When multiple interchanges are present, the index starts from the first ISA of the first interchange. It is 0 based.


TransactionRef string

The transaction reference of the transaction which contains the failed segment. The value is for X12 is ISA.InterchangeControlNumber_13 and for EDIFACT is UNB.InterchangeControlReference_5.

This value can be used to reference a transaction in the interchange if you need to know the status of a particular transaction instead of the whole interchange.


SegmentId string

The ID of the failed segment.


Value string

The value of the failed item. It could be either the whole segment or a data element.


Message string

The error message.


Status enumeration

The status of the failed item.

The available values are:

Value Description
info Control segment non-critical data validation
warning Some transactions were translated using secondary model
error The item is invalid or a transaction was partially parsed
Was this article helpful?
0 out of 0 found this helpful