-
Notifications
You must be signed in to change notification settings - Fork 2
Class Properties
CrystalKLD edited this page Apr 15, 2024
·
54 revisions
String
The account for this entity.
Integer
A UserIDInfo Object to represent the user of this entity for Accounting.
String(0,511)
Acknowledgment for this entity.
Integer
The number of actual bytes.
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.
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.
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.
Integer
The alias MailboxID assigned to a within a Network on ECGrid.
Integer
The alias NetworkID assigned on ECGrid.
An ENUM to represent the API Call for session event.
String
The application for this entity.
String
The application log file for this entity.
Short
The application timeout for this entity.
Short
The number of archive days.
Short
The number of external archive days.
Short
The number of internal archive days.
String
An AS2 ID used for an entity.
An attachment associated with a note.
An ENUM to represent the Authority Level for system access.
System.DateTime
If DateTime to begin or start using an entity.
String
The name of a contact person for billing.
String
The email address of a contact person for billing.
Integer
The value assigned to a specific Billing User entity.
Short
The value assigned to a specific Billing Type for the entity.
Short
The value assigned to the Block Size for the entity.
Integer
The number of bytes for this entity.
Integer
The value assigned to a specific Carbon Copy entity.
An ECGridIDInfo Object matching the Carbon Copy interchange Sender.
An ECGridIDInfo Object matching the Carbon Copy interchange Receiver.
A ENUM to indicate the cell phone carrier in order to send SMS text messages.
String(0,20)
A cell phone number.
An array of CertificateInfo objects for the certificates of an entity.
A Network Gateway Comm Channel ENUM of an entity.
String
Related comments logged in the system.
Integer
The CommID assigned to a AS2 Communication within a Mailbox within a Network on ECGrid.
System.DateTime
The DateTime an entity was commissioned.
String(0,50)
A company name.
System.DateTime
The DateTime an entity was completed.
Boolean
If an entity requires data to be compressed or not.
The Mailbox configuration object.
A Network Gateway Connection ENUM of an entity.
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.
A UserIDInfo Object to represent the contact user of this entity.
byte[]
The base 64 byte array for the entity content.
Integer
The value assigned to a specific Contract entity.
Short
The number of records or entities.
System.DateTime
The DateTime an entity was created.
Integer
A UserIDInfo Object to represent the user of this entity for Customer Service.
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;"
System.DateTime
The DateTime for the session event.
Short
The Database Maximum Open Cycles for this entity.
Short
The Database Maximum Open Seconds for this entity.
System.DateTime
The DateTime an entity was decommissioned.
String
The Default AS2 ID used for an entity.
Boolean
A flag indicating if the parcels are to be deleted on download is enabled for this Mailbox.
String(3,35)
The name associated with a Qualifier/ID pair.
A freeform value describing the log entry.
ENUM Indicating whether this was posted to an InBox or OutBox.
String
The EDI document transaction try.
Boolean
A flag indicating if EBCDIC Filtering is enabled for this Mailbox.
Contact NetOps for more information if you require this filter.
Boolean
Flag to identify if this is an ECGrid Account.
Integer
A value representing a route-able address on ECGrid.
An Array of ECGridIDInfo entities.
String
The version of the current ECGridOS API.
System.DateTime
The date/time (UTC) the record becomes active.
Byte (0-127)
Allows the forced translation of the X12 Element Separator.
A decimal representation of an ASCII character; the value of 0 is used to signify no translation.
String(1,50)
A valid Email address.
Boolean
If an entity requires data to be encrypted or not.
String[]
The Encryption Domain array for this VPN entity.
An ENUM to represent the Encryption Method.
System.DateTime
If DateTime to end or stop using an entity.
System.DateTime
If DateTime when the Session ended.
Short
The value assigned to the MB per Environment for the entity.
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.
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.
Integer
A UserIDInfo Object to represent the user of this entity for errors.
SessionEvents Object Array of this session entity.
System.DateTime
The date/time (UTC) the record terminates.
String
The external inbound directory for this entity.
String
The external outbound directory for this entity.
String
The external root directory for this entity.
String
The date of the file.
String
The name of the file.
String(1,50)
A user's first name.
Short
The gateway frequency for this entity.
Boolean
A flag indicating if FTP ASCII Filtering is enabled for this Mailbox.
Contact NetOps for more information if you require this filter.
The NetworkFTPInfo Client object for this entity.
The NetworkFTPInfo Server object for this entity.
A Network Gateway Object to represent of this entity.
A Network Gateway Handshake ENUM of an entity.
String
The EDI envelope header ISA or UNB.
String
Uniform Resource Locator: a specific web home page or file on the internet.
Boolean
If an entity is hosted on ECGrid or not.
A HTTPAuthInfo Object to represent the HTTP authorization information of an entity.
String(1,35)
The X12 or EDIFACT ID for the ISA and UNB segments.
String
The Unique AS2 Identifier to be used for an entity.
String
The InBox Pattern assigned to this entity.
Short
The number of minutes the system should wait before sending out an e-mail notice of pending Parcels to download.
String
The envelope control number for this interchange entity.
System.DateTime
The date/time for this interchange.
Long
The value assigned to a specific Interchange entity.
A InterchangeIDInfo Object Collection of an entity.
System.DateTime
The date/time this interchange was processed.
A InterchangeIDInfo Object Collection of an entity.
Integer
The serial/ID number assigned to the specific Interchange Note.
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.
String(0,48)
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.
Integer
The value assigned to a specific Interconnect request.
Integer
The serial/ID number assigned to the specific Interconnect Note.
Integer
A UserIDInfo Object to represent the user of this entity for innerconnects.
String
The internal directory for this entity.
String
The name of a contact person for an Invoice.
String
The email address of a contact person for an Invoice.
String String[]
The Internet Protocol (IP) address for this entity.
System.DateTime
The last date/time there was activity on this Network or the channel process checked in.
String(1,50)
A user's last name.
Latest log entry for this Network entity.
System.DateTime
The last date/time this User logged in.
System.DateTime
The last DateTime the an entity had traffic.
System.DateTime
The last DateTime the an entity had inbound traffic.
System.DateTime
The last DateTime the an entity had outbound traffic.
String(1,50)
This is a legacy configuration for a Network Password and to be deprecated.
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.
System.DateTime
The date/time of the local status.
String
The local tunnel for this VPN entity.
String(0,255)
The address of the Network.
Boolean
Whether or not the User is currently locked out.
A ManifestInfo Object Collection of an entity.
System.DateTime
The timestamp for the log entry.
String
The logical directory for this entity.
Integer
The log identifier.
String(8,16)
A user's login name.
String
Uniform Resource Locator: a specific web login page or file on the internet.
Boolean
A flag indicating if Low Pass Filtering is enabled for this Mailbox.
Contact NetOps for more information if you require this filter.
String
The X12.56 Mailbag Number if applied to this Parcel.
Boolean
A flag indicating if ECGrid's exclusive X12.56 Mailbag Pass Through is enabled for this Mailbox.
Contact NetOps for more information if you require this filter.
Boolean
true if this mailbox is the default, False if it is not.
Integer
The MailboxID assigned to a Mailbox within a Network on ECGrid.
Integer
The MailboxID the entity is from.
Integer
The MailboxID the entity is to.
String(3,40)
The name of the Mailbox.
String(3,40)
The name of the Mailbox the entity is from.
String(3,40)
The name of the Mailbox the entity is to.
String
The list of e-mail addresses the note was sent to.
Boolean
Flag to identify if the mailbox is managed
System.DateTime
The date/time this transaction occurred (UTC).
String
A Master Account for this entity.
Short
The Maximum Batches for this entity.
Short
The Maximum Threads for this entity.
Integer
The execution time for the call.
String
The Multipurpose Internet Mail Extension to convert to in order to supersede/override the original.
Short
The Gateway Minimum Polling for this entity.
System.DateTime
The DateTime an entity was last modified.
String
An entity or object name.
The ECGrid Network Operations technician assigned to the request. This is only partially implemented for v2.0 for backwards compatibility.
A NetOpsInfo Object to of this entity.
Integer
The NetworkID assigned to a Network on ECGrid.
Integer
The NetworkID the entity is from.
Integer
The NetworkID the entity is to.
String(0,40)
The name of the Network.
String(0,40)
The name of the Network the entity is from.
String(0,40)
The name of the Network the entity is to.
An ENUM to indicates operational status and outage condition
String(0,250)
The text of the Note itself.
System.DateTime
The date/time the Note was posted to the system (UTC).
Integer
A UserIDInfo Object to represent the user of this entity for notices.
Short
Number of current open sessions for this User.
An ECGridIDInfo Object matching the Original interchange Sender.
An ECGridIDInfo Object matching the Original interchange Receiver.
String
The OutBox Pattern assigned to this entity.
Short
The value assigned to the outbox timeout for the entity.
A UserIDInfo Object to represent the owner of an entity.
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.
Integer
A UserIDInfo Object to represent the user of this entity for an owner.
Short
The page number.
Short
The size of the page.
Integer
The total number of bytes in the Parcel. This includes all interchanges and any X12.56 mailbag segments if present in the Parcel.
System.DateTime
The date/time the Parcel was uploaded or created on ECGrid (UTC).
Long
The value assigned to track a specific Parcel on ECGrid.
An ParcelIDInfo Object array for this entity.
Integer
The value assigned to track a specific Parcel Note.
An ParcelIDInfo Object collection for this interchange.
String
The password for this entity.
String(0,20)
A phone number.
String
The name of the person or system that posted the note.
Integer
The value assigned to a specific Pricelist entity.
Integer
The value assigned to a specific Process entity.
String(0,3)
The X12 or EDIFACT ID Qualifier for the ISA and UNB segments.
An ENUM to represent the Type of Receipt to use for an entity.
String(0,16)
A user defined question used to restore lost password or to activate an account with too many failed logins.
String(0,50)
A user-defined reference number to attach to a Interconnect request for TP.
String
The remote tunnel for this VPN entity.
Integer
A UserIDInfo Object to represent the user of this entity for reports.
A UserIDInfo Object to represent the requestor of this entity.
An ENUM to indicate the return code result for the call.
An ENUM to represent the routing of an entity.
An ENUM to represent the routing group an entity.
Integer
A numeric value to represent the user of this entity for routing.
String
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.
String
The run directory for this entity.
An ENUM to represent the entry's current running status.
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.
String
The server assigned to this entity.
Integer
The session event identifier for this entity.
String - GUID
The current session's GUID in string format.
String
The Shared Secret for this VPN entity.
Boolean
If an entity requires data to have a digital signature or not.
String
The Software Version for this entity.
Boolean
If an entity requires SSL Client Authentication or not.
An ENUM to represent the EDI Standard of an entity.
System.DateTime
If DateTime when the Session started.
An ENUM to represent the status an entity.
String
Interchange Status Code for this entity. Parcel Status Code for this entity.
String
Color representation for the status of this entity.
System.DateTime
The date/time for this Status.
String
Interchange Status Message for this entity. Parcel Status Message for this entity.
Boolean
A flag indicating if the non EDI file/parcel envelopes add are to be stripped for this Mailbox.
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.
String
Uniform Resource Locator: a specific web support page or file on the internet.
String
Uniform Resource Locator: a specific web support page or file on the internet.
Boolean
Flag to suspend the pending interchanges for and interconnect or entity.
Short
The Time Out value.
Short
The number of minutes + or - the user local time is from UTC.
Short
The the total number of pages.
Integer
The the total number of records.
An ECGridIDInfo Object for the requesting Trading Partner.
An ECGridIDInfo Object matching the TP interchange Sender.
An ECGridIDInfo Object matching the TP interchange Receiver.
String(0,20)
String to match the Transaction Set type, standard dependent.
An ENUM to represent the type of this entity.
or
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.
String
Unique ID for an interconnect.
String
Uniform Resource Locator: a specific web page or file on the internet.
String
The user domain assigned to this entity.
Integer
A numeric value used to represent a specific user on the system. A value of zero indicates an internally generated entry.
String
The username assigned to this entity.
An ENUM to represent the type of use for an entity.
ENUM Indicating whether this Parcel was able to be processed completely.
String
The Version of the session ECGridOS API.
String
The virtual inbound directory for this entity.
String
The virtual outbound directory for this entity.
The VPN object for this entity.
Boolean
If an entity uses X1256 or not.
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