Class Properties

Greg Kolinski edited this page Nov 28, 2017 · 53 revisions

Back To Appendix Home


Account

String

The account for this entity.  

AccountingUserID

Integer

UserIDInfo

 A UserIDInfo Object to represent the user of this entity for Accounting. 

Acknowledgment

String(0,511)

 Acknowledgment for this entity.

ActualBytes

Integer

 The number of actual bytes. 

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.  

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.  

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.  

AliasMailboxID

Integer

 The alias MailboxID assigned to a within a Network on ECGrid. 

AliasNetworkID

Integer

 The alias NetworkID assigned on ECGrid. 

APICall

APICall

 An ENUM to represent the API Call for session event. 

Application

String

The application for this entity.  

ApplicationLogFile

String

The application log file for this entity.  

ApplicationTimeOut

Short

The application timeout for this entity.  

ArchiveDays

Short

 The number of archive days. 

ArchiveDaysExternal

Short

 The number of external archive days. 

ArchiveDaysInternal

Short

 The number of internal archive days. 

AS2ID

String

 An AS2 ID used for an entity. 

Attachment

NoteAttachment

 An attachment associated with a note. 

AuthLevel

AuthLevel

 An ENUM to represent the Authority Level for system access. 

BeginUsage

System.DateTime

 If DateTime to begin or start using an entity. 

BillingContact

String

 The name of a contact person for billing. 

BillingEMail

String

 The email address of a contact person for billing. 

BillingUserID

Integer

 The value assigned to a specific Billing User entity. 

BillingType

Short

 The value assigned to a specific Billing Type for the entity. 

BlockSize

Short

 The value assigned to the Block Size for the entity. 

Bytes

Integer

 The number of bytes for this entity. 

CarbonCopyID

Integer

 The value assigned to a specific Carbon Copy entity. 

CCFrom

ECGridIDInfo

 An ECGridIDInfo Object matching the Carbon Copy interchange Sender. 

CCTo

ECGridIDInfo

 An ECGridIDInfo Object matching the Carbon Copy interchange Receiver. 

CellCarrier

CellCarrier

 A ENUM to indicate the cell phone carrier in order to send SMS text messages. 

CellPhone

String(0,20)

 A cell phone number. 

Certificates

CertificateInfo[]

 An array of CertificateInfo objects for the certificates of an entity. 

CommChannel

NetworkGatewayCommChannel

 A Network Gateway Comm Channel ENUM of an entity. 

Comment

String

 Related comments logged in the system. 

CommID

Integer

 The CommID assigned to a AS2 Communication within a Mailbox within a Network on ECGrid.

Commissioned

System.DateTime

 The DateTime an entity was commissioned. 

Company

String(0,50)

 A company name. 

Completed

System.DateTime

 The DateTime an entity was completed. 

CompressData

Boolean

 If an entity requires data to be compressed or not. 

Config

MailboxConfig

 The Mailbox configuration object. 

Connection

NetworkGatewayConnection

 A Network Gateway Connection ENUM of an entity. 

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. 

ContactUser

UserIDInfo

 A UserIDInfo Object to represent the contact user of this entity. 

Content

byte[]

 The base 64 byte array for the entity content. 

ContractID

Integer

 The value assigned to a specific Contract entity. 

Count

Short

 The number of records or entities. 

Created

System.DateTime

 The DateTime an entity was created. 

CustomerServiceUserID

Integer

UserIDInfo

 A UserIDInfo Object to represent the user of this entity for Customer Service. 

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;" 

Date

System.DateTime

 The DateTime for the session event. 

dbOpenMaxCycles

Short

 The Database Maximum Open Cycles for this entity. 

dbOpenMaxSeconds

Short

 The Database Maximum Open Seconds for this entity.

Decommissioned

System.DateTime

 The DateTime an entity was decommissioned. 

DefaultAS2ID

String

 The Default AS2 ID used for an entity. 

DeleteOnDownload

Boolean

A flag indicating if the parcels are to be deleted on download is enabled for this Mailbox. 

Description

String(3,35)

 The name associated with a Qualifier/ID pair. 

 A freeform value describing the log entry. 

Direction

Direction

ENUM Indicating whether this was posted to an InBox or OutBox. 

DocumentType

String

 The EDI document transaction try. 

EBCDICFilter

Boolean

A flag indicating if EBCDIC Filtering is enabled for this Mailbox. 
Contact NetOps for more information if you require this filter. 

ECGridAccount

Boolean

 Flag to identify if this is an ECGrid Account.

ECGridID

Integer

 A value representing a route-able address on ECGrid.

ECGridIDInfoList

