documents | String List (optional) EDI documents to which to add an IC envelope. | |
syntaxId | String Syntax identifier. | |
syntaxVersion | String Syntax version number. | |
senderId | String The sender ID of the interchange. | |
senderQual | String (optional) The sender EDI ID qualifier code. | |
reverseRoute | String (optional) The sender internal identification. Note: Do not use this parameter if you supplied a value for senderInternalId or senderInternalSubId. | |
receiverId | String The receiver ID of the interchange. | |
receiverQual | String (optional) The receiver EDI ID qualifier code. | |
routingAddress | String (optional) The receiver internal identification. Note: Do not use this parameter if you supplied a value for receiverInternalId or receiverInternalSubId. | |
ICreference | String (optional) The IC control number of the EDI document. | |
ctlFromTable | String (optional) Whether you want the service to obtain the control number for the interchange from the EDIControlNumber table, which is a module-specific table in the Trading Networks database. | |
Value | Meaning | |
true | Obtain the control number from the EDIControlNumber table. | |
false | Do not obtain the control number from the EDIControlNumber table. Use the value specified in the ICreference parameter. | |
password | String The recipient reference password. | |
passwordQual | String (optional) The recipient reference password qualifier. | |
applReference | String (optional) The application reference. | |
priority | String (optional) The processing priority code. | |
ackRequested | String (optional) Whether you want to request an acknowledgment for this interchange. | |
Value | Meaning | |
1 | Request an acknowledgment for this interchange. | |
agreementId | String (optional) The interchange agreement identifier. | |
testIndicator | String (optional) Indicates the testing parameters. | |
Value | Meaning | |
1 | Indicates that the interchange is a test. | |
2 | Indicates that test only the syntax of the structure. | |
3 | Return the request without any change. | |
4 | Return the response without any change except for this data element changing from 3 to 4. | |
UNARequired | String (optional) Whether you want the service to create a UNA segment in front of the resulting output. Note:  Set the UNARequired property as true to generate a UNA segment for UNOA.By default, the service generates the UNA segment for UNOB, UNOC, UNOD, UNOE, and UNOF. The service also generates UNA segment when the delimiters record, field, subfield, release is other than the default value. | |
Value | Meaning | |
true | Create the UNA segment. | |
false | Do not create the UNA segment. | |
removeUNA | String (Optional). To remove the UNA segment from the UN/EDIFACT document. | |
Value | Meaning | |
true | Removes the UNA segment from UN/EDIFACT document irrespective of the value configured in the input parameter UNARequired. | |
false | removeUNA does not remove the UNA segment from the UN/EDIFACT document when: UNARequired is set as true, orUNARequired is set as false, but the UNA segment is added based on the default behavior of UNARequired. | |
addGroups | String (optional) Whether you want the service to add group header and trailer (UNG and UNE) segments in the interchange. Note: You can add a group envelope either by setting this parameter to true, or setting this parameter to false and using the addGroupEnvelope service prior to using the addICEnvelopeEDIFACT service. Creating a group envelope twice will result in an invalid document. | |
Value | Meaning | |
true | Add the UNG and UNE segments to the document prior to adding the interchange envelope. | |
false | Do not add the UNG and UNE segments. | |
groupInfo | Document (optional) Information about the group segments added by addGroup. | |
Value | Meaning | |
IDcode | String (optional) The Functional ID Code of the EDI document according to the EDI standard. | |
senderID | String (optional when the value of syntaxVersion is greater than 3) The sender to identify in the group envelope. For example, if you specify 01 for senderQual (indicating a D-U-N-S number), specify the value of the D-U-N-S number for sender. Note: When the value of syntaxVersion is 1 and you do not specify values for the group-level senderID, senderQual, receiverID, and receiverQual fields, the service uses the values specified in the interchange-level senderID, senderQual, receiverID, and receiverQual fields. When the value of syntaxVersion is 4 and you do not specify values for the group-level senderID, senderQual, receiverID, and receiverQual fields, the service leaves these group-level fields blank. | |
senderQual | String (optional) EDI ID qualifier for the sender ID. | |
receiverID | String (optional when the value of syntaxVersion is greater than 3) The receiver to identify in the group envelope. For example, if you specify 01 for receiverQual (indicating a D-U-N-S number), specify the value of the D-U-N-S number for receiver. | |
receiverQual | String (optional) EDI ID qualifier for the receiver ID. | |
grpCtlNumber | String (optional) The group control number of the EDI document. | |
agencyCode | String (optional) Responsible agency code: UN (default) or AA. | |
verCode | String (optional) EDI standard version code, e.g., D, S, etc. | |
relCode | String (optional) EDI message standard release code, e.g., 96A, 97B, etc. | |
aACode | String (optional) EDI message standard assigned code, e.g., OD, EN, etc. | |
password | String (optional) The recipient transmission reference password. | |
delimiters | Document (optional) Delimiters used in the outbound EDI document. | |
Value | Meaning | |
record | String The segment terminator for the EDI document, e.g., \u000a to use the new line character. The default is the ' character. | |
field | String The field separator for each EDI segment e.g., !. The default is the + character. | |
subfield | String The separator for composite elements, e.g., ^. The default is the : character. | |
release | String The release character for composite elements, e.g., ^. The default is the ? character. | |
decimal | String The decimal character for composite elements, e.g., ^. If UNARequired is true, the decimal delimiter is used. The default is the . character. You may enter only one character. If UNARequired is false, decimal is ignored. | |
directoryVersionNumber | String The directory version number to be placed in the UNB01/S00103 sub field of the EDIFACT envelope interchange header. | |
characterEncoding | String The character encoding to be placed in the UNB01/S00104 sub field of the EDIFACT envelope interchange header. | |
syntaxReleaseNumber | String The syntax release number to be placed in the UNB01/S00105 sub field of the EDIFACT envelope interchange header. | |
senderInternalId | String (optional) The sender's internal ID to be placed in the UNB02/S00203 sub field of the EDIFACT envelope interchange header. Note: Do not use this parameter if you supplied a value for reverseRoute. | |
senderInternalSubId | String (optional) The sender's internal sub ID to be placed in the UNB02/S00204 sub field of the EDIFACT envelope interchange header. Note: Do not use this parameter if you supplied a value for routingAddress. | |
receiverInternalId | String (optional) The receiver's internal ID to be placed in the UNB03/S00203 sub field of the EDIFACT envelope interchange header. Note: Do not use this parameter if you supplied a value for routingAddress. | |
receiverInternalSubId | String (optional) The receiver's internal sub ID to be placed in the UNB03/S00204 sub field of the EDIFACT envelope interchange header. Note: Do not use this parameter if you supplied a value for routingAddress. | |
repeatingField_separator | String (optional) The parameter adds a space as delimiter to denote repetition by default. | |