API Calls

Back To API Calls Home

Notice! - As of 2/1/2018 API versions previous to 3.2 will only have access to the last 30 days of data. API versions 3.2 and up will have data archives dating back to 3/1/2015.

Notice! - As of 12/31/2018 API versions previous to 3.2 will no longer be supported.

---

CallBackPendingListExA

List of all Pending CallBackQueue records for Specified Network/Mailbox.

---

CallBackFailedList

List of Failed CallBackQueue records for session Network/Mailbox.

---

CallBackFailedListEx

List of Failed CallBackQueue records for 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.

---

ReportInstantStats

Instant Statistics for the Session Network/Mailbox.

---

ReportInstantStatsEx

Instant Statistics for a specified Network/Mailbox.

---

ReportMailboxStats

Mailbox Parcel Statistics for the Session Network/Mailbox.

---

ReportMailboxStatsEx

Mailbox Parcel Statistics for the specified Network/Mailbox.

---

ReportMailboxInterchangeStats

Mailbox Interchange Statistics for the Session Network/Mailbox.

---

ReportMailboxInterchangeStatsEx

Mailbox Interchange Statistics for the specified Network/Mailbox.

---

ReportInterchangeStats

Interchange Statistics for the Session Network/Mailbox.

---

ReportInterchangeStatsEx

Interchange Statistics for the specified Network/Mailbox.

---

CommAdd

Add a new Communication Connection.

---

CommSetPair

Set the Comm Identifier pair for two ECGridIDs.

---

CommPair

Find the Comm ID pair for two ECGridIDs.

---

CommUpdate

Update an Comm Connection.

---

CommList

List Communication Profiles for Session Network/Mailbox.

---

CommListEx

List Communications Profiles for specified Network/Mailbox.

---

CommFind

Find Communication Profiles by Identifier.

---

CommInfo

Get Comm Profile by CommID.

---

CommSetStatus

Set AS2 Connection Status.

---

CertificateAddPublic

Add a new Public Certificate.

---

CertificateAddPublicA

Add a new Public Certificate.

---

CertAddPrivate

Add a new Private AS2 Certificate.</font>

---

CertAddPrivateA

Add a new Private Comm Certificate.</font>

---

CertificateCreatePrivate

Create a new Private Certificate generated by ECGridOS.

---

CertificateRenewPrivate

Renew a Private Certificate generated by ECGridOS.

---

CertificateTerminate

Terminate a Certificate.

---

CommDefaultMailbox

Set CommID as Default for a Mailbox.

---

NowUTC

Current UTC Date/Time.

---

InterchangeDate

Get Date from EDI Envelope (ISA or UNB)

---

Version

ECGridOS Version.

---

X400Format

Convert X.400 Address Elements into Compatible ECGrid Format.

---

ParcelUploadExA

Upload an X12, EDIFACT, Tradacoms or VDA Parcel to the Specified Network/Mailbox OutBox with Base64String.

---

ParcelUpdateStatus

Update Parcel Status.

---

ParcelUpdateLocalStatus

Update Parcel Local Status, a user defined variable.

---

ParcelUploadMft

Managed File Transfer (MFT, non-EDI data) upload to the OutBox with Base64Array.

---

ParcelUploadMftA

Managed File Transfer (MFT, non-EDI data) upload to the OutBox with Base64String.

---

ParcelTest

Send a test Parcel.

---

ParcelSetMailbagControlID

Set MailbagControlID (e.g. X12.56 MailbagID or AS2-MessageID) for Parcel.

---

ParcelFindMailbagControlID

Find Parcel by sender MailbagControlID (e.g. X12.56 MailbagID or AS2-MessageID).

---

ParcelFindMailbagControlIDTo

Find Parcel by receiver MailbagControlID (e.g. X12.56 MailbagID or AS2-MessageID).

---

ParcelManifest

List the Transaction Manifest for a Parcel.

---

InterchangeManifest

A complete end-to-end transaction Manifest for a specific Interchange.

