Return Values


CarbonCopyID
Integer
The value assigned to a specific Carbon Copy entry.
InterchangeDateTime
Date
The Date/Time of an Interchange derived from the Interchange Envelope ISA or UNB segment.
ECGridID
Integer The ECGridID is a unique identifier on the ECGrid Network specifying a handle to a specific Qualifier/ID pair on a specific Network/Mailbox.
InterchangeID
Long
A value representing a specific Interchange within ECGrid.
InterconnectID
Integer
The value assigned to a specific Interconnect request.
MailboxID
Integer
The MailboxID assigned to a Mailbox within a Network on ECGrid.
NetworkID
Integer
The NetworkID assigned to a Network on ECGrid.
ParcelID
Long
The value assigned to track a specific Parcel on ECGrid.
UserID
Integer
A numeric value used to represent a specific user on the system.

 

CarbonCopyIDInfo Object

CarbonCopyID
Integer
The value assigned to a specific Carbon Copy entry.
NetworkID
Integer
The NetworkID of the Network owning the Carbon Copy.
MailboxID
Integer
The MailboxID assigned to a Mailbox owning the Carbon Copy.
Created
Date
The date/time (UTC) the record was created.
Modified
Date
The date/time (UTC) the record was last modified.
Status
Short - ECGridOSv0200.Status ENUM
A numeric value representing the entry's status.
OriginalFrom
Object - ECGridIDInfo
An ECGridIDInfo Object matching the Original interchange Sender.
OriginalTo
Object - ECGridIDInfo
An ECGridIDInfo Object matching the Original interchange Receiver.
CCFrom
Object - ECGridIDInfo
An ECGridIDInfo Object matching the Carbon Copy interchange Sender.
CCTo
Object - ECGridIDInfo
An ECGridIDInfo Object matching the Carbon Copy interchange Receiver.
TransactionSet 
String(0,20)
String to match the Transaction Set type, standard dependant. 

 

ECGridIDInfo Object

ECGridID
Integer
A value representing a routeable address on ECGrid. See ECGridIDs.
NetworkID
Integer
The Network where this address is located.
NetworkName
String(0,40)
The name of the Network.
Qualifier
String(0,3)
The X12 or EDIFACT ID Qualifier for the ISA and UNB segments.
ID
String(1,35)
The X12 or EDIFACT ID for the ISA and UNB segments. 
Description
String(3,35)
The name associated with a Qualifier/ID pair. 
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;"
Status
Short - ECGridOSv0200.StatusECGrid ENUM
A numeric value representing the entry's status.
OwnerInfo
ECGridOwnerInfo - Object
The OwnerInfo object is only returned if the current UserID has sufficient ownership rights to this entry; otherwise, a value of Nothing is returned for this object. Network-level users can see this information for any ECGridID in any Mailbox on the Network. Mailbox-level users only see this information within their own mailbox.
NetworkID
Integer
The actually Network where this address is routed on ECGrid, may be different in the case of Redirection.
NetworkName
String(3,40)
The descriptive name of the Network.
MailboxID
Integer
The Mailbox where this address is routed on ECGrid.
MailboxName
String(3,40)
The descriptive nameoftheMailbox.
Created
Date
The date/time (UTC) the record was created.
Modified
Date
The date/time (UTC) the record was last modified.
Effective
Date
The date/time (UTC) the record becomes active. Used for migrations from one Network/Mailbox to another.
Expires
Date
The date/time (UTC) the record terminates. Used for migrations from one Network/Mailbox to another.
LastTraffic 
Date
The date/time (UTC) of the last traffic to/from this ECGridID.

 

FileInfo Object

ParcelID
Long
The value assigned to track a specific Parcel on ECGrid.
FileName
String(1,127)
The file name assigned to a Parcel. It will be stored on disk with this name.
FileDate
Date
The date/time stamp of the file (UTC).
Bytes
Integer
The number of bytes in the Parcel.
Content
Byte()
A byte array representing the data in the Parcel. See Uploading & Downloading Files.

 

InterchangeIDInfo Object

