-
Notifications
You must be signed in to change notification settings - Fork 2
Parameters
Greg Kolinski edited this page Sep 26, 2017
·
43 revisions
String
The Unique AS2 Identifier to be used for this AS2 connection.
The base 64 byte array for the attachment content.
String
The name of an attachment or attachment filename.
The Authority Level required to access this specific note. An AuthLevel of MailboxUser allows everyone to view the note.
System.DateTime
The DateTime to begin the result return or search of an Inbox or Outbox.
System.DateTime
The DateTime to begin using this AS2 Connection.
Integer
The value assigned to a specific Carbon Copy entry.
Boolean
If this AS2 Connection will compress the data.
String(6,48)
The Email address of a contact person for the request.
String(3,48)
The name of a contact person for the request.
The Type of contact this entity is being use for or the type that should be notified.
String
A generic variable that is used to match any type of Description of an entity/field.
Integer
The ECGridID representing the sending Trading Partner.
Integer
The Trading Partner a Carbon Copy is to be sent from. See [ECGridIDs](https://github.com/LorenData/ECGridOS_API/wiki/Trading-Partners-&-ECGridIDs).
Integer
The Trading Partner a Carbon Copy is to be sent to. See [ECGridIDs](https://github.com/LorenData/ECGridOS_API/wiki/Trading-Partners-&-ECGridIDs).
Integer
The ECGridID representing the sending Trading Partner. The ECGridID representing the Original Sending Trading Partner. User -1 to match any. See [ECGridIDs](https://github.com/LorenData/ECGridOS_API/wiki/Trading-Partners-&-ECGridIDs).
Boolean
If this AS2 Connection will be hosted on ECGrid.
Integer
The Trading Partner a Carbon Copy is to be sent from. The ECGridID representing the Original Receiving Trading Partner. User -1 to match any. See [ECGridIDs](https://github.com/LorenData/ECGridOS_API/wiki/Trading-Partners-&-ECGridIDs).
_Byte (0-127) _
The decimal representation of an ASCII character an X12 Element Separator. The value of 0 is used to signify no translation.
A flag to indicate to whom a note or update should be emailed.
Boolean
If this AS2 Connection will use encrypted data.
System.DateTime
The DateTime to begin the result return or search of an Inbox or Outbox.
System.DateTime
The DateTime to end using this AS2 Connection.
The type of HTTPAuthentication expressed as an Integer - Basic (2), Digest (1), None (0)
String
The password for HTTPAuthentication - if none use empty string.
String
The user for HTTPAuthentication - if none use empty string.
String
The interchange control ID of the envelope.
String or Base64 Byte[]
The EDI interchange header envelope.
Integer
The value assigned to a specific interchange.
Integer
The value assigned to a specific Interconnect request.
Short
The Number of characters or positions for a string/number.
String
The location associated with this network.
Short
The Max Number of Days returned.
Integer
The ECGrid MailboxID assigned to the ID on the specified network.
Boolean
A flag to identify if the entity/mailbox is managed or not.
Short
The Number of minutes for a duration as a number.
String
A generic variable that is used to match any type of Name field (e.g. Network Name, FirstName, LastName, LoginName, etc.).
Integer
The ECGrid NetworkID assigned to the network.
String(8,32)
A "strong" password with a minimum length of 8 and maximum length of 32.
String(0,250)
A free-form note to document the transaction.
Boolean
Indicates whether the Contact should be notified by e-mail when this Interconnect is added to the system.
String(8,32)
Must match current session password.
String(0,48)
A valid e-mail address outside of a system User address.
Integer
The ECGrid UserID for the owner of this AS2 Connection assigned to the ID on the specified mailbox.
Short
The number of pages to return.
String(8,32)
A "strong" password with a minimum length of 8 and maximum length of 32 for this entity.
Boolean
Indicates whether the interconnect should be preconfirmed.
The type of MDN Receipt expressed as an Integer ENUM
Short
The Number of records to return per page.
String(0,16)
A user-defined reference number to attach to a Interconnect request.
The type of network routing this entity is or is used for as an ENUM.
String
The Run Directory for this Network.
_Byte (0-127) _
The decimal representation of an ASCII character an X12 Segment Terminator. The value of 0 is used to signify no translation.
String
The Server for this Network.
String - GUID
The current session's GUID in string format. This is a 32-character hexidecimal string in the format:00000000-0000-0000-0000-000000000000. This is your API Key. For Legacy Calls this is the value returned by the Login() function.
Boolean
A logical flag which determines if Inactive (Suspended and Terminated) records should be included in the return set.
Boolean
If this AS2 Connection will use a digital signature.
The type of Use this AS2 connection will be used for expressed as an Integer ENUM
A numeric value representing the Interconnect's status expressed as an Short ENUM.
_Byte (0-127) _
The decimal representation of an ASCII character an X12 Subelement Separator. The value of 0 is used to signify no translation.
String(0,20)
String to match the Transaction Set type, standard dependant.
The type of network this entity is or is used for as an ENUM
_String - GUID_
GUID in string format. This is a 32-character hexidecimal string in the format:00000000-0000-0000-0000-000000000000.
String
The URL that AS2 Connection uses to communicate/connect.
Integer
A numeric value used to represent a specific user on the system.
The type of Use this entity will be used for expressed as an ENUM
Getting Started
- Getting Started - Basics
- Getting Started - Extended Capabilities
- HTTP Connections
- Visual Studio SOAP Connections
- About ECGridOS and Loren Data Corp.
- Documentation & Nomenclature
- Using Web Services
- Networks & Mailboxes
- Users & Authorization Levels
- API Keys & Sessions
- Trading Partners & ECGridIDs
- Interconnects & Trading Partnerships
- Parcels, Interchanges & Mailbags
- Carbon Copies
ECGridOS API Calls
- API Calls - Full Definitions Available
- Asynchronous API Calls - Events
- Asynchronous API Calls - Task\Async\Await