Vous êtes sur la page 1sur 205

ECGridOS

ECGridOS™ provides a 100% Web Services API into the ECGrid® Interconnect Network.
Unlike Value Added Networks (VANs), ECGridOS turns ECGrid into a 100% programmable
electronic commerce routing switch. EDI transport has never been more flexible nor more
powerful.

Imagine no longer being bound to the web interface provided by the VAN, but having the
tools to tailor the end user's experience to exactly their needs, easily, efficiently, reliably and
securely.

Conceived as an operating system, ECGridOS is a set of primitives that allow the developer
to create the system as best suites their client. No longer limited by a few predefined,
unmodifiable web pages provided by the VAN or Electronic Commerce Service Provider,
ECGridOS unleashes the full power of the ECGrid.

Loren Data Corp.


The Electronic Commerce Evolution

Founded in 1987, Loren Data Corp. has been at the forefront of electronic commerce
evolution. ECGrid is the result of two decades of innovation and technology. Initially released
in 2000, ECGrid bridges the gap between EDI technology and utility caliber infrastructure.

Vision

A world economy empowered by automated, interbusiness communication.

Mission

Loren Data will provide the leading, globally accessible, electronic commerce operating
system.

As AT&T Long Distance defined telephone service and FedEx revolutionized trackable,
overnight delivery, ECGrid seamlessly connects Value Added Networks, ASPs, Electronic
Commerce Service Providers (ECSP) and all their customers on a standardized EDI VAN
interconnect infrastructure.

ECGrid ®
The Missing Link

ECGrid began in 1997 as a web-based VAN connected to the US Department of Defense


EDI Network. Since 2001 ECGrid has been the preferred Interconnect Network for major
electronic commerce service providers such as SPS Commerce, CovalentWorks, and others.

ECGrid is the global infrastructure that enables organizations to transact


business seamlessly across all Electronic Commerce Service Providers.

Conceived specifically to service the infrastructure needs of major service providers, ECGrid
focuses primarily on network interconnects, routing and reporting. Value added end-user
services such as translation, mapping and application integration are the domain of ECGrid's
customers.

Currently, ECGrid supports over 14,000 local trading partners and over 80 network and
service provider connections.

By not competing for end-users, ECGrid has established itself as non-competitive provider of
high-quality interconnect services.

ECGridOS™ v2.0
Total Control

ECGridOS turns the ECGrid Interconnect Network into a fully programmable EDI switch.
With every aspect of the management and operation of ECGrid being exposed as a web
services API, services and systems connected to ECGrid can now deliver the most seamless
EDI transport available anywhere.

With ECGridOS, the developer, consultant or system integrator can quickly and easily deliver
the exact product their customers need.

Developers can integrate ECGridOS throughout their applications, allowing


one click configuration of trading partners and interconnects as well
as complete interchange management.
System integrators can use the power of web services to tightly integrate
client applications to the ECGrid Interconnect Network, eliminating the need to
train customers on multiple systems.
Consultants can rapidly create and host custom web page that best service
their clients' needs in a secure, reliable environment.

Where VANs require that all configuration, tracking and reporting be performed through a
proprietary, out-of-band, web interface while data is routed through a completely different
channel, ECGridOS delivers complete control of the entire process through an in-band, web
services API.

End-users are no longer required to learn separate systems, or call IT for tasks as simple as
adding a new vendor or tracking the status of an interchange. Through ECGridOS, seamless
control is provided directly through the end-user application to the desktop, where it
belongs.

ECGridOS allows developers and system integrators to tightly integrate end-user


applications, delivering complete control of the ECGrid Network directly to the end-user
desktop. End-users can now add trading partners, send and receive interchanges, and track
the status of all ECGrid operations without ever leaving their primary environment.

Getting Started
The following documentation is designed to assist the developer, system integrator and
consultant implement ECGridOS in their own environments in a way that best serves their
clients.
ECGridOS User's Guide
ECGridOS philosophies and methodologies outlined and explained.

ECGridOS APIs
Each API call explained in detail with example code.

Appendices
Object Classes

Certain APIs return objects or collections of objects instead of discrete values or table
data.

ENUMs

To facilitate readable code and assure proper inputs, numerous input parameters use
ENUMs in addition to arbitrary Short values.

Parameters

A listing of all parameter definitions used throughout ECGridOS.

Return Values

A listing of all Return Values used by ECGridOS APIs.

SOAP Exceptions

A guide to elegantly handling errors when using ECGridOS.

Revision Updates

The chronology of all system and documentation updates.

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
ECGridOS User's Guide
The most current version of this documentation may be found on-line:

HTML: http://ecgridos.net/docs/index.htm
CHM: http://ecgridos.net/docs/ecgridos.chm (zipped)

Documentation & Nomenclature


Please take a moment to familiarize yourself with the nomenclature used in the development
of this documentation.

Using Web Services


An overview of how to use Web Services in a development environment.

Networks & Mailboxes


As a true electronic commerce infrastructure, ECGrid primarily routes documents between
Electronic Commerce Service Provider (ECPS) Networks. Networks which are tightly
integrated with ECGrid, may further route documents by Mailbox within the network.

Users & Authorization Levels


The ability to view and modify information throughout ECGridOS is regulated by the User's
assigned Authorization Level.

Sessions
Session State is maintained through HTTP Cookies or through SOAP Headers. Each
function call must be completed within a several second timeout period, or the session
expires.

Trading Partners & ECGridIDs


Each discrete, Trading Partner ID on ECGrid is assigned a unique ECGridID. These
ECGridIDs are used throughout ECGridOS to route and track documents.

Interconnects
Interconnects are used to confirm that trading partners on two different Networks can reliably
exchange documents across the ECGrid infrastructure.

Parcels, Interchanges & Mailbags


Electronic Commerce traffic management. How to create, track and manage data on
ECGrid.

Carbon Copies
How to manage carbon copies of interchanges within the infrastructure. This transport level
value added service delivers copies of any interchange to any network attached to ECGrid.

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
Documentation & Nomenclature
Our goal is to make this documentation usable above all other goals. If you have any
suggestions to improve this document, please forward them to NetOps@ECGrid.com.

Data Types
All parameters are required for each web service call. In some cases, default values may be
used as indicated when a value itself is optional.

All data types are listed in Visual Basic format for simplicity.

Strings

Wherever necessary Strings are listed with their minimum and maximum lengths using the
following format:

String(min,max)

If this String is fixed length, it is listed as follows:

String(len)

Integers

The following table describes the integer types used throughout ECGridOS.

Integer Size Values


Byte 1 Byte 0-255
Short 2 Bytes -32,768 through 32,767 (signed)
Integer 4 Bytes -2,147,483,648 through 2,147,483,647
Long 8 Bytes -9,223,372,036,854,775,808 through 9,223,372,036,854,775,807

Boolean

Boolean true/false values are used within the system. Your system might interpret these as
integer zero (false) and non-zero (true) values or some other way.

Objects

ECGridOS makes extensive use of Objects to return complex information, and to guarantee
a consistent response format. Please familiarize yourself with the class structures used
throughout ECGridOS.

Uploading & Downloading Files


When uploading and downloading files Byte Arrays are used: byte(). The .NET Framework
automatically converts this data type into BASE64 encoding for transport. A convenient web
site for on-line ASCII to BASE64 conversion is located at
http://www.paulschou.com/tools/xlate/.

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
ECGridOS Support
Forums
Loren Data Corp. maintains a public ECGridOS Support Forum at
http://forums.ecgrid.com/forumdisplay.php?f=70. This Forum is the primary support path
for all users of ECGridOS.

Beta Testing
For participation in our Beta Testing program, please send you request to
beta@ecgridos.net.

ECGrid Networks
Networks directly connected to ECGrid have additional support options including direct
access to both the ECGrid Network and Technical Operations staffs.

Please contact bizdev@ecgrid.com if you are interested in directly connecting your system
to ECGrid.

ECGridOS Developers' Program


The ECGridOS Developers' Program provides full network access to ECGrid and ECGridOS
with certain trading partner and transaction limits. This is the perfect place to create and test
new ECGridOS enabled applications.

Please contact developers@ecgrid.com for more information.

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
Using Web Services
ECGridOS is a Web Services API built on the Microsoft .NET Framework. It can be
accessed through any system capable of making Web Services calls.

What is a Web Service?


In a nutshell, Web Services are simply remote class library. It contains properties and
methods just like any other class. There are also a set of classes to define various return
Objects and ENUMs to assist in building function calls. It really is very simple.

Attaching to the ECGridOS Web Services


The ECGridOS v2.0 web services are located at:

Production: https://ecgridos.net/v2.0/prod/ecgridosv0200.asmx
Beta: https://ecgridos.net/v2.0/beta/ecgridosv0200.asmx

Given the confidential nature of electronic commerce, ECGridOS can only be accessed
securely over HTTPS.

While ECGridOS can be accessed through HTTP GET and POST methods, it is highly
recommended that you use the SOAP v1.1 or v1.2 protocol as GET and POST may be
removed at a future date.

If you open the above URL in a web browser, you will see the list of all the methods
defined to ECGridOS v2.0. Each link describes in detail how requests and responses are
formatted, along with the ability to make test calls right from the browser. You will need a
LoginName and Password to access all methods except for NowUTC(), which can be used
as a quick test.

Have no fear, a development tool that recognizes a WDSL file will automatically import
everything you need directly into your development environment. Using Visual Studio 2008,
you use Website/Add Web Reference... to create a reference to ECGridOS using the
above URL.

The default name will be net.ecgridos.ecgridosv0200. This can be given a shorter name if
you desire.

In the Microsoft development environment, you will see the following entry in the web.config
file:

web.config
<configur a ti o n >
<appSet t in g s >
<ad d k e y = " n e t . e c g r i d o s . e c g r i d o s v 0 2 0 0 " v a l u e = " h t t p : / / e c gr i d o s . n e t / e c g r i d o s v 0 2 0 0 . a s m x " / >
</appSe t ti n g s >
</configu r at i o n >

In order to access the ECGridOS web services, it must first be instantiated by declaring it as
a new object.

Visual Basic
Private e c gr i d o s A s N e w n e t . e c g r i d o s . E C G r i d O S v 0 2 0 0

All Object and Object Collection declarations require a similar reference to its
respective web service class:

Visual Basic
Dim parce l () A s n e t . e c g r i d o s . P a r c e l I D I n f o

When calling an ECGridOS API, reference the method of your object:

Visual Basic
Dim Sessi o nI D A s S t r i n g = e c g r i d o s . L o g i n ( L o g i n N a m e , P a s s w o r d )

Dim parce l s( ) A s n e t . e c g r i d o s . P a r c e l I D I n f o = _
ecgridos.ParcelInBoxArchiveEx(NetworkID, _
MailboxID, _
BeginDate, _
EndDate, _
ECGridIDFrom, _
ECGridIDTo, _
Status)

Programming Philosophy
The basic philosophy of using ECGridOS is by discrete session. Which at the highest level
consists of the following steps

1. login()
2. method-1()
3. method-2()
4. ...
5. method-n()
6. logout()

A typical, complete session only last a few seconds. Sessions cannot be established and
held open, but shall be opened and closed as needed.

Data returned from the APIs can be single values, datasets, objects or collections of objects.

When returning datasets and collections of objects, keep in mind that the entire response is
returned at once, as no cursors are created as with a SQL server. Discretion should be used
to not create a request that generates excessively large responses as this will significantly
affect performance and local memory requirements.

See Also
ENUMs
Object Classes
Sessions
SOAP Exceptions

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
Networks & Mailboxes
ECGrid is the global infrastructure that enables organizations to transact business
seamlessly across all Electronic Commerce Service Providers.

Directly attached to the infrastructure are Networks. Networks can be Value Added
Networks (VAN) such as Sterling Commerce, Inovis, GXS, etc, or they can be service
providers such as SPS Commerce, CovalentWorks, Trubiquity, etc. They can even be other
infrastructures such as the US Federal Government's GEX or Department of
Defense's DAASC Hub.

Networks on ECGrid can be any electronic commerce system that supports one or more end
users. This is important: End Users do not connect to ECGrid as a Network.

Within ECGrid each Network is identified by an Integer value called the NetworkID. You
can use NetworkSearch to find the NetworkID by name and NetworkInfo to find the name
by NetworkID.

A traditional Network, such as a VAN, provides its own routing and mailboxing services to its
end users. Many Electronic Commerce Service Providers (ECSPs) also provide their own
internal mailbox services. Prior to ECGridOS, the ECGrid Infrastructure only provided
Network connections without Mailboxes.

With this release of ECGridOS, a complete set of APIs allows the ECGrid attached Network
to create and maintain individual mailboxes within their Network connection.
Each Mailbox on ECGrid is assigned a unique MailboxID. The default Mailbox for each
Network is 0 (zero).

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
Value Added Networks
Traditionally, EDI has been transported over Value Added Networks (VANs). To
accommodate trading partners on different VANs, interconnects were created to route traffic
between the different networks.

First generation VANs built private mailbox networks, provided basic value added services
and delivered numerous system integration services. The big players were the usual big IT
companies such as IBM and GEIS.

With the advent of the Internet, second generation (2G) VANs emerged that routed data
over the internet, and began providing a greater variety of web-based services and less
traditional system integration. In order to be competitive, these 2G VANs required the same
interconnects as the traditional VANs had.

ECGrid was born out of this need, allowing 2G VANs to rapidly build their differentiating
value added services, while outsourcing their interconnect needs.

ECGridOS brings ECGrid to full third generation (3G) level, allowing it to operate as a fully
programmable, interconnect routing infrastructure switch between 1G and 2G VANs.

Mailbagging
Once Interconnects were created between 1G VANs, it quickly became evident that there
was a need to track interchanges that went over the Interconnects. The ANSI ASC X12
standards body developed a protocol known as the X12.56 Mailbag Protocol.

Mailbagging created a structure and mechanism by which VANs can track delivery and
communicate structural problems with interchanges automatically over the Interconnects.

ECGrid is 100% X12.56 compatible and implements this protocol with any Network which
will comply with the standard.

ECGrid has also developed a powerful extension of this protocol which allows X12.56
information to pass through from one ECGrid Network connection to another. Please contact
ECGrid NetOps if you are interested in implementing this feature.

ECGrid Connected Networks


As of the publication of this document, ECGrid provides full interconnect capability to the
following 1G and 2G Value Added Networks.

Those listed in black maintain traditional 1G interconnects with ECGrid. Those listed in blue
are maintaining 2G or 3G connectivity with ECGrid. Those in bold are using the X12.56
Mailbag Protocol.

NetworkID Name
201 Advanced Communications Systems
250 BCE Emergis (Bell Canada)
243 Commport Communications
430 CovalentWorks Corporation
106 Department of VA - Financial Services
257 Descartes (GLN)
256 DINET UK
228 Easylink (AT&T)
253 EC/EDI, Inc. (Promethean Software)
231 EDS
302 Energy Services Group
246 Fountainhead Communications
212 GXS - Global eXchange Services
215 GXS (IBM Advantis)
600 GXS (IBM DEBX)
255 I-Connect
214 Inovis (Peregrine/Harbinger)
239 Internet Commerce Corporation
305 Internet Operations Center/Netlink
247 InterTrade Systems Corp.
233 Kleinschmidt
235 Nubridges (MCI/Worldcom)
224 Softshare
602 Sole Technology, Inc.
401 SPS Commerce - CERTLD
409 SPS Commerce - SPSCLD2
403 SPS Commerce - SPSLDCAT
406 SPS Commerce - SPSLDHRTH
402 SPS Commerce - SPSLDHUB
411 SPS Commerce - SPSLDNGI
301 SPS Commerce - SPSLDSAC
407 SPS Commerce - SPSLDVAN
405 SPS Commerce - SPSLDVND
237 Sterling Commerce
225 Technology Management Programs
251 Transentric
440 Trubiquity (Trinary Systems)
258 True Commerce, Inc.
104 U.S. DoD DAASC Hub (DTDN)
101 U.S. Federal GEX Ogden
241 Vantree Systems Inc.
490 Winrep Software
249 York Worldwide - Foundation

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
Users & Authorization Levels
Users
All access to ECGridOS requires a User account. Logins and strong passwords help secure
the system. All system access is monitored and logged to the UserID. Any problems or
malicious activity can be quickly identified and attributed to the specific account.

There is an extensive list of User methods within the System Access APIs.

Sessions

By default, any one UserID may have 5 simultaneous sessions open. As sessions should
only be open for the length of a specific request, the does not substantially limit how
systems access ECGridOS.

If you do not Logout after each login, the session will be held open for an indefinite period
of time, which can lead to lockouts. Be sure to allows Logout of each session. A
housekeeping process will regularly clear out expired sessions, but this should not be
considered a dependable process. You may also use the UserReset method to reset the
open session count.

To see the number of currently open sessions, use the WhoAmI method.

Passwords

ECGridOS requires strong passwords of at least 8 characters. There must be at least one
Uppercase, one Lowercase, one numeric digit and one special character. Password must be
updated at least once every 180 days.

While this may seem cumbersome, ECGridOS is intended to be a machine interface, and
systems connecting can be designed to generate their own passwords and automate their
own updates.

Email Addresses

Maintaining valid Email addresses is very important in order to provide proactive messaging
from ECGrid.

Cell Phones

ECGrid will be making extensive use of cell phone text messaging. Please be sure that any
UserIDs used to monitor critical functions of the infrastructure have valid cell phone numbers
entered into their accounts.

Authorization Level
Different Authorization Levels allow varied access to areas of ECGridOS. Please see
Networks & Mailboxes for more information on ECGrid hierarchies.
Mailbox-Level

Mailbox User
Access is strictly restricted to the Session Network/Mailbox.

Mailbox Administrator
Access is strictly restricted to the Session Network/Mailbox. Also granted
authority to manage other Mailbox Users assigned to the same Session
Network/Mailbox.

Network-Level

Network User
Access is restricted to all Mailboxes with in the Session Network.

Network Administrator
Access is restricted to all Mailboxes with in the Session Network. Also
granted the authority to manage other Network Users and Mailbox
Administrators assigned to the same Session Network.

System-Level

NetOps
Only available to Loren Data staff, allows access throughout the ECGrid to
assist an manage all Networks and Mailboxes.

See Also
Networks & Mailboxes
Networks & Mailboxes
Session Network/Mailbox
System Access APIs

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
Sessions
Sessions form an integral part of ECGridOS. They are essential to authentication and
security. Understanding them is key to creating robust, efficient ECGridOS applications.

A typical session will last only a few seconds. Applications should only be logged into a
session Integer enough to perform a specific task.

SessionID
The SessionID is a Globally Unique Identifier (GUID) presented in string format:

XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

The SessionID along with the client IP address is used to authenticate a client through each
API call between Login() and Logout().

Note: At this time, ECGridOS requires that the Client IP not change during a session. Given
that a typical session is only a few seconds, this is not expected to present a significant
problem.

After authenticating to ECGridOS with the Login() API, the system returns a SessionID both
as a value and as a cookie.

Your programming environment might require that you explicitly create a container to hold
the cookie as this is not the default as it is with a web browser.

Visual Basic
Private C o ok i e s A s S y s t e m . N e t . C o o k i e C o n t a i n e r
Private e c gr i d o s A s N e w n e t . e c g r i d o s . E C G r i d O S v 0 2 0 0

If Cookie s I s N o t h i n g T h e n
Cooki e s = N e w S y s t e m . N e t . C o o k i e C o n t a i n e r ( )
End If

ecgridos. C oo k i e C o n t a i n e r = C o o k i e s

BETA NOTE: It is the intention that the SessionID can be alternatively be passed as a
SOAP Header. As of the first Beta release, this has not been tested.

Session Network/Mailbox
Every LoginName is assigned to a specific Network/Mailbox. When logged in, that
Network/Mailbox becomes the default Session Network/Mailbox.

Based on its Authorization Level the user may be restricted to the Session
Network/Mailbox, may have access to all Mailboxes within the Session Network.

See Also
System Access APIs

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
Trading Partners & ECGridIDs
ECGrid moves business documents between Trading Partners. ECGridIDs represent a
discrete address within the ECGrid Infrastructure which may be on a Value Added Network
or other Electronic Commerce Service Provider (ECSP) which are represented by Network
& Mailboxes.

Internally, all traffic within ECGrid is routed by the ECGridID, represented by a Integer
value. Each ECGridID is assigned to a specific Network/Mailbox and has an associated
NetworkID and MailboxID value.

