NetworkList()


List Networks, optionally filter by Name.

Public Function NetworkList(ByVal SessionID As String, _
                            
ByVal Name As String) _
                           
As NetworkIDInfo()

Parameters

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.
Name
String(0,40)
A generic variable that is used to match any type of Name field (e.g. Network Name, FirstName, LastName, LoginName, etc.).

Returns

NetworkIDInfo Collection

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.

Remarks

Partial names are matched. If a Name is passed and no matches are found, then a SOAP Exception is thrown.

Example

Visual Basic
[insert code sample]

EventID: 2002

See Also

 


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