ECGridIDInfo

 An Array of ECGridIDInfo entities. 

ECGridOSVersion

String

The version of the current ECGridOS API. 

Effective

System.DateTime

 The date/time (UTC) the record becomes active.

ElmSep

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. 

Email

String(1,50)

 A valid Email address. 

EncryptData

Boolean

 If an entity requires data to be encrypted or not. 

EncryptionDomain

String[]

 The Encryption Domain array for this VPN entity. 

EncryptionMethod

NetworkVPNEncryptionMethod

 An ENUM to represent the Encryption Method. 

EndUsage

System.DateTime

 If DateTime to end or stop using an entity. 

EndTime

System.DateTime

 If DateTime when the Session ended.

EnvPerMB

Short

 The value assigned to the MB per Environment for the entity. 

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.  

ErrorsUserID

Integer

UserIDInfo

 A UserIDInfo Object to represent the user of this entity for errors. 

Events

SessionEvents[]

 SessionEvents Object Array of this session entity. 

Expires

System.DateTime

 The date/time (UTC) the record terminates.

ExternalDirectoryIn

String

 The external inbound directory for this entity. 

ExternalDirectoryOut

String

 The external outbound directory for this entity. 

ExternalDirectoryRoot

String

 The external root directory for this entity. 

FileDate

String

 The date of the file. 

FileName

String

 The name of the file. 

FirstName

String(1,50)

 A user's first name. 

Frequency

Short

The gateway frequency for this entity.  

FTPasciiFilter

Boolean

A flag indicating if FTP ASCII Filtering is enabled for this Mailbox. 
Contact NetOps for more information if you require this filter. 

FTPClient

NetworkFTPInfo

The NetworkFTPInfo Client object for this entity. 

FTPServer

NetworkFTPInfo

The NetworkFTPInfo Server object for this entity. 

Gateway

NetworkGateway

 A Network Gateway Object to represent of this entity. 

Handshake

NetworkGatewayHandshake

 A Network Gateway Handshake ENUM of an entity. 

Header

String

 The EDI envelope header ISA or UNB.

HomeWebsite

String

 Uniform Resource Locator: a specific web home page or file on the internet. 

Hosted

Boolean

 If an entity is hosted on ECGrid or not. 

HTTPAuthentication

HTTPAuthInfo

 A HTTPAuthInfo Object to represent the HTTP authorization information of an entity. 

ID

String(1,35)

 The X12 or EDIFACT ID for the ISA and UNB segments.

Identifier

String

 The Unique AS2 Identifier to be used for an entity.

InBoxPattern

String

 The InBox Pattern assigned to this entity. 

InBoxTimeout

Short

 The number of minutes the system should wait before sending out an e-mail notice of pending Parcels to download.

InterchangeControlID

String

 The envelope control number for this interchange entity. 

InterchangeDateTime

System.DateTime

 The date/time for this interchange.

InterchangeID

Long

 The value assigned to a specific Interchange entity. 

InterchangeIDInfoList

InterchangeIDInfo[]

 A InterchangeIDInfo Object Collection of an entity. 

InterchangeProcessDate

System.DateTime

 The date/time this interchange was processed.

Interchanges

InterchangeIDInfo[]

 A InterchangeIDInfo Object Collection of an entity. 

InterchangeNoteID

Integer

 The serial/ID number assigned to the specific Interchange Note.  

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,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. 

InterconnectID

Integer

 The value assigned to a specific Interconnect request. 

InterconnectNoteID

Integer

 The serial/ID number assigned to the specific Interconnect Note.  

InterconnectsUserID

Integer

UserIDInfo

 A UserIDInfo Object to represent the user of this entity for innerconnects. 

InternalDirectory

String

 The internal directory for this entity. 

InvoiceContact

String

 The name of a contact person for an Invoice. 

InvoiceEMail

String

 The email address of a contact person for an Invoice. 

IP

String String[]

The Internet Protocol (IP) address for this entity.  

LastContact

System.DateTime

 The last date/time there was activity on this Network or the channel process checked in. 

LastName

String(1,50)

 A user's last name. 

LastLog

NetworkLog

 Latest log entry for this Network entity.

LastLogin

System.DateTime

 The last date/time this User logged in.

LastTraffic

System.DateTime

 The last DateTime the an entity had traffic. 

LastTrafficInbound

System.DateTime

 The last DateTime the an entity had inbound traffic. 

LastTrafficOutbound

System.DateTime

 The last DateTime the an entity had outbound traffic. 

LegacyPassword

String(1,50)

 This is a legacy configuration for a Network Password and to be deprecated.


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.


LocalStatusDate

