-
Notifications
You must be signed in to change notification settings - Fork 2
API Calls
CrystalKLD edited this page Apr 15, 2024
·
10 revisions
Asynchronous Calls - Task-Async-Await
Create a CallBack Event for a specified Network/Mailbox.
List CallBack Event by CallBackEventID
List CallBack Events for a specified Network/Mailbox
Set the status of a CallBackEvent.
List of Failed CallBackQueue records for session Network/Mailbox.
List of Failed CallBackQueue records for Specified Network/Mailbox.
List of all Pending CallBackQueue records for session Network/Mailbox.
List of all Pending CallBackQueue records for Specified Network/Mailbox.
List of all Pending CallBackQueue records for Specified Network/Mailbox.
Information for a a specific CallBackQueueID.
Create a test call for a specific CallBackEventID.
Activate a suspended Carbon Copy.
Add a Carbon Copy which is billed to the Session Network/Mailbox.
Add a Carbon Copy which is billed to a specified Network/Mailbox.
Detail for a Carbon Copy.
List of Carbon Copy configurations for the Session Network/Mailbox.
List of Carbon Copy configurations for a specified Network/Mailbox.
Suspend an active Carbon Copy.
Terminate a Carbon Copy.
Add a new Private AS2 Certificate.</font>
Add a new Private Comm Certificate.</font>
Add a new Public Certificate.
Add a new Public Certificate.
Create a new Private Certificate generated by ECGridOS.
Renew a Private Certificate generated by ECGridOS.
Terminate a Certificate.
Use to change password of current User Account. Effective immediately.
Add a new Communication Connection.
Set CommID as Default for a Mailbox.
Find Communication Profiles by Identifier.
Get Comm Profile by CommID.
List Communication Profiles for Session Network/Mailbox.
List Communications Profiles for specified Network/Mailbox.
Find the Comm ID pair for two ECGridIDs.
Set the Comm Identifier pair for two ECGridIDs.
Set AS2 Connection Status.
Update an Comm Connection.
Generate a persistent APIKey for a specified UserID
Generate a random password.
Cancel an Interchange.
Get Date from EDI Envelope (ISA or UNB)
Get Interchange Info from EDI Envelope (ISA or UNB).</font>
Get Interchange Info from EDI Envelope (ISA or UNB)
InBox Interchange List for the Session Network/Mailbox.
InBox Interchange List for the Session Network/Mailbox.
InBox Interchange List for a specified Network/Mailbox.
InBox Interchange Blocked List for the Session Network/Mailbox.
InBox Interchange Blocked List for a specified Network/Mailbox.
InBox Interchange List for a specified Network/Mailbox.
OutBox Interchange Pending List for a specified Network/Mailbox.
InBox Interchange Pending List for a specified Network/Mailbox.
Interchange information by InterchangeID.
A complete end-to-end transaction Manifest for a specific Interchange.
OutBox Interchange List for the Session Network/Mailbox.
OutBox Interchange List for the Session Network/Mailbox.
OutBox Interchange List for a specified Network/Mailbox.
OutBox Interchange Blocked List for the Session Network/Mailbox.
OutBox Interchange Blocked List for a specified Network/Mailbox.
OutBox Interchange List for a specified Network/Mailbox.
Unroutable Interchanges for the Session Network/Mailbox.
Unroutable Interchanges for a specified Network/Mailbox.
OutBox Interchange Pending List for a session Network/Mailbox.
OutBox Interchange Pending List for a specified Network/Mailbox.
Resend and Interchange, allows for rerouting.
Create a new Interconnect Request.
Cancel an Interconnect Request.
Count of Interconnects by status for the Session Network/Mailbox.
Count of Interconnects by status for a specified Network/Mailbox.
Detail for an Interconnect.
Detail for an Interconnect.
Listing of Interconnects for an ECGridID with optional trading partner pair. If ECGridID2=-1, then match all for ECGridID1
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.
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.
Add a Note to an Interconnect Request.
Notes for an Interconnect.
Get a Persistent Key Value Attached to an Object.
Get a list of all Persistent Key Values Attached to an Object.
Remove a Persistent Key Value Attached to an Object.
Set a Persistent Key Value Attached to an Object.
Required first call in order to establish a session.
Required final call to close a session.
Activate a suspended Mailbox.
Add a Mailbox to the Session Network.
Add a Mailbox to a specified Network.
Change the DeleteOnDownload configuration of a specified Mailbox.
Update a Mailbox Description value.
Update a Mailbox InBox Timeout notification value.
Detail for a Mailbox.
Get a list of Mailboxes for the Session Network.
Get a list of Mailboxes for a specified Network.
Change the Managed Status of a specified Mailbox.
Update a Mailbox Name.
Update Specified Mailbox Contact.
Suspend an active Mailbox.
Update a Mailbox Description value.
Update a Mailbox override values for Segment Terminator, Element Separator and Subelement Separator.
Add a Migration List for session network/mailbox.
Add a Migration List for specified network/mailbox.
Add TP to Migration List.
Detail for an Migration.
Migration List for session network/mailbox.
Migration List for specified network/mailbox.
Get Specified Network Contact Info.
Details for a specific Network.
Details for a specific Network wtih Log.
List Networks, optionally filter by Name.
List of Network Outages.
Change the DeleteOnDownload configuration of a specified Network Root Mailbox.
Update Specified Network Contact.
Update Specified Network Website.
A Summary List of Network Status.
Update a Network Infromation.
Update a Network override values for Segment Terminator, Element Separator and Subelement Separator.
Current UTC Date/Time.
Add Acknowledgment Note for Parcel Note.
Download Parcel from InBox or Archive as Base64Array.
Download Parcel from InBox or Archive as Base64String.
Cancel Download of Parcel from InBox and remove it.
Confirm Download of Parcel from InBox and remove it.
Confirm Download of Parcel wtih Pending Acknowledgment from InBox and remove it.
Download Parcel from InBox or Archive without updating status with Base64Array.
Download Parcel from InBox or Archive without updating status with Base64String.
Reset Download of Parcel and restore to InBox.
Download Parcel from InBox or Archive.
Find Parcel by sender MailbagControlID (e.g. X12.56 MailbagID or AS2-MessageID).
Find Parcel by receiver MailbagControlID (e.g. X12.56 MailbagID or AS2-MessageID).
Current InBox for the Session Network/Mailbox.
InBox Archive Collection for the Session Network/Mailbox.
InBox Archive Collection for a specified Network/Mailbox in DESC order
InBox Archive Collection for a specified Network/Mailbox.
InBox Archive Collection for a specified Network/Mailbox - short form.
Current InBox for a specified Network/Mailbox.
Current InBox for a specified Network/Mailbox - short form.
Parcel Meta Information.
List the Transaction Manifest for a Parcel.
List the system generated Notes for a Parcel.
OutBox Archive Collection for the Session Network/Mailbox.
OutBox Archive Collection for a specified Network/Mailbox in DESC order
OutBox Archive Collection for a specified Network/Mailbox.
OutBox Archive Collection for a specified Network/Mailbox - short form.
List of Parcels which could not be processed for the Session Network/Mailbox.
List of Parcels which could not be processed for a specified Network/Mailbox.
List of Parcels which are in process for the session Network/Mailbox.
List of Parcels which are in process for a specified Network/Mailbox.
Resend Parcel from Internal Router.<br /><b>Requires NetOps authorization.</b>
Set MailbagControlID (e.g. X12.56 MailbagID or AS2-MessageID) for Parcel.
Send a test Parcel.
Update Parcel Local Status, a user defined variable.
Update Parcel Status.
Upload an X12, EDIFACT, Tradacoms or VDA Parcel to the OutBox with Base64Array.
Upload an X12, EDIFACT, Tradacoms or VDA Parcel to the OutBox with Base64String.
Upload an X12, EDIFACT, Tradacoms or VDA Parcel to the Specified Network/Mailbox OutBox with Base64Array.
Upload an X12, EDIFACT, Tradacoms or VDA Parcel to the Specified Network/Mailbox OutBox with Base64String.
Managed File Transfer (MFT, non-EDI data) upload to the OutBox with Base64Array.
Managed File Transfer (MFT, non-EDI data) upload to the OutBox with Base64String.
Instant Statistics for the Session Network/Mailbox.
Instant Statistics for a specified Network/Mailbox.
Interchange Statistics for the Session Network/Mailbox.
Interchange Statistics for the specified Network/Mailbox.
Mailbox Interchange Statistics for the Session Network/Mailbox.
Mailbox Interchange Statistics for the specified Network/Mailbox.
Mailbox Parcel Statistics for the Session Network/Mailbox.
Mailbox Parcel Statistics for the specified Network/Mailbox.
Selected Monthly Report for the Session Network/Mailbox.
Selected Monthly Report for a specified Network/Mailbox.
Statistical Traffic Report for a period of time for the Session Network/Mailbox.
Statistical Traffic Report for a period of time for a specified Network/Mailbox.
Statistical Public System-Wide Traffic Report for Last 72 Hours.
Get a Session Log for the Session User.
Get a Session Log for the Current Session.
Get a Session Log for a specified User.
Returns list of all System Status codes.
Activate a suspended ECGridID entry.
Add a Trading Partner ID to the Session Network/Mailbox.
Add a Trading Partner ID to specified Network/Mailbox.
Add a Trading Partner ID to a Value Added Network (VAN) connection.
Find Trading Partners by Description in a specified Network/Mailbox.
Gets the default ECGridID for a mailbox.
Detail for an ECGridID.
List all Trading Partners in the Session Network/Mailbox.
List Trading Partners by Owner UserID.
List all Trading Partners in a specified Network/Mailbox.
List all Trading Partners in a specified Network/Mailbox with Paging.
Move a single Trading Partner ID from a Network/Mailbox to the Session Network/Mailbox.
Move a single Trading Partner ID from a Network/Mailbox to a specified Network/Mailbox.
Move a single Trading Partner ID to a different Mailbox on the same Network.
Finds matching ECGridID(s) for specified X12 or EDIFACT Qualifier/ID pair in the session Network/Mailbox.
Finds matching ECGridID(s) for specified X12 or EDIFACT Qualifier/ID pair in a specified Network/Mailbox.
Sets an ECGridID as the default in its mailbox (must be X12 ISA compatible).
Update an ECGridID entry's Owner (OwnerUserID=0 to remove owner).
Suspend an active ECGridID entry.
Suspend an active ECGridID entry.
Terminate an ECGridID entry.
Update an ECGridID entry's EMail Address for Data.
Update an ECGridID entry's Description.
Activate a suspended User.
Create a User for the Session Network and a specified Mailbox.
Create a User for a specified Network/Mailbox.
Retrieve a persistent APIKey for a specified UserID
Detail for a specified User.
Detail for a specified User by LoginName.
Get a list of Users for the Session Network/Mailbox.
Get a list of Users for a specified Network/Mailbox.
Get a list of Locked Out Users for a specified Network/Mailbox.
Get a list of Locked Out Users for a specified Network/Mailbox.
Update a User's security information.
Reset a user's GraceLogins and OpenSessions count.
Send an SMS to a User.
Change a User's Authorizaton Level.
Change a User's Maximum Sessions.
Change a User's Network/Mailbox.
Suspend a User.
Terminate a User.
Update a User account.
ECGridOS Version.
Returns current session information.
Convert X.400 Address Elements into Compatible ECGrid Format.
Getting Started
- Getting Started - Basics
- Getting Started - Extended Capabilities
- HTTP Connections
- Visual Studio SOAP Connections
- About ECGridOS and Loren Data Corp.
- Documentation & Nomenclature
- Using Web Services
- Networks & Mailboxes
- Users & Authorization Levels
- API Keys & Sessions
- Trading Partners & ECGridIDs
- Interconnects
- Parcels, Interchanges & Mailbags
- Carbon Copies
ECGridOS API Calls
- API Calls - Full Definitions Available
- Asynchronous API Calls - Events
- Asynchronous API Calls - Task\Async\Await