InterchangeID
Long
A value representing a specific Interchange within ECGrid.
InterchangeProcessDate
Date
The Date/Time an Interchange was processed into ECGrid. 
NetworkIDFrom
Integer
The NetworkID where the Parcel originated.
NetworkIDTo
Integer
The Parcel destination NetworkID.
Standard
String
The standard used for the outside envelope: X12 (ISA) or EDIFACT (UNB).
Bytes
Integer
The total number of bytes in the Interchange. This includes the envelope, but will not include any X12.56 mailbag segments if present in the Parcel.
InterchangeControlID
String
For X12 and EDIFACT this will be the control number
InterchangeDateTime
Date
The Date/Time of an Interchange derived from the Interchange Envelope ISA or UNB segment.
StatusDate
Date
The date/time this status was assigned (UTC).
StatusCode
String
The current status code associated with this Interchange. The 'E' prefix refers to the Interchange (Envelope). The suffix is a Short.
StatusMessage
String
The description of the Status Code.
DocumentType 
String
A listing of document type(s) in an interchange (e.g. 810, 850, INVOIC, ORDERS, etc.) 
Header
String
The complete X12 ISA or EDIFACT UNB for the interchange.
TPFrom
Object - ECGridIDInfo
An ECGridIDInfo Object for the Interchange Sender.
TPTo
Object - ECGridIDInfo
An ECGridIDInfo Object for the Interchange Receiver.

 

InterconnectIDInfo Object

InterconnectID
Integer
The value assigned to a specific Interconnect request.
Created
Date
The date/time (UTC) the record was created.
Modified
Date
The date/time (UTC) the record was last modified.
Completed
Date
The date/time (UTC) the Interconnect was completed.
LastTraffic 
Date
The date/time (UTC) of the last traffic between these trading partners.
ContactName
String(3,48)
The name of a contact person for the request.
ContactEMail
String(6,48)
The Email address of a contact person for the request.
Status
Short - StatusInterconnect ENUM
A numeric value representing the Interconnect's status.
TP1
Object - ECGridIDInfo
An ECGridIDInfo Object for the requesting Trading Partner.
Reference1
String(0,16)
A user-defined reference number to attach to a Interconnect request for TP1.
TP2
Object - ECGridIDInfo
An ECGridIDInfo Object for the Interconnect Trading Partner.
Reference2
String(0,16)
A user-defined reference number to attach to a Interconnect request for TP2.
NetOps
UserIDInfo
The ECGrid Network Operations technician assigned to the request. This is only partially implemented for v2.0 for backwards compatibility.

 

InterconnectNote Object

InterconnectID
Integer
The value assigned to a specific Interconnect request.
InterconnectNoteID
Integer
The serial number assigned to the specific Interconnect Note.
NoteDate
Date
The date/time the Note was posted to the system (UTC).
Status
Short - StatusInterconnect ENUM
A numeric value representing the Interconnect's status.
PostedBy
String
The name of the person or system that posted the note.
UserID
Integer
The UserID for the user account that posted the note. If posted by the system, the UserID will equal zero (0).
MailTo
String
The list of e-mail addresses the note was sent to.
Note
String(0,250)
The text of the Note itself.

 

MailboxIDInfo Object

MailboxID
Integer
The MailboxID assigned to this Mailbox. It is unique throughout ECGrid.
NetworkID
Integer
The Network where this Mailbox exists..
Name
String(3,40)
The descriptive name of the Mailbox.
Created
Date
The date/time (UTC) the record was created.
Modified
Date
The date/time (UTC) the record was last modified.
Status
Short - ECGridOSv0200.Status ENUM
A numeric value representing the Mailbox's current status.
OwnerUserID
Object - UserIDInfo
A UserIDInfo Object for the user having ownership of this Mailbox.
ErrorsUserID
Object - UserIDInfo
A UserIDInfo Object for the user to receive error messages.
InterconnectsUserID
Object - UserIDInfo
A UserIDInfo Object for the user to receive Interconnect messages.
NoticesUserID
Object - UserIDInfo
A UserIDInfo Object for the user to receive administrative ECGrid messages.
Managed
Boolean 
Whether or not ECGrid manages the Mailbox (default=true). 
Config
Object - MailboxConfig
InBoxTimeout
Short
The number of minutes the system should wait before sending out an e-mail notice of pending Parcels to download.
SegTerm
Byte (0-127)
Allows forced translation of the X12 Segment Terminator.
A decimal representation of an ASCII character; the value of 0 is used to signify no translation.
ElmSep
Byte (0-127)
Allows forced translation of the X12 Element Separator.
A decimal representation of an ASCII character; the value of 0 is used to signify no translation.
SubElmSep
Byte (0-127)
Allows the forced translation of the X12 Subelement Separator.
A decimal representation of an ASCII character; the value of 0 is used to signify no translation.
EBCDICFilter
Boolean
A flag indicating if EBCDIC Filtering is enabled for this Mailbox.
Contact NetOps for more information if you require this filter.
FTPasciiFilter
Boolean
A flag indicating if FTP ASCII Filtering is enabled for this Mailbox.
Contact NetOps for more information if you require this filter.
LowPassFilter
Boolean
A flag indicating if Low Pass Filtering is enabled for this Mailbox.
Contact NetOps for more information if you require this filter.
MailbagPassThrough
Boolean
A flag indicating if ECGrid's exclusive X12.56 Mailbag Pass Through is enabled for this Mailbox.
Contact NetOps for more information.
AS2Info 
Object - AS2Info
ID
String
The entities AS2 Identifier 
URL
String
URL stuff
Certificate
String
The actual public certificate string. 
CertificateActive
Date
The date/time that the indicated certificate began production use.
CertificateExpires
Date
The expiration date/time for the indicated certificate.

 