System.DateTime

The date/time of the local status.


LocalTunnel

String

 The local tunnel for this VPN entity. 

Location

String(0,255)

 The address of the Network. 

LockedOut

Boolean

 Whether or not the User is currently locked out. 

Log

ManifestInfo[]

 A ManifestInfo Object Collection of an entity. 

LogDate

System.DateTime

The timestamp for the log entry.


LogicalDirectory

String

 The logical directory for this entity. 

LogID

Integer

 The log identifier. 

LoginName

String(8,16)

 A user's login name. 

LoginWebsite

String

 Uniform Resource Locator: a specific web login page or file on the internet. 

LowPassFilter

Boolean

A flag indicating if Low Pass Filtering is enabled for this Mailbox. 
Contact NetOps for more information if you require this filter. 

MailbagControlID

String

 The X12.56 Mailbag Number if applied to this Parcel. 

MailbagPassThrough

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. 

MailboxDefault

Boolean

 true if this mailbox is the default, False if it is not.

MailboxID

Integer

 The MailboxID assigned to a Mailbox within a Network on ECGrid. 

MailboxIDFrom

Integer

 The MailboxID the entity is from. 

MailboxIDTo

Integer

 The MailboxID the entity is to. 

MailboxName

String(3,40)

 The name of the Mailbox. 

MailboxNameFrom

String(3,40)

 The name of the Mailbox the entity is from. 

MailboxNameTo

String(3,40)

 The name of the Mailbox the entity is to. 

MailTo

String

 The list of e-mail addresses the note was sent to.  

Managed

Boolean

 Flag to identify if the mailbox is managed

ManifestDate

System.DateTime

 The date/time this transaction occurred (UTC). 

MasterAccount

String

 A Master Account for this entity. 

MaxBatch

Short

 The Maximum Batches for this entity. 

MaxThreads

Short

 The Maximum Threads for this entity. 

Milliseconds

Integer

The execution time for the call.  

MimeTypeOverride

String

 The Multipurpose Internet Mail Extension to convert to in order to supersede/override the original. 

MinimumPolling

Short

The Gateway Minimum Polling for this entity.  

Modified

System.DateTime

 The DateTime an entity was last modified. 

Name

String

 An entity or object name. 

NetOps

UserIDInfo

 The ECGrid Network Operations technician assigned to the request. This is only partially implemented for v2.0 for backwards compatibility.

NetOpsInfo

MailboxNetOpsInfo

NetworkNetOpsInfo

 A NetOpsInfo Object to of this entity. 

NetworkID

Integer

 The NetworkID assigned to a Network on ECGrid. 

NetworkIDFrom

Integer

 The NetworkID the entity is from. 

NetworkIDTo

Integer

 The NetworkID the entity is to. 

NetworkName

String(0,40)

 The name of the Network. 

NetworkNameFrom

String(0,40)

 The name of the Network the entity is from. 

NetworkNameTo

String(0,40)

 The name of the Network the entity is to. 

NetworkStatus

NetworkStatus

 An ENUM to indicates operational status and outage condition

Note

String(0,250)

 The text of the Note itself.

NoteDate

System.DateTime

The date/time the Note was posted to the system (UTC).


NoticesUserID

Integer

UserIDInfo

 A UserIDInfo Object to represent the user of this entity for notices. 

OpenSessions

Short

 Number of current open sessions for this User.

OriginalFrom

ECGridIDInfo

 An ECGridIDInfo Object matching the Original interchange Sender. 

OriginalTo

ECGridIDInfo

 An ECGridIDInfo Object matching the Original interchange Receiver. 

OutBoxPattern

String

 The OutBox Pattern assigned to this entity. 

OutBoxTimeOut

Short

 The value assigned to the outbox timeout for the entity. 

Owner

UserIDInfo

 A UserIDInfo Object to represent the owner of an entity. 

OwnerInfo

ECGridOwnerInfo

NetworkOwnerInfo

MailboxOwnerInfo

 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. 

OwnerUserID

Integer

UserIDInfo

 A UserIDInfo Object to represent the user of this entity for an owner. 

PageNumber

Short

 The page number. 

PageSize

Short

 The size of the page. 

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

System.DateTime

 The date/time the Parcel was uploaded or created on ECGrid (UTC). 

ParcelID

Long

 The value assigned to track a specific Parcel on ECGrid. 

ParcelIDInfoList

ParcelIDInfo[]

 An ParcelIDInfo Object array for this entity. 

ParcelNoteID

Integer

 The value assigned to track a specific Parcel Note. 

Parcels

ParcelIDInfo[]

 An ParcelIDInfo Object collection for this interchange. 

