senderID | String The sender ID associated with the control number. | |
senderQualifier | String (optional) The sender EDI ID qualifier associated with the control number. | |
receiverID | String The receiver ID associated with the control number. | |
receiverQualifier | String (optional) The receiver EDI ID qualifier associated with the control number. | |
standard | String EDI standard associated with the control number. Specify one of the following: X12, UNEDIFACT, VICS, UCS, -or- EANCOM. | |
productionMode | String Production mode associated with the control number. Specify one of the following: Production (default), Test, or Custom. | |
version | String Version of the EDI standard for the control number, e.g., 4010. | |
isEnvelope | String Whether the control number is for an envelope or a group. | |
Value | Meaning | |
true | The control number is associated with an envelope. | |
false | The control number is associated with a group. | |
groupType | String (optional) The group type associated with the control number. ![]() ![]() | |
createIfNotFound | String Whether you want to create an entry for this control number this sender/receiver pair if there is currently no entry. | |
Value | Meaning | |
true | Creates a control number entry for the specified sender/receiver, production mode, standard and version combination and sets the next expected control number. The next expected control number is calculated by adding the specified control number (in numberToValidate) to the configured control number increment. If the result exceeds the configured control number cap, the next expected control number is set to the configured control number minimum. | |
false | Does not create a control number entry for the specified sender/receiver, production mode, standard and version combination. | |
numberToValidate | String The control number that you want to validate. |
result | String Whether the control number you specified in numberToValidate is valid. The value of result will be one of the following: | |
Value | Meaning | |
Valid | The control number that you specified is valid and the next expected control number has been incremented. | |
OutOfSequence | The control number that you specified is not valid. The service has determined that the control number is out-of-sequence. | |
Duplicate | The control number that you specified is not valid. The service has determined that the control number is a duplicate. |