ECGridOS API v2
ECGridOS™ is a comprehensive operating system for the ECGrid® Interconnect Infrastructure,
consisting of the following set of .NET Web Services.
For more information on ECGridOS, please visit the Official ECGridOS Website at http://ecgridos.com
The complete ECGridOS Developer's Guide can be downloaded from http://ecgridos.net/docs/.
ECGridOS Developer's Forum: http://forums.ecgrid.com/.
Version v2.3 (Build 42)
© 2001-2012, Loren Data Corp. All rights reserved.
The following operations are supported. For a formal definition, please review the Service Description.
-
CarbonCopyActivate
Activate a suspended Carbon Copy. -
CarbonCopyAdd
Add a Carbon Copy which is billed to the Session Network/Mailbox. -
CarbonCopyAddEx
Add a Carbon Copy which is billed to a specified Network/Mailbox. -
CarbonCopyInfo
Detail for a Carbon Copy. -
CarbonCopyList
List of Carbon Copy configurations for the Session Network/Mailbox. -
CarbonCopyListEx
List of Carbon Copy configurations for a specified Network/Mailbox. -
CarbonCopySuspend
Suspend an active Carbon Copy. -
CarbonCopyTerminate
Terminate a Carbon Copy. -
ChangePassword
Use to change password of current User Account. Effective immediately. -
InterchangeDate
Get Date from EDI Envelope (ISA or UNB) -
InterchangeHeaderInfo
Get Interchange Info from EDI Envelope (ISA or UNB) -
InterchangeInBox
InBox Interchange List for the Session Network/Mailbox. -
InterchangeInBoxEx
InBox Interchange List for a specified Network/Mailbox. -
InterchangeInfo
Interchange information by InterchangeID. -
InterchangeOutBox
OutBox Interchange List for the Session Network/Mailbox. -
InterchangeOutBoxEx
OutBox Interchange List for a specified Network/Mailbox. -
InterchangeOutBoxNoRoute
Unroutable Interchanges for the Session Network/Mailbox. -
InterchangeOutBoxNoRouteEx
Unroutable Interchanges for a specified Network/Mailbox. -
InterchangeResend
Resend and Interchange, allows for rerouting. -
InterconnectAdd
Create a new Interconnect Request. -
InterconnectAssignNetOps
Assigns NetOps staff to Interconnect Request.
Requires NetOps authorization. -
InterconnectCancel
Cancel an Interconnect Request. -
InterconnectCount
Count of Interconnects by status for the Session Network/Mailbox. -
InterconnectCountEx
Count of Interconnects by status for a specified Network/Mailbox. -
InterconnectInfo
Detail for an Interconnect. -
InterconnectListByECGridID
Listing of Interconnects for an ECGridID with optional trading partner pair. If ECGridID2=0, then match all for ECGridID1 -
InterconnectListByStatus
Listing of Interconnects for a specific Status for the session Network/Mailbox. May be limited in scope by ECGridID and maximum number of days old. -
InterconnectListByStatusEx
Listing of Interconnects for a specific Status for the session Network/Mailbox. May be limited in scope by ECGridID and maximum number of days old. -
InterconnectNote
Add a Note to an Interconnect Request. -
InterconnectNoteList
Notes for an Interconnect. -
InterconnectUpdate
Update Status of an Interconnect Request.
Requires NetOps authorization. -
Login
Required first call in order to establish a session. -
Logout
Required final call to close a session. -
MailboxActivate
Activate a suspended Mailbox. -
MailboxAdd
Add a Mailbox to the Session Network. -
MailboxAddEx
Add a Mailbox to a specified Network. -
MailboxErrorsContact
Update Errors Contact for a Mailbox. -
MailboxInBoxTimeout
Update a Mailbox InBox Timeout notification value. -
MailboxInfo
Detail for a Mailbox. -
MailboxInterconnectsContact
Update Interconnects Contact for a Mailbox. -
MailboxList
Get a list of Mailboxes for the Session Network. -
MailboxListEx
Get a list of Mailboxes for a specified Network. -
MailboxManaged
Change the Managed Status of a specified Mailbox. -
MailboxName
Update a Mailbox Name. -
MailboxNoticesContact
Update Notices Contact for a Mailbox. -
MailboxOwnerContact
Update Administrative Owner of a Mailbox. -
MailboxSuspend
Suspend an active Mailbox. -
MailboxTerminate
Terminate a Mailbox. -
MailboxX12Delimiters
Update a Mailbox override values for Segment Terminator, Element Separator and Subelement Separator. -
NetworkAdd
Add a Network to ECGrid.
Requires NetOps authorization. -
NetworkBillingContact
Update Billing Contact for a Network. -
NetworkErrorsContact
Update Errors Contact for a Network. -
NetworkInfo
Details for a specific Network. -
NetworkInterconnectsContact
Update Interconnects Contact for a Network. -
NetworkList
List Networks, optionally filter by Name. -
NetworkNoticesContact
Update Notices Contact for a Network. -
NetworkOutageList
List of Network Outages. -
NetworkOwnerContact
Update Administrative Owner of a Network. -
NetworkReportsContact
Update Reports Contact for a Network. -
NetworkRestart
Restart a Network Process. TechOps Authorization Required -
NetworkStart
Start a Network Process. TechOps Authorization Required -
NetworkStatusSummary
A Summary List of Network Status. -
NetworkStop
Stop a Network Process. TechOps Authorization Required -
NowUTC
Current UTC Date/Time. -
ParcelDownload
Download Parcel from InBox or Archive. -
ParcelDownloadConfirm
Confirm Download of Parcel from InBox and remove it. -
ParcelDownloadGZip
Download Parcel from InBox or Archive with GZip compression. -
ParcelDownloadInner
Download inner content of Parcel from InBox or Archive with outer X12 ISA/IEA envelope removed. -
ParcelDownloadReset
Reset Download of Parcel and restore to InBox. -
ParcelInBox
Current InBox for the Session Network/Mailbox. -
ParcelInBoxArchive
InBox Archive List for the Session Network/Mailbox. -
ParcelInBoxArchiveEx
InBox Archive List for a specified Network/Mailbox. -
ParcelInBoxEx
Current InBox for a specified Network/Mailbox. -
ParcelInfo
List of Interchanges in a Parcel. -
ParcelInterchangeManifest
A complete end-to-end transaction Manifest for a specific Interchange. -
ParcelManifest
List the Transaction Manifest for a Parcel. -
ParcelNoteList
List the system generated Notes for a Parcel. -
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. -
ParcelUpload
Upload an X12 or EDIFACT Parcel to the OutBox. -
ParcelUploadEx
Upload any format Parcel to the OutBox. -
ParcelUploadGZip
Upload an X12 or EDIFACT Parcel to the OutBox with GZip Compression. -
ParcelUploadGZipEx
Upload any format Parcel to the OutBox with GZip compression. -
ReportInstantStats
Instant Statistics for the Session Network/Mailbox. -
ReportInstantStatsEx
Instant Statistics for a specified Network/Mailbox. -
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. -
ReportTrafficStatsPublic
Statistical Public System-Wide Traffic Report for Last 72 Hours. -
SessionLog
Get a Session Log for the Session User. -
SessionLogEx
Get a Session Log for a specified User. -
TPActivate
Activate a suspended ECGridID entry. -
TPAdd
Add a Trading Partner ID to the Session Network/Mailbox. -
TPAddEx
Add a Trading Partner ID to specified Network/Mailbox. -
TPAddVAN
Add a Trading Partner ID to a Value Added Network (VAN) connection. -
TPFind
Find Trading Partners by Description in the session Network/Mailbox. -
TPFindEx
Find Trading Partners by Description in a specified Network/Mailbox. -
TPInfo
Detail for an ECGridID. -
TPList
List all Trading Partners in the Session Network/Mailbox. -
TPListEx
List all Trading Partners in a specified Network/Mailbox. -
TPMove
Move a single Trading Partner ID from a Network/Mailbox to the Session Network/Mailbox. -
TPMoveEx
Move a single Trading Partner ID from a Network/Mailbox to a specified Network/Mailbox. -
TPSearch
Finds matching ECGridID(s) for specified X12 or EDIFACT Qualifier/ID pair in the session Network/Mailbox. -
TPSearchEx
Finds matching ECGridID(s) for specified X12 or EDIFACT Qualifier/ID pair in a specified Network/Mailbox. -
TPSuspend
Suspend an active ECGridID entry. -
TPTerminate
Terminate an ECGridID entry. -
TPUpdateDateEMail
Update an ECGridID entry's Description. -
TPUpdateDescription
Update an ECGridID entry's Description. -
UserActivate
Activate a suspended User. -
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. -
UserList
Get a list of Users for the Session Network/Mailbox. -
UserListEx
Get a list of Users for a specified Network/Mailbox. -
UserPassword
Update a User's security information. -
UserReset
Reset a user's GraceLogins and OpenSessions count. -
UserSuspend
Suspend a User. -
UserTerminate
Terminate a User. -
UserUpdate
Update a User account. -
Version
ECGridOS Version. -
WhoAmI
Returns current session information.