Each Trading Partner on ECGrid will have one or more ECGridIDs associated with them.
For X12 data, the ECGridID is associated with a Qualifier/ID (QID) pair and for EDIFACT
data with an ID and optional Qualifier.

The system requires that a Qualifier/ID pair be unique across the infrastructure at any one
time. TPMove and TPMoveEx allows a QID to be moved from on Network/Mailbox to
another at a specific date and time in the future.

Non-EDI data can be routed strictly by ECGridID throughout the infrastructure.

To find an ECGridID for a specific QID use TPSearch. To see the information for a specific
ECGridID, use TPInfo.

ECGridIDs conform to normal ECGridOS Status Levels.

Auto Routes
AutoRoutes occur when a Parcel is sent through ECGrid from an Unknown Sender QID.
The ECGrid infrastructure will automatically create an ECGridID for this QID and assign it to
the Network/Mailbox where the parcel originated. In this way, any return parcels will be
properly routed to the sender.

It is up to the owner of the QID to update the ECGridID entry and change the status to
Active.

See Also
Trading Partner Management

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
Interconnects
Traditionally, EDI transactions are seen to be of two types: 1) on the VAN or 2) between
VANs. The latter have been called Interconnects.

While Interconnects have been much maligned, the fact is Interconnects are the cornerstone
of network-based EDI. Imagine telephone service without long distance, cities without
highways between them or economies without shipping. In short, Interconnects make
electronic commerce possible.

ECGrid ®
From its inception, ECGrid has been conceived as an Interconnect Infrastructure. By
focusing on the connection between systems, and making it a highly reliable and highly
accountable system, traditional VANs and other Electronic Commerce Service Providers
(ECSPs) can focus on the "Value Added" side of the equation and transfer skilled resources
from the "Network" side.

ECGrid provides complete end-to-end tracking of all traffic between networks.

Trading Partner Directory?


There is one fundamental flaw in how Trading Partners are managed throughout EDI: There
is no central directory of Trading Partners and their Qualifier/IDs (QIDs).

No VAN or any other ECSP has any way to lookup on which system any specific Trading
Partner is located. Each tries to maintain its own internal database. Tens of thousands of
transactions are lost everyday because of this.

Loren Data has offered up access to its directory to be a central depository of this
information for the industry. Through ECGridOS, every network can automate the
maintenance of its own customers, and automate lookups for all Interconnect traffic.

Value Added Networks


One of the biggest issues is in creating the Interconnect in the first place. Different VANs
have different routing philosophies. The three major ones are as follows:

1. Routes globally based on the Receiver QID. Will route even if the Sender QID is
unknown.
2. Routes globally based on the Receiver QID. Will block incoming interchanges from
unknown Sender QIDs.
3. Routes based on Sender/Receiver pair. Will block all interchanges unless a Trading
Partner Relationship has been created.

ECGrid's expert system understands the requirements of each network and properly
configures each Interconnect Request and efficiently follows each request to its completion.

See Also
Interconnect Management APIs

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
Parcels, Interchanges & Mailbags
ECGrid is a system to move electronic business documents from one organization to another
in a reliable, efficient and trackable manner. So, when everything else it put aside: It's
all about the data.

Using the physical world as a model, all these business documents are wrapped in
envelopes. The lowest level that ECGrid penetrates is the Interchange. In X12 this is
represented by the ISA envelope and in EDIFACT it is the UNB envelope.

It is our philosophy and policy that nothing within this envelope is within our domain. This
area is left to the VANs and ECSPs. This clearly delineates ECGrid from the networks that
connect to it. It also allows us to clearly concentrate on our mission.

Interchanges
This is the level of enveloping where Sender and Receivers are defined. All data is routed
on ECGrid and all Interconnects at this level.

ECGrid natively routes X12 and EDIFACT envelopes. Through the ParcelUploadEx() and
ParcelDownloadInner() ECGrid can route any data types within an X12 ISA envelope.

Mailbags
Mailbags are a convention for moving Interchanges between networks. In order to get a
handle on Interchanges over Interconnects, many VANs use the X12.56 Mailbag Protocol.

X12.56 allows for VANs to track Mailbags over Interconnects. While Mailbags may contain
multiple Interchanges, ECGrid only sends one Interchange per Mailbag as the protocol
requires that an entire Mailbag be rejected if even a single Interchange is corrupt.

Parcels
Whether wrapped in an X12.56 Mailbag or by itself, all files and uploaded to and
downloaded from ECGrid are considered Parcels.

Within EDI itself, data is considered a stream and is not tied to the concept of a file. For this
reason, ECGrid uses the term Parcel to describe EDI data turned into a file-based format.

Archiving
All Parcels, Mailbags & Interchanges are kept on-line for a minimum of 90 days, after which
they are moved off-line to archives. To recover data from Archive, please contact ECGrid
NetOps.

See Also
Parcel Management

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
Carbon Copies
More and more, EDI is being called upon to replicate functions in the real world. Where we
used to fill out forms in triplicate with carbon paper, Carbon Copy requests are on the rise.

While Carbon Copies can definitely be called a Value Added service, and outside the
domain of ECGrid, it is provided on the infrastructure for two reasons:

1. The current level of front-end software is mostly inadequate in this area.


2. It is a function at the envelope level, and does not require ECGrid to go any further
into the Interchange.

The Carbon Copy process is quite simple. A database is kept of Original Sender/Receiver
pairs. Whenever a match is made a copy of the interchange is made and the Original
Sender/Receiver pair is replaced with the Carbon Copy Sender/Receiver pair.

Interconnect Requests
Before the Carbon Copy Interchange can be routed, you will need to make sure that an
Interconnect Request has been made and confirmed for the Carbon Copy Sender/Receiver
pair.

Note that this only has to be done once for each Carbon Copy Sender/Receiver pair, not
matter how many Carbon Copies it appears in.

Security
In order to make sure that data is not copied without proper authorization, either the Original
Sender or Original Receiver must be on the Network/Mailbox making the request.

Since it is possible that a legitimate requester may be the Carbon Copy Receiver, NetOps
can override this limitation when authorization has been obtained from either the Original
Sender or Original Receiver.

Limitations
Given that some Value Added Networks route based strictly on Sender/Receiver pairs or
block Senders that appear to be coming from the wrong Network, and adjustment is
sometimes needed to the Carbon Copy Receiver in order for the Carbon Copy to go
through.

For this purpose, you might want to make a generic Carbon Copy ECGridID (e.g.
ZZ*MYCC). Of course, it will need to be unique across the infrastructure. You can always
safely use this as your Carbon Copy Sender QID. Remember that you will need to create an
Interconnect Request for your Carbon Copy Sender/Receiver pair.

See Also
Carbon Copy Management

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
ECGridOS™ API Calls
System Access & User Management
This control set of APIs provides login/logout and other basic system access functionality.

Network/Mailbox Management
APIs to create and maintain Networks and Mailboxes

Trading Partner ID Management


Use this set of APIs to add, edit, delete and manage all aspects of Trading Partners
assigned to a specific Network/Mailbox.

Interconnect Management
These functions are used to create and manage Interconnects between IDs throughout the
ECGrid Network.

Carbon Copy Management


APIs to manage Carbon Copy interchanges for Trading Partner pairs.

Parcel Management
A complete set of APIs to send and receive mailbags, interchanges and other payloads over
the ECGrid Network.

Reports
Various system reports.

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
System Access APIs
Login
Required first call in order to establish a session.
Logout
Required final call to close a session.
NowUTC
Current UTC Date/Time. Does not require login().
ChangePassword
Use to change password of current User Account.
WhoAmI
Returns current session information.
UserAdd
Create a User for the Session Network and a specified Mailbox.
UserAddEx
Create a User for a specified Network/Mailbox.
UserInfo
Detail for a specified User.
UserUpdate
Update a User account.
UserPassword
Update a User's security information.
UserActivate
Activate a suspended User.
UserSuspend
Suspend a User.
UserTerminate
Terminate a User.
UserReset
Reset a User's GraceLogins and OpenSessions count.
UserList
Get a list of Users for the Session Network/Mailbox.
UserListEx
Get a list of Users for a specified Network/Mailbox.

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
Login()
Required first call in order to establish a session.

Public Function Login(ByVal LoginName As String, _


ByVal Password As String) _
As String

Parameters
LoginName
String(8,16)
A user's login name.
Required.
Password
String(8,32)
The LoginName password value.
Required.

Returns
SessionID string
This is a GUID returned in string format. This is also passed back as a cookie.
Optionally, this value may be returned in a the SoapHeader:SessionID. See
Sessions.

Remarks
Sessions will time out when the timeout value between API calls is exceeded. The default
timeout value is 60 seconds.

Example
Visual Basic

Imports System.Xml
Imports System.Web.Services.Protocols

Class ErrorInfo
Public ErrorCode As Short
Public ErrorString As String
Public ErrorItem As String
Public ErrorMessage As String
End Class

Partial Class _Default


Inherits System.Web.UI.Page
Private ecgridos As New net.ecgridos.ECGridOSv0200
Private Cookies As System.Net.CookieContainer

Protected Sub TradingPartners_Click(ByVal sender As Object, _


ByVal e As System.EventArgs) _
Handles TradingPartners.Click
If StartSession() Then
GridView1.DataSource = _
ecgridos.TPList(False)
GridView1.DataBind()
EndSession()
End If
End Sub

Private Function StartSession() As Boolean


Dim SessionID As String
Dim ErrorInfo As ErrorInfo
If Cookies Is Nothing Then
Cookies = New System.Net.CookieContainer()
End If
ecgridos.CookieContainer = Cookies
Try
SessionID = ecgridos.Login(LoginName.Text, Password.Text)
Return True
Catch ex As SoapException 'Note that the default is Exception
ErrorInfo = CatchException(ex)
Return False
End Try
End Function

Private Function EndSession()


Dim SessionTime As Integer
EndSession = ecgridos.Logout()
End Function

Priva t e F u n c t i o n C a t c h E x c e p t i o n ( B y V a l e x A s S o a p E x c e p t i o n) A s E r r o r I n f o
Dim doc As New XmlDocument
Dim Node As XmlNode
C a tc h E x c e p t i o n = N e w E r r o r I n f o
d o c. L o a d X m l ( e x . D e t a i l . O u t e r X m l )
N o de = d o c . D o c u m e n t E l e m e n t . S e l e c t S i n g l e N o d e ( " E r r o r I n fo " )
If Node Is Nothing Then
' T h i s p i c k s u p F r a m e w o r k g e n e r a t e d S O A P E x c e p t i o ns
With CatchException
.ErrorCode = -1
.ErrorString = ex.Message
.ErrorItem = ""
.ErrorMessage = ""
End With
E l se
'This picks up ECGridOS generated SOAP Exceptions
With CatchException
. E r r o r C o d e = C I n t ( N o d e . S e l e c t S i n g l e N o d e ( " E r r or C o d e " ) . I n n e r T e x t )
. E r r o r S t r i n g = N o d e . S e l e c t S i n g l e N o d e ( " E r r o r S tr i n g " ) . I n n e r T e x t
. E r r o r I t e m = N o d e . S e l e c t S i n g l e N o d e ( " E r r o r I t e m" ) . I n n e r T e x t
. E r r o r M e s s a g e = N o d e . S e l e c t S i n g l e N o d e ( " E r r o r Me s s a g e " ) . I n n e r T e x t
End With
End If
End F u nc t i o n

End Class

EventID: 1001
See Also
Logout()
ErrorInfo Class
Sessions
SOAP Exceptions

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
Logout()
Required final call to close a session.

Public Function Logout() As Integer

Parameters
none

Returns
SessionTime Integer
Length of session in milliseconds.

Remarks
Be sure to always Logout() of sessions. Each account has a limited number of allowed
simultaneous sessions. If the Logout() function is not called, the session will not be properly
closed.

Sessions will time out when the timeout value between API calls is exceeded. The default
timeout value is 60 seconds.

Example
Visual Basic

Imports System.Xml
Imports System.Web.Services.Protocols

Class ErrorInfo
Public ErrorCode As Short
Public ErrorString As String
Public ErrorItem As String
Public ErrorMessage As String
End Class

Partial Class _Default


Inherits System.Web.UI.Page
Private ecgridos As New net.ecgridos.ECGridOSv0200
Private Cookies As System.Net.CookieContainer

Protected Sub TradingPartners_Click(ByVal sender As Object, _


ByVal e As System.EventArgs) _
Handles TradingPartners.Click
If StartSession() Then
GridView1.DataSource = _
ecgridos.TPList(False)
GridView1.DataBind()
EndSession()
End If
End Sub

Private Function StartSession() As Boolean


Dim SessionID As String
Dim ErrorInfo As ErrorInfo
If Cookies Is Nothing Then
Cookies = New System.Net.CookieContainer()
End If
ecgridos.CookieContainer = Cookies
Try
SessionID = ecgridos.Login(LoginName.Text, Password.Text)
Return True
Catch ex As SoapException 'Note that the default is Exception
ErrorInfo = CatchException(ex)
Return False
End Try
End Function

Private Function EndSession()


Dim SessionTime As Integer
EndSession = ecgridos.Logout()
End Function
Priva t e F u n c t i o n C a t c h E x c e p t i o n ( B y V a l e x A s S o a p E x c e p t i o n) A s E r r o r I n f o
Dim doc As New XmlDocument
Dim Node As XmlNode
C a tc h E x c e p t i o n = N e w E r r o r I n f o
d o c. L o a d X m l ( e x . D e t a i l . O u t e r X m l )
N o de = d o c . D o c u m e n t E l e m e n t . S e l e c t S i n g l e N o d e ( " E r r o r I n fo " )
If Node Is Nothing Then
' T h i s p i c k s u p F r a m e w o r k g e n e r a t e d S O A P E x c e p t i o ns
With CatchException
.ErrorCode = -1
.ErrorString = ex.Message
.ErrorItem = ""
.ErrorMessage = ""
End With
E l se
'This picks up ECGridOS generated SOAP Exceptions
With CatchException
. E r r o r C o d e = C I n t ( N o d e . S e l e c t S i n g l e N o d e ( " E r r or C o d e " ) . I n n e r T e x t )
. E r r o r S t r i n g = N o d e . S e l e c t S i n g l e N o d e ( " E r r o r S tr i n g " ) . I n n e r T e x t
. E r r o r I t e m = N o d e . S e l e c t S i n g l e N o d e ( " E r r o r I t e m" ) . I n n e r T e x t
. E r r o r M e s s a g e = N o d e . S e l e c t S i n g l e N o d e ( " E r r o r Me s s a g e " ) . I n n e r T e x t
End With
End If
End F u nc t i o n

End Class

EventID: 1002
See Also
Login()
SOAP Exceptions

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
NowUTC()
Current UTC Date/Time

Public Function NowUTC() As Date

Parameters
None

Returns
Date
Current ECGridOS system time expressed in Universal Coordinate Time (UTC)

Remarks
NowUTC() does not require logging into the system. This API allows the developer to test
connectivity and easily obtain UTC time.

Example
Visual Basic

Dim ecgridos As New net.ecgridos.ECGridOSv0200


Dim tm As Date

tm = ecgridos.NowUTC()

EventID: [none]
See Also

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
ChangePassword()
Use to change password of current User Account.

Public Function ChangePassword(ByVal OldPassword As String, _


ByVal NewPassword As String) _
As Boolean

Parameters
OldPassword
String(8,32)
Must match current session password.
NewPassword
String(8,32)
A "strong" password with a minimum length of 8 and maximum length of 32.

Returns
Boolean
True if successful, false on failure.

Remarks
Loren Data requires strong passwords that include at least one uppercase, one lowercase,
one number and one special character. For example This1IsGood!

Example
Visual Basic

Imports System.Xml
Imports System.Web.Services.Protocols

Class ErrorInfo
Public ErrorCode As Short
Public ErrorString As String
Public ErrorItem As String
Public ErrorMessage As String
End Class

Partial Class _Default


Inherits System.Web.UI.Page
Private ec As New ecgrid.ECGridOSv20
Private Cookies As System.Net.CookieContainer

Protected Sub ChangePassword_Click(ByVal sender As Object, _


ByVal e As System.EventArgs) _
Handles ChangePassword.Click
If StartSession() Then
if ec.ChangePassword(Password.text, NewPassword.text) then
Password.text = NewPassword.text
else
NewPassword.text = "[Invalid]"
End If
EndSession()
End If
End Sub

Private Function StartSession() As Boolean


Dim SessionID As String
Dim ErrorInfo As ErrorInfo
If Cookies Is Nothing Then
Cookies = New System.Net.CookieContainer()
End If
ec.CookieContainer = Cookies
Try
SessionID = ec.Login(LoginName.Text, Password.Text)
_SessionID.Text = SessionID
Return True
Catch ex As SoapException
ErrorInfo = ShowException(ex)
Return False
End Try
End Function

Private Function EndSession()


Dim SessionTime As Integer
EndSession = ec.Logout()
End Function

Private Function ShowException(ByVal ex As SoapException) As ErrorInfo


Dim doc As New XmlDocument
Dim Node As XmlNode
ShowException = New ErrorInfo
doc.LoadXml(ex.Detail.OuterXml)
Node = doc.DocumentElement.SelectSingleNode("ErrorInfo")
ShowException.ErrorCode = _
CInt(Node.SelectSingleNode("ErrorCode").InnerText)
ShowException.ErrorString = _
Node.SelectSingleNode("ErrorString").InnerText
ShowException.ErrorItem = _
Node.SelectSingleNode("ErrorItem").InnerText
ShowException.ErrorMessage = _
Node.SelectSingleNode("ErrorMessage").InnerText
End Function
End Class

EventID: 1003
See Also
UserPassword()

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
WhoAmI()
Returns current session information.

Public Function WhoAmI() As SessionInfo

Parameters
none

Returns
SessionInfo Object

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

Remarks
This is purely an informational call and can be used to verify system functionality.
Example
Visual Basic

[insert code sample]

EventID: 1004
See Also
AuthorizationLevel
Sessions
SessionInfo Object

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
UserAdd()
Create a User for the Session Network and a specified Mailbox.

Public Fu n ct i o n U s e r A d d ( B y V a l M a i l b o x I D A s I n t e g e r , _
ByVal LoginName As String, _
ByVal Password As String, _
ByVal RecoveryQuestion As String, _
ByVal RecoveryAnswer As String, _
ByVal FirstName As String, _
ByVal LastName As String, _
ByVal Company As String, _
ByVal Email As String, _
ByVal Phone As String, _
ByVal CellPhone As String, _
ByVal CellCarrier As CellCarrier, _
ByVal AuthLevel As AuthLevel) _
As Integer

Parameters
MailboxID
Integer
The ECGrid MailboxID assigned to the ID on the specified network.
LoginName
String(8,16)
A user's login name.
Password
String(8,32)
A "strong" password with a minimum length of 8 and maximum length of 32.
RecoveryQuestion
String(0,50)
A user defined question used to restore lost password or to activate an account with
too many failed logins.
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.
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.
AuthLevel
Short - AuthLevel ENUM
The Authority Level for system access.

Returns
UserID
Integer
A numeric value used to represent a specific user on the system.
Remarks
This will add a new user to the Session Network/Mailbox. The maximum Authorization
Level is that of the current Session UserID.

To add users to other Network/Mailboxes use UserAddEx().

Example
Visual Basic

[insert code sample]

EventID: 1005
See Also
UserAddEx()
Authorization Level
Session Network/Mailbox

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
UserAddEx()
Create a User for a specified Network/Mailbox.

Public F u n c t i o n U s er A d d E x ( B y V a l N e t w o r k I D A s I n t e g e r , _
ByVal MailboxID As Integer, _
ByVal LoginName As String, _
ByVal Password As String, _
ByVal RecoveryQuestion As String, _
ByVal RecoveryAnswer As String, _
ByVal FirstName As String, _
ByVal LastName As String, _
ByVal Company As String, _
ByVal Email As String, _
ByVal Phone As String, _
ByVal CellPhone As String, _
ByVal CellCarrier As CellCarrier, _
ByVal AuthLevel As AuthLevel) _
As Integer

Parameters
NetworkID
Integer
The ECGrid NetworkID assigned to the network.
MailboxID
Integer
The ECGrid MailboxID assigned to the ID on the specified network.
LoginName
String(8,16)
A user's login name.
Password
String(8,32)
A "strong" password with a minimum length of 8 and maximum length of 32.
RecoveryQuestion
String(0,50)
A user defined question used to restore lost password or to activate an account with
too many failed logins.
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.
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.
AuthLevel
Short - AuthLevel ENUM
The Authority Level for system access.
Returns
UserID
Integer
A numeric value used to represent a specific user on the system.

