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 v3.0 (Build 103.1)

© 2001-2014, Loren Data Corp. All rights reserved.

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

• AS2Add
  Add a new AS2 Connection.
• AS2CertAddPrivate
  Add a new Private AS2 Certificate.
• AS2CertAddPublic
  Add a new Public AS2 Certificate.
• AS2CertCreatePrivate
  Create a new Private AS2 Certificate signed by ECGrid.
• AS2CertTerminate
  Terminate an AS2 Certificate.
• AS2DefaultMailbox
  Set AS2ID as Default for a Mailbox.
• AS2Find
  Find AS2 Profiles by Identifier.
• AS2Info
  Get AS2 Profile by CommID.
• AS2List
  List AS2 Profiles for Session Network/Mailbox.
• AS2ListEx
  List AS2 Profiles for specified Network/Mailbox.
• AS2Pair
  Find the AS2 ID pair for two ECGridIDs.
• AS2SetPair
  Set the AS2 ID pair for two ECGridIDs.
• AS2Terminate
  Terminate an AS2 Connection.
• AS2Update
  Update an AS2 Connection.
• 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
• CallBackInvoke
  Invoke the CallBack Process for a specific CallBackQueueID.
  Requires Root authorization.
• CallBackPendingList
  List of all Pending CallBackQueue records for session Network/Mailbox.
• CallBackPendingListEx
  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.
• ChangePassword
  Use to change password of current User Account. Effective immediately.
• ContractInfo
  PENDING Get Contract by ContractID
• ContractList
  PENDING Get List of Contracts belonging to Session User
• GISBFind
  PENDING Find GISB Profiles by Identifier.
• GISBInfo
  PENDING Get GISB Profile by CommID.
• GISBList
  PENDING List GISB Profiles for Session Network/Mailbox.
• GISBListEx
  PENDING List GISB Profiles for specified Network/Mailbox.
• InterchangeDate
  Get Date from EDI Envelope (ISA or UNB)
• InterchangeHeaderInfo
  DEPRECATED: use InterchangeHeaderInfoB() /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.
• InterchangeInBoxEx
  InBox Interchange 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.
• 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.
• 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
  Update Status of an Interconnect Request.
  Requires NetOps authorization.
• InvoiceCalculate
  PENDING Create and Invoice by ContractID
• InvoiceInfo
  PENDING Get Invoice by InvoiceID
• InvoiceList
  PENDING List Invoices for Date Range
• InvoiceSetStatus
  PENDING Set Invoice Status
• 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.
• 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.
• MailboxDescription
  Update a Mailbox Description value.
• 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.
• MailboxUse
  Update a Mailbox Description value.
• MailboxX12Delimiters
  Update a Mailbox override values for Segment Terminator, Element Separator and Subelement Separator.
• NetworkAdd
  Add a Network to ECGrid.
  Requires NetOps authorization.
• NetworkBillingContact
  DEPRECATED: use NetworkSetContact() /Update Billing Contact for a Network./
• NetworkErrorsContact
  DEPRECATED: use NetworkSetContact() /Update Errors Contact for a Network./
• NetworkGetContact
  Get Specified Network Contact Info.
• NetworkInfo
  Details for a specific Network.
• NetworkInfoWithLog
  Details for a specific Network wtih Log.
• NetworkInterconnectsContact
  DEPRECATED: use NetworkSetContact() /Update Interconnects Contact for a Network./
• NetworkList
  List Networks, optionally filter by Name.
• NetworkNoticesContact
  DEPRECATED: use NetworkSetContact() /Update Notices Contact for a Network./
• NetworkOutageList
  List of Network Outages.
• NetworkOwnerContact
  DEPRECATED: use NetworkSetContact() /Update Administrative Owner of a Network./
• NetworkReportsContact
  DEPRECATED: use NetworkSetContact() /Update Reports Contact for a Network./
• NetworkRestart
  Restart a Network Process. TechOps Authorization Required
• NetworkSetContact
  Update Specified Network Contact.
• NetworkSetStatus
  Set Network Status. TechOps Authorization Required
• NetworkSetWebsite
  Update Specified Network Website.
• 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.
• 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.
• ParcelDownloadInner
  DEPRECATED: Function automatically part of ParcelDownload() now. /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 Collection for the Session Network/Mailbox.
• ParcelInBoxArchiveEx
  InBox Archive Collection for a specified Network/Mailbox.
• ParcelInBoxEx
  Current InBox for a specified Network/Mailbox.
• ParcelInfo
  List of Interchanges in a Parcel.
• ParcelInterchangeManifest
  DEPRECATED: use InterchangeManifest() /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 Collection for the Session Network/Mailbox.
• 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.
• ParcelSetMailbagControlID
  Set the MailbagControlID for a 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.
• ParcelUploadEx
  DEPRECATED: Use ParcelUploadDirected() /Upload any format Parcel to the OutBox./
• 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.
• ParcelUploadGZipEx
  DEPRECATED: Use ParcelUploadDirectedGZip(). /Upload any format Parcel to the OutBox with GZip compression./
• PricelistInfo
  PENDING Get Pricelist by PricelistID
• 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
  Sets an ECGridID as the default in its 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.
• 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 from a Network/Mailbox to the Session 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.
• TPSetMailboxDefault
  Sets an ECGridID as the default in its mailbox.
• 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.
• 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
  Reset all locked out users after timeout.
  Requires Root authorization.
• 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.