---

ParcelNoteList

List the system generated Notes for a Parcel.

---

ParcelInBoxArchive

InBox Archive Collection for the Session Network/Mailbox.

---

ParcelInBoxArchiveEx

InBox Archive Collection for a specified Network/Mailbox.

---

ParcelInBoxArchiveExShort

InBox Archive Collection for a specified Network/Mailbox - short form.

---

ParcelInBoxArchiveDescEx

InBox Archive Collection for a specified Network/Mailbox in DESC order

---

ParcelOutBoxArchive

OutBox Archive Collection for the Session Network/Mailbox.

---

ParcelOutBoxArchiveEx

OutBox Archive Collection for a specified Network/Mailbox.

---

ParcelOutBoxArchiveExShort

OutBox Archive Collection for a specified Network/Mailbox - short form.

---

ParcelOutBoxArchiveDescEx

OutBox Archive Collection for a specified Network/Mailbox in DESC order

---

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.

---

ParcelOutBoxInProcess

List of Parcels which are in process for the session Network/Mailbox.

---

ParcelOutBoxInProcessEx

List of Parcels which are in process for a specified Network/Mailbox.

---

InterchangeInfo

Interchange information by InterchangeID.

---

InterchangeInBox

InBox Interchange List for the Session Network/Mailbox.

---

InterchangeInBoxArchive

InBox Interchange List for the Session Network/Mailbox.

---

InterchangeInBoxEx

InBox Interchange List for a specified Network/Mailbox.

---

InterchangeInBoxArchiveEx

InBox Interchange List for a specified Network/Mailbox.

---

InterchangeOutBox

OutBox Interchange List for the Session Network/Mailbox.

---

InterchangeOutBoxArchive

OutBox Interchange List for the Session Network/Mailbox.

---

InterchangeOutBoxEx

OutBox Interchange List for a specified Network/Mailbox.

---

InterchangeOutBoxArchiveEx

OutBox Interchange List for a specified Network/Mailbox.

---

InterchangeOutBoxPending

OutBox Interchange Pending List for a session Network/Mailbox.

---

InterchangeOutBoxPendingEx

OutBox Interchange Pending List for a specified Network/Mailbox.

---

InterchangeInBoxPending

OutBox Interchange Pending List for a specified Network/Mailbox.

---

InterchangeInBoxPendingEx

InBox Interchange Pending List for a specified Network/Mailbox.

---

InterchangeInBoxBlocked

InBox Interchange Blocked List for the Session Network/Mailbox.

---

InterchangeInBoxBlockedEx

InBox Interchange Blocked List for a specified Network/Mailbox.

---

InterchangeOutBoxBlocked

OutBox Interchange Blocked List for the Session Network/Mailbox.

---

InterchangeOutBoxBlockedEx

OutBox Interchange Blocked List for a specified Network/Mailbox.

---

InterchangeHeaderInfo

Get Interchange Info from EDI Envelope (ISA or UNB).</font>

---

InterchangeHeaderInfoB

Get Interchange Info from EDI Envelope (ISA or UNB)

---

InterchangeOutBoxNoRoute

Unroutable Interchanges for the Session Network/Mailbox.

---

InterchangeOutBoxNoRouteEx

Unroutable Interchanges for a specified Network/Mailbox.

---

InterchangeResend

Resend and Interchange, allows for rerouting.

---

InterchangeCancel

Cancel an Interchange.

---

CallBackEventInfo

List CallBack Event by CallBackEventID

---

CallBackEventListEx

List CallBack Events for a specified Network/Mailbox

---

CallBackAddEx

Create a CallBack Event for a specified Network/Mailbox.

---

CallBackEventSetStatus

Set the status of a CallBackEvent.

---

CallBackQueueInfo

Information for a a specific CallBackQueueID.

---

CallBackTest

Create a test call for a specific CallBackEventID.

---

CallBackPendingList

List of all Pending CallBackQueue records for session Network/Mailbox.

---

CallBackPendingListEx