Remarks
This will add a new user to a specified Network/Mailbox. The maximum Authorization Level
is that of the current Session UserID.

Example
Visual Basic

[insert code sample]

EventID: 1006
See Also
UserAdd()
Authorization Level

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
UserInfo()
Detail for a specified User.

Public Fu n ct i o n U s e r I n f o ( B y V a l U s e r I D A s I n t e g e r ) _
As UserIDInfo

Parameters
UserID
Integer
A numeric value used to represent a specific user on the system.

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

Remarks
Access to a User's info is based on the current Session Authorization Level.

Example
Visual Basic

[insert code sample]

EventID: 1007
See Also
UserIDInfo Object
Authorization Level

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
UserUpdate()
Update a User account.

Pu bl ic F unc tio n Use rUp da te( ByV al Us erID As I nt eg e r , _


ByV al Fi rstN ame A s St r i ng, _
ByV al La stNa me A s S tr i n g, _
ByV al Co mpan y A s St ri n g , _
ByV al Em ail As S t ri ng , _
ByV al Ph one As S t ri ng , _
ByV al Ce llPh one A s St r i ng, _
ByV al Ce llCa rri e r A s C e llC a r rie r , _
ByV al Au thLe vel A s Au t h Lev e l ) _
As Boole an

Parameters
UserID
Integer
A numeric value used to represent a specific user on the system.
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.
AuthLevel
Short - AuthLevel ENUM
The Authority Level for system access.

Returns
Boolean
True if successful, false on failure.

Remarks
To keep current values, use the string "[Default]" for the string values. The ENUMs
have NoUpdate values for the same purpose.

The AuthLevel cannot be set higher than the current session Authorization Level.

Example
Visual Basic

[insert code sample]

EventID: 1008
See Also
Users & Authorization Level

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
UserPassword()
Update a User's security information.

Public Fu n ct i o n U s e r P a s s w o r d ( B y V a l U s e r I D A s I n t e g e r , _
B y V a l C u r r e n t R e c o v e r y A n s w e r A s St r i n g , _
ByVal Password As String, _
B y V a l R e c o v e r y Q u e s t i o n A s S t r i n g, _
ByVal RecoveryAnswer As String) _
As Boolean

Parameters
UserID
Integer
A numeric value used to represent a specific user on the system.
CurrentRecoveryAnswer
String(0,50)
The current RecoveryAnswer, required to match in order to process Password
change.
Password
String(8,32)
A "strong" password with a minimum length of 8 and maximum length of 32.
RecoveryQuestion
String(0,50)
A user defined question used to restore lost password or to activate an account with
too many failed logins.
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.

Returns
Boolean
True if successful, false on failure.

Remarks
By default, passwords expire every 180 days. This counter is reset whenever the password
is changed.

If CurrentRecoveryAnswer does not match the one in they system, the method will fail.

Loren Data requires strong passwords that include at least one uppercase, one lowercase,
one number and one special character. For example This1IsGood!

Example
Visual Basic

[insert code sample]

EventID: 1015
See Also
Users & Authorization Levels
ChangePassword()

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
UserActivate()
Activate a suspended User.

Public Fu n ct i o n U s e r A c t i v a t e ( B y V a l U s e r I D A s I n t e g e r ) _
As Boolean

Parameters
UserID
Integer
A numeric value used to represent a specific user on the system.

Returns
Boolean
True if successful, false on failure.

Remarks
Once a User has been Suspended, it can be reactivated through this method. Terminated
Users may not be reactivated.

Example
Visual Basic

[insert code sample]

EventID: 1009
See Also
UserSuspend()
UserTerminate()

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
UserSuspend()
Suspend a User.

Public Fu n ct i o n U s e r S u s p e n d ( B y V a l U s e r I D A s I n t e g e r ) _
As Boolean

Parameters
UserID
Integer
A numeric value used to represent a specific user on the system.

Returns
Boolean
True if successful, false on failure.

Remarks
An Active User may be temporarily Suspended. When Suspended, the User cannot log into
the system until Activated; however, if the UserID is used for notices, it will continue to
receive notices.

To permanently remove a User from the system, use UserTerminate().

Example
Visual Basic

[insert code sample]

EventID: 1010
See Also
UserActivate()
UserTerminate()

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
UserTerminate()
Terminate a User.

Public Fu n ct i o n U s e r T e r m i n a t e ( B y V a l U s e r I D A s I n t e g e r ) _
As Boolean

Parameters
UserID
Integer
A numeric value used to represent a specific user on the system.

Returns
Boolean
True if successful, false on failure.

Remarks
Termination completely ends the life of a UserID on ECGrid. It cannot be activated once
terminated. Use UserSuspend() to temporarily suspend a UserID.

Example
Visual Basic

[insert code sample]

EventID: 1011
See Also
UserActivate()
UserSuspend()

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
UserReset()
Reset a User's GraceLogins and OpenSessions count.<>

Public Fu n ct i o n U s e r R e s e t ( B y V a l U s e r I D A s I n t e g e r ) _
As Boolean

Parameters
UserID
Integer
A numeric value used to represent a specific user on the system.

Returns
Boolean
True if successful, false on failure.

Remarks
There are two parameters that can cause a User to be unable to log into the system. The
first is too many bad logins (wrong password), the second is too many Open Sessions. This
function resets both parameters.

You can use the RecoveryQuestion and RecoveryAnswer fields to automate validating a
user prior to resetting the account.

Too many Open Sessions can be caused by there being that many simultaneous sessions,
in which case you can request that the limit be raised.

The other problem can be too many incomplete Sessions, where the Logout() method has
not been used. Be sure to trap all SOAP Exceptions and Logout() after all Sessions,
whether successful or not.

Example
Visual Basic

[insert code sample]

EventID: 1012
See Also
Logout()
SOAP Exceptions

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
UserList()
Get a list of Users for the Session Network/Mailbox.

Public Fu n ct i o n U s e r L i s t ( B y V a l N a m e A s S t r i n g ) _
As List(Of UserIDInfo)

Parameters
Name
String(0,40)
A generic variable that is used to match any type of Name field (e.g. FirstName,
LastName, LoginName, etc.).

Returns
UserIDInfo Collection

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

Remarks
The Name parameter is treated as a wildcard and will match all or part of a name in the
LoginName, FirstName and LastName fields. If a empty string ("") is passed, it will return
all records in the Session Network/Mailbox.

If the Session Mailbox is 0, then all users within the Network will be returned.

Use UserListEx() to list users in other Network/Mailboxes.

Example
Visual Basic

[insert code sample]

EventID: 1013
See Also
UserListEx()
Session Network/Mailbox

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
UserListEx()
Get a list of Users for a specified Network/Mailbox.

Public Fu n ct i o n U s e r L i s t E x ( B y V a l N e t w o r k I D A s I n t e g e r , _
ByVal MailboxID As Integer, _
ByVal Name As String) _
As List(Of UserIDInfo)

Parameters
NetworkID
Integer
The ECGrid NetworkID assigned to the network.
MailboxID
Integer
The ECGrid MailboxID assigned to the ID on the specified network. A value of
zero (0) lists all Mailboxes for the specified NetworkID, contingent on Authorization
Level.
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.).

Returns
UserIDInfo Collection

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

Remarks
The Name parameter is treated as a wildcard and will match all or part of a name in the
LoginName, FirstName and LastName fields. If a empty string ("") is passed, it will return
all records in the specified Network/Mailbox.

If the specified Mailbox is 0, then all users within the specified Network will be returned.

The current User must have sufficient Authorization Level to request the specified
Network/Mailbox; otherwise, a Access Denied SOAP Exception will be generated.

Use UserList() to list users in the Session Network/Mailboxes.

Example
Visual Basic

[insert code sample]

EventID: 1014
See Also
UserList()

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
Network/Mailbox Management APIs
NetworkInfo
Details for specific Network.
NetworkList
List Networks, optionally filter by Name.
NetworkStatusSummary
A Summary List of Network Status.
NetworkOutageList
List of Network Outages.
MailboxAdd
Add a Mailbox to the Session Network.
MailboxAddEx
Add a Mailbox to a specified Network.
MailboxActivate
Activate a suspended Mailbox.
MailboxSuspend
Suspend a specified Mailbox.
MailboxTerminate
Terminate a specified Mailbox.
MailboxInfo
Detail for a specific Mailbox.
MailboxName
Update a Mailbox Name.
MailboxOwnerContact
Update Administrative Owner of a Mailbox.
MailboxErrorsContact
Update Errors Contact for a specified Mailbox.
MailboxInterconnectsContact
Update Interconnects Contact for a specified Mailbox.
MailboxNoticesContact
Update Notices Contact for a specified Mailbox.
MailboxX12Delimiters
Update a Mailbox override values for Segment Terminator, Element Separator
and Subelement Separator.
MailboxInBoxTimeout
Update a Mailbox InBox Timeout notification value.
MailboxList
Get a list of Mailboxes for the Session Network.
MailboxListEx
Get a list of Mailboxes for a specified Network.

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
NetworkInfo()
Details for a specific Network.

Public Function NetworkInfo(ByVal NetworkID As Integer) _


As NetworkIDInfo

Parameters
NetworkID
Integer
The ECGrid NetworkID assigned to the network.

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

Remarks
Used to get descriptive information about for a NetworkID when only the NetworkID is
returned in other APIs.

Example
Visual Basic

Dim ecgridos As New net.ecgridos.ECGridOSv0200


Dim NetInfo As net.ecgridos.NetworkIDInfo
Dim NetworkID As Integer

NetworkID = 215
NetInfo = ecgridos.NetworkInfo(NetworkID)

EventID: 2001
See Also
NetworkIDInfo Object

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
NetworkList()
List Networks, optionally filter by Name.

Pu bl ic F unc tio n Net wor kL ist (By Val N ame As S t ri ng ) _


As List (Of Net w o rk ID I n fo)

Parameters
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-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
NetworkStatusSummary()
A Summary List of Network Status.

Public Fu n ct i o n N e t w o r k S t a t u s S u m m a r y ( ) A s D a t a S e t

Parameters
[None]

Returns
DataSet
The fields included are as follows:

Type
String
The type of Network service. Equivalent to ECGridOSv0200.NetworkType
ENUM.
Status
String
The Network's configuration status. Equivalent to ECGridOSv0200.Status
ENUM.

RunStatus
String
The Operational Status. The Equivalent to
ECGridOSv0200.NetworkRunStatus ENUM.

NetworkStatus
String
Outage status. The Equivalent to ECGridOSv0200.NetworkStatus ENUM.

Count
Integer
The number of Networks with this StatusCode.

Remarks
This service returns a quick summary of all Network connections. For a detailed list of
Network Outages use NetworkOutageList().

Example
Visual Basic

[insert code sample]

EventID: 2003
See Also
NetworkOutageList()

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
NetworkOutageList()
List of Network Outages.

Pu bl ic F unc tio n Net wor kO uta geL ist() As Lis t ( Of N e t wor k I DIn f o )

Parameters
[None]

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
A list of Networks with current outages.

Example
Visual Basic

[insert code sample]

EventID: 2004
See Also

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
MailboxAdd()
Add a Mailbox to the Session Network.

Public Fu n ct i o n M a i l b o x A d d ( B y V a l N a m e A s S t r i n g , _
ByVal UserID as Integer) _
As Integer

Parameters
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.).
UserID
Integer
The User to have administrative ownership of this Mailbox.

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

Remarks
Create a new Mailbox on the Session Network. To add a Mailbox to a different Network use
MailboxAddEx().

The current User must have at least Network User Authorization Level..

The MailboxID is a randomly generated Integer and is unique across ECGrid.

The UserID is assigned to the Owner Contact, Errors Contact, Interconnects Contact
and Notices Contact.

Example
Visual Basic

[insert code sample]

EventID: 2101
See Also
Networks & Mailboxes
MailboxAddEx()
Session Network/Mailbox
MailboxID
MailboxOwnerContact()
MailboxErrorsContact()
MailboxInterconnectsContact()
MailboxNoticesContact()

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
MailboxAddEx()
Add a Mailbox to a specified Network.

Public Fu n ct i o n M a i l b o x A d d E x ( B y V a l N e t w o r k I D A s I n t e g e r , _
ByVal Name As String, _
ByVal UserID as Integer) _
As Integer

Parameters
NetworkID
Integer
The ECGrid NetworkID assigned to the network.
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.).
UserID
Integer
The User to have administrative ownership of this Mailbox.

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

Remarks
Create a new Mailbox on the specified Network. Use MailboxAdd() to add a Mailbox to the
Session Network.

The current User must have at least NetOps Authorization Level to add a Mailbox to a
Network other than the Session Network.

The MailboxID is a randomly generated Integer and is unique across ECGrid.

The UserID is assigned to the Owner Contact, Errors Contact, Interconnects Contact
and Notices Contact.

Example
Visual Basic

[insert code sample]

EventID: 2102
See Also
Networks & Mailboxes
MailboxAdd()
Session Network/Mailbox
MailboxID
MailboxOwnerContact()
MailboxErrorsContact()
MailboxInterconnectsContact()

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
MailboxActivate()
Activate a suspended Mailbox.

Public Fu n ct i o n M a i l b o x A c t i v a t e ( B y V a l M a i l b o x I D A s I n t e g e r ) _
As Boolean

Parameters
MailboxID
Integer
The ECGrid MailboxID assigned to the ID on the specified network.

Returns
Boolean
True if successful, false on failure.

Remarks
When a Mailbox has been suspended using MailboxSuspend(), it can be reactivated
through this function. Terminated Mailboxes cannot be reactivated.

Example
Visual Basic

[insert code sample]

EventID: 2103
See Also
MailboxSuspend()
MailboxTerminate()

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
MailboxSuspend()
Suspend an active Mailbox.

Public Fu n ct i o n M a i l b o x S u s p e n d ( B y V a l M a i l b o x I D A s I n t e g e r ) _
As Boolean

Parameters
MailboxID
Integer
The ECGrid MailboxID assigned to the ID on the specified network.

Returns
Boolean
True if successful, false on failure.

Remarks
The function allows a Mailbox to be suspended. It can be reactivated through
MailboxActivate().

A suspended Mailbox continues to be recognized by the system, but blocks user access. All
Trading Partners assigned to a suspended Mailbox are preserved.

The permanently terminate a Mailbox and release all the Trading Partners, use
MailboxTerminate().

Example
Visual Basic

[insert code sample]

EventID: 2104
See Also
MailboxActivate()
MailboxTerminate()

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
MailboxTerminate()
Terminate a Mailbox.

Public Fu n ct i o n M a i l b o x T e r m i n a t e ( B y V a l M a i l b o x I D A s I n t e g e r ) _
As Boolean

Parameters
MailboxID
Integer
The ECGrid MailboxID assigned to the ID on the specified network.

Returns
Boolean
True if successful, false on failure.

Remarks
Terminating a Mailbox permanently removes it from the system and releases all assigned
Trading Partners. It cannot be reactivated.

To temporarily suspend a Mailbox, while retaining all Trading Partners, use


MailboxSuspend().

Example
Visual Basic

[insert code sample]

EventID: 2105
See Also
MailboxActivate()
MailboxSuspend()

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
MailboxInfo()
Detail for a Mailbox.

Public Fu n ct i o n M a i l b o x I n f o ( B y V a l M a i l b o x I D A s I n t e g e r ) _
As MailboxIDInfo

Parameters
MailboxID
Integer
The ECGrid MailboxID assigned to the ID on the specified network.

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

Remarks
This method returns the current configuration of the specified Mailbox.

This information is only available to Users assigned to this Mailbox or Network level users
assigned to the Mailbox's Network. If a User from a different Mailbox or Network attempts to
access this information, they will receive an Access Denied message.

Example
Visual Basic

[insert code sample]

EventID: 2106
See Also
Ref1
Ref2

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
MailboxName()
Update a Mailbox Name.

Public Fu n ct i o n M a i l b o x N a m e ( B y V a l M a i l b o x I D A s I n t e g e r , _
ByVal Name As String) _
As Boolean

Parameters
MailboxID
Integer
The ECGrid MailboxID assigned to the ID on the specified network.
Name
String(3,40)
The name to assign to the Mailbox.

Returns
Boolean
True if successful, false on failure.

Remarks
Mailbox names are only available to Network level Users and Mailbox Users of the specific
Network/Mailbox. This is a descriptive function for local use only.

Example
Visual Basic

[insert code sample]

EventID: 2107
See Also
MailboxAdd()
MailboxAddEx()

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
MailboxOwnerContact()
Update Administrative Owner of a Mailbox.

Public Fu n ct i o n M a i l b o x O w n e r C o n t a c t ( B y V a l M a i l b o x I D A s I n t e g er , _
ByVal UserID As Integer) _
As Boolean

Parameters
MailboxID
Integer
The ECGrid MailboxID assigned to the ID on the specified network.
UserID
Integer
A numeric value used to represent a specific user on the system.

Returns
Boolean
True if successful, false on failure.

Remarks
Changes the Owner UserID associated with this mailbox. The Owner is initially set when
the Mailbox is created through MailboxAdd() or MailboxAddEx().

This allows the system to properly direct automated administrative notices regarding this
Mailbox.

Future versions of ECGridOS will include methods to send ad hoc notices to Mailbox
Owners.

Example
Visual Basic

[insert code sample]

EventID: 2116
See Also
MailboxAdd()
MailboxAddEx()

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
MailboxErrorsContact()
Update Errors Contact for a Mailbox.

Public Fu n ct i o n M a i l b o x E r r o r s C o n t a c t ( B y V a l M a i l b o x I D A s I n t e ge r , _
ByVal UserID As Integer) _
As Boolean

Parameters
MailboxID
Integer
The ECGrid MailboxID assigned to the ID on the specified network.
UserID
Integer
A numeric value used to represent a specific user on the system.

Returns
Boolean
True if successful, false on failure.

Remarks
Changes the Errors Contact UserID associated with this mailbox. This value is initially set
when the Mailbox is created through MailboxAdd() or MailboxAddEx().

This allows the system to properly direct automated Error Messages regarding this Mailbox.

Future versions of ECGridOS will include methods to send ad hoc notices to the Mailbox
Errors Contact.

Example
Visual Basic

[insert code sample]

EventID: 2108
See Also
MailboxAdd()
MailboxAddEx()

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
MailboxInterconnectsContact()
Update Interconnects Contact for a Mailbox.

Public Fu n ct i o n M a i l b o x I n t e r c o n n e c t s C o n t a c t ( B y V a l M a i l b o x I D As I n t e g e r , _
B y V a l U s e r I D A s In t e g e r ) _
As Boolean

Parameters
MailboxID
Integer
The ECGrid MailboxID assigned to the ID on the specified network.
UserID
Integer
A numeric value used to represent a specific user on the system.

Returns
Boolean
True if successful, false on failure.

Remarks
Changes the Interconnects Contact UserID associated with this mailbox. This value is
initially set when the Mailbox is created through MailboxAdd() or MailboxAddEx().

This allows the system to properly direct automated Interconnect messages regarding this
Mailbox.

Example
Visual Basic

[insert code sample]

EventID: 2109
See Also
Interconnect
Interconnect Management APIs
InterconnectAdd()
InterconnectNote()
InterconnectCancel()

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
MailboxNoticesContact()
Update Notices Contact for a Mailbox.

Public Fu n ct i o n M a i l b o x N o t i c e s C o n t a c t ( B y V a l M a i l b o x I D A s I n t eg e r , _
B y V a l U s e r I D A s I n t e g e r) _
As Boolean

Parameters
MailboxID
Integer
The ECGrid MailboxID assigned to the ID on the specified network.
UserID
Integer
A numeric value used to represent a specific user on the system.

Returns
Boolean
True if successful, false on failure.

Remarks
Changes the Notices Contact UserID associated with this mailbox. This value is initially set
when the Mailbox is created through MailboxAdd() or MailboxAddEx().

This allows the system to properly direct automated ECGrid status messages regarding this
Mailbox.

Example
Visual Basic

[insert code sample]

EventID: 2110
See Also
MailboxAdd()
MailboxAddEx()

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
MailboxX12Delimiters()
Update a Mailbox override values for Segment Terminator, Element Separator and
Subelement Separator.