Password

String

The password for this entity.  

Phone

String(0,20)

 A phone number. 

PostedBy

String

 The name of the person or system that posted the note. 

PricelistID

Integer

 The value assigned to a specific Pricelist entity. 

ProcessID

Integer

 The value assigned to a specific Process entity. 

Qualifier

String(0,3)

 The X12 or EDIFACT ID Qualifier for the ISA and UNB segments. 

Receipt

ReceiptType

 An ENUM to represent the Type of Receipt to use for an entity. 

RecoveryQuestion

String(0,16)

 A user defined question used to restore lost password or to activate an account with too many failed logins. 

Reference

String(0,50)

 A user-defined reference number to attach to a Interconnect request for TP. 

RemoteTunnel

String

 The remote tunnel for this VPN entity. 

ReportsUserID

Integer

UserIDInfo

 A UserIDInfo Object to represent the user of this entity for reports. 

RequestorUser

UserIDInfo

 A UserIDInfo Object to represent the requestor of this entity. 

ReturnCode

RetCode

 An ENUM to indicate the return code result for the call. 

Routing

NetworkRoutingType

 An ENUM to represent the routing of an entity. 

RoutingGroup

RoutingGroup

 An ENUM to represent the routing group an entity. 

RoutingUserID

Integer

 A numeric value to represent the user of this entity for routing. 

RoutingType

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. 

RunDir

String

 The run directory for this entity. 

RunStatus

NetworkRunStatus

 An ENUM to represent the entry's current running status. 

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. 

Server

String

 The server assigned to this entity. 

SessionEventID

Integer

 The session event identifier for this entity. 

SessionID

String - GUID

 The current session's GUID in string format. 

SharedSecret

String

 The Shared Secret for this VPN entity. 

SignData

Boolean

 If an entity requires data to have a digital signature or not. 

SoftwareVersion

String

  The Software Version for this entity. 

SSLClientAuthentication

Boolean

 If an entity requires SSL Client Authentication or not. 

Standard

EDIStandard

 An ENUM to represent the EDI Standard of an entity. 

StartTime

System.DateTime

 If DateTime when the Session started.

Status

NetworkLogStatus

SessionStatus

Status

StatusECGridID

StatusInterconnect

 An ENUM to represent the status an entity. 

StatusCode

String

Interchange Status Code for this entity. Parcel Status Code for this entity.


StatusColor

String

 Color representation for the status of this entity. 

StatusDate

System.DateTime

 The date/time for this Status.

StatusMessage

String

Interchange Status Message for this entity. Parcel Status Message for this entity.


StripDirectedEnvelope

Boolean

A flag indicating if the non EDI file/parcel envelopes add are to be stripped for this Mailbox. 

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. 

SupportURL

String

 Uniform Resource Locator: a specific web support page or file on the internet. 

SupportWebsite

String

 Uniform Resource Locator: a specific web support page or file on the internet. 

SuspendPendingInterchanges

Boolean

 Flag to suspend the pending interchanges for and interconnect or entity. 

TimeOut

Short

 The Time Out value. 

TimeZoneOffset

Short

 The number of minutes + or - the user local time is from UTC. 

TotalPages

Short

 The the total number of pages. 

TotalRecords

Integer

 The the total number of records. 

TP

ECGridIDInfo

 An ECGridIDInfo Object for the requesting Trading Partner. 

TPFrom

ECGridIDInfo

 An ECGridIDInfo Object matching the TP interchange Sender. 

TPTo

ECGridIDInfo

 An ECGridIDInfo Object matching the TP interchange Receiver. 

TransactionSet

String(0,20)

 String to match the Transaction Set type, standard dependent. 

Type

ManifestType

NetworkType

NetworkLogType

 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. 

UniqueID

String

 Unique ID for an interconnect. 

URL

String

 Uniform Resource Locator: a specific web page or file on the internet. 

UserDomain

String

 The user domain assigned to this entity. 

UserID

Integer

 A numeric value used to represent a specific user on the system. A value of zero indicates an internally generated entry.  

UserName

String

 The username assigned to this entity. 

UseType

UseType

 An ENUM to represent the type of use for an entity. 

Valid

ParcelValid

ENUM Indicating whether this Parcel was able to be processed completely. 

Version

String

 The Version of the session ECGridOS API. 

VirtualDirectoryIn

String

 The virtual inbound directory for this entity. 

VirtualDirectoryOut

String

 The virtual outbound directory for this entity. 

VPN

NetworkVPN

The VPN object for this entity. 

X1256

Boolean

 If an entity uses X1256 or not. 

Back To Appendix Home

Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.