Common API Calls

Greg Kolinski edited this page Jan 15, 2018 · 18 revisions

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! - On 12/31/2018 API versions previous to 3.2 will no longer be supported.


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.

GenerateAPIKey

Generate a persistent APIKey for a specified UserID

GeneratePassword

Generate a random password.

InterchangeCancel

Cancel an Interchange.

InterchangeDate

Get Date from EDI Envelope (ISA or UNB)

InterchangeHeaderInfoB

Get Interchange Info from EDI Envelope (ISA or UNB)

InterchangeInBox

InBox Interchange List for the Session Network/Mailbox.

InterchangeInBoxArchive

InBox Interchange List for the Session Network/Mailbox.

InterchangeInBoxArchiveEx

InBox Interchange List for a specified Network/Mailbox.

InterchangeInBoxEx

InBox Interchange List for a specified Network/Mailbox.

InterchangeInBoxPending

InBox Interchange Pending List for a specified Network/Mailbox.

InterchangeInBoxPendingEx

InBox Interchange Pending List for a specified Network/Mailbox.

InterchangeInfo

Interchange information by InterchangeID.

InterchangeManifest

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

InterchangeOutBox

OutBox Interchange List for the Session Network/Mailbox.

InterchangeOutBoxArchive

OutBox Interchange List for the Session Network/Mailbox.

InterchangeOutBoxArchiveEx

OutBox Interchange List for a specified 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.

InterchangeOutBoxPending

OutBox Interchange Pending List for a session Network/Mailbox.

InterchangeOutBoxPendingEx

OutBox Interchange Pending List for a specified Network/Mailbox.

InterchangeResend

Resend and Interchange, allows for rerouting.

InterconnectAdd

Create a new Interconnect Request.

InterconnectAssignNetOps

*** Requires NetOps authorization. ***

Assigns NetOps staff to Interconnect Request.

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.

InterconnectInfoGUID

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

*** Requires NetOps authorization. ***

Update Status of an Interconnect Request.

MailboxActivate

Activate a suspended Mailbox.

MailboxAdd

Add a Mailbox to the Session Network.

MailboxAddEx

Add a Mailbox to a specified Network.

MailboxDescription

Update a Mailbox Description value.

MailboxInBoxTimeout

Update a Mailbox InBox Timeout notification value.

MailboxInfo

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

MailboxSetContact

Update Specified Mailbox Contact.

MailboxSuspend

Suspend an active Mailbox.

MailboxTerminate

Terminate a Mailbox.

MailboxUse

Update a Mailbox Description value.

MailboxX12Delimiters

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

NetworkAdd

*** Requires NetOps authorization. ***

Add a Network to ECGrid.

NetworkBackupAllConfigs

*** TechOps Authorization Required. ***

Backup all Network Configurations to Database.

NetworkGetContact

Get Specified Network Contact Info.

NetworkInfo

Details for a specific Network.

NetworkInfoWithLog

Details for a specific Network wtih Log.

NetworkList

List Networks, optionally filter by Name.

NetworkOutageList

List of Network Outages.

NetworkRestart

*** TechOps Authorization Required. ***

Restart a Network Process.

NetworkSetContact

Update Specified Network Contact.

NetworkSetStatus

*** TechOps Authorization Required. ***

Set Network Status.

NetworkSetWebsite

Update Specified Network Website.

NetworkStart

*** TechOps Authorization Required. ***

Start a Network Process.

NetworkStatusSummary

A Summary List of Network Status.

NetworkStop

*** TechOps Authorization Required. ***

Stop a Network Process.

NetworkX12Delimiters

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

NowUTC

Current UTC Date/Time.

ParcelAcknowledgmentNote

Add Acknowledgment Note for Parcel Note.

ParcelDownload

Download Parcel from InBox or Archive.

ParcelDownloadCancel

Cancel Download of Parcel from InBox and remove it.

ParcelDownloadConfirm

Confirm Download of Parcel from InBox and remove it.

ParcelDownloadConfirmPendingAck

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

ParcelDownloadGZip

Download Parcel from InBox or Archive with GZip compression.

ParcelDownloadNoUpdate

Download Parcel from InBox or Archive without updating status.

ParcelDownloadReset

Reset Download of Parcel and restore to InBox.

ParcelInBox

Current InBox for the Session Network/Mailbox.

ParcelInBoxArchive

InBox Archive Collection for the Session Network/Mailbox.

ParcelInBoxArchiveDescEx

InBox Archive Collection for a specified Network/Mailbox in DESC order - v3.2 only.

ParcelInBoxArchiveEx

InBox Archive Collection for a specified Network/Mailbox.

ParcelInBoxEx

Current InBox for a specified Network/Mailbox.

ParcelInfo

List of Interchanges in a Parcel.

ParcelManifest

List the Transaction Manifest for a Parcel.

ParcelNoteList

List the system generated Notes for a Parcel.

ParcelOutBoxArchive

OutBox Archive Collection for the Session Network/Mailbox.

ParcelOutBoxArchiveDescEx

OutBox Archive Collection for a specified Network/Mailbox in DESC order - v3.2 only.

ParcelOutBoxArchiveEx

OutBox Archive Collection 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.

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.

ParcelResend

*** Requires NetOps authorization. ***

Resend Parcel from Internal Router.

ParcelSetMailbagControlID

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

ParcelTest

Send a test Parcel.

ParcelUpdateLocalStatus

Update Parcel Local Status, a user defined variable.

ParcelUpdateStatus

Update Parcel Status.

ParcelUpload

Upload an X12 or EDIFACT Parcel to the OutBox.

ParcelUploadDirected

Upload any format Parcel to the OutBox.

ParcelUploadDirectedGZip

Upload any format Parcel to the OutBox with GZip compression.

ParcelUploadExA

Upload an X12 or EDIFACT Parcel to the Specified Network/Mailbox OutBox.

ParcelUploadGZip

Upload an X12 or EDIFACT 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.

SessionLogCurrent

Get a Session Log for the Current Session.

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.

TPFindEx

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

TPGetMailboxDefault

Gets the default ECGridID for a mailbox.

TPInfo

Detail for an ECGridID.

TPList

List all Trading Partners in the Session Network/Mailbox.

TPListByOwner

List Trading Partners by Owner UserID.

TPListEx

List all Trading Partners in a specified Network/Mailbox.

TPListExPaged

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

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.

TPMoveMailbox

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

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.

TPSetMailboxDefault

Sets an ECGridID as the default in its mailbox.

TPSetOwner

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

TPSetRoutingGroup

Suspend an active ECGridID entry.

TPSuspend

Suspend an active ECGridID entry.

TPTerminate

Terminate an ECGridID entry.

TPUpdateDataEMail

Update an ECGridID entry's EMail Address for Data.

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.

UserGetAPIKey

Retrieve a persistent APIKey for a specified UserID

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.

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.

UserPassword

Update a User's security information.

UserReset

Reset a user's GraceLogins and OpenSessions count.

UserResetAll

*** Requires Root authorization. ***

Reset all locked out users after timeout.

UserSendSMS

Send an SMS to a User.

UserSetAuthLevel

Change a User's Authorizaton Level.

UserSetNetworkMailbox

Change a User's Network/Mailbox.

UserSuspend

Suspend a User.

UserTerminate

Terminate a User.

UserUpdate

Update a User account.

Version

ECGridOS Version.

WhoAmI

Returns current session information.

X400Format

Convert X.400 Address Elements into Compatible ECGrid Format.

Back To API Calls Home

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