Public Fu n ct i o n M a i l b o x X 1 2 D e l i m i t e r s ( B y V a l M a i l b o x I D A s I n t e ge r , _
ByVal SegTerm As Byte, _
ByVal ElmSep As Byte, _
ByVal SubElmSep As Byte) _
As Boolean

Parameters
MailboxID
Integer
The ECGrid MailboxID assigned to the ID on the specified network.
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.
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.
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.

Returns
Boolean
True if successful, false on failure.

Remarks
ECGrid has the ability to normalize X12 delimiters for all inbound Parcels. By changing the
value from zero (0) to any value 1 to 127, the matching ASCII character will be substituted
for the specific delimiter.

By default, all values are set to zero (0) and no translation occurs.

Always leave these values as zero (0) if you plan to transfer non-EDI data over ECGrid.
These values will have no effect on EDIFACT interchanges.

This has no affect on outbound Parcels.

Example
Visual Basic

[insert code sample]

EventID: 2111
See Also
Parcels

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
MailboxInBoxTimeout()
Update a Mailbox InBox Timeout notification value.

Public Fu n ct i o n M a i l b o x I n B o x T i m e o u t ( B y V a l M a i l b o x I D A s I n t e g er , _
ByVal Minutes As Short) _
As Boolean

Parameters
MailboxID
Integer
The ECGrid MailboxID assigned to the ID on the specified network.
Minutes
Short
Number of minutes.

Returns
Boolean
True if successful, false on failure.

Remarks
Sets the number of minutes that a Parcel can remain pending download in the InBox
before the system sends out an automated notice.

If ParcelDownloadConfirm() is not called after successfully downloading a Parcel, this may


also trigger a automated notice.

Example
Visual Basic

[insert code sample]

EventID: 2112
See Also
Parcel
ParcelInBox()
ParcelInBoxEx()
ParcelDownloadEDI()
ParcelDownloadInner()
ParcelDownloadConfirm()

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
MailboxList()
Get list of Mailboxes for the Session Network.

Public Fu n ct i o n M a i l b o x L i s t ( B y V a l N a m e A s S t r i n g ) _
As List(Of MailboxIDInfo)

Parameters
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.).

Returns
MailboxIDInfo Collection

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

Remarks
This method is only available to a Network Level Users to list Mailboxes within their
Network. All others will receive an Access Denied response.

Example
Visual Basic

[insert code sample]

EventID: 2113
See Also

Session Network/Mailbox
MailboxListEx()
Networks & Mailboxes

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
MailboxListEx()
Get list of Mailboxes for a specified Network.

Pu bl ic F unc tio n Mai lbo xL ist Ex( ByVal Net wor k I D As I nte g e r, _
ByVal Nam e A s St ri n g ) _
As Li st(O f M a i lb ox I D Inf o )

Parameters
NetworkID
Integer
The ECGrid NetworkID assigned to the network.
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.).

Returns
MailboxIDInfo Collection

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

Remarks
This method is only effectively available to NetOps to list Mailboxes within a specified
Network. All others will receive an Access Denied response.

User MailboxList() to list Mailboxes for the current Session Network.

Example
Visual Basic

[insert code sample]

EventID: 2114
See Also
Session Network/Mailbox
MailboxList()
Networks & Mailboxes

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
Trading Partner ID Management APIs
TPAdd
Add a Trading Partner ID to the Session Network/Mailbox.
TPAddVAN
Add a Trading Partner ID to a Value Added Network (VAN) connection.
TPAddEx
Add a Trading Partner ID to specified Network/Mailbox.
TPMove
Move a single Trading Partner ID from a Network to the Session
Network/Mailbox.
TPMoveEx
Move a single Trading Partner ID from a Network to a
specified Network/Mailbox.
Requires NetOps authorization.
TPUpdateDescription
Update an ECGridID entry's description.
TPActivate
Activate a suspended ECGridID entry.
TPSuspend
Suspend an ECGridID entry.
TPTerminate
Terminate an ECGridID entry.
TPInfo
Detail for a specific ECGridID.
TPSearch
Finds matching ECGridID(s) for specified X12 or EDIFACT Qualifier/ID pair.
TPList
List all Trading Partners in Session Network/Mailbox.
TPListEx
List all Trading Partners in specified Network/Mailbox.

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
TPAdd()
Add a Trading Partner ID to the Session Network/Mailbox.

Public Fu n ct i o n T P A d d ( B y V a l Q u a l i f i e r A s S t r i n g , _
ByVal ID As String, _
ByVal Description As String) _
As Integer

Parameters
Qualifier
String(0,3)
The X12 or EDIFACT ID Qualifier for the ISA and UNB segments.
ID
String(1,15)
The X12 or EDIFACT ID for the ISA and UNB segments.
Description
String(3,35)
The name associated with a Qualifier/ID pair.

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

Remarks
The system will check for duplicates in the same Network/Mailbox and if the Qualifier/ID pair
(QID) exists in a different Network/Mailbox, throwing an appropriate Soap Exception if
found. Use TPMove() or TPMoveEx() to move a QID from one Network/Mailbox to another.

Use TPAddVAN() and TPAddEx() to add QIDs to other Network/Mailboxes.

Example
Visual Basic

[insert code sample]

EventID: 3001
See Also
TPAddEx()
TPAddVAN()
TPMove()
TPMoveEx()
ECGridID
Networks & Mailboxes
Session Network/Mailbox

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
TPAddVAN()
Add a Trading Partner ID to a Value Added Network (VAN) connection.

Public Fu n ct i o n T P A d d V A N ( B y V a l N e t w o r k I D A s I n t e g e r , _
ByVal Qualifier As String, _
ByVal ID As String, _
ByVal Description As String) _
As Integer

Parameters
NetworkID
Integer
The ECGrid NetworkID assigned to the Value Added Network.
No MailboxID is required as all VANs operate with a single Mailbox.
Qualifier
String(0,3)
The X12 or EDIFACT ID Qualifier for the ISA and UNB segments.
ID
String(1,15)
The X12 or EDIFACT ID for the ISA and UNB segments.
Description
String(3,35)
The name associated with a Qualifier/ID pair.

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

Remarks
The system will check for duplicates in the same VAN and if the Qualifier/ID pair (QID)
exists in a different Network/Mailbox, throwing an appropriate Soap Exception if found. Use
TPMove() or TPMoveEx() to move a QID from one Network/Mailbox to another.

Use TPAdd() and TPAddEx() to add QIDs to other Network/Mailboxes.

Example
Visual Basic

[insert code sample]

EventID: 3002
See Also
TPAdd()
TPAddEx()
TPMove()
TPMoveEx()
ECGridID
Networks & Mailboxes
Value Added Networks

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
TPAddEx()
Add a Trading Partner ID to specified Network/Mailbox.

Public Fu n ct i o n T P A d d E x ( B y V a l N e t w o r k I D A s I n t e g e r , _
ByVal MailboxID As Integer, _
ByVal Qualifier As String, _
ByVal ID As String, _
ByVal Description As String) _
As Integer

Parameters
NetworkID
Integer
The ECGrid NetworkID assigned to the network.
MailboxID
Integer
The ECGrid MailboxID assigned to the ID on the specified network.
Qualifier
String(0,3)
The X12 or EDIFACT ID Qualifier for the ISA and UNB segments.
ID
String(1,15)
The X12 or EDIFACT ID for the ISA and UNB segments.
Description
String(3,35)
The name associated with a Qualifier/ID pair.

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

Remarks
The system will check for duplicates in the specified Network/Mailbox and if the Qualifier/ID
pair (QID) exists in a different Network/Mailbox, throwing an appropriate Soap Exception if
found. Use IDMove() or IDMoveEx() to move a QID from one Network/Mailbox to another.

A sufficient AuthorizationLevel is required in order to use TPAddEx().

Use TPAdd() to add QIDs to the Session Network/Mailbox and TPAddVAN() to add QIDs to
Value Added Networks.

Example
Visual Basic

[insert code sample]

EventID: 3003
See Also
TPAdd()
TPAddVAN()
TPMove()
TPMoveEx()
ECGridID
Networks & Mailboxes

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
TPMove()
Move a single Trading Partner ID from a Network/Mailbox to the Session Network/Mailbox.

Public Fu n ct i o n T P M o v e ( B y V a l E C G r i d I D A s I n t e g e r , _
ByVal MoveDateTime As Date) _
As Integer

Parameters
ECGridID
Integer
The ECGridID that represents the existing Trading Partner on another
Network/Mailbox.
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.

Returns
ECGridID
Integer
A new ECGridID for the ID on the Session Network/Mailbox.

Remarks
Moving a Trading Partner Qualifier/ID (QID) from one Network/Mailbox to another is a
process also known as a Migration. There are numerous complexities in this process which
may include written authorization by the owner of the QID to release the QID from the
existing Network. In general, a PDF of such a request on company letterhead is sufficient.

ECGrid can optionally manage this migration by sending out notices of the pending migration
to all Networks, sending reminders and tracking confirmations.

Most Networks require at least 3 business days advanced notification for an ID to be moved.
The system enforces this rule. If you need a move expedited, please contact ECGrid
NetOps to override this limitation.

To move a QID to a specified Network/Mailbox use TPMoveEx().

Example
Visual Basic

[insert code sample]

EventID: 3004
See Also
TPMoveEx()
Session Network/Mailbox

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
TPMoveEx()
Move a single Trading Partner ID from a Network to a specified Network/Mailbox.

Public Fu n ct i o n T P M o v e E x ( B y V a l N e t w o r k I D A s I n t e g e r , _
ByVal MailboxID As Integer, _
ByVal ECGridID As Integer, _
ByVal MoveDateTime As Date) _
As Integer

Parameters
NetworkID
Integer
The new NetworkID..
MailboxID
Integer
The new MailboxID.
ECGridID
Integer
The ECGridID that represents the existing Trading Partner on another
Network/Mailbox.
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.

Returns
ECGridID Integer
A new ECGridID for the ID on the specified Network/Mailbox.

Remarks
Moving a Trading Partner Qualifier/ID (QID) from one Network/Mailbox to another is a
process also known as a Migration. There are numerous complexities in this process which
may include written authorization by the owner of the QID to release the QID from the
existing Network. In general, a PDF of such a request on company letterhead is sufficient.

Most Networks require at least 3 business days advanced notification for an ID to be moved.
The system enforces this rule. If you need a move expedited, please contact ECGrid
NetOps to override this limitation.

ECGrid can optionally manage this migration by sending out notices of the pending migration
to all Networks, sending reminders and tracking confirmations.

A Network Admin/Network User can move QIDs between Mailboxes within the same
Network. To move QIDs to another Network requires NetOps Authorization Level.

To move a QID to a specified Network/Mailbox use TPMove().

Example
Visual Basic

[insert code sample]

EventID: 3005
See Also
TPMove()

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
TPUpdateDescription()
Update an ECGridID entry's Description.

Public Fu n ct i o n T P U p d a t e D e s c r i p t i o n ( B y V a l E C G r i d I D A s I n t e g e r, _
B y V a l D e s c r i p t i o n A s S t r in g ) _
As Boolean

Parameters
ECGridID
Integer
A value representing a routeable address on ECGrid. See ECGridIDs.
Description
String(3,35)
The name associated with a Qualifier/ID pair.

Returns
Boolean
True if successful, false on failure.

Remarks
This allows the description associated with the ECGridID and Qualifier/ID to be changed.
The system requires at least three (3) characters.

Example
Visual Basic

[insert code sample]

EventID: 3008
See Also
TPAdd()

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
TPActivate()
Activate a suspended ECGridID entry.

Public Fu n ct i o n T P A c t i v a t e ( B y V a l E C G r i d I D A s I n t e g e r ) _
As Boolean

Parameters
ECGridID
Integer
A value representing a routeable address on ECGrid. See ECGridIDs.

Returns
Boolean
True if successful, false on failure.

Remarks
This allows Trading Partner entries that have been previously suspended with
TPSuspend() to be reactivated. Entries that have been terminated with
TPTerminate() cannot be reactivated.

Example
Visual Basic

[insert code sample]

EventID: 3010
See Also
TPSuspend()
TPTerminate()

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
TPSuspend()
Suspend an ECGridID entry.

Public Fu n ct i o n T P S u s p e n d ( B y V a l E C G r i d I D A s I n t e g e r ) _
As Boolean

Parameters
ECGridID
Integer
A value representing a routeable address on ECGrid. See ECGridIDs.

Returns
Boolean
True if successful, false on failure.

Remarks
Trading Partners that are suspended will not have traffic routed to them; it will be held in a
suspense queue for up to 30 days. If the entry is reactivated with TPActivate() any
interchanges in the suspense queue will be immediately delivered to the InBox.

Qualifier/IDs of an Trading Partner that is suspended cannot be assigned to another


Network/Mailbox by TPAdd(), TPAddVAN() or TPAddEx(); however, they can be moved
using TPMove() or TPMoveEx().

To permanently remove a Trading Partner Qualifier/ID from a Network/Mailbox us


TPTerminate().

Example
Visual Basic

[insert code sample]

EventID: 3011
See Also
TPActivate()
TPTerminate()

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
TPTerminate()
Terminate an ECGridID entry.

Public Fu n ct i o n T P T e r m i n a t e ( B y V a l E C G r i d I D A s I n t e g e r ) _
As Boolean

Parameters
ECGridID
Integer
A value representing a routeable address on ECGrid. See ECGridIDs.

Returns
Boolean
True if successful, false on failure.

Remarks
This method permanently removes a Trading Partner's Qualifier/ID from its assigned
Network/Mailbox. Once terminated, it cannot be reactivated by TPActivate(), the Qualifier/ID
is completely released.

To temporarily suspend an entry use TPSuspend().

Example
Visual Basic

[insert code sample]

EventID: 3012
See Also
TPActivate()
TPSuspend()

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
TPInfo()
Detail for a specific ECGridID.

Public Fu n ct i o n T P I n f o ( B y V a l E C G r i d I D A s I n t e g e r ) _
As ECGridIDInfo

Parameters
ECGridID
Integer
A value representing a routeable address on ECGrid. See ECGridIDs.

Returns
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,15)
The X12 or EDIFACT ID for the ISA and UNB segments.
Description
String(3,35)
The name associated with a Qualifier/ID pair.
Status
Short - ECGridOSv0200.StatusECGrid ENUM
A numeric value representing the entry's status.
OwnerInfo
Object - ECGridOwnerInfo
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.

MailboxID
Integer
The Mailbox where this address is routed on ECGrid.
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.

Remarks
This method returns information for a specified ECGridID.
Example
Visual Basic

[insert code sample]

EventID: 3013
See Also
Trading Partners & ECGridIDs
Users & Authorization Levels

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
TPSearch()
Finds matching ECGridID(s) for specified X12 or EDIFACT Qualifier/ID pair.

Public Fu n ct i o n T P S e a r c h ( B y V a l Q u a l i f i e r A s S t r i n g , _
ByVal ID As String, _
ByVal ShowInactive As Boolean) _
As List(Of ECGridIDInfo)

Parameters
Qualifier
String(0,3)
The X12 or EDIFACT ID Qualifier for the ISA and UNB segments.
ID
String(1,15)
The X12 or EDIFACT ID for the ISA and UNB segments.
ShowInactive
Boolean
A logical flag which determines if Inactive (Suspended and Terminated) records
should be included in the return set.

Returns
ECGridIDInfo Collection

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,15)
The X12 or EDIFACT ID for the ISA and UNB segments.
Description
String(3,35)
The name associated with a Qualifier/ID pair.
Status
Short - ECGridOSv0200.StatusECGrid ENUM
A numeric value representing the entry's status.
OwnerInfo
Object - ECGridOwnerInfo
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.

MailboxID
Integer
The Mailbox where this address is routed on ECGrid.
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.

Remarks
When ShowActive is True both Suspended and Terminated records are returned. In this
way, historical data can be retrieved for any ECGridID.

To list Trading Partners by Network/Mailbox use TPList() or TPListEx()

Example
Visual Basic

[insert code sample]

EventID: 3014
See Also
TPInfo()
TPList()
TPListEx()

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
TPList()
List all Trading Partners IDs in Session Network/Mailbox.

Public Fu n ct i o n T P L i s t ( B y V a l S h o w I n a c t i v e A s B o o l e a n ) _
As List(Of ECGridIDInfo)

Parameters
ShowInactive
Boolean
A logical flag which determines if Inactive (Suspended and Terminated) records
should be included in the return set.

Returns
ECGridIDInfo Collection

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,15)
The X12 or EDIFACT ID for the ISA and UNB segments.
Description
String(3,35)
The name associated with a Qualifier/ID pair.
Status
Short - ECGridOSv0200.StatusECGrid ENUM
A numeric value representing the entry's status.
OwnerInfo
Object - ECGridOwnerInfo
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.

MailboxID
Integer
The Mailbox where this address is routed on ECGrid.
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.

Remarks
When ShowActive is True both Suspended and Terminated records are returned. In this
way, historical data can be retrieved for any ECGridID.

To list Trading Partners by a specific Network/Mailbox use TPListEx(). To list by Qualifier/ID


use TPSearch().

Example
Visual Basic

[insert code sample]

EventID: 3015
See Also
TPInfo()
TPSearch()
TPListEx()
Session Network/Mailbox

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
TPListEx()
List all Trading Partners IDs in specified Network/Mailbox.

Public Fu n ct i o n T P L i s t E x ( B y V a l N e t w o r k I D A s I n t e g e r , _
ByVal MailboxID As Integer, _
ByVal ShowInactive As Boolean) _
As List(Of ECGridIDInfo)

Parameters
NetworkID
Integer
The ECGrid NetworkID assigned to the network.
MailboxID
Integer
The ECGrid MailboxID assigned to the ID on the specified network. A value of
zero (0) lists all Mailboxes for the specified NetworkID, contingent on Authorization
Level.
ShowInactive
Boolean
A logical flag which determines if Inactive (Suspended and Terminated) records
should be included in the return set.

Returns
ECGridIDInfo Collection

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,15)
The X12 or EDIFACT ID for the ISA and UNB segments.
Description
String(3,35)
The name associated with a Qualifier/ID pair.
Status
Short - ECGridOSv0200.StatusECGrid ENUM
A numeric value representing the entry's status.
OwnerInfo
Object - ECGridOwnerInfo
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.

MailboxID
Integer
The Mailbox where this address is routed on ECGrid.
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.

Remarks
When ShowActive is True both Suspended and Terminated records are returned. In this
way, historical data can be retrieved for any ECGridID.

To list Trading Partners for the Session Network/Mailbox use TPList(). To list by Qualifier/ID
use TPSearch().

Example

Visual Basic

[insert code sample]

EventID: 3016
See Also
TPInfo()
TPSearch()
TPList()

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
Interconnect Management
InterconnectAdd
Create a new Interconnect Request.
InterconnectUpdate
Update Status of an Interconnect Request.
Requires NetOps authorization.
InterconnectNote
Add a Note to an Interconnect Request.
InterconnectCancel
Cancel an Interconnect Request.
InterconnectInfo
Detail for an InterconnectID.
InterconnectNoteList
Notes for a specific Interconnect.
InterconnectListByECGridID
Listing of Interconnects for a specific ECGridID with optional trading partner
pair.
InterconnectListByStatus
Listing of Interconnects for a specific Status for the session Network/Mailbox.
InterconnectListByStatusEx
Listing of Interconnects for a specific Status for a specified Network/Mailbox.
InterconnectAssignNetOps
Assigns NetOps staff to Interconnect Request.
Requires NetOps authorization.

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
InterconnectAdd()
Create a new Interconnect Request.

Public Fu n ct i o n I n t e r c o n n e c t A d d ( B y V a l E C G r i d I D 1 A s I n t e g e r , _
ByVal ECGridID2 As Integer, _
ByVal Reference As String, _
ByVal ContactName As String, _
ByVal ContactEMail As String, _
ByVal Note As String) _
As Integer

Parameters
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.
Reference
String(0,16)
A user-defined reference number to attach to a Interconnect request.
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.
Note
String(0,250)
A free-form note to document the transaction.

Returns
InterconnectID
Integer
The value assigned to a specific Interconnect request.

Remarks
This method initiates an Interconnect Request. Based on previous requests and the type of
Network that the ECGridID2 resides on, an expert system will determine if the Interconnect
can be immediately activated or if it requires confirmation by the Interconnected Network.

