Parameters

The following is the complete list of parameter definitions for ECGridOS.

AuthLevel: Short - AuthLevel ENUM; The Authority Level for system access.
BeginDate: Date; The date & time to start a report. All dates are in UTC. See NowUTC().
Bytes: Integer; The number of bytes in the Parcel.
CarbonCopyID: Integer; The value assigned to a specific Carbon Copy entry.
CellCarrier: Short - CellCarrier ENUM; A value to indicate the cell phone carrier in order to send SMS text messages.
CellPhone: String(0,20); A Cell Phone number.
Company: String(0,50); A company name.
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.
CurrentRecoveryAnswer: String(0,50); The current RecoveryAnswer, required to match in order to process Password change.
Content: Byte(); A byte array representing the data in a Parcel. See Uploading & Downloading Files.
DataEMail: String(0,511); When the data is to be forwarded to an SMTP or X.400 system, the e-mail address is entered here. X.400 addresses are noted by using "X400:" to prefix the address as in "X400:c=us;a=ecgrid;p=testdata;"
Description: String(3,35); The name associated with a Qualifier/ID pair.
ECGridID: Integer; A value representing a routeable address on ECGrid. See ECGridIDs.
ECGridID1: Integer; The ECGridID representing the Trading Partner requesting the Interconnect. See ECGridIDs.
ECGridID2: Integer; The ECGridID representing the Trading Partner being Interconnected to. See ECGridIDs.
ECGridIDFrom: Integer; The ECGridID representing the sending Trading Partner. See ECGridIDs.
ECGridIDTo: Integer; The ECGridID representing the receiving Trading Partner. See ECGridIDs.
ECGridIDCCFrom: Integer; The Trading Partner a Carbon Copy is to be sent from. See ECGridIDs.
ECGridIDCCTo: Integer; The Trading Partner a Carbon Copy is to be sent to. See 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.
Email: String(1,50); A valid Email address.
EMailTo: Short - eMailTo ENUM; A flag to indicate to whom a note or update should be emailed.
EndDate: Date; The date & time to end a report. All dates are in UTC. See NowUTC().
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.
ID: String(1,35); The X12 or EDIFACT ID for the ISA and UNB segments.
InterchangeControlID: String(0,40); Optional value to match the Interchange Control ID for the Interchange.
InterchangeHeader: String; A valid ISA or UNB segment.
InterchangeID: Long; A value representing a specific Interchange within ECGrid.
InterconnectID: Integer; The value assigned to a specific Interconnect request.
LastName: String(1,50); A user's last name.
LoginName: String(8,16); A user's login name.
MailbagControlID: String(0,15); Optional value to match the X12.56 Mailbag Control ID for the Parcel.
MailboxID: Integer; The ECGrid MailboxID assigned to the ID on the specified network.
Managed: Boolean; Whether or not ECGrid is to manage the Mailbox.
MaxDays: Short; The maximum number of days a report should go back from today.
Minutes: Short; Number of minutes.
MaxRecords: Short; The maximum number of records to be returned by the API call.
Month: Date; The month for the report. Must be the 1st of the month such as 11/01/2008.
MoveDateTime: Date; 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(i,j); 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.
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.
OldPassword: String(8,32); Must match current session password.
OtherEMailAddress: String(0,48); A valid e-mail address outside of a system User address.
PageNo: Short; Selects page of records to return for certain function, used in conjunction with RecordsPerPage. A value of -1 indicates to return all records.
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.
Period: Short - StatisticsPeriod ENUM; A numeric value representing the sampling interval.
Phone: String(0,20); A phone number.
Qualifier: String(0,3); The X12 or EDIFACT ID Qualifier for the ISA and UNB segments.
RecordsPerPage: Short; Selects number of records to return for certain function, used in conjunction with PageNo. A value of -1 indicates to return all records.
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.
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.
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 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.
Status: Short - StatusInterconnect ENUM; A numeric value representing the Interconnect's status.
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.
TargetTime: Date; This indicates the inital or final time for the report based on whether NumPeriods is positive or negative.
TransactionSet: String(0,20); String to match the Transaction Set type, standard dependant.
UserID: Integer; A numeric value used to represent a specific user on the system.

ECGrid is a registered service mark of Loren Data Corp.
ECGridOS is a service mark of Loren Data Corp.