List of all Pending CallBackQueue records for Specified Network/Mailbox.

---

MailboxDescription

Update a Mailbox Description value.

---

MailboxUse

Update a Mailbox Description value.

---

MailboxList

Get a list of Mailboxes for the Session Network.

---

MailboxListEx

Get a list of Mailboxes for a specified Network.

---

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/Mailbox to the Session Network/Mailbox.

---

TPMoveMailbox

Move a single Trading Partner ID to a different Mailbox on the same Network.

---

TPMoveEx

Move a single Trading Partner ID from a Network/Mailbox to a specified Network/Mailbox.

---

TPUpdateDescription

Update an ECGridID entry's Description.

---

TPUpdateDataEMail

Update an ECGridID entry's EMail Address for Data.

---

TPActivate

Activate a suspended ECGridID entry.

---

TPSuspend

Suspend an active ECGridID entry.

---

TPTerminate

Terminate an ECGridID entry.

---

TPSetRoutingGroup

Suspend an active ECGridID entry.

---

TPInfo

Detail for an ECGridID.

---

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.

---

TPList

List all Trading Partners in the Session Network/Mailbox.

---

TPListEx

List all Trading Partners in a specified Network/Mailbox.

---

TPListExPaged

List all Trading Partners in a specified Network/Mailbox with Paging.

---

TPListByOwner

List Trading Partners by Owner UserID.

---

TPFindEx

Find Trading Partners by Description in a specified Network/Mailbox.

---

TPGetMailboxDefault

Gets the default ECGridID for a mailbox.

---

TPSetMailboxDefault

Sets an ECGridID as the default in its mailbox (must be X12 ISA compatible).

---

TPSetOwner

Update an ECGridID entry's Owner (OwnerUserID=0 to remove owner).

---

InterconnectAdd

Create a new Interconnect Request.

---

InterconnectNote

Add a Note to an Interconnect Request.

---

InterconnectCancel

Cancel an Interconnect Request.

---

InterconnectInfo

Detail for an Interconnect.

---

InterconnectInfoGUID

Detail for an Interconnect.

---

InterconnectNoteList

Notes for an Interconnect.

---

InterconnectListByECGridID

Listing of Interconnects for an ECGridID with optional trading partner pair. If ECGridID2=-1, 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.

---

InterconnectCount

Count of Interconnects by status for the Session Network/Mailbox.

---

InterconnectCountEx

Count of Interconnects by status for a specified Network/Mailbox.

---

MigrationAdd

Add a Migration List for session network/mailbox.

---

MigrationAddEx

Add a Migration List for specified network/mailbox.

---

MigrationList

Migration List for session network/mailbox.

---

MigrationListEx

Migration List for specified network/mailbox.

---

MigrationInfo

Detail for an Migration.

---

MigrationAddTP

Add TP to Migration List.

---

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.

---

CarbonCopyActivate

Activate a suspended Carbon Copy.

---

CarbonCopySuspend

Suspend an active Carbon Copy.

---

CarbonCopyTerminate

Terminate a Carbon Copy.

---

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.

---

ParcelInBox

Current InBox for the Session Network/Mailbox.

---

ParcelInBoxEx

Current InBox for a specified Network/Mailbox.

---

ParcelInBoxExShort

Current InBox for a specified Network/Mailbox - short form.

---

ParcelInfo

Parcel Meta Information.

---

ParcelDownload

Download Parcel from InBox or Archive as Base64Array.

---

ParcelDownloadA

Download Parcel from InBox or Archive as Base64String.

---

ParcelDownloadS3

Download Parcel from InBox or Archive.

---

ParcelDownloadNoUpdate

Download Parcel from InBox or Archive without updating status with Base64Array.

---

ParcelDownloadNoUpdateA

Download Parcel from InBox or Archive without updating status with Base64String.

---

ParcelDownloadConfirm

Confirm Download of Parcel from InBox and remove it.

---

ParcelAcknowledgmentNote

Add Acknowledgment Note for Parcel Note.

