ECGridOS™ is a comprehensive API operating system for the ECGrid® Interconnect Infrastructure,
consisting of the following set of Web Services.

For more information on ECGridOS, please visit the Official ECGridOS Website on GitHub at https://ecgridos.net

To become an ECGrid Service Provider, please visit http://LD.com/ECGrid.

    

Version v4.1 (Build 473a)

© 1999-2024 Loren Data Corp. All rights reserved.

The following operations are supported. For a formal definition, please review the Service Description.

• CallBackAddEx
  Create a CallBack Event for a specified Network/Mailbox.
• CallBackEventInfo
  List CallBack Event by CallBackEventID
• CallBackEventListEx
  List CallBack Events for a specified Network/Mailbox
• CallBackEventSetStatus
  Set the status of a CallBackEvent.
• CallBackFailedList
  List of Failed CallBackQueue records for session Network/Mailbox.
• CallBackFailedListEx
  List of Failed CallBackQueue records for Specified Network/Mailbox.
• CallBackPendingList
  List of all Pending CallBackQueue records for session Network/Mailbox.
• CallBackPendingListEx
  List of all Pending CallBackQueue records for Specified Network/Mailbox.
• CallBackPendingListExA
  List of all Pending CallBackQueue records for Specified Network/Mailbox.
• CallBackQueueInfo
  Information for a a specific CallBackQueueID.
• CallBackTest
  Create a test call for a specific CallBackEventID.
• 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.
• CertAddPrivate
  Add a new Private AS2 Certificate.
• CertAddPrivateA
  Add a new Private Comm Certificate.
• CertificateAddPublic
  Add a new Public Certificate.
• CertificateAddPublicA
  Add a new Public Certificate.
• CertificateCreatePrivate
  Create a new Private Certificate generated by ECGridOS.
• CertificateRenewPrivate
  Renew a Private Certificate generated by ECGridOS.
• CertificateTerminate
  Terminate a Certificate.
• ChangePassword
  Use to change password of current User Account. Effective immediately.
• CommAdd
  Add a new Communication Connection.
• CommDefaultMailbox
  Set CommID as Default for a Mailbox.
• CommFind
  Find Communication Profiles by Identifier.
• CommInfo
  Get Comm Profile by CommID.
• CommList
  List Communication Profiles for Session Network/Mailbox.
• CommListEx
  List Communications Profiles for specified Network/Mailbox.
• CommPair
  Find the Comm ID pair for two ECGridIDs.
• CommSetPair
  Set the Comm Identifier pair for two ECGridIDs.
• CommSetStatus
  Set AS2 Connection Status.
• CommUpdate
  Update an Comm Connection.
• 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)
• InterchangeHeaderInfo
  Get Interchange Info 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.
• InterchangeInBoxBlocked
  InBox Interchange Blocked List for the Session Network/Mailbox.
• InterchangeInBoxBlockedEx
  InBox Interchange Blocked List for a specified Network/Mailbox.
• InterchangeInBoxEx
  InBox Interchange 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.
• 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.
• InterchangeOutBoxArchiveExNoParcel
  OutBox Interchange 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.
• 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.
• 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=-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.
• InterconnectNote
  Add a Note to an Interconnect Request.
• InterconnectNoteList
  Notes for an Interconnect.
• KeyGet
  Get a Persistent Key Value Attached to an Object.
• KeyList
  Get a list of all Persistent Key Values Attached to an Object.
• KeyRemove
  Remove a Persistent Key Value Attached to an Object.
• KeySet
  Set a Persistent Key Value Attached to an Object.
• KeySetMinutes
  Set a Persistent Key Value Attached to an Object with Minutes to Live.
• 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.
• MailboxDeleteOnDownload
  Change the DeleteOnDownload configuration of a specified Mailbox.
• 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.
• MigrationAdd
  Add a Migration List for session network/mailbox.
• MigrationAddEx
  Add a Migration List for specified network/mailbox.
• MigrationAddTP
  Add TP to Migration List.
• MigrationInfo
  Detail for an Migration.
• MigrationList
  Migration List for session network/mailbox.
• MigrationListEx
  Migration List for specified network/mailbox.
• 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.
• NetworkRootDeleteOnDownload
  Change the DeleteOnDownload configuration of a specified Network Root Mailbox.
• NetworkSetContact
  Update Specified Network Contact.
• NetworkSetWebsite
  Update Specified Network Website.
• NetworkStatusSummary
  A Summary List of Network Status.
• NetworkUpdate
  Update a Network Infromation.
• 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 as Base64Array.
• ParcelDownloadA
  Download Parcel from InBox or Archive as Base64String.
• 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.
• ParcelDownloadNoUpdate
  Download Parcel from InBox or Archive without updating status with Base64Array.
• ParcelDownloadNoUpdateA
  Download Parcel from InBox or Archive without updating status with Base64String.
• ParcelDownloadReset
  Reset Download of Parcel and restore to InBox.
• ParcelDownloadS3
  Download Parcel from InBox or Archive.
• 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).
• 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
• ParcelInBoxArchiveEx
  InBox Archive Collection for a specified Network/Mailbox.
• ParcelInBoxArchiveExShort
  InBox Archive Collection for a specified Network/Mailbox - short form.
• ParcelInBoxEx
  Current InBox for a specified Network/Mailbox.
• ParcelInBoxExShort
  Current InBox for a specified Network/Mailbox - short form.
• ParcelInfo
  Parcel Meta Information.
• 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
• ParcelOutBoxArchiveEx
  OutBox Archive Collection for a specified Network/Mailbox.
• ParcelOutBoxArchiveExShort
  OutBox Archive Collection for a specified Network/Mailbox - short form.
• 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
  Resend Parcel from Internal Router.
  Requires NetOps authorization.
• 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, 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.
• ParcelUploadExA
  Upload an X12, EDIFACT, Tradacoms or VDA Parcel to the Specified Network/Mailbox OutBox with Base64String.
• 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.
• ReportByDateEx
  Selected Report for a date period for a specified Network/Mailbox.
• ReportInstantStats
  Instant Statistics for the Session Network/Mailbox.
• ReportInstantStatsEx
  Instant Statistics for a specified Network/Mailbox.
• ReportInterchangeStats
  Interchange Statistics for the Session Network/Mailbox.
• ReportInterchangeStatsEx
  Interchange Statistics for the specified Network/Mailbox.
• ReportMailboxInterchangeStats
  Mailbox Interchange Statistics for the Session Network/Mailbox.
• ReportMailboxInterchangeStatsEx
  Mailbox Interchange Statistics for the specified Network/Mailbox.
• ReportMailboxStats
  Mailbox Parcel Statistics for the Session Network/Mailbox.
• ReportMailboxStatsEx
  Mailbox Parcel Statistics for the 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.
• StatusList
  Returns list of all System Status codes.
• 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 (must be X12 ISA compatible).
• 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.
• UserInfobyLogin
  Detail for a specified User by LoginName.
• 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.
• UserSendSMS
  Send an SMS to a User.
• UserSetAuthLevel
  Change a User's Authorizaton Level.
• UserSetMaxSessions
  Change a User's Maximum Sessions.
• 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.