ECGridOS API v3
Click here for a complete list of operations.
CallBackQueueInfo
Information for a a specific CallBackQueueID.
Test
To test the operation using the HTTP POST protocol, click the 'Invoke' button.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /v3.0/prod/ecgridos.asmx HTTP/1.1 Host: ecgridos.net Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "http://ecgridos.net/CallBackQueueInfo" <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <CallBackQueueInfo xmlns="http://ecgridos.net/"> <SessionID>string</SessionID> <CallBackQueueID>int</CallBackQueueID> </CallBackQueueInfo> </soap:Body> </soap:Envelope>
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <CallBackQueueInfoResponse xmlns="http://ecgridos.net/"> <CallBackQueueInfoResult> <CallBackQueueID>int</CallBackQueueID> <Date>dateTime</Date> <CallBackEvent> <CallBackEventID>int</CallBackEventID> <NetworkID>int</NetworkID> <MailboxID>int</MailboxID> <UserID>int</UserID> <Created>dateTime</Created> <Modified>dateTime</Modified> <SystemObject>User or Network or Mailbox or ECGridID or Interconnect or Migration or Parcel or Interchange or CarbonCopy or CallBackEvent or AS2 or GISB or ParcelNotes or InterconnectNote or PriceList or Contract or Invoice</SystemObject> <ObjectStatus>short</ObjectStatus> <StatusCode>string</StatusCode> <Direction>NoDir or OutBox or InBox</Direction> <Frequency>short</Frequency> <MaxCalls>short</MaxCalls> <Status>Development or Active or Preproduction or Suspended or Terminated</Status> <URL>string</URL> <HTTPAuthentication> <Type>None or Basic or Digest</Type> <User>string</User> <Password>string</Password> </HTTPAuthentication> <CallBackQueue> <CallBackQueueIDInfo xsi:nil="true" /> <CallBackQueueIDInfo xsi:nil="true" /> </CallBackQueue> </CallBackEvent> <CallsRemaining>short</CallsRemaining> <NextCall>dateTime</NextCall> <Status>Active or Pending or Completed or Error or Canceled</Status> <ObjectID>int</ObjectID> <ParcelID>int</ParcelID> <InterchangeID>int</InterchangeID> <UserID>int</UserID> <Test>boolean</Test> <CallBackLog> <CallBackLogInfo> <CallBackLogID>int</CallBackLogID> <Date>dateTime</Date> <CallNumber>short</CallNumber> <ReturnCode>int</ReturnCode> <Message>string</Message> </CallBackLogInfo> <CallBackLogInfo> <CallBackLogID>int</CallBackLogID> <Date>dateTime</Date> <CallNumber>short</CallNumber> <ReturnCode>int</ReturnCode> <Message>string</Message> </CallBackLogInfo> </CallBackLog> </CallBackQueueInfoResult> </CallBackQueueInfoResponse> </soap:Body> </soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /v3.0/prod/ecgridos.asmx HTTP/1.1 Host: ecgridos.net Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <CallBackQueueInfo xmlns="http://ecgridos.net/"> <SessionID>string</SessionID> <CallBackQueueID>int</CallBackQueueID> </CallBackQueueInfo> </soap12:Body> </soap12:Envelope>
HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <CallBackQueueInfoResponse xmlns="http://ecgridos.net/"> <CallBackQueueInfoResult> <CallBackQueueID>int</CallBackQueueID> <Date>dateTime</Date> <CallBackEvent> <CallBackEventID>int</CallBackEventID> <NetworkID>int</NetworkID> <MailboxID>int</MailboxID> <UserID>int</UserID> <Created>dateTime</Created> <Modified>dateTime</Modified> <SystemObject>User or Network or Mailbox or ECGridID or Interconnect or Migration or Parcel or Interchange or CarbonCopy or CallBackEvent or AS2 or GISB or ParcelNotes or InterconnectNote or PriceList or Contract or Invoice</SystemObject> <ObjectStatus>short</ObjectStatus> <StatusCode>string</StatusCode> <Direction>NoDir or OutBox or InBox</Direction> <Frequency>short</Frequency> <MaxCalls>short</MaxCalls> <Status>Development or Active or Preproduction or Suspended or Terminated</Status> <URL>string</URL> <HTTPAuthentication> <Type>None or Basic or Digest</Type> <User>string</User> <Password>string</Password> </HTTPAuthentication> <CallBackQueue> <CallBackQueueIDInfo xsi:nil="true" /> <CallBackQueueIDInfo xsi:nil="true" /> </CallBackQueue> </CallBackEvent> <CallsRemaining>short</CallsRemaining> <NextCall>dateTime</NextCall> <Status>Active or Pending or Completed or Error or Canceled</Status> <ObjectID>int</ObjectID> <ParcelID>int</ParcelID> <InterchangeID>int</InterchangeID> <UserID>int</UserID> <Test>boolean</Test> <CallBackLog> <CallBackLogInfo> <CallBackLogID>int</CallBackLogID> <Date>dateTime</Date> <CallNumber>short</CallNumber> <ReturnCode>int</ReturnCode> <Message>string</Message> </CallBackLogInfo> <CallBackLogInfo> <CallBackLogID>int</CallBackLogID> <Date>dateTime</Date> <CallNumber>short</CallNumber> <ReturnCode>int</ReturnCode> <Message>string</Message> </CallBackLogInfo> </CallBackLog> </CallBackQueueInfoResult> </CallBackQueueInfoResponse> </soap12:Body> </soap12:Envelope>
HTTP GET
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
GET /v3.0/prod/ecgridos.asmx/CallBackQueueInfo?SessionID=string&CallBackQueueID=string HTTP/1.1 Host: ecgridos.net
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <CallBackQueueIDInfo xmlns="http://ecgridos.net/"> <CallBackQueueID>int</CallBackQueueID> <Date>dateTime</Date> <CallBackEvent> <CallBackEventID>int</CallBackEventID> <NetworkID>int</NetworkID> <MailboxID>int</MailboxID> <UserID>int</UserID> <Created>dateTime</Created> <Modified>dateTime</Modified> <SystemObject>User or Network or Mailbox or ECGridID or Interconnect or Migration or Parcel or Interchange or CarbonCopy or CallBackEvent or AS2 or GISB or ParcelNotes or InterconnectNote or PriceList or Contract or Invoice</SystemObject> <ObjectStatus>short</ObjectStatus> <StatusCode>string</StatusCode> <Direction>NoDir or OutBox or InBox</Direction> <Frequency>short</Frequency> <MaxCalls>short</MaxCalls> <Status>Development or Active or Preproduction or Suspended or Terminated</Status> <URL>string</URL> <HTTPAuthentication> <Type>None or Basic or Digest</Type> <User>string</User> <Password>string</Password> </HTTPAuthentication> <CallBackQueue> <CallBackQueueIDInfo> <CallBackQueueID>int</CallBackQueueID> <Date>dateTime</Date> <CallBackEvent d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <CallsRemaining>short</CallsRemaining> <NextCall>dateTime</NextCall> <Status>Active or Pending or Completed or Error or Canceled</Status> <ObjectID>int</ObjectID> <ParcelID>int</ParcelID> <InterchangeID>int</InterchangeID> <UserID>int</UserID> <Test>boolean</Test> <CallBackLog d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> </CallBackQueueIDInfo> <CallBackQueueIDInfo> <CallBackQueueID>int</CallBackQueueID> <Date>dateTime</Date> <CallBackEvent d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <CallsRemaining>short</CallsRemaining> <NextCall>dateTime</NextCall> <Status>Active or Pending or Completed or Error or Canceled</Status> <ObjectID>int</ObjectID> <ParcelID>int</ParcelID> <InterchangeID>int</InterchangeID> <UserID>int</UserID> <Test>boolean</Test> <CallBackLog d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> </CallBackQueueIDInfo> </CallBackQueue> </CallBackEvent> <CallsRemaining>short</CallsRemaining> <NextCall>dateTime</NextCall> <Status>Active or Pending or Completed or Error or Canceled</Status> <ObjectID>int</ObjectID> <ParcelID>int</ParcelID> <InterchangeID>int</InterchangeID> <UserID>int</UserID> <Test>boolean</Test> <CallBackLog> <CallBackLogInfo> <CallBackLogID>int</CallBackLogID> <Date>dateTime</Date> <CallNumber>short</CallNumber> <ReturnCode>int</ReturnCode> <Message>string</Message> </CallBackLogInfo> <CallBackLogInfo> <CallBackLogID>int</CallBackLogID> <Date>dateTime</Date> <CallNumber>short</CallNumber> <ReturnCode>int</ReturnCode> <Message>string</Message> </CallBackLogInfo> </CallBackLog> </CallBackQueueIDInfo>
HTTP POST
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
POST /v3.0/prod/ecgridos.asmx/CallBackQueueInfo HTTP/1.1 Host: ecgridos.net Content-Type: application/x-www-form-urlencoded Content-Length: length SessionID=string&CallBackQueueID=string
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <CallBackQueueIDInfo xmlns="http://ecgridos.net/"> <CallBackQueueID>int</CallBackQueueID> <Date>dateTime</Date> <CallBackEvent> <CallBackEventID>int</CallBackEventID> <NetworkID>int</NetworkID> <MailboxID>int</MailboxID> <UserID>int</UserID> <Created>dateTime</Created> <Modified>dateTime</Modified> <SystemObject>User or Network or Mailbox or ECGridID or Interconnect or Migration or Parcel or Interchange or CarbonCopy or CallBackEvent or AS2 or GISB or ParcelNotes or InterconnectNote or PriceList or Contract or Invoice</SystemObject> <ObjectStatus>short</ObjectStatus> <StatusCode>string</StatusCode> <Direction>NoDir or OutBox or InBox</Direction> <Frequency>short</Frequency> <MaxCalls>short</MaxCalls> <Status>Development or Active or Preproduction or Suspended or Terminated</Status> <URL>string</URL> <HTTPAuthentication> <Type>None or Basic or Digest</Type> <User>string</User> <Password>string</Password> </HTTPAuthentication> <CallBackQueue> <CallBackQueueIDInfo> <CallBackQueueID>int</CallBackQueueID> <Date>dateTime</Date> <CallBackEvent d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <CallsRemaining>short</CallsRemaining> <NextCall>dateTime</NextCall> <Status>Active or Pending or Completed or Error or Canceled</Status> <ObjectID>int</ObjectID> <ParcelID>int</ParcelID> <InterchangeID>int</InterchangeID> <UserID>int</UserID> <Test>boolean</Test> <CallBackLog d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> </CallBackQueueIDInfo> <CallBackQueueIDInfo> <CallBackQueueID>int</CallBackQueueID> <Date>dateTime</Date> <CallBackEvent d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <CallsRemaining>short</CallsRemaining> <NextCall>dateTime</NextCall> <Status>Active or Pending or Completed or Error or Canceled</Status> <ObjectID>int</ObjectID> <ParcelID>int</ParcelID> <InterchangeID>int</InterchangeID> <UserID>int</UserID> <Test>boolean</Test> <CallBackLog d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> </CallBackQueueIDInfo> </CallBackQueue> </CallBackEvent> <CallsRemaining>short</CallsRemaining> <NextCall>dateTime</NextCall> <Status>Active or Pending or Completed or Error or Canceled</Status> <ObjectID>int</ObjectID> <ParcelID>int</ParcelID> <InterchangeID>int</InterchangeID> <UserID>int</UserID> <Test>boolean</Test> <CallBackLog> <CallBackLogInfo> <CallBackLogID>int</CallBackLogID> <Date>dateTime</Date> <CallNumber>short</CallNumber> <ReturnCode>int</ReturnCode> <Message>string</Message> </CallBackLogInfo> <CallBackLogInfo> <CallBackLogID>int</CallBackLogID> <Date>dateTime</Date> <CallNumber>short</CallNumber> <ReturnCode>int</ReturnCode> <Message>string</Message> </CallBackLogInfo> </CallBackLog> </CallBackQueueIDInfo>