Any Interconnects that move to a Pending status will be monitored by ECGrid NetOps until
completion. To monitor the status of an Interconnect Request use InterconnectInfo() and
InterconnectNoteList().

If the requested Interconnect already exists on the system, a Duplicate SOAP Exception
will be returned.

Example
Visual Basic

[insert code sample]

EventID: 4001
See Also
Interconnects
InterconnectInfo()
InterconnectNoteList()

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
InterconnectUpdate()
Update Status of an Interconnect Request.

Public Fu n ct i o n I n t e r c o n n e c t U p d a t e ( B y V a l I n t e r c o n n e c t I D A s I nt e g e r , _
B y V a l S t a t u s A s S t a t u s I n t er c o n n e c t , _
B y V a l A u t h L e v e l A s A u t h L e ve l , _
ByVal Note As String, _
ByVal EMailTo As eMailTo, _
ByVal OtherEMailAddress As String) _
As Boolean

Parameters
InterconnectID
Integer
The value assigned to a specific Interconnect request.
Status
Short - StatusInterconnect ENUM
A numeric value representing the Interconnect's status
AuthLevel
Short - AuthLevel ENUM
The Authority Level for system access. An AuthLevel of MailboxUser allows
everyone to view the note.
Note
String(0,250)
A free-form note to document the transaction.
EMailTo
Short - eMailTo ENUM
A flag to indicate to whom a note or update should be emailed.
OtherEMailAddress
String(0,48)
A valid e-mail address outside of a system User address.

Returns
Boolean
True if successful, false on failure.

Remarks
Requires NetOps authorization.

This method allows ECGrid NetOps to manage an Interconnect that is not immediately
confirmed. To monitor the status of an Interconnect Request use InterconnectInfo() and
InterconnectNoteList().

Example
Visual Basic

[insert code sample]

EventID: 4002
See Also
Interconnects
InterconnectInfo()
InterconnectNoteList()
InterconnectAssignNetOps()

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
InterconnectNote()
Add a Note to an Interconnect Request.

Public Fu n ct i o n I n t e r c o n n e c t N o t e ( B y V a l I n t e r c o n n e c t I D A s I n t eg e r , _
B y V a l A u t h L e v e l A s A u t h L e v e l, _
ByVal Note As String, _
ByVal EMailTo As eMailTo, _
B y V a l O t h e r E M a i l A d d r e s s A s St r i n g ) _
As Boolean

Parameters
InterconnectID
Integer
The value assigned to a specific Interconnect request.
AuthLevel
Short - AuthLevel ENUM
The Authority Level required to access this specific note. An AuthLevel of
MailboxUser allows everyone to view the note.
Note
String(0,250)
A free-form note to document the transaction.
EMailTo
Short - eMailTo ENUM
A flag to indicate to whom a note or update should be emailed.
OtherEMailAddress
String(0,48)
A valid e-mail address outside of a system User address.

Returns
Boolean
True if successful, false on failure.

Remarks
Ad hoc notes can be added to an Interconnect Request.

The EMailTo parameter allows a note to be e-mailed in addition to being stored in the
system. Each Interconnect has several default e-mail addresses attached to it:

The Requester (see ContactName & ContactEMail in InterconnectAdd())


The Mailbox InterconnectsContact. [pending implementation]
The Network InterconnectContact/InterconnectEMail.

ECGrid NetOps is CCed with all Interconnect Notes that are e-mailed.

OtherEMailAddress allows any additional party to be e-mailed with this note.

Example
Visual Basic

[insert code sample]

EventID: 4003
See Also
InterconnectAdd()
MailboxInterconnectsContact()

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
InterconnectCancel()
Cancel an Interconnect Request.

Public Fu n ct i o n I n t e r c o n n e c t C a n c e l ( B y V a l I n t e r c o n n e c t I D A s I nt e g e r , _
ByVal Note As String, _
ByVal EMailTo As eMailTo, _
ByVal OtherEMailAddress As String) _
As Boolean

Parameters
InterconnectID
Integer
The value assigned to a specific Interconnect request.
Status
Short - StatusInterconnect ENUM
A numeric value representing the Interconnect's status
Note
String(0,250)
A free-form note to document the transaction.
EMailTo
Short - eMailTo ENUM
A flag to indicate to whom a note or update should be emailed.
OtherEMailAddress
String(0,48)
A valid e-mail address outside of a system User address.

Returns
Boolean
True if successful, false on failure.

Remarks
This allows a Pending Interconnect Request to be canceled. An optional Note can be
included with the cancellation.

It does not prevent data from flowing between Trading Partners if an Interconnect is already
in place. For this, you will need to contact the Trading Partner directly.

The EMailTo parameter allows a copy of the Cancellation to be e-mailed in addition to


being stored in the system. Each Interconnect has several default e-mail addresses attached
to it:

The Requester (see ContactName & ContactEMail in InterconnectAdd())


The Mailbox InterconnectsContact. [pending implementation]
The Network InterconnectContact/InterconnectEMail.

ECGrid NetOps is CCed with all Interconnect Cancellations that are e-mailed.

OtherEMailAddress allows any additional party to be e-mailed with this Cancellation.

Example
Visual Basic

[insert code sample]

EventID: 4004
See Also
Interconnects

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
InterconnectInfo()
Detail for an Interconnect.

Public Fu n ct i o n I n t e r c o n n e c t I n f o ( B y V a l I n t e r c o n n e c t I D A s I n t eg e r ) _
As InterconnectIDInfo

Parameters
InterconnectID
Integer
The value assigned to a specific Interconnect request.

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

Remarks
This method returns the current state of an Interconnect Request by InterconnectID. Use
InterconnectNoteList() to get a list of all Notes associated with this Interconnect.

To locate an Interconnect Request by ECGridID use InterconnectListByECGridID(). To


locate an Interconnect Request by Network/Mailbox and Status use
InterconnectListByStatus() or InterconnectListByStatusEx().

Example
Visual Basic
[insert code sample]

EventID: 4005
See Also
Interconnects
InterconnectListByECGridID()
InterconnectListByStatus()
InterconnectListByStatusEx()

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
InterconnectNoteList()
Notes for a specific Interconnect.

Public Fu n ct i o n I n t e r c o n n e c t N o t e L i s t ( B y V a l I n t e r c o n n e c t I D A s I n t e g e r ) _
A s L i s t ( O f I n t e r c o n n e c t No t e )

Parameters
InterconnectID
Integer
The value assigned to a specific Interconnect request.

Returns
InterconnectNote Collection

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.

Remarks
A list of notes associated with the Interconnect Request. Notes can be appended to
Interconnect Requests directly by InterconnectNote(), InterconnectUpdate() and
InterconnectCancel().

Example
Visual Basic

[insert code sample]

EventID: 4007
See Also
InterconnectNote()
InterconnectUpdate()
InterconnectCancel()

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
InterconnectListByECGridID()
Listing of Interconnects for a specific ECGridID with optional trading partner pair.

Public Fu n ct i o n I n t e r c o n n e c t L i s t B y E C G r i d I D ( B y V a l E C G r i d I D 1 A s I n t e g e r , _
ByVal ECGridID2 As Integer) _
A s L i s t ( O f I n t e r c on n e c t I D I n f o )

Parameters
ECGridID1
Integer
The ECGridID representing the Trading Partner requesting the Interconnect. See
ECGridIDs.
ECGridID2
Integer
The ECGridID representing the Trading Partner being Interconnected to. If this value
is set to zero (0) a list of all Interconnect Requests for ECGridID1 will be returned.

Returns
InterconnectIDInfo Collection

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

Remarks
Returns a list of Interconnect Requests for ECGridID1, or the specific Interconnect Request
for ECGridID1 and ECGridID2.
To locate an Interconnect Request by Network/Mailbox and Status use
InterconnectListByStatus() or InterconnectListByStatusEx().

Example
Visual Basic

[insert code sample]

EventID: 4008
See Also
InterconnectListByStatus()
InterconnectListByStatusEx()

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
InterconnectListByStatus()
Listing of Interconnects for a specific Status for the session Network/Mailbox.

Public Fu n ct i o n I n t e r c o n n e c t L i s t B y S t a t u s ( B y V a l S t a t u s A s S t a tu s I n t e r c o n n e c t , _
B y V a l E C G r i d I D A s I nt e g e r , _
B y V a l M a x D a y s A s S h or t ) _
A s L i s t ( O f I n t e r c o n ne c t I D I n f o )

Parameters
Status
Short - StatusInterconnect ENUM
A numeric value representing the Interconnect's status
ECGridID
Integer
A value representing a routeable address on ECGrid. See ECGridIDs. Use zero (0)
to match all ECGridIDs.
MaxDays
Short
The maximum number of days a report should go back from today. Use -1 to return
all matching records regardless of date.

Returns
InterconnectIDInfo Collection

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.
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.
Remarks
Returns a list of Interconnect Requests for the Session Network/Mailbox for a specific
Interconnect Status. It may be filtered by ECGridID and MaxDays.

To list Interconnect Requests by Status on a specified Network/Mailbox, use


InterconnectListByStatusEx(). For a list of Interconnect Requests by ECGridID, regardless
of Status, use InterconnectListByECGridID().

Example
Visual Basic

[insert code sample]

EventID: 4009
See Also
Status Levels
StatusInterconnect ENUM
InterconnectListByStatusEx()
InterconnectListByECGridID()

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
InterconnectListByStatusEx()
Listing of Interconnects for a specific Status for a specified Network/Mailbox.

Public Fu n ct i o n I n t e r c o n n e c t L i s t B y S t a t u s E x ( B y V a l N e t w o r k I D A s I n t e g e r , _
ByVal MailboxID As Integer, _
B y V a l S t a t u s A s S ta t u s I n t e r c o n n e c t , _
ByVal ECGridID As Integer, _
B y V a l M a x D a y s A s Sh o r t ) _
A s L i s t ( O f I n t e r c on n e c t I D I n f o )

Parameters
NetworkID
Integer
The ECGrid NetworkID assigned to the network.
MailboxID
Integer
The ECGrid MailboxID assigned to the ID on the specified network. A value of
zero (0) lists all Mailboxes for the specified NetworkID, contingent on Authorization
Level.
Status
Short - StatusInterconnect ENUM
A numeric value representing the Interconnect's status
ECGridID
Integer
A value representing a routeable address on ECGrid. See ECGridIDs. Use zero (0)
to match all ECGridIDs.
MaxDays
Short
The maximum number of days a report should go back from today. Use -1 to return
all matching records regardless of date.

Returns
InterconnectIDInfo Collection

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

Remarks
Returns a list of Interconnect Requests for the specified Network/Mailbox for a specific
Interconnect Status. It may be filtered by ECGridID and MaxDays.

To list Interconnect Requests by Status for the Session Network/Mailbox, use


InterconnectListByStatus(). For a list of Interconnect Requests by ECGridID, regardless of
Status, use InterconnectListByECGridID().

Example
Visual Basic

[insert code sample]

EventID: 4010
See Also
Status Levels
StatusInterconnect ENUM
InterconnectListByStatus()
InterconnectListByECGridID()

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
InterconnectAssignNetOps()
Assigns NetOps staff to Interconnect Request.

Public Fu n ct i o n I n t e r c o n n e c t A s s i g n N e t O p s ( B y V a l I n t e r c o n n e c t I D A s I n t e g e r , _
B y V a l U s e r I D a s I n t eg e r , _
B y V a l e M a i l T o A s e M ai l T o ) _
As Boolean

Parameters
InterconnectID
Integer
The value assigned to a specific Interconnect request.
UserID
Integer
A numeric value used to represent a specific user on the system.
User must be of NetOps AuthLevel or higher.
EMailTo
Short - eMailTo ENUM
A flag to indicate to whom a note or update should be emailed.

Returns
Boolean
True if successful, false on failure.

Remarks
The method is used to assign a NetOps user to follow up on the specific Interconnect
Request.

Requires NetOps authorization.

Example
Visual Basic

[insert code sample]

EventID: 4011
See Also
Users & Authorization Levels
Interconnects

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
Carbon Copy Management
CarbonCopyAdd
Add a Carbon Copy which is billed to the Session Network/Mailbox.
CarbonCopyAddEx
Add a new Carbon Copy which is billed to a specified Network/Mailbox.
CarbonCopyActivate
Activate a suspended Carbon Copy.
CarbonCopySuspend
Suspend an active Carbon Copy.
CarbonCopyTerminate
Terminate a Carbon Copy.
CarbonCopyInfo
Details for a Carbon Copy configuration.
CarbonCopyList
List of Carbon Copy configurations for the Session Network/Mailbox.
CarbonCopyListEx
List of Carbon Copy configurations for a specified Network/Mailbox.

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
CarbonCopyAdd()
Add a Carbon Copy which is billed to the Session Network/Mailbox.

Public Fu n ct i o n C a r b o n C o p y A d d ( B y V a l E C G r i d I D F r o m A s I n t e g e r , _
ByVal ECGridIDTo As Integer, _
B y V a l E C G r i d I D C C F r o m A s I n t e g e r, _
ByVal ECGridIDCCTo As Integer) _
As Integer

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

Returns
CarbonCopyID
Integer
The value assigned to a specific Carbon Copy entry.

Remarks
This method adds a Carbon Copy configuration to the ECGrid Infrastructure. If an
Interchange passes through ECGrid with a Sender & Receiver that matches the
ECGridIDFrom and ECGridIDTo parameters, then a copy of that Interchange will be
created using ECGridIDCCFrom and ECGridIDCCTo as the copy's Sender & Receiver.

In order to make sure that data is not copied without proper authorization, either the
ECGridIDFrom or ECGridIDTo must be on the Network/Mailbox making the request. Since
it is possible that a legitimate requester may be the Carbon Copy Receiver, NetOps can
override this limitation when authorization has been obtained from either the Original Sender
or Original Receiver.

Carbon Copies are immediately active. Be sure to an Interconnect Request is in place for
the ECGridIDCCFrom and ECGridIDCCTo before creating the Carbon Copy.

Please review Carbon Copies for limitations and special considerations depending on the
Receiver's Network.

Any Carbon Copy created by this method will have any billable portions charged to the
Session Network/Mailbox which created it. To charge a Carbon Copy to another
Network/Mailbox use CarbonCopyAddEx().

Example
Visual Basic

[insert code sample]

EventID: 5001
See Also
Carbon Copies
CarbonCopyAddEx()
Session Network/Mailbox

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
CarbonCopyAddEx()
Add a new Carbon Copy which is billed to a specified Network/Mailbox.

Public Fu n ct i o n C a r b o n C o p y A d d E x ( B y V a l N e t w o r k I D A s I n t e g e r , _
ByVal MailboxID As Integer, _
B y V a l E C G r i d I D F r o m A s I n t e g e r, _
ByVal ECGridIDTo As Integer, _
B y V a l E C G r i d I D C C F r o m A s I n t e ge r , _
B y V a l E C G r i d I D C C T o A s I n t e g e r) _
As Integer

Parameters
NetworkID
Integer
The ECGrid NetworkID assigned to the network.
MailboxID
Integer
The ECGrid MailboxID assigned to the ID on the specified network.
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.

Returns
CarbonCopyID
Integer
The value assigned to a specific Carbon Copy entry.

Remarks
This method adds a Carbon Copy configuration to the ECGrid Infrastructure. If an
Interchange passes through ECGrid with a Sender & Receiver that matches the
ECGridIDFrom and ECGridIDTo parameters, then a copy of that Interchange will be
created using ECGridIDCCFrom and ECGridIDCCTo as the copy's Sender & Receiver.

In order to make sure that data is not copied without proper authorization, either the
ECGridIDFrom or ECGridIDTo must be on the Network/Mailbox making the request. Since
it is possible that a legitimate requester may be the Carbon Copy Receiver, NetOps can
override this limitation when authorization has been obtained from either the Original Sender
or Original Receiver.

Carbon Copies are immediately active. Be sure to an Interconnect Request is in place for
the ECGridIDCCFrom and ECGridIDCCTo before creating the Carbon Copy.

Please review Carbon Copies for limitations and special considerations depending on the
Receiver's Network.

Any Carbon Copy created by this method will have any billable portions charged to the
specified Network/Mailbox. A sufficient Authorization Level is required to make the
assignment. To charge a Carbon Copy to the Session Network/Mailbox use
CarbonCopyAdd().

Example
Visual Basic

[insert code sample]

EventID: 5002
See Also
Carbon Copies
CarbonCopyAdd()

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
CarbonCopyActivate()
Activate a suspended Carbon Copy.

Public Fu n ct i o n C a r b o n C o p y A c t i v a t e ( B y V a l C a r b o n C o p y I D A s I n t eg e r ) _
As Boolean

Parameters
CarbonCopyID
Integer
The value assigned to a specific Carbon Copy entry.

Returns
Boolean
True if successful, false on failure.

Remarks
This method reactivates a Carbon Copy that has been suspended with
CarbonCopySuspend(). A Carbon Copy that has been terminated with
CarbonCopyTerminate() cannot be reactivated.

Example
Visual Basic

[insert code sample]

EventID: 5003
See Also
CarbonCopySuspend()
CarbonCopyTerminate()

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
CarbonCopySuspend()
Suspend an active Carbon Copy.

Public Fu n ct i o n C a r b o n C o p y S u s p e n d ( B y V a l C a r b o n C o p y I D A s I n t e ge r ) _
As Boolean

Parameters
CarbonCopyID
Integer
The value assigned to a specific Carbon Copy entry.

Returns
Boolean
True if successful, false on failure.

Remarks
Active Carbon Copies can be temporarily suspended using this method. Once suspended,
they can be reactivated with CarbonCopyActivate(). To permanently terminated a Carbon
Copy use CarbonCopyTerminate().

Example
Visual Basic

[insert code sample]

EventID: 5004
See Also
CarbonCopyActivate()
CarbonCopyTerminate()

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
CarbonCopyTerminate()
Terminate a Carbon Copy.

Public Fu n ct i o n C a r b o n C o p y T e r m i n a t e ( B y V a l C a r b o n C o p y I D A s I n te g e r ) _
As Boolean

Parameters
CarbonCopyID
Integer
The value assigned to a specific Carbon Copy entry.

Returns
Boolean
True if successful, false on failure.

Remarks
This method permanently terminates a Carbon Copy. To temporarily suspended a Carbon
Copy use CarbonCopySuspend().

Example
Visual Basic

[insert code sample]

EventID: 5005
See Also
CarbonCopyActivate()
CarbonCopySuspend()

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
CarbonCopyInfo()
Detail for a Carbon Copy.

Pu bl ic F unc tio n Car bon Co pyI nfo (ByVa l Ca rbo n C op yI D As I n teg e r ) _


As C arbo nCo p y ID In f o

Parameters
CarbonCopyID
Integer
The value assigned to a specific Carbon Copy entry.

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

Remarks
Detailed information for a specific CarbonCopyID. To find Carbon Copies by
Network/Mailbox and/or Original Sender/Receiver use CarbonCopyList() or
CarbonCopyListEx().

Example
Visual Basic

[insert code sample]

EventID: 5006
See Also
CarbonCopyList()
CarbonCopyListEx()

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
CarbonCopyList()
List of Carbon Copy configurations for the Session Network/Mailbox.

Public Fu n ct i o n C a r b o n C o p y L i s t ( B y V a l E C G r i d I D F r o m A s I n t e g e r , _
ByVal ECGridIDTo As Integer, _
ByVal ShowInactive As Boolean) _
As List(Of CarbonCopyIDInfo)

Parameters
ECGridIDFrom
Integer
The ECGridID representing the Original Sending Trading Partner. User zero (0) to
match any. See ECGridIDs.
ECGridIDTo
Integer
The ECGridID representing the Original Receiving Trading Partner. User zero (0) to
match any. See ECGridIDs.
ShowInactive
Boolean
A logical flag which determines if Inactive (Suspended and Terminated) records
should be included in the return set.

Returns
CarbonCopyIDInfo Collection

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.

Remarks
A list of Carbon Copies for the Session Network/Mailbox.

It may be filtered by Original Sender and or Original Receiver. To list all Carbon Copies for a
specific Original Sender, set ECGridIDTo to zero (0). To list all Carbon Copies for a specific
Original Receiver, set ECGridIDFrom to zero (0).
To list Carbon Copies for a specified Network/Mailbox use CarbonCopyListEx().

Example
Visual Basic

[insert code sample]

EventID: 5007
See Also