ManifestInfo Object

ManifestID
Long
The serial number for this Manifest transaction.
ManifestDate
Date
The date/time this transaction occurred (UTC).
NetworkID
Integer
The NetworkID of the system posting the Manifest transaction.
NetworkName
String(0,40)
The name of the system posting the Manifest transaction.
ParcelID
Long
The Parcel referenced by the Manifest.
InterchangeID
Long
The Interchange referenced by the Manifest.
StatusCode
String
The process status code associated with this Manifest. An 'M' prefix refers to the Parcel (Mailbag) and an 'E' prefer refers to the Interchange (Envelope). The suffix is a Short.
StatusMessage
String
The description of the Status Code.

 

NetworkIDInfo Object

NetworkID
Integer
The NetworkID assigned to a Network on ECGrid.
Name
String(3,40)
The descriptive name of the Network.
Location
String(0,255)
The address of the Network.
AdminContact
String(0,80)
The name of the Network's administrative contact.
This is a legacy configuration and to be deprecated in the next version and replaced with UserIDs.
AdminPhone
String(0,80)
The phone number for the Network's administrative contact.
This is a legacy configuration and to be deprecated in the next version and replaced with UserIDs.
AdminEMail
String(0,80)
The email address of the Network's administrative contact.
This is a legacy configuration and to be deprecated in the next version and replaced with UserIDs.
LastContact 
Date
The last date/time there was activity on this Network or the channel process checked in.
Type
Short - ECGridOSv0200.NetworkType ENUM
A public descriptor of the Network type, (e.g. Network, Router). A more detailed value is available to owners in the OwnerInfo subclass.
Status
Short - ECGridOSv0200.Status ENUM
A numeric value representing the entry's status.
RunStatus
Short - ECGridOSv0200.NetworkRunStatus ENUM
A numeric value representing the entry's current running status.
NetworkStatus
Short - ECGridOSv0200.NetworkStatus ENUM
Indicates operational status and outage condition.
LastLog 
Object - NetworkLog
Latest log entry for this Network 
LogID
Integer 
The log identifier. 
LogDate 
Date 
The timestamp for the log entry. 
UserID 
Integer 
The UserID of the person responsible for the entry. A value of zero indicates an internally generated entry. 
Type 
Short - ECGridOSv0200.NetworkLogType ENUM 
Indicates whether the entry is system or user generated.
Status 
Short - ECGridOSv0200.NetworkLogStatus ENUM 
The action that generated this log entry.
AuthLevel 
Short - ECGridOSv0200.AuthLevel ENUM 
Minimum authorization level to view this entry.
Description 
String 
A freeform value describing the log entry. 
AS2Info 
Object - AS2Info
Key AS2 connectivity parameters.
ID
String
The entities AS2 Identifier 
URL
String
URL stuff
Certificate
String
The actual public certificate string. 
CertificateActive
Date
The date/time that the indicated certificate began production use.
CertificateExpires
Date
The expiration date/time for the indicated certificate.
OwnerInfo
NetworkOwnerInfo - Object
The OwnerInfo object is only returned if the current UserID has sufficient ownership rights to this entry; otherwise, a value of Nothing is returned for this object.
Type
String(3)
A short string code to represent the internal Network Type within ECGrid. A few examples are below.
VAN - Value Added Network
SVC - Electronic Commerce Service Provider
NET - Special network service.
INT - Internal routing service.
MBX - Legacy direct connected mailbox.
RoutingType
String(1)
Used for automating Interconnects. Represents the model that the Network uses to route between Trading Partners.
A,B - Routing based on Receiver QID only.
C - Routing based on Sender/Receiver QID pairs.
E - ECGrid manages routing.
InterconnectContact
String(0,48)
The name of the entity receiving Interconnect requests and related issues.
This is a legacy configuration and to be deprecated in the next version and replaced with UserIDs.
InterconnectEMail
String(0,80)
The email address of the entity receiving Interconnect requests and related issues.
This is a legacy configuration and to be deprecated in the next version and replaced with UserIDs.
ErrorContact
String(0,80)
The name of the entity receiving error messages.
This is a legacy configuration and to be deprecated in the next version and replaced with UserIDs.
ErrorEMail
String(0,80)
The email address of the entity receiving error messages.
This is a legacy configuration and to be deprecated in the next version and replaced with UserIDs.
Config
Object - MailboxConfig
InBoxTimeout
Short
The number of minutes the system should wait before sending out an e-mail notice of pending Parcels to download.
SegTerm
Byte (0-127)
Allows forced translation of the X12 Segment Terminator.
A decimal representation of an ASCII character; the value of 0 is used to signify no translation.
ElmSep
Byte (0-127)
Allows forced translation of the X12 Element Separator.
A decimal representation of an ASCII character; the value of 0 is used to signify no translation.
SubElmSep
Byte (0-127)
Allows the forced translation of the X12 Subelement Separator.
A decimal representation of an ASCII character; the value of 0 is used to signify no translation.
EBCDICFilter
Boolean
A flag indicating if EBCDIC Filtering is enabled for this Network.
Contact NetOps for more information if you require this filter.
FTPasciiFilter
Boolean
A flag indicating if FTP ASCII Filtering is enabled for this Network.
Contact NetOps for more information if you require this filter.
LowPassFilter
Boolean
A flag indicating if Low Pass Filtering is enabled for this Network.
Contact NetOps for more information if you require this filter.
MailbagPassThrough
Boolean
A flag indicating if ECGrid's exclusive X12.56 Mailbag Pass Through is enabled for this Network.
Contact NetOps for more information.

 

