Parameters - LorenData/ECGrid-API GitHub Wiki
ADMD
String
The X400 ADMD Value.
AS2Identifier
String
The Unique AS2 Identifier to be used for this AS2 connection.
AttachmentContent
The base 64 byte array for the attachment content.
AttachmentName
String
The name of an attachment or attachment filename.
AuthLevel
The Authority Level required to access this specific note. An AuthLevel of MailboxUser allows everyone to view the note.
BeginDate
System.DateTime
The DateTime to begin the result return or search of an Inbox or Outbox.
BeginUsage
System.DateTime
The DateTime to begin using this AS2 Connection.
Bytes
Integer
The number of bytes in the uploaded/downloaded Parcel.
CarbonCopyID
Integer
The value assigned to a specific Carbon Copy entry.
CellCarrier
The cell phone carrier used expressed as an ENUM.
CellPhone
String(0,20)
A cell phone number.
CommonName
String
The X400 CommonName Value.
Company
String(0,50)
A company name.
CompressData
Boolean
If this AS2 Connection will compress the data.
ContactEMail
String(6,48)
The Email address of a contact person for the request.
ContactName
String(3,48)
The name of a contact person for the request.
ContactType
The Type of contact this entity is being use for or the type that should be notified.
Content
Byte[] (Base64)
A byte array representing the data in a Parcel/Entity.
Country
String
The X400 Country.
CurrentRecoveryAnswer
String(0,50)
The current user defined answer to the RecoveryQuestion, used to restore lost password or to activate an account with too many failed logins.
DataEMail
String
The email address associated with the Trading Partner Data
DDA
String
The X400 DDA Value.
Description
String
A generic variable that is used to match any type of Description of an entity/field.
The name associated with a Qualifier/ID pair.
DocumentType
The EDI Document Type for this parcel entity.
ECGridID
Integer
The ECGridID representing the sending Trading Partner.
ECGridIDCCFrom
Integer
The Trading Partner a Carbon Copy is to be sent from. See [ECGridIDs](https://github.com/LorenData/ECGridOS_API/wiki/Trading-Partners-&-ECGridIDs).
ECGridIDCCTo
Integer
The Trading Partner a Carbon Copy is to be sent to. See [ECGridIDs](https://github.com/LorenData/ECGridOS_API/wiki/Trading-Partners-&-ECGridIDs).
ECGridIDFrom
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).
ECGridHosted
Boolean
If this AS2 Connection will be hosted on ECGrid.
ECGridIDTo
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).
ElmSep
_Byte (0-127) _
The decimal representation of an ASCII character an X12 Element Separator. The value of 0 is used to signify no translation.
String(0,50)
A valid Email address.
EMailSystem
The Email system type used to send/receive Trading Partner Data as an ENUM.
eMailTo
A flag to indicate to whom a note or update should be emailed.
EncryptData
Boolean
If this AS2 Connection will use encrypted data.
EndDate
System.DateTime
The DateTime to begin the result return or search of an Inbox or Outbox.
EndTime
System.DateTime
When the Session ended.
EndUsage
System.DateTime
The DateTime to end using this AS2 Connection.
FileName
String(1,127)
The file name assigned to a Parcel. It will be stored on disk with this name.
FirstName
String(1,50)
A user's first name.
Generation
String
The X400 Generation Value.
GivenName
String
The X400 GivenName Value.
HTTPAuthentication
The type of HTTPAuthentication expressed as an Integer - Basic (2), Digest (1), None (0)
HTTPPassword
String
The password for HTTPAuthentication - if none use empty string.
HTTPUser
String
The user for HTTPAuthentication - if none use empty string.
ID
String(1,35)
The X12 or EDIFACT ID for the ISA and UNB segments.
InterchangeControlID
String
The interchange control ID of the envelope.
InterchangeHeader
String or Base64 Byte[]
The EDI interchange header envelope.
InterchangeID
Long
The value assigned to a specific interchange.
InterconnectID
Integer
The value assigned to a specific Interconnect request.
Initials
String
The X400 Initials Value.
LastName
String(1,50)
A user's last name.
Length
Short
The Number of characters or positions for a string/number.
Location
String
The location associated with this network.
LoginName
String(8,16)
A user's login name.
MaxDays
Short
The Max Number of Days returned.
MailbagControlID
String
The ECGrid MailbagControlID assigned to the ID on the specified network.
MailboxID
Integer
The ECGrid MailboxID assigned to the ID on the specified network.
Managed
Boolean
A flag to identify if the entity/mailbox is managed or not.
MaxRecords
Short
The maximum number of records to be returned by the API call.
Minutes
Short
The Number of minutes for a duration as a number.
Month
System.DateTime
The month for the report. Must be the 1st of the month such as 09/01/2017.
MoveDateTime
System.DateTime
Specified date and time in UTC (see NowUTC) for the move. At that date and time the old ECGridID will be terminated and the new ECGridID will be activated.
Name
String
A generic variable that is used to match any type of Name field (e.g. Network Name, FirstName, LastName, LoginName, etc.).
NetworkID
Integer
The ECGrid NetworkID assigned to the network.
NewPassword
String(8,32)
A "strong" password with a minimum length of 8 and maximum length of 32.
Note
String(0,250)
A free-form note to document the transaction.
NotifyContact
Boolean
Indicates whether the Contact should be notified by e-mail when this Interconnect is added to the system.
NumPeriods
Short
The number of reporting periods to include. A positive number are peroids after the TargetTime. A negative number samples periods with the TargetTime as the last period.
N_ID
String
The X400 N_ID Value.
OldPassword
String(8,32)
Must match current session password.
OrderBy
A numeric value representing the way to organize the data using a numeric ENUM.
Organization
String
The X400 Organization Value.
OrganizationUnit
String
The X400 Organization Unit Value.
OtherEMailAddress
String(0,48)
A valid e-mail address outside of a system User address.
OwnerUserID
Integer
The ECGrid UserID for the owner of this AS2 Connection assigned to the ID on the specified mailbox.
PageNo
Short
The number of pages to return.
PageNumber
Short
The number of the page to return.
PageSize
Short
The number of records/size to return per page.
ParcelID
Long
The value assigned to track a specific Parcel on ECGrid.
Password
String(8,32)
A "strong" password with a minimum length of 8 and maximum length of 32 for this entity.
PayloadPosition
The Email payload type for the data as an ENUM.
Period
A numeric value representing the sampling interval.
Phone
String(0,20)
A phone number.
Preconfirm
Boolean
Indicates whether the interconnect should be preconfirmed.
PRMD
String
The X400 PRMD Value.
Qualifier
String(0,3)
The X12 or EDIFACT ID Qualifier for the ISA and UNB segments.
ReceiptType
The type of MDN Receipt expressed as an Integer ENUM
RecordsPerPage
Short
The Number of records to return per page.
RecoveryAnswer
String(0,50)
A user defined answer to the RecoveryQuestion, used to restore lost password or to activate an account with too many failed logins.
RecoveryQuestion
String(0,50)
A user defined question used to restore lost password or to activate an account with too many failed logins.
Reference
String(0,16)
A user-defined reference number to attach to a Interconnect request.
Report
Short
A numeric value representing the requested report.
RoutingGroup
The type of routing group this entity is or is used for as an ENUM.
RoutingType
The type of network routing this entity is or is used for as an ENUM.
RunDir
String
The Run Directory for this Network.
SegTerm
_Byte (0-127) _
The decimal representation of an ASCII character an X12 Segment Terminator. The value of 0 is used to signify no translation.
Server
String
The Server for this Network.
SessionID
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.
ShowInactive
Boolean
A logical flag which determines if Inactive (Suspended and Terminated) records should be included in the return set.
SignData
Boolean
If this AS2 Connection will use a digital signature.
StartTime
System.DateTime
When the Session started.
Status
A numeric value representing the Network status expressed as an Short ENUM.
A numeric value representing the Network Run status expressed as an Short ENUM.
A numeric value representing the Parcel status expressed as an Short ENUM.
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.
SubElmSep
_Byte (0-127) _
The decimal representation of an ASCII character an X12 Subelement Separator. The value of 0 is used to signify no translation.
Surname
String
The X400 Surname Value.
Subject
String
The subject or brief description of a note/attachment/entity.
TargetTime
System.DateTime
This indicates the inital or final time for the report based on whether NumPeriods is positive or negative.
Text
String
The text string content to send.
TimeOutMinutes
Short
The Number of minutes for a duration as a timeout.
TransactionSet
String(0,20)
String to match the Transaction Set type, standard dependant.
TransLogOnly
Boolean
Flag to identify if this parcel is to return log only.
Type
The type of network this entity is or is used for as an ENUM
T_ID
String
The X400 T_ID Value.
T_TY
String
The X400 T_TY Value.
UniqueID
_String - GUID_
GUID in string format. This is a 32-character hexidecimal string in the format:00000000-0000-0000-0000-000000000000.
URL
String
The URL that AS2 Connection uses to communicate/connect.
UserID
Integer
A numeric value used to represent a specific user on the system.
UseType
The type of Use this entity will be used for expressed as an ENUM
WebsiteType
The type of website this entity will be used for or contains expressed as an ENUM
X_121
String
The X400 X_121 Value.