CarbonCopyListEx()
Session Network/Mailbox

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
CarbonCopyListEx()
List of Carbon Copy configurations for a specified Network/Mailbox.

Public Fu n ct i o n C a r b o n C o p y L i s t E x ( B y V a l N e t w o r k I D A s I n t e g e r , _
ByVal MailboxID As Integer, _
B y V a l E C G r i d I D F r o m A s I n t e g er , _
ByVal ECGridIDTo As Integer, _
B y V a l S h o w I n a c t i v e A s B o o l e an ) _
As List(Of CarbonCopyIDInfo)

Parameters
NetworkID
Integer
The ECGrid NetworkID assigned to the network.
MailboxID
Integer
The ECGrid MailboxID assigned to the ID on the specified network. A value of
zero (0) lists all Mailboxes for the specified NetworkID, contingent on Authorization
Level.
ECGridIDFrom
Integer
The ECGridID representing the Original Sending Trading Partner. User zero (0) to
match any. See ECGridIDs.
ECGridIDTo
Integer
The ECGridID representing the Original Receiving Trading Partner. User zero (0) to
match any. See ECGridIDs.
ShowInactive
Boolean
A logical flag which determines if Inactive (Suspended and Terminated) records
should be included in the return set.

Returns
CarbonCopyIDInfo Collection

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.

Remarks
A list of Carbon Copies for a specified Network/Mailbox. Proper Authorization Level is
required.

It may be filtered by Original Sender and or Original Receiver. To list all Carbon Copies for a
specific Original Sender, set ECGridIDTo to zero (0). To list all Carbon Copies for a specific
Original Receiver, set ECGridIDFrom to zero (0).

To list Carbon Copies for the Session Network/Mailbox use CarbonCopyList().

Example
Visual Basic

[insert code sample]

EventID: 5008
See Also
CarbonCopyList()

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
Parcel Management
ParcelInBox
Current InBox for the Session Network/Mailbox.
ParcelInBoxEx
Current InBox for a specified Network/Mailbox.
ParcelDownload
Download Parcel from InBox or Archive with EDI envelope intact.
ParcelDownloadInner
Download inner content of Parcel from InBox or Archive with outer X12
ISA/IEA envelope removed.
ParcelDownloadConfirm
Confirm Download of Parcel from InBox and remove it.
ParcelUpload
Upload X12 or EDIFACT Parcel to OutBox.
ParcelUploadEx
Upload non-EDI Parcel to OutBox.
ParcelInfo
List of Interchanges in a Parcel.
ParcelManifest
Transaction Manifest for a Parcel.
ParcelInterchangeManifest
A complete end-to-end transaction Manifest for a specific Interchange.
ParcelNoteList
List the system generated Notes for a Parcel.
ParcelInBoxArchive
InBox Archive List for the Session Network/Mailbox.
ParcelInBoxArchiveEx
InBox Archive List for a specified Network/Mailbox.
ParcelOutBoxArchive
OutBox Archive List for the Session Network/Mailbox.
ParcelOutBoxArchiveEx
OutBox Archive List for a specified Network/Mailbox.
ParcelOutBoxError
List of Parcels which could not be processed for the Session
Network/Mailbox.
ParcelOutBoxErrorEx
List of Parcels which could not be processed for a specified Network/Mailbox.
InterchangeDate
Get Date/Time from EDI Envelope (ISA or UNB).

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
ParcelInBox()
Current InBox for the Session Network/Mailbox.

Public Fu n ct i o n P a r c e l I n B o x ( ) A s L i s t ( O f P a r c e l I D I n f o )

Parameters
None

Returns
ParcelIDInfo Collection

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.
NetworkIDTo
Integer
The Parcel destination NetworkID.
NetworkNameTo
String(3,40)
The descriptive name of the Network.
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.
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.

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

Remarks
A list of all Parcels pending download in the Session Network/Mailbox.

Use ParcelDownload() or ParcelDownloadInner() to download the Parcels through


ECGridOS. Alternatively, they may be accessed through other communications channels
such as FTP or AS2.

Use ParcelDownloadConfirm() to confirm successful download of a Parcel through


ECGridOS and remove it from the pending list.

To list Parcels from a specified Network/Mailbox use ParcelInBoxEx().

Example
Visual Basic

[insert code sample]

EventID: 6001
See Also
Parcels
ParcelDownload()
ParcelDownloadInner()
ParcelInBoxEx()
Session Network/Mailbox

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
ParcelInBoxEx()
Current InBox for a specified Network/Mailbox.

Public Fu n ct i o n P a r c e l I n B o x E x ( B y V a l N e t w o r k I D A s I n t e g e r , _
ByVal MailboxID As Integer) _
As List(Of ParcelIDInfo)

Parameters
NetworkID
Integer
The ECGrid NetworkID assigned to the network.
MailboxID
Integer
The ECGrid MailboxID assigned to the ID on the specified network. A value of
zero (0) lists all Mailboxes for the specified NetworkID, contingent on Authorization
Level.

Returns
ParcelIDInfo Collection

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.
NetworkIDTo
Integer
The Parcel destination NetworkID.
NetworkNameTo
String(3,40)
The descriptive name of the Network.
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.
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.

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

Remarks
A list of all Parcels pending download in a specified Session Network/Mailbox.

Use ParcelDownload() or ParcelDownloadInner() to download the Parcels through


ECGridOS. Alternatively, they may be accessed through other communications channels
such as FTP or AS2.

Use ParcelDownloadConfirm() to confirm successful download of a Parcel through


ECGridOS and remove it from the pending list.

To list Parcels from the Session Network/Mailbox use ParcelInBox().


Example
Visual Basic

[insert code sample]

EventID: 6002
See Also
Parcels
ParcelDownload()
ParcelDownloadInner()
ParcelInBox()

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
ParcelDownload()
Download Parcel from InBox or Archive with EDI envelope intact.

Public Fu n ct i o n P a r c e l D o w n l o a d ( B y V a l P a r c e l I D A s L o n g ) _
As FileInfo

Parameters
ParcelID
Long
The value assigned to track a specific Parcel on ECGrid.

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

Remarks
Downloads a complete Parcel from ECGrid as long as it has not been archived.

Once a Parcel has been successfully downloaded from the InBox the first time,
ParcelDownloadConfirm() should be called to remove it from the pending download list.

If the payload is non-EDI data, then ParcelDownloadInner() should be used to strip off the
outer EDI Envelope.

Example
Visual Basic

[insert code sample]

EventID: 6003
See Also
Parcels
ParcelDownloadConfirm()
ParcelDownloadInner()
Uploading & Downloading Files

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
ParcelDownloadInner()
Download inner content of Parcel from InBox or Archive with outer X12 ISA/IEA envelope
removed.

Public Fu n ct i o n P a r c e l D o w n l o a d I n n e r ( B y V a l P a r c e l I D A s L o n g ) _
As FileInfo

Parameters
ParcelID
Long
The value assigned to track a specific Parcel on ECGrid.

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

Remarks
Downloads the inner contents of Parcel from ECGrid as long as it has not been archived.

Bytes will match the actual inner Content downloaded and not the number of bytes in the
complete Parcel when looking at the ParcelIDInfo Object.

Once a Parcel has been successfully downloaded from the InBox the first time,
ParcelDownloadConfirm() should be called to remove it from the pending download list.

If the payload is EDI data, then ParcelDownload() should be used to keep the outer EDI
Envelope intact.

Example
Visual Basic

[insert code sample]

EventID: 6004
See Also
Parcels
ParcelDownloadConfirm()
ParcelDownload()
ParcelIDInfo Object
Uploading & Downloading Files

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
ParcelDownloadConfirm()
Confirm Download of Parcel from InBox and remove it.

Public Fu n ct i o n P a r c e l D o w n l o a d C o n f i r m ( B y V a l P a r c e l I D A s L o n g ) _
As Boolean

Parameters
ParcelID
Long
The value assigned to track a specific Parcel on ECGrid.

Returns
Boolean
True if successful, false on failure.

Remarks
Once a Parcel has been successfully downloaded from the InBox the first time,
ParcelDownloadConfirm() should be called to remove it from the pending download list.

If ParcelDownloadConfirm() is not called or the file deleted from disk through FTP or AS2,
the system will generate a Pending Parcel Download message when the InBoxTimeout
value is exceeded.

It will also physically remove the Parcel from the InBox on disk, which is used for other
communication channels such as FTP and AS2.

Example
Visual Basic

[insert code sample]

EventID: 6005
See Also
ParcelDownload()
ParcelDownloadInner()
MailboxInBoxTimeout()

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
ParcelUpload()
Upload X12 or EDIFACT Parcel to OutBox.

Public Fu n ct i o n P a r c e l U p l o a d ( B y V a l F i l e N a m e A s S t r i n g , _
ByVal Bytes As Integer, _
ByVal Content As Byte()) _
As Integer

Parameters
FileName
String(1,127)
The file name assigned to a Parcel. It will be stored on disk with this name.
Bytes
Integer
The number of bytes in the uploaded Parcel.
Content
Byte()
A byte array representing the data in a Parcel. See Uploading & Downloading
Files.

Returns
ParcelID
Long
The value assigned to track a specific Parcel on ECGrid.

Remarks
This method allows Parcels to be directly uploaded to ECGrid through the ECGridOS
interface. Other communication channels are available such as FTP or AS2.

The content must be X12 or EDIFACT in order to be processed and routed by ECGrid. To
send non-EDI data, use ParcelUploadEx().

FileName must be a valid Windows filename, invalid FileNames will generate SOAP
Exception.

Bytes must equal the Content length, or a SOAP Exception will be raised.

Example
Visual Basic

[insert code sample]

EventID: 6006
See Also

Parcels
ParcelUploadEx()
SOAP Exceptions
Uploading & Downloading Files

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
ParcelUploadEx()
Upload any format Parcel to OutBox.

Public Fu n ct i o n P a r c e l U p l o a d E x ( B y V a l F i l e N a m e A s S t r i n g , _
ByVal Bytes As Integer, _
ByVal Content As Byte()
ByVal ECGridIDFrom As Integer, _
ByVal ECGridIDTo As Integer) _
As Integer

Parameters
FileName
String(1,127)
The file name assigned to a Parcel. It will be stored on disk with this name.
Bytes
Integer
The number of bytes in the uploaded Parcel.
Content
Byte()
A byte array representing the data in a Parcel. See Uploading & Downloading
Files.
ECGridIDFrom
Integer
The ECGridID representing the sending Trading Partner. See ECGridIDs.
ECGridIDTo
Integer
The ECGridID representing the receiving Trading Partner. See ECGridIDs.

Returns
ParcelID
Long
The value assigned to track a specific Parcel on ECGrid.

Remarks
This method allows non-EDI Parcels to be directly uploaded to ECGrid through the
ECGridOS interface. An X12 EDI envelope will be wrapped around the data using
ECGridIDFrom and ECGridIDTo in order to route it over ECGrid. Use
ParcelDownloadInner() to strip the envelope and download the original Content.

The X12 ISA segment will have the following values assigned to assist in quickly identifying
an Interchange which has been uploaded with ParcelUploadEx():

ISA01: ZZ
ISA02: ECGRIDOS
ISA03: ZZ
ISA04: UPLOADEX

To send EDI data, use ParcelUpload().

FileName must be a valid Windows filename, invalid FileNames will generate SOAP
Exception.

Bytes must equal the Content length, or a SOAP Exception will be raised.

NOTE: While some Networks will be able to accept EDI-wrapped data, most will not. Be
sure to check with your Trading Partner to make sure their system can handle this type of
data.

Example
Visual Basic

[insert code sample]

EventID: 6007
See Also
Parcels
ParcelDownloadInner()
ParcelUpload()
SOAP Exceptions
Uploading & Downloading Files

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
ParcelInfo()
List of Interchanges in a Parcel.

Public Fu n ct i o n P a r c e l I n f o ( B y V a l P a r c e l I D A s L o n g ) _
As ParcelIDInfo

Parameters
ParcelID
Long
The value assigned to track a specific Parcel on ECGrid.

Returns
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.
NetworkIDTo
Integer
The Parcel destination NetworkID.
NetworkNameTo
String(3,40)
The descriptive name of the Network.
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.
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.
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.
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.

Remarks
This method returns detail for a specific Parcel.

While Parcels can contain multiple Interchanges, it is strongly discouraged on ECGrid. We


recommend one Interchange per Parcel. However, many VANs still batch multiple
Interchanges in a single Mailbag. It is anticipated that this method will be made
predominately with InterchangeID := 0.

If there are multiple Interchanges in a Parcel, but some of the Interchanges are for other
Network/Mailboxes to which the current User is not authorized, only the authorized
Interchanges will be returned.

Example
Visual Basic

[insert code sample]

EventID: 6008
See Also
Parcels, Interchanges & Mailbags
ParcelIDInfo Object

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
ParcelManifest()
Transaction Manifest for a Parcel.

Public Fu n ct i o n P a r c e l M a n i f e s t ( B y V a l P a r c e l I D A s L o n g ) _
As List(Of ManifestInfo)

Parameters
ParcelID
Long
The value assigned to track a specific Parcel on ECGrid.

Returns
ManifestInfo Collection

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' prefix refers to the Interchange (Envelope). The suffix is a
Short.
StatusMessage
String
The description of the Status Code.

Remarks
This method returns a manifest for a specific Parcel. This data is kept on-line until the
Parcel is archived. Manifests contain all the specific steps a Parcel takes when traversing
ECGrid. It is similar to FedEx Tracking.

For OutBox Parcels (see ParcelUpload() or ParcelUploadEx()), this contains all the steps
a Parcel has taken on ECGrid up to the routing of the contained Interchanges.

For InBox Parcels (see ParcelDownload() or ParcelDownloadInner()), this contains all the
steps a Parcel has taken through ECGrid since Interchanges were added to it for delivery.

To get the complete manifest for an Interchange use ParcelInterchangeManifest().

Example
Visual Basic

[insert code sample]

EventID: 6009
See Also
ParcelUpload()
ParcelUpload()
ParcelUploadEx()
ParcelDownload()
ParcelDownloadInner()
ParcelInterchangeManifest()
Parcels, Interchanges & Mailbags

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
ParcelInterchangeManifest()
A complete end-to-end transaction Manifest for a specific Interchange.

Public Fu n ct i o n P a r c e l I n t e r c h a n g e M a n i f e s t ( B y V a l I n t e r c h a n g e I D A s L o n g ) _
A s L i s t ( O f M a n i f e s tI n f o )

Parameters
InterchangeID
Long
A value representing a specific Interchange within ECGrid.

Returns
ManifestInfo Collection

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' prefix refers to the Interchange (Envelope). The suffix is a
Short.
StatusMessage
String
The description of the Status Code.

Remarks
This method returns a manifest for a specific Interchange. This data is kept on-line until the
Interchange is archived. Manifests contain all the specific steps a Interchange takes when
traversing ECGrid. It is similar to FedEx Tracking.

To get the manifest for the InBox Parcel or OutBox Parcel of an Interchange use
ParcelManifest().

Example
Visual Basic

[insert code sample]

EventID: 6010
See Also
ParcelManifest()
Parcels, Interchanges & Mailbags

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
ParcelNoteList()
List the system generated Notes for a Parcel.

Public F un c t i o n P a r c e l N o t e L i s t ( B y V a l P a r c e l I D A s L o n g ) _
As List(Of ParcelNote)

Parameters
ParcelID
Long
The value assigned to track a specific Parcel on ECGrid.

Returns
ParcelNote Collection

ParcelID
Long
The value assigned to a specific Parcel.
ParcelNoteID
Integer
The serial number assigned to the specific Parcel Note.
InterchangeID
Long
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.

Remarks
When an exception occurs in the processing of a Parcel, a note is entered into the system
automatically or by ECGrid NetOps. This method is helpful in diagnosing OutBox errors.

Most Parcels will not have any Notes associated with them. See ParcelManifest() for
normal processing information.

Example
Visual Basic

[insert code sample]

EventID: 6011
See Also
ParcelManifest()
ParcelOutBoxError()
ParcelOutBoxErrorEx()

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
ParcelInBoxArchive()
InBox Archive List for the Session Network/Mailbox.

Public Fu n ct i o n P a r c e l I n B o x A r c h i v e ( B y V a l B e g i n D a t e A s D a t e , _
ByVal EndDate As Date, _
B y V a l E C G r i d I D F r o m A s I n t eg e r , _
B y V a l E C G r i d I D T o A s I n t e g er ) _
As List(Of ParcelIDInfo)

Parameters
BeginDate
Date
The date & time to start a report. All dates are in UTC. See NowUTC().
EndDate
Date
The date & time to end a report. All dates are in UTC. See NowUTC().
ECGridIDFrom
Integer
The ECGridID representing the sending Trading Partner. Set value to zero (0) to
match any Sender. See ECGridIDs.
ECGridIDTo
Integer
The ECGridID representing the receiving Trading Partner. Set value to zero (0) to
match any Receiver. See ECGridIDs.

Returns
ParcelIDInfo Collection

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.
NetworkIDTo
Integer
The Parcel destination NetworkID.
NetworkNameTo
String(3,40)
The descriptive name of the Network.
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.
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.

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

Remarks
This method returns a list of Parcels from the Session Network/Mailbox InBox Archive.
The actual content and manifest are kept on-line for at least 90-days, after that this
information can be retrieved from ECGrid NetOps.
The list may be filtered by providing non-zero values for ECGridIDFrom or ECGridIDTo. At
least one of the two when provided must be in the Session Network/Mailbox.

The maximum span between BeginDate and EndDate is 31 days.

To run reports on a specified Network/Mailbox use ParcelInBoxArchiveEx().

Example
Visual Basic

[insert code sample]

EventID: 6012
See Also

Parcels
ParcelInBoxArchiveEx()
ParcelOutBoxArchive()
ParcelOutBoxArchiveEx()
Session Network/Mailbox

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
ParcelInBoxArchiveEx()
InBox Archive List for a specified Network/Mailbox.

Public Fu n ct i o n P a r c e l I n B o x A r c h i v e E x ( B y V a l N e t w o r k I D A s I n t e ge r , _
B y V a l M a i l b o x I D A s I n t e ge r , _
ByVal BeginDate As Date, _
ByVal EndDate As Date, _
B y V a l E C G r i d I D F r o m A s I nt e g e r , _
B y V a l E C G r i d I D T o A s I n t eg e r ) _
As List(Of ParcelIDInfo)

Parameters
NetworkID
Integer
The ECGrid NetworkID assigned to the network.
MailboxID
Integer
The ECGrid MailboxID assigned to the ID on the specified network. A value of
zero (0) lists all Mailboxes for the specified NetworkID, contingent on Authorization
Level.
BeginDate
Date
The date & time to start a report. All dates are in UTC. See NowUTC().
EndDate
Date
The date & time to end a report. All dates are in UTC. See NowUTC().
ECGridIDFrom
Integer
The ECGridID representing the sending Trading Partner. Set value to zero (0) to
match any Sender. See ECGridIDs.
ECGridIDTo
Integer
The ECGridID representing the receiving Trading Partner. Set value to zero (0) to
match any Receiver. See ECGridIDs.

Returns
ParcelIDInfo Collection

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.
NetworkIDTo
Integer
The Parcel destination NetworkID.
NetworkNameTo
String(3,40)
The descriptive name of the Network.
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.
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.

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

Remarks
This method returns a list of from a specified Network/Mailbox InBox Archive. The actual
content and manifest are kept on-line for at least 90-days, after that this information can be
retrieved from ECGrid NetOps.

The current User must have the proper Authorization Level to query the specified
Network/Mailbox or a SOAP Exception will be thrown.

The list may be filtered by providing non-zero values for ECGridIDFrom or ECGridIDTo. At
least one of the two when provided must be in the specified Network/Mailbox.

The maximum span between BeginDate and EndDate is 31 days.

To run reports on the Session Network/Mailbox use ParcelInBoxArchive().

Example
Visual Basic

[insert code sample]

EventID: 6013
See Also
Parcels
ParcelInBoxArchive()
Authorization Level
SOAP Exceptions

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
ParcelOutBoxArchive()
OutBox Archive List for the Session Network/Mailbox.

Public Fu n ct i o n P a r c e l O u t B o x A r c h i v e ( B y V a l B e g i n D a t e A s D a t e , _
ByVal EndDate As Date, _
B y V a l E C G r i d I D F r o m A s I n te g e r , _
B y V a l E C G r i d I D T o A s I n t e ge r ) _
As List(Of ParcelIDInfo)

Parameters
BeginDate
Date
The date & time to start a report. All dates are in UTC. See NowUTC().
EndDate
Date
The date & time to end a report. All dates are in UTC. See NowUTC().
ECGridIDFrom
Integer
The ECGridID representing the sending Trading Partner. Set value to zero (0) to
match any Sender. See ECGridIDs.
ECGridIDTo
Integer
The ECGridID representing the receiving Trading Partner. Set value to zero (0) to
match any Receiver. See ECGridIDs.

Returns
ParcelIDInfo Collection

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.
NetworkIDTo
Integer
The Parcel destination NetworkID.
NetworkNameTo
String(3,40)
The descriptive name of the Network.
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.
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.

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

Remarks
This method returns a list of Parcels from the Session Network/Mailbox OutBox Archive.
The actual content and manifest are kept on-line for at least 90-days, after that this
information can be retrieved from ECGrid NetOps.
The list may be filtered by providing non-zero values for ECGridIDFrom or ECGridIDTo. At
least one of the two when provided must be in the Session Network/Mailbox.

The maximum span between BeginDate and EndDate is 31 days.

To run reports on a specified Network/Mailbox use ParcelOutBoxArchiveEx().

Example
Visual Basic

[insert code sample]

EventID: 6014
See Also
Parcels
ParcelOutBoxArchiveEx()
ParcelInBoxArchive()
ParcelInBoxArchiveEx()
Session Network/Mailbox

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
ParcelOutBoxArchiveEx()
OutBox Archive List for a specified Network/Mailbox.

Public Fu n ct i o n P a r c e l O u t B o x A r c h i v e E x ( B y V a l N e t w o r k I D A s I n t eg e r , _
B y V a l M a i l b o x I D A s I n t eg e r , _
B y V a l B e g i n D a t e A s D a t e, _
ByVal EndDate As Date, _
B y V a l E C G r i d I D F r o m A s In t e g e r , _
B y V a l E C G r i d I D T o A s I n te g e r ) _
A s L i s t ( O f P a r c e l I D I n f o)

Parameters
NetworkID
Integer
The ECGrid NetworkID assigned to the network.
MailboxID
Integer
The ECGrid MailboxID assigned to the ID on the specified network. A value of
zero (0) lists all Mailboxes for the specified NetworkID, contingent on Authorization
Level.
BeginDate
Date
The date & time to start a report. All dates are in UTC. See NowUTC().
EndDate
Date
The date & time to end a report. All dates are in UTC. See NowUTC().
ECGridIDFrom
Integer
The ECGridID representing the sending Trading Partner. Set value to zero (0) to
match any Sender. See ECGridIDs.
ECGridIDTo
Integer
The ECGridID representing the receiving Trading Partner. Set value to zero (0) to
match any Receiver. See ECGridIDs.

Returns
ParcelIDInfo Collection

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.
NetworkIDTo
Integer
The Parcel destination NetworkID.
NetworkNameTo
String(3,40)
The descriptive name of the Network.
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.
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.

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

Remarks
This method returns a list of from a specified Network/Mailbox OutBox Archive. The actual
content and manifest are kept on-line for at least 90-days, after that this information can be
retrieved from ECGrid NetOps.

The current User must have the proper Authorization Level to query the specified
Network/Mailbox or a SOAP Exception will be thrown.

The list may be filtered by providing non-zero values for ECGridIDFrom or ECGridIDTo. At
least one of the two when provided must be in the specified Network/Mailbox.

The maximum span between BeginDate and EndDate is 31 days.

To run reports on the Session Network/Mailbox use ParcelOutBoxArchive().

Example
Visual Basic

[insert code sample]

EventID: 6015
See Also
Parcels
ParcelOutBoxArchive()
ParcelInBoxArchive()
ParcelInBoxArchiveEx()
Authorization Level
SOAP Exceptions

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
ParcelOutBoxError()
List of Parcels which could not be processed for the Session Network/Mailbox.

Pu bl ic F unc tio n Par cel Ou tBo xEr ror(B yVal Be g i nD at e As D a te, _


B yVal En d D at e A s Da t e ) _
A s Li st( O f P ar c e lID I n fo)

Parameters
BeginDate
Date
The date & time to start a report. All dates are in UTC. See NowUTC().
EndDate
Date
The date & time to end a report. All dates are in UTC. See NowUTC().

Returns
ParcelIDInfo Collection

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.
NetworkIDTo
Integer
The Parcel destination NetworkID.
NetworkNameTo
String(3,40)
The descriptive name of the Network.
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.
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.

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

Remarks
[stuff]

Example
Visual Basic

[insert code sample]

EventID: 6016
See Also

Session Network/Mailbox

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
ParcelOutBoxErrorEx()
List of Parcels which could not be processed for a specified Network/Mailbox.

Public Fu n ct i o n P a r c e l O u t B o x E r r o r E x ( B y V a l N e t w o r k I D A s I n t e g er , _
B y V a l M a i l b o x I D A s I n t e g er , _
ByVal BeginDate As Date, _
ByVal EndDate As Date) _
As List(Of ParcelIDInfo)

Parameters
NetworkID
Integer
The ECGrid NetworkID assigned to the network.
MailboxID
Integer
The ECGrid MailboxID assigned to the ID on the specified network. A value of
zero (0) lists all Mailboxes for the specified NetworkID, contingent on Authorization
Level.
BeginDate
Date
The date & time to start a report. All dates are in UTC. See NowUTC().
EndDate
Date
The date & time to end a report. All dates are in UTC. See NowUTC().

Returns
ParcelIDInfo Collection

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.
NetworkIDTo
Integer
The Parcel destination NetworkID.
NetworkNameTo
String(3,40)
The descriptive name of the Network.
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.
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.

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

Remarks
The method returns a list of Parcels that have a Valid value of other than
ParcelValid.Valid (1) for a specified Network/Mailbox.
The current User must have the proper Authorization Level to query the specified
Network/Mailbox or a SOAP Exception will be thrown.

The list may be filtered by providing non-zero values for ECGridIDFrom or ECGridIDTo. At
least one of the two when provided must be in the specified Network/Mailbox.

The Valid values are defined as follows:

ParcelValid.Invalid (0)
There was something structurally wrong with the Parcel, and it could not be
processed. The problems with the Parcel need to be corrected and resubmitted.
ParcelNoteList() may be of assistance in finding the problem.
ParcelValid.ValidPartialRouted (2)
The structure of the Parcel is valid; however, in a multi-Interchange Parcel (not
recommended) some of the Interchanges had known Receiver Qualifier/IDs, some
did not. The suspended Interchange(s) will be forwarded if a matching Trading
Partner Qualifier/ID is added to ECGrid within 30 days.

TPTo = nothing, indicates that the Interchange could not be routed.


ParcelValid.ValidNoneRouted (3)
The structure of the Parcel is valid; however, no Interchange(s) had known Receiver
Qualifier/IDs. The suspended Interchange(s) will be forwarded if a matching Trading
Partner Qualifier/ID is added to ECGrid within 30 days.

TPTo = nothing, indicates that the Interchange could not be routed.

The maximum span between BeginDate and EndDate is 31 days.

To create an OutBox error report for the Session Network/Mailbox use


ParcelOutBoxError().

Example
Visual Basic

[insert code sample]

EventID: 6017
See Also
ParcelValid ENUM
ParcelNoteList()
Parcels, Interchanges & Mailbags

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
InterchangeDate()
Get Date/Time from EDI Envelope (ISA or UNB).

Public F unc t ion I nte r chan g eDat e(ByV al In terc hange Head er As Stri ng) As Dat e

Parameters
InterchangeHeader
String
A valid ISA or UNB segment.

Returns
InterchangeDateTime
Date
The Date/Time of an Interchange derived from the Interchange Envelope ISA or UNB
segment.

Remarks
This method does not require a login.

Example
Visual Basic
Dim d t A s Dat e

Dim i sa A s St r ing = _
"ISA* 00* *00* *01* 00012 3456 *ZZ* ECGRID *081 116*0 622* U*004 00*0 00000 181*0 *P*> "
dt = Int e rcha n geD a te(i s a) ' Novem ber 16, 2 008 6 :22a m

Dim u nb A s St r ing = _
"UNB+ UNO A :2+0 0 012 3 456+ 1 +ECG RID:Z Z+08 0704: 1351+ 1000 00717 ++DELJ IT"
dt = Int e rcha n geD a te(u n b) ' July 4, 2 008 1 :51pm

EventID: n/a
See Also

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
Reports
ReportMonthly
Selected Monthly Report for the Session Network/Mailbox.
ReportMonthlyEx
Selected Monthly Report for a specified Network/Mailbox.
ReportTrafficStats
Statistical Traffic Report for a period of time for the Session Network/Mailbox.
ReportTrafficStatsEx
Statistical Traffic Report for a period of time for a specified Network/Mailbox.
ReportInstantStats
Instant Statistics for the Session Network/Mailbox.
ReportInstantStatsEx
Instant Statistics for a specified Network/Mailbox.

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
ReportMonthly()
Selected Monthly Report for the Session Network/Mailbox.

Public Fu n ct i o n R e p o r t M o n t h l y ( B y V a l R e p o r t A s S h o r t , _
ByVal Month As Date) _
As DataSet

Parameters
Report
Short
A numeric value representing the requested report.
Month
Date
The month for the report. Must be the 1st of the month such as 11/01/2008.

Returns
DataSet
Dependent on specific report.

Remarks
The current reports available are:

Report Description
1 Traffic Summary by Day
2 Traffic Summary by Trading Partner
3 Trading Partner Summary by Network
4 Trading Partner Transaction Detail

Example
Visual Basic

[insert code sample]

EventID: 8001
See Also
ReportMonthlyEx()

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
ReportMonthlyEx()
Selected Monthly Report for a specified Network/Mailbox.

Public Fu n ct i o n R e p o r t M o n t h l y ( B y V a l N e t w o r k I D A s I n t e g e r , _
ByVal MailboxID As Integer, _
ByVal Report As Short, _
ByVal Month As Date) _
As DataSet

Parameters
NetworkID
Integer
The ECGrid NetworkID assigned to the network.
MailboxID
Integer
The ECGrid MailboxID assigned to the ID on the specified network. A value of
zero (0) lists all Mailboxes for the specified NetworkID, contingent on Authorization
Level.
Report
Short
A numeric value representing the requested report.
Month
Date
The month for the report. Must be the 1st of the month such as 11/01/2008.

Returns
DataSet
Dependent on specific report.

Remarks
The current reports available are:

Report Description
1 Traffic Summary by Day
2 Traffic Summary by Trading Partner
3 Trading Partner Summary by Network
4 Trading Partner Transaction Detail

Example
Visual Basic

[insert code sample]

EventID: 8002
See Also
ReportMonthly()

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
ReportTrafficStats()
Statistical Traffic Report for a period of time for the Session Network/Mailbox.

Public Fu n ct i o n R e p o r t T r a f f i c S t a t s ( B y V a l T a r g e t T i m e A s D a t e , _
ByVal NumPeriods As Short, _
B y V a l P e r i o d A s S t a t i s t i c sP e r i o d ) _
As DataSet

Parameters
TargetTime
Date
This indicates the inital or final time for the report based on whether NumPeriods is
positive or negative.
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.
Period
Short - StatisticsPeriod ENUM
A numeric value representing the sampling interval.

Returns
DataSet
The fields included are as follows:

Period
Date
The date/time denoting the beginning of the reported period.
ParcelIn
Integer
The number of Parcels received.
ParcelInKC
Integer
The number of Parcel KCs received.
ParcelOut
Integer
The number of Parcels sent.
ParcelOutKC
Integer
The number of Parcel KCs sent.
InterchangeIn
Integer
The number of Interchanges received.
InterchangeInKC
Integer
The number of Interchange KCs received.
InterchangeOut
Integer
The number of Interchanges sent.
InterchangeOutKC
Integer
The number of Interchange KCs sent.

Remarks
When NumPeriods is positive, TargetTime will be rolled back to match the initial time of the
selected Period interval. For example, if the Period is Day, then the TargetTime will be set
back to 12 midnight or if the period is Week, then the TargetTime will be set to Sunday at
12 midnight. When NumPeriods is a negative value, TargetTime will be rolled forward to
the end of the Period.

There is no record for periods without any activity.

Kilocharacters (KCs) are rounded per Parcel/Interchange based on the Network/Mailbox


Kilocharacters (KCs) are rounded per Parcel/Interchange based on the Network/Mailbox
configuration.

Example
Visual Basic

[insert code sample]

EventID: 8003
See Also
ReportTrafficStatsEx()

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
ReportTrafficStatsEx()
Statistical Traffic Report for a period of time for a specified Network/Mailbox.

Public Fu n ct i o n R e p o r t T r a f f i c S t a t s E x ( B y V a l N e t w o r k I D A s I n t e ge r , _
B y V a l M a i l b o x I D A s I n t e ge r , _
B y V a l T a r g e t T i m e A s D a t e, _
B y V a l N u m P e r i o d s A s S h o rt , _
B y V a l P e r i o d A s S t a t i s t ic s P e r i o d ) _
As DataSet

Parameters
NetworkID
Integer
The ECGrid NetworkID assigned to the network.
MailboxID
Integer
The ECGrid MailboxID assigned to the ID on the specified network. A value of
zero (0) lists all Mailboxes for the specified NetworkID, contingent on Authorization
Level.
TargetTime
Date
This indicates the inital or final time for the report based on whether NumPeriods is
positive or negative.
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.
Period
Short - StatisticsPeriod ENUM
A numeric value representing the sampling interval.

Returns
DataSet
The fields included are as follows:

Period
Date
The date/time denoting the beginning of the reported period.
ParcelIn
Integer
The number of Parcels received.
ParcelInKC
Integer
The number of Parcel KCs received.
ParcelOut
Integer
The number of Parcels sent.
ParcelOutKC
Integer
The number of Parcel KCs sent.
InterchangeIn
Integer
The number of Interchanges received.
InterchangeInKC
Integer
The number of Interchange KCs received.
InterchangeOut
Integer
The number of Interchanges sent.
InterchangeOutKC
Integer
The number of Interchange KCs sent.
Remarks
When NumPeriods is positive, TargetTime will be rolled back to match the initial time of the
selected Period interval. For example, if the Period is Day, then the TargetTime will be set
back to 12 midnight or if the period is Week, then the TargetTime will be set to Sunday at
12 midnight. When NumPeriods is a negative value, TargetTime will be rolled forward to
the end of the Period.

There is no record for periods without any activity.

Kilocharacters (KCs) are rounded per Parcel/Interchange based on the Network/Mailbox


configuration.

Example
Visual Basic

[insert code sample]

EventID: 8004
See Also
ReportTrafficStats()

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
ReportTrafficStats()
Statistical Traffic Report for a period of time for the Session Network/Mailbox.

Public Fu n ct i o n R e p o r t I n s t a n t S t a t s ( ) A s D a t a S e t

Parameters
[None]

Returns
DataSet
The fields included are as follows:

Type
String
The type of Parcels or Interchange.
Color
String
A color code that can be used to accent nature of status.
StatusCode
String
The status code associated with the Parcel or Interchange. An 'M' prefix
refers to a Parcel (Mailbag) and an 'E' prefex refers to an Intechange
(Envelope). The suffix is a Short.
Count
Integer
The number of Parcels or Interchanges with this StatusCode.

Remarks
This function returns the instantaneous statistics on the status of any Parcels and
Interchanges which are not of a Closed or Archived status.

Example
Visual Basic

[insert code sample]

EventID: 8005
See Also
ReportInstantStatsEx()

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
ReportTrafficStatsEx()
Statistical Traffic Report for a period of time for a specified Network/Mailbox.

Public Fu n ct i o n R e p o r t I n s t a n t S t a t s E x ( B y V a l N e t w o r k I D A s I n t e ge r , _
B y V a l M a i l b o x I D A s I n t e ge r ) _
As DataSet

Parameters
NetworkID
Integer
The ECGrid NetworkID assigned to the network.
MailboxID
Integer
The ECGrid MailboxID assigned to the ID on the specified network. A value of
zero (0) lists all Mailboxes for the specified NetworkID, contingent on Authorization
Level.

Returns
DataSet
The fields included are as follows:

Type
String
The type of Parcels or Interchange.
Color
String
A color code that can be used to accent nature of status.
StatusCode
String
The status code associated with the Parcel or Interchange. An 'M' prefix refers to a
Parcel (Mailbag) and an 'E' prefex refers to an Intechange (Envelope). The suffix is a
Short.
Count
Integer
The number of Parcels or Interchanges with this StatusCode.

Remarks
This function returns the instantaneous statistics on the status of any Parcels and
Interchanges which are not of a Closed or Archived status.

Example
Visual Basic

[insert code sample]

EventID: 8006
See Also
ReportInstantStats()

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
ReportTrafficStatsEx()
Statistical Traffic Report for a period of time for a specified Network/Mailbox.

Public Fu n ct i o n R e p o r t I n s t a n t S t a t s E x ( B y V a l N e t w o r k I D A s I n t e ge r , _
B y V a l M a i l b o x I D A s I n t e ge r ) _
As DataSet

Parameters
NetworkID
Integer
The ECGrid NetworkID assigned to the network.
MailboxID
Integer
The ECGrid MailboxID assigned to the ID on the specified network. A value of
zero (0) lists all Mailboxes for the specified NetworkID, contingent on Authorization
Level.

Returns
DataSet
The fields included are as follows:

Type
String
The type of Parcels or Interchange.
Color
String
A color code that can be used to accent nature of status.
StatusCode
String
The status code associated with the Parcel or Interchange. An 'M' prefix refers to a
Parcel (Mailbag) and an 'E' prefex refers to an Intechange (Envelope). The suffix is a
Short.
Count
Integer
The number of Parcels or Interchanges with this StatusCode.

Remarks
This function returns the instantaneous statistics on the status of any Parcels and
Interchanges which are not of a Closed or Archived status.

Example
Visual Basic

[insert code sample]

EventID: 8006
See Also
ReportInstantStats()

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
Status Levels
Numerous Objects within ECGridOS use the standard status level represented by the
Status ENUM.

The status levels are as follows:

Active (1)
This is the normal, fully operational status.

Development (2)
A special status for systems in development.

Preproduction (0)
The object is pending Active status but is not available for normal operations. This cannot
be set through ECGridOS, but can be created within the ECGrid infrastructure.

Suspended (-1)
The object has been suspended for active operation; however, any associated external ID
(e.g. Qualifier/ID) remains reserved on the system. A suspended object can be reactivated.

Terminated (-2)
This object no longer is available for active operations on ECGrid. Any associated external
ID is released for use by others on the ECGrid infrastructure. Terminated objects cannot be
reactivated.

AutoRoute (2)
ECGridID Only. This is the same as Active; however, it indicates that the entry was created
by the sending of an unknown sender Qualifier/ID pair through the ECGrid infrastructure.

Duplicate (-3)
ECGridID Only. This is a legacy status code and may show up on stale records. They can
be considered Terminated.

Interconnect Status
Interconnects have a separate set of status levels represented by the InterconnectStatus
ENUM and are defined as follows:

Pending (0)
Interconnect request transferred to NetOps. Waiting to hear back from the Network, pending
confirmation.

Completed (-1)
Interconnect has been confirmed.
Canceled (-2)
Interconnect has been canceled.

Delayed (1)
Interconnect request transferred to NetOps. The confirmation has been delayed.

Problem (2)
Interconnect request transferred to NetOps. There is a problem with the Interconnect
request.

AuthorizationRequired (3)
Interconnect request transferred to NetOps. The Network is requesting written authorization
in order to complete this Interconnect. This normally involves the migration of a Qualifier/ID
to a new Network.

NoStatusChange (-99)
This is the status code to use to add a note to an Interconnect request without causing a
status change.

© 2008, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
ENUMs
The following Enums are defined in ECGridOS to facilitate creating better documented code.

NOTE: Enum values are interpreted by Web Services, so you cannot rely or determine the
underlying value except at runtime.

ENUMs - Visual Basic

Enum AuthLevel As Short


NoChange
Root
TechOps
NetOps
NetworkAdmin
NetworkUser
MailboxAdmin
MailboxUser
General
End Enum

Enum CellCarrier As Short


NoChange
Undefined
ATTCingular
Verizon
TMobile
SprintPCS
Nextel
Alltel
VirginMobile
ATTPreCingular
End Enum