ParcelIDInfo Object

ParcelID
Long
The value assigned to track a specific Parcel on ECGrid.
ParcelBytes
Integer
The total number of bytes in the Parcel. This includes all interchanges and any X12.56 mailbag segments if present in the Parcel.
ParcelDate
Date
The date/time the Parcel was uploaded or created on ECGrid (UTC).
NetworkIDFrom
Integer
The NetworkID where the Parcel originated.
NetworkNameFrom
String(3,40)
The descriptive name of the Network.
MailboxIDFrom
Integer
The MailboxID where theParcel originated.
NetworkIDTo
Integer
The Parcel destination NetworkID.
NetworkNameTo
String(3,40)
The descriptive name of the Network.
MailboxIDTo
Integer
The Parcel destination MailboxID.
FileName
String(1,127)
The file name assigned to a Parcel. It will be stored on disk with this name.
MailbagControlID
String(0,9)
The X12.56 Mailbag Number if applied to this Parcel.
StatusDate
Date
The date/time this status was assigned (UTC).
StatusCode
String
The current status code associated with this Parcel. The 'M' prefix refers to the Parcel (Mailbag). The suffix is a Short.
StatusMessage
String
The description of the Status Code.
LocalStatus 
Short 
This is a status set by the developer to indicate local disposition of the Parcel. The default is 0. Values 0-31 are reserved for ECGridOS designated common values.
Valid 
Short - ECGridOSv0200.ParcelValid ENUM
Indicating whether this Parcel was able to be processed completely.
Direction
Short - ECGridOSv0200.Direction ENUM
Indicating whether this Parcel was posted to an InBox or OutBox.
Interchanges
Object Collection - InterchangeIDInfo
The list of Interchanges within the Parcel.

 

ParcelNote Object

ParcelID
Long
The value assigned to a specific Parcel.
ParcelNoteID
Integer
The serial number assigned to the specific Parcel Note.
InterchangeID
Integer
The serial number assigned to a referenced Interchange, can be zero (0).
NoteDate
Date
The date/time the Note was posted to the system (UTC).
StatusCode
String
The current status code associated with this Parcel. The 'M' prefix refers to the Parcel (Mailbag). The suffix is a Short.
PostedBy
String
The name of the person or system that posted the note.
UserID
Integer
The UserID for the user account that posted the note. If posted by the system, the UserID will equal zero (0).
Note
String(0,255)
The text of the Note itself.

 

SessionInfo Object

ECGridOSVersion 
String
The version of the current ECGridOS API.
SessionID
String - GUID
The current session's GUID in string format.
UserID
Integer
A numeric value used to represent a specific user on the system.
LoginName
String(8,16)
A user's login name.
FirstName
String(1,50)
A user's first name.
LastName
String(1,50)
A user's last name.
Company
String(0,50)
A company name.
Email
String(1,50)
A valid Email address.
Phone
String(0,20)
A phone number.
TimeZoneOffset 
Short
The number of minutes + or - the user local time is from UTC.
AuthLevel
Short - AuthLevel ENUM
The Authority Level for system access.
LastLogin
Date
The last date/time this User logged in.
OpenSessions
Short
The number of current open session for this User.
TimeOut
Short
The maximum number of seconds between calls in a session before it automatically times out.
NetworkID
Integer
The NetworkID assigned to Network on ECGrid.
MailboxID
Integer
The MailboxID assigned to a Mailbox within a Network on ECGrid.
ip
String
The IP address for the current session.

 

SessionLog Object

SessionID
String - GUID
The current session's GUID in string format.
StartTime 
Date 
When the Session started with a Login.
EndTime 
Date 
When the Session was ended with a Logout
Expires
Date 
When the Session will or did expire due to inactivity. 
NetworkID
Integer
The NetworkID assigned to Network on ECGrid.
MailboxID
Integer
The MailboxID assigned to a Mailbox within a Network on ECGrid.
UserID
Integer
A numeric value used to represent a specific user on the system.
Status
Short - SessionStatus 
Whether the Session is currently Open, Closed or Expired.
Events 
Object Collection - SessionEvents 
A listnig off all calls made during the Session. 
SessionEvents Object 
APICall 
Short - APICall ENUM
The name of the ECGridOS function call.
Date 
Date 
The date/time stamp for the call. 
Milliseconds 
Integer 
The execution time for the call 
ip
String
The IP address for the current session.
ReturnCode 
Short - RetCode ENUM
The return code result for the call
Comment 
String 
Related comments logged in the system.

 

UserIDInfo Object

UserID
Integer
A numeric value used to represent a specific user on the system.
LoginName
String(8,16)
A user's login name.
RecoveryQuestion
String(0,50)
A user defined question used to restore lost password or to activate an account with too many failed logins.
FirstName
String(1,50)
A user's first name.
LastName
String(1,50)
A user's last name.
Company
String(0,50)
A company name.
Email
String(1,50)
A valid Email address.
Phone
String(0,20)
A phone number.
CellPhone
String(0,20)
A Cell Phone number.
CellCarrier
Short - CellCarrier ENUM
A value to indicate the cell phone carrier in order to send SMS text messages.
TimeZoneOffset 
Short
The number of minutes + or - the user local time is from UTC.
NetworkID
Integer
The NetworkID assigned to Network on ECGrid.
MailboxID
Integer
The MailboxID assigned to a Mailbox within a Network on ECGrid.
AuthLevel
Short - AuthLevel ENUM
The Authority Level for system access.
Created
Date
The date/time (UTC) the record was created.
Modified
Date
The date/time (UTC) the record was last modified.
LastLogin
Date
The last date/time this User logged in.
Status
Short - ECGridOSv0200.Status ENUM
A numeric value representing the entry's status.
LockedOut
Boolean 
Whether or not the User is currently locked out.
OpenSessions
Short 
Number of current open sessions for this User.


© 2008-2011, Loren Data Corp.
All rights reserved.
ECGrid is a registered service mark of Loren Data Corp.
ECGridOS is a service mark of Loren Data Corp.