---

ParcelDownloadCancel

Cancel Download of Parcel from InBox and remove it.

---

ParcelDownloadConfirmPendingAck

Confirm Download of Parcel wtih Pending Acknowledgment from InBox and remove it.

---

ParcelDownloadReset

Reset Download of Parcel and restore to InBox.

---

ParcelResend

Resend Parcel from Internal Router.<br /><b>Requires NetOps authorization.</b>

---

ParcelUpload

Upload an X12, EDIFACT, Tradacoms or VDA Parcel to the OutBox with Base64Array.

---

ParcelUploadA

Upload an X12, EDIFACT, Tradacoms or VDA Parcel to the OutBox with Base64String.

---

ParcelUploadEx

Upload an X12, EDIFACT, Tradacoms or VDA Parcel to the Specified Network/Mailbox OutBox with Base64Array.

---

Login

Required first call in order to establish a session.

---

GenerateAPIKey

Generate a persistent APIKey for a specified UserID

---

GeneratePassword

Generate a random password.

---

Logout

Required final call to close a session.

---

ChangePassword

Use to change password of current User Account. Effective immediately.

---

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.

---

UserInfobyLogin

Detail for a specified User by LoginName.

---

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.

---

UserSendSMS

Send an SMS to 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.

---

UserListLockedOut

Get a list of Locked Out Users for a specified Network/Mailbox.

---

UserListLockedOutEx

Get a list of Locked Out Users for a specified Network/Mailbox.

---

UserSetNetworkMailbox

Change a User's Network/Mailbox.

---

UserSetAuthLevel

Change a User's Authorizaton Level.

---

UserSetMaxSessions

Change a User's Maximum Sessions.

---

UserGetAPIKey

Retrieve a persistent APIKey for a specified UserID

---

SessionLogCurrent

Get a Session Log for the Current Session.

---

SessionLog

Get a Session Log for the Session User.

---

SessionLogEx

Get a Session Log for a specified User.

---

KeyGet

Get a Persistent Key Value Attached to an Object.

---

KeyList

Get a list of all Persistent Key Values Attached to an Object.

---

KeySet

Set a Persistent Key Value Attached to an Object.

---

KeyRemove

Remove a Persistent Key Value Attached to an Object.

---

StatusList

Returns list of all System Status codes.

---

NetworkInfo

Details for a specific Network.

---

NetworkInfoWithLog

Details for a specific Network wtih Log.

---

NetworkList

List Networks, optionally filter by Name.

---

NetworkStatusSummary

A Summary List of Network Status.

---

NetworkOutageList

List of Network Outages.

---

NetworkUpdate

Update a Network Infromation.

---

NetworkSetContact

Update Specified Network Contact.

---

NetworkGetContact

Get Specified Network Contact Info.

---

NetworkSetWebsite

Update Specified Network Website.

---

NetworkX12Delimiters

Update a Network override values for Segment Terminator, Element Separator and Subelement Separator.

---

NetworkRootDeleteOnDownload

Change the DeleteOnDownload configuration of a specified Network Root Mailbox.

---

MailboxAdd

Add a Mailbox to the Session Network.

---

MailboxAddEx

Add a Mailbox to a specified Network.

---

MailboxActivate

Activate a suspended Mailbox.

---

MailboxSuspend

Suspend an active Mailbox.

---

MailboxTerminate

Terminate a Mailbox.

---

MailboxManaged

Change the Managed Status of a specified Mailbox.

---

MailboxDeleteOnDownload

Change the DeleteOnDownload configuration of a specified Mailbox.

---

MailboxInfo

Detail for a Mailbox.

---

MailboxName

Update a Mailbox Name.

---

MailboxSetContact

Update Specified Mailbox Contact.

---

MailboxX12Delimiters

Update a Mailbox override values for Segment Terminator, Element Separator and Subelement Separator.

---

MailboxInBoxTimeout

Update a Mailbox InBox Timeout notification value.

Back To API Calls Home