Enum Direction As Short


OutBound
InBound
End Enum

Enum EDIStandard As Short


X12
EDIFACT
End Enum

Enum eMailTo As Short


NoEMail
Local
Network
LocalAndNetwork
Other
LocalAndOther
NetworkAndOther
EMailAll
End Enum

Enum NetworkLogStatus As Short


Start
CheckIn
Access
Pause
Restart
Shutdown
End Enum

Enum NetworkLogType As Short


SystemAutomated
User
End Enum

Enum NetworkRunStatus As Short


OffLine
Active
Sleeping
Alert
End Enum

Enum NetworkStatus As Short


NormalOperation
ECGridScheduledOutage
ECGridUnscheduledOutage
NetworkScheduledOutage
NetworkUnscheduledOutage
End Enum

Enum NetworkType As Short


Network
Router
End Enum

Enum ParcelValid As Short

Pending
Invalid
Valid
ValidPartialRouted
ValidNoneRouted
End Enum

Enum RetCode As Short


Success
SesssionTimeout
AccessDenied
NotFound
InvalidID
Duplicate
IDExistsOnNetwork
InvalidDataType
InvalidDataLength
DataError
SQLError
End Enum

Enum StatisticsPeriod As Short


Hour
Day
Week
Month
End Enum

Enum Status As Short


Development
Active
Preproduction
Suspended
Terminated
End Enum

Enum StatusECGridID As Short


Active
AutoRoute
Pending
Suspended
Terminated
Duplicate
End Enum

Enum StatusInterconnect As Short


Pending
Completed
Canceled
Delayed
Problem
AuthorizationRequired
NoStatusChange
End Enum

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
Object Classes
The following classes are used to return objects from certain ECGridOS methods. Only
public properties are available.

net.ecgridos Object Classes - Visual Basic


Public Cl a ss A S 2 I n f o
Publi c I D A s S t r i n g
Publi c U R L A s S t r i n g
Publi c C e r t i f i c a t e A s S t r i n g
Publi c C e r t i f i c a t e E x p i r e s A s D a t e
End Class

Public Cl a ss C a r b o n C o p y I D I n f o
Publi c C a r b o n C o p y I D A s I n t e g e r
Publi c N e t w o r k I D A s I n t e g e r
Publi c M a i l b o x I D A s I n t e g e r
Publi c C r e a t e d A s D a t e
Publi c M o d i f i e d A s D a t e
Publi c S t a t u s A s E C G r i d O S v 0 2 0 0 . S t a t u s
Publi c O r i g i n a l F r o m A s E C G r i d I D I n f o
Publi c O r i g i n a l T o A s E C G r i d I D I n f o
Publi c C C F r o m A s E C G r i d I D I n f o
Publi c C C T o A s E C G r i d I D I n f o
End Class

Public Cl a ss E r r o r I n f o
Publi c E r r o r C o d e A s S h o r t
Publi c E r r o r S t r i n g A s S t r i n g
Publi c E r r o r I t e m A s S t r i n g
Publi c E r r o r M e s s a g e A s S t r i n g
End Class

Public Cl a ss E C G r i d I D I n f o
Publi c E C G r i d I D A s I n t e g e r
Publi c N e t w o r k I D A s I n t e g e r
Publi c N e t w o r k N a m e A s S t r i n g
Publi c Q u a l i f i e r A s S t r i n g
Publi c I D A s S t r i n g
Publi c D e s c r i p t i o n A s S t r i n g
Publi c S t a t u s A s E C G r i d O S v 0 2 0 0 . S t a t u s E C G r i d I D
Publi c O w n e r I n f o A s E C G r i d O w n e r I n f o

Publi c C l a s s E C G r i d O w n e r I n f o
P u bl i c M a i l b o x I D A s I n t e g e r
P u bl i c C r e a t e d A s D a t e
P u bl i c M o d i f i e d A s D a t e
P u bl i c E f f e c t i v e A s D a t e
P u bl i c E x p i r e s A s D a t e
End C l as s
End Class

Public Cl a ss F i l e I n f o
Publi c P a r c e l I D A s I n t e g e r
Publi c F i l e N a m e A s S t r i n g
Publi c F i l e D a t e A s D a t e
Publi c B y t e s A s I n t e g e r
Publi c C o n t e n t ( ) A s B y t e
End Class

Public Cl a ss I n t e r c h a n g e I D I n f o
Publi c I n t e r c h a n g e I D A s L o n g
Publi c I n t e r c h a n g e P r o c e s s D a t e A s D a t e
Publi c N e t w o r k I D F r o m A s I n t e g e r
Publi c N e t w o r k I D T o A s I n t e g e r
Publi c S t a n d a r d A s E C G r i d O S v 0 2 0 0 . E D I S t a n d a r d
Publi c B y t e s A s I n t e g e r
Publi c I n t e r c h a n g e C o n t r o l I D A s S t r i n g
Publi c I n t e r c h a n g e D a t e T i m e A s D a t e
Publi c S t a t u s D a t e A s D a t e
Publi c S t a t u s C o d e A s S t r i n g
Publi c S t a t u s M e s s a g e A s S t r i n g
Publi c H e a d e r A s S t r i n g
Publi c T P F r o m A s E C G r i d I D I n f o
Publi c T P T o A s E C G r i d I D I n f o
Publi c P a r c e l s A s L i s t ( O f P a r c e l I D I n f o )
End Class

Public Cl a ss I n t e r c o n n e c t I D I n f o
Publi c I n t e r c o n n e c t I D A s I n t e g e r
Publi c C r e a t e d A s D a t e
Publi c M o d i f i e d A s D a t e
Publi c C o m p l e t e d A s D a t e
Publi c C o n t a c t N a m e A s S t r i n g
Publi c C o n t a c t E M a i l A s S t r i n g
Publi c S t a t u s A s E C G r i d O S v 0 2 0 0 . S t a t u s I n t e r c o n n e c t
Publi c T P 1 A s E C G r i d I D I n f o
Publi c R e f e r e n c e 1 A s S t r i n g
Publi c T P 2 A s E C G r i d I D I n f o
Publi c R e f e r e n c e 2 A s S t r i n g
Publi c N e t O p s A s U s e r I D I n f o
End Class

Public Cl a ss I n t e r c o n n e c t N o t e
Publi c I n t e r c o n n e c t I D A s I n t e g e r
Publi c I n t e r c o n n e c t N o t e I D A s I n t e g e r
Publi c N o t e D a t e A s D a t e
Publi c S t a t u s A s E C G r i d O S v 0 2 0 0 . S t a t u s I n t e r c o n n e c t
Publi c P o s t e d B y A s S t r i n g
Publi c U s e r I D A s I n t e g e r
Publi c M a i l T o A s S t r i n g
Publi c N o t e A s S t r i n g
End Class

Public Cl a ss M a i l b o x C o n f i g
Publi c I n B o x T i m e o u t A s S h o r t
Publi c S e g T e r m A s B y t e
Publi c E l m S e p A s B y t e
Publi c S u b E l m S e p A s B y t e
Publi c E B C D I C F i l t e r A s B o o l e a n
Publi c F T P a s c i i F i l t e r A s B o o l e a n
Publi c L o w P a s s F i l t e r A s B o o l e a n
Publi c M a i l b a g P a s s T h r o u g h A s B o o l e a n
End Class

Public Cl a ss M a i l b o x I D I n f o
Publi c M a i l b o x I D A s I n t e g e r
Publi c N e t w o r k I D A s I n t e g e r
Publi c N a m e A s S t r i n g
Publi c C r e a t e d A s D a t e
Publi c M o d i f i e d A s D a t e
Publi c S t a t u s A s E C G r i d O S v 0 2 0 0 . S t a t u s
Publi c O w n e r U s e r I D A s U s e r I D I n f o
Publi c E r r o r s U s e r I D A s U s e r I D I n f o
Publi c I n t e r c o n n e c t s U s e r I D A s U s e r I D I n f o
Publi c N o t i c e s U s e r I D A s U s e r I D I n f o
Publi c C o n f i g A s M a i l b o x C o n f i g
Publi c A S 2 I n f o A s A S 2 I n f o
End Class

Public Cl a ss M a n i f e s t I n f o
Publi c M a n i f e s t I D A s L o n g
Publi c M a n i f e s t D a t e A s D a t e
Publi c N e t w o r k I D A s I n t e g e r
Publi c N e t w o r k N a m e A s S t r i n g
Publi c P a r c e l I D A s L o n g
Publi c I n t e r c h a n g e I D A s L o n g
Publi c S t a t u s C o d e A s S t r i n g
Publi c S t a t u s M e s s a g e A s S t r i n g
End Class

Public Cl a ss N e t w o r k I D I n f o
Publi c N e t w o r k I D A s I n t e g e r
Publi c N a m e A s S t r i n g
Publi c L o c a t i o n A s S t r i n g
Publi c A d m i n C o n t a c t A s S t r i n g
Publi c A d m i n P h o n e A s S t r i n g
Publi c A d m i n E M a i l A s S t r i n g
Publi c L a s t C o n t a c t A s D a t e
Publi c A S 2 I n f o A s A S 2 I n f o
Publi c T y p e A s E C G r i d O S v 0 2 0 0 . N e t w o r k T y p e
Publi c S t a t u s A s E C G r i d O S v 0 2 0 0 . S t a t u s
Publi c R u n S t a t u s A s E C G r i d O S v 0 2 0 0 . N e t w o r k R u n S t a t u s
Publi c N e t w o r k S t a t u s A s E C G r i d O S v 0 2 0 0 . N e t w o r k S t a t u s
Publi c L a s t L o g A s N e t w o r k L o g
Publi c A S 2 I n f o A s A S 2 I n f o
Publi c O w n e r I n f o A s N e t w o r k O w n e r I n f o

Publi c C l a s s N e t w o r k O w n e r I n f o
P u bl i c T y p e A s S t r i n g
P u bl i c R o u t i n g T y p e A s S t r i n g
P u bl i c I n t e r c o n n e c t C o n t a c t A s S t r i n g
P u bl i c I n t e r c o n n e c t E M a i l A s S t r i n g
P u bl i c E r r o r C o n t a c t A s S t r i n g
P u bl i c E r r o r E M a i l A s S t r i n g
P u bl i c C o n f i g A s M a i l b o x C o n f i g
End C l as s
End Class

Public Cl a ss N e t w o r k L o g
Publi c L o g I D A s I n t e g e r
Publi c L o g D a t e A s D a t e
Publi c U s e r I D A s I n t e g e r
Publi c T y p e A s E C G r i d O S v 0 2 0 0 . N e t w o r k L o g T y p e
Publi c S t a t u s A s E C G r i d O S v 0 2 0 0 . N e t w o r k L o g S t a t u s
Publi c A c c e s s L e v e l A s E C G r i d O S v 0 2 0 0 . A u t h L e v e l
Publi c D e s c r i p t i o n A s S t r i n g
End Class

Public Cl a ss P a r c e l I D I n f o
Publi c P a r c e l I D A s L o n g
Publi c P a r c e l B y t e s A s I n t e g e r
Publi c P a r c e l D a t e A s D a t e
Publi c NetworkIDFrom As Integer
Publi c NetworkNameFrom As String
Publi c NetworkIDTo As Integer
Publi c NetworkNameTo As String
Publi c FileName As String
Publi c MailbagControlID As String
Publi c StatusDate As Date
Publi c StatusCode As String
Publi c StatusMessage As String
Publi c Valid As ECGridOSv0200.ParcelValid
Publi c Direction As ECGridOSv0200.Direction
Publi c Interchanges As List(Of InterchangeIDInfo)
End Class

Public Cl a ss P a r c e l N o t e
Publi c P a r c e l I D A s L o n g
Publi c P a r c e l N o t e I D A s I n t e g e r
Publi c I n t e r c h a n g e I D A s L o n g
Publi c N o t e D a t e A s D a t e
Publi c S t a t u s C o d e A s S t r i n g
Publi c P o s t e d B y A s S t r i n g
Publi c U s e r I D A s I n t e g e r
Publi c N o t e A s S t r i n g
End Class

Public Cl a ss S e s s i o n I n f o
Publi c S e s s i o n I D A s S t r i n g
Publi c S e s s i o n E v e n t I D A s I n t e g e r
Publi c U s e r I D A s I n t e g e r
Publi c L o g i n N a m e A s S t r i n g
Publi c F i r s t N a m e A s S t r i n g
Publi c L a s t N a m e A s S t r i n g
Publi c C o m p a n y A s S t r i n g
Publi c E m a i l A s S t r i n g
Publi c P h o n e A s S t r i n g
Publi c A u t h L e v e l A s E C G r i d O S v 0 2 0 0 . A u t h L e v e l
Publi c L a s t L o g i n A s D a t e
Publi c O p e n S e s s i o n s A s S h o r t
Publi c T i m e O u t A s S h o r t
Publi c N e t w o r k I D A s I n t e g e r
Publi c M a i l b o x I D A s I n t e g e r
Publi c i p A s S t r i n g
End Class

Public Cl a ss U s e r I D I n f o
Publi c U s e r I D A s I n t e g e r
Publi c L o g i n N a m e A s S t r i n g
Publi c R e c o v e r y Q u e s t i o n A s S t r i n g
Publi c F i r s t N a m e A s S t r i n g
Publi c L a s t N a m e A s S t r i n g
Publi c C o m p a n y A s S t r i n g
Publi c E m a i l A s S t r i n g
Publi c P h o n e A s S t r i n g
Publi c C e l l P h o n e A s S t r i n g
Publi c C e l l C a r r i e r A s E C G r i d O S v 0 2 0 0 . C e l l C a r r i e r
Publi c N e t w o r k I D A s I n t e g e r
Publi c M a i l b o x I D A s I n t e g e r
Publi c A u t h L e v e l A s E C G r i d O S v 0 2 0 0 . A u t h L e v e l
Publi c C r e a t e d A s D a t e
Publi c M o d i f i e d A s D a t e
Publi c L a s t L o g i n A s D a t e
Publi c S t a t u s A s E C G r i d O S v 0 2 0 0 . S t a t u s
End Class

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
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.
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,15)
The X12 or EDIFACT ID for the ISA and UNB segments.
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.
MailboxID
Integer
The ECGrid MailboxID assigned to the ID on the specified network.
MaxDays
Short
The maximum number of days a report should go back from today.
Minutes
Short
Number of minutes.
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.
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.
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.
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.
UserID
Integer
A numeric value used to represent a specific user on the system.

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
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.

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,15)
The X12 or EDIFACT ID for the ISA and UNB segments.
Description
String(3,35)
The name associated with a Qualifier/ID pair.
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.

MailboxID
Integer
The Mailbox where this address is routed on ECGrid.
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.

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.

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.
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.
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.
NetworkIDTo
Integer
The Parcel destination NetworkID.
NetworkNameTo
String(3,40)
The descriptive name of the Network.
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.
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.

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

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

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

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

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
SOAP Exceptions
Catching Errors in ECGridOS™
As in all good programming, trapping error situations is key to a great user experience.
ECGridOS makes extensive use of SOAP Exceptions to help the developer along when
problems occur.

There are two types of SOAP errors that can by thrown by ECGridOS. The first is by the
Framework itself, primarily syntactic, and the second is by the ECGridOS system, syntactic
and semantic.

Framework Exceptions

The most common Framework Exception is for missing parameters, as with web services all
parameters are required. Additionally, an exception generated due to internal server errors
will likely throw a Framework Exception.

ECGridOS Exceptions

When ECGridOS throws an exception, it creates a specifically formatted <detail></detail>


node that is included in the SOAP Exception.

details XML Node

<details>
<ErrorCode>8</ErrorCode>
<ErrorString>Invalid data length.</ErrorString>
<ErrorItem>Description</ErrorItem>
<ErrorMessage>Too Integer (max=35)</ErrorMessage>
</details>

By parsing out the details node, you can determine programmatically what happened and
make corrective actions. The various ECGridOS Error Codes are listed at the bottom of this
section.

The system will detect and report the attempt to create duplicate IDs, redundant
Interconnect Requests, unauthorized access and a host of data errors.

The following code snippet shows how to catch and parse SOAP Exceptions in Visual Basic.

Visual Basic

Imports System.Xml

Class ErrorInfo
Public ErrorCode As Short
Public ErrorString As String
Public ErrorItem As String
Public ErrorMessage As String
End Class
Private Sub SomeFunction()
Dim errInfo As ErrorInfo
Try
Dim parcels() As net.ecgridos.ParcelIDInfo = _
ecgridos.ParcelInBoxArchiveEx(NetworkID, _
MailboxID, _
BeginDate, _
EndDate, _
ECGridID1, _
ECGridID2, _
Status)
[...]
Catch ex As SoapException
errInfo = CatchException(ex)
[...]
End Try
[...]
End Sub

Private Function CatchException(ByVal ex As SoapException) As ErrorInfo


Dim doc As New XmlDocument
Dim Node As XmlNode
CatchException = New ErrorInfo
doc.LoadXml(ex.Detail.OuterXml)
Node = doc.DocumentElement.SelectSingleNode("ErrorInfo")
If Node Is Nothing Then
'This picks up Framework generated SOAP Exceptions
With CatchException
.ErrorCode = -1
.ErrorString = ex.Message
.ErrorItem = ""
.ErrorMessage = ""
End With
Else
'This picks up ECGridOS generated SOAP Exceptions
With CatchException
.ErrorCode = CInt(Node.SelectSingleNode("ErrorCode").InnerText)
.ErrorString = Node.SelectSingleNode("ErrorString").InnerText
.ErrorItem = Node.SelectSingleNode("ErrorItem").InnerText
.ErrorMessage = Node.SelectSingleNode("ErrorMessage").InnerText
End With
End If
End Function

ECGridOS Error Codes


1 Session timeout
2 Access denied
3 Not found
4 Invalid ID
5 Duplicate ID
6 ID exists on network
7 Invalid data type
8 Invalid data length
9 Data error
10 SQL Error

© 2008-2009, Loren Data Corp. ECGrid is a registered service mark of Loren Data Corp.
All rights reserved. ECGridOS is a service mark of Loren Data Corp.
Revision Updates
v2.0.5 - 05/19/2009
Fixed bug in MailboxOwnerContact()
v2.0.4 - 04/14/2009
Fixed NetworkIDInfo and MailboxIDInfo classes to properly reflect AS2Info class.
Modified NetworkIDInfo class to include additional operational status information.
Added NetworkLog class and LastLog as NetworkLog subclass to NetworkIDInfo
class.
Added General to AuthLevel Enum.
Added NetworkOutageList().
v2.0.3 - 04/02/2009
Renamed NetworkSearch() to NetworkList() for consistency.
Added CreateDirectory functionality to ParcelUpload() and ParcelUploadEx()
Removed ENUM values as Web Services do not pass the underlying values.
v2.0.2 - 03/31/2009
Fixed missing data in NetworkSearch().
Added LastContact to NetworkIDInfo class.
Removed Migration APIs until next version.
Made NetOps information public as UserIDInfo for InterconnectIDInfo class.
v2.0.1 - 03/26/2009
Fixed Delimiter issue in NetworkInfo().
Added Status (2) Development
v2.0.1 - 03/16/2009
Added ReportInstantStats() and ReportInstantStatsEx()
v2.0 - 03/5/2009
Added InterchangeDateTime to InterchangeIDInfo class
Extended TimeOut of _ParcelInBoxArchiveList() and _ParcelOutBoxArchiveList() to
1200 seconds
Added Migration Management APIs
Fixed TPAddEx() and TPAddVAN() where ECGridID was declared as Short
Fixed invalid ReturnCode in TPAddEx() and TPAddVAN()
Added AS2Info Class to MailboxIDInfo and NetworkIDInfo classes
Updated description in ParcelUploadEx()
Changed EventIDs for ReportMonthly() and ReportMonthlyEx()
Added InterchangeDate()
Added InterchangeProcessDate to InterchangeIDInfo class
Removed ManagedMigration parameter from TPMove() and TPMoveEx()
Added ReportStatistics() and ReportStatisticsEx()
First Production Release
v2.0 [beta] - 10/8/2008
Documentation Only - Typographical updates
v2.0 [beta] - 9/29/2008
Documentation Only - Added ECGridOS Support & Forum information
v2.0 [beta] - 9/25/2008
Modified ParcelIDInfo Class
Fixed ECGridIDInfo
Added ReportMonthly() and ReportMonthlyEx()

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