ECGridOS API v4
Click here for a complete list of operations.
CallBackFailedList
List of Failed CallBackQueue records for session Network/Mailbox.
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 /v4.1/prod/ECGridOS.asmx HTTP/1.1 Host: os.ecgrid.io Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "https://os.ecgrid.io/CallBackFailedList" <?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> <CallBackFailedList xmlns="https://os.ecgrid.io/"> <SessionID>string</SessionID> <MaxDays>short</MaxDays> </CallBackFailedList> </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> <CallBackFailedListResponse xmlns="https://os.ecgrid.io/"> <CallBackFailedListResult> <CallBackQueueIDInfo> <CallBackQueueID>long</CallBackQueueID> <Date>dateTime</Date> <CallBackEvent> <CallBackEventID>int</CallBackEventID> <NetworkID>int</NetworkID> <MailboxID>int</MailboxID> <UserID>int</UserID> <Created>dateTime</Created> <Modified>dateTime</Modified> <SystemObject>System or User or Network or Mailbox or ECGridID or Interconnect or Migration or Parcel or Interchange or CarbonCopy or CallBackEvent or AS2 or Comm or GISB 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 xsi:nil="true" /> <CallBackQueue xsi:nil="true" /> </CallBackEvent> <CallsRemaining>short</CallsRemaining> <NextCall>dateTime</NextCall> <Status>Active or Pending or Completed or Error or Canceled</Status> <ObjectID>long</ObjectID> <UserID>int</UserID> <Test>boolean</Test> <CallBackLog> <CallBackLogInfo xsi:nil="true" /> <CallBackLogInfo xsi:nil="true" /> </CallBackLog> </CallBackQueueIDInfo> <CallBackQueueIDInfo> <CallBackQueueID>long</CallBackQueueID> <Date>dateTime</Date> <CallBackEvent> <CallBackEventID>int</CallBackEventID> <NetworkID>int</NetworkID> <MailboxID>int</MailboxID> <UserID>int</UserID> <Created>dateTime</Created> <Modified>dateTime</Modified> <SystemObject>System or User or Network or Mailbox or ECGridID or Interconnect or Migration or Parcel or Interchange or CarbonCopy or CallBackEvent or AS2 or Comm or GISB 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 xsi:nil="true" /> <CallBackQueue xsi:nil="true" /> </CallBackEvent> <CallsRemaining>short</CallsRemaining> <NextCall>dateTime</NextCall> <Status>Active or Pending or Completed or Error or Canceled</Status> <ObjectID>long</ObjectID> <UserID>int</UserID> <Test>boolean</Test> <CallBackLog> <CallBackLogInfo xsi:nil="true" /> <CallBackLogInfo xsi:nil="true" /> </CallBackLog> </CallBackQueueIDInfo> </CallBackFailedListResult> </CallBackFailedListResponse> </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 /v4.1/prod/ECGridOS.asmx HTTP/1.1 Host: os.ecgrid.io 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> <CallBackFailedList xmlns="https://os.ecgrid.io/"> <SessionID>string</SessionID> <MaxDays>short</MaxDays> </CallBackFailedList> </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> <CallBackFailedListResponse xmlns="https://os.ecgrid.io/"> <CallBackFailedListResult> <CallBackQueueIDInfo> <CallBackQueueID>long</CallBackQueueID> <Date>dateTime</Date> <CallBackEvent> <CallBackEventID>int</CallBackEventID> <NetworkID>int</NetworkID> <MailboxID>int</MailboxID> <UserID>int</UserID> <Created>dateTime</Created> <Modified>dateTime</Modified> <SystemObject>System or User or Network or Mailbox or ECGridID or Interconnect or Migration or Parcel or Interchange or CarbonCopy or CallBackEvent or AS2 or Comm or GISB 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 xsi:nil="true" /> <CallBackQueue xsi:nil="true" /> </CallBackEvent> <CallsRemaining>short</CallsRemaining> <NextCall>dateTime</NextCall> <Status>Active or Pending or Completed or Error or Canceled</Status> <ObjectID>long</ObjectID> <UserID>int</UserID> <Test>boolean</Test> <CallBackLog> <CallBackLogInfo xsi:nil="true" /> <CallBackLogInfo xsi:nil="true" /> </CallBackLog> </CallBackQueueIDInfo> <CallBackQueueIDInfo> <CallBackQueueID>long</CallBackQueueID> <Date>dateTime</Date> <CallBackEvent> <CallBackEventID>int</CallBackEventID> <NetworkID>int</NetworkID> <MailboxID>int</MailboxID> <UserID>int</UserID> <Created>dateTime</Created> <Modified>dateTime</Modified> <SystemObject>System or User or Network or Mailbox or ECGridID or Interconnect or Migration or Parcel or Interchange or CarbonCopy or CallBackEvent or AS2 or Comm or GISB 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 xsi:nil="true" /> <CallBackQueue xsi:nil="true" /> </CallBackEvent> <CallsRemaining>short</CallsRemaining> <NextCall>dateTime</NextCall> <Status>Active or Pending or Completed or Error or Canceled</Status> <ObjectID>long</ObjectID> <UserID>int</UserID> <Test>boolean</Test> <CallBackLog> <CallBackLogInfo xsi:nil="true" /> <CallBackLogInfo xsi:nil="true" /> </CallBackLog> </CallBackQueueIDInfo> </CallBackFailedListResult> </CallBackFailedListResponse> </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 /v4.1/prod/ECGridOS.asmx/CallBackFailedList?SessionID=string&MaxDays=string HTTP/1.1 Host: os.ecgrid.io
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <ArrayOfCallBackQueueIDInfo xmlns="https://os.ecgrid.io/"> <CallBackQueueIDInfo> <CallBackQueueID>long</CallBackQueueID> <Date>dateTime</Date> <CallBackEvent> <CallBackEventID>int</CallBackEventID> <NetworkID>int</NetworkID> <MailboxID>int</MailboxID> <UserID>int</UserID> <Created>dateTime</Created> <Modified>dateTime</Modified> <SystemObject>System or User or Network or Mailbox or ECGridID or Interconnect or Migration or Parcel or Interchange or CarbonCopy or CallBackEvent or AS2 or Comm or GISB 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 or Certificate</Type> <User>string</User> <Password>string</Password> </HTTPAuthentication> <CallBackQueue> <CallBackQueueIDInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <CallBackQueueIDInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> </CallBackQueue> </CallBackEvent> <CallsRemaining>short</CallsRemaining> <NextCall>dateTime</NextCall> <Status>Active or Pending or Completed or Error or Canceled</Status> <ObjectID>long</ObjectID> <UserID>int</UserID> <Test>boolean</Test> <CallBackLog> <CallBackLogInfo> <CallBackLogID>long</CallBackLogID> <Date>dateTime</Date> <CallNumber>short</CallNumber> <ReturnCode>int</ReturnCode> <Message>string</Message> </CallBackLogInfo> <CallBackLogInfo> <CallBackLogID>long</CallBackLogID> <Date>dateTime</Date> <CallNumber>short</CallNumber> <ReturnCode>int</ReturnCode> <Message>string</Message> </CallBackLogInfo> </CallBackLog> </CallBackQueueIDInfo> <CallBackQueueIDInfo> <CallBackQueueID>long</CallBackQueueID> <Date>dateTime</Date> <CallBackEvent> <CallBackEventID>int</CallBackEventID> <NetworkID>int</NetworkID> <MailboxID>int</MailboxID> <UserID>int</UserID> <Created>dateTime</Created> <Modified>dateTime</Modified> <SystemObject>System or User or Network or Mailbox or ECGridID or Interconnect or Migration or Parcel or Interchange or CarbonCopy or CallBackEvent or AS2 or Comm or GISB 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 or Certificate</Type> <User>string</User> <Password>string</Password> </HTTPAuthentication> <CallBackQueue> <CallBackQueueIDInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <CallBackQueueIDInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> </CallBackQueue> </CallBackEvent> <CallsRemaining>short</CallsRemaining> <NextCall>dateTime</NextCall> <Status>Active or Pending or Completed or Error or Canceled</Status> <ObjectID>long</ObjectID> <UserID>int</UserID> <Test>boolean</Test> <CallBackLog> <CallBackLogInfo> <CallBackLogID>long</CallBackLogID> <Date>dateTime</Date> <CallNumber>short</CallNumber> <ReturnCode>int</ReturnCode> <Message>string</Message> </CallBackLogInfo> <CallBackLogInfo> <CallBackLogID>long</CallBackLogID> <Date>dateTime</Date> <CallNumber>short</CallNumber> <ReturnCode>int</ReturnCode> <Message>string</Message> </CallBackLogInfo> </CallBackLog> </CallBackQueueIDInfo> </ArrayOfCallBackQueueIDInfo>
HTTP POST
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
POST /v4.1/prod/ECGridOS.asmx/CallBackFailedList HTTP/1.1 Host: os.ecgrid.io Content-Type: application/x-www-form-urlencoded Content-Length: length SessionID=string&MaxDays=string
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <ArrayOfCallBackQueueIDInfo xmlns="https://os.ecgrid.io/"> <CallBackQueueIDInfo> <CallBackQueueID>long</CallBackQueueID> <Date>dateTime</Date> <CallBackEvent> <CallBackEventID>int</CallBackEventID> <NetworkID>int</NetworkID> <MailboxID>int</MailboxID> <UserID>int</UserID> <Created>dateTime</Created> <Modified>dateTime</Modified> <SystemObject>System or User or Network or Mailbox or ECGridID or Interconnect or Migration or Parcel or Interchange or CarbonCopy or CallBackEvent or AS2 or Comm or GISB 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 or Certificate</Type> <User>string</User> <Password>string</Password> </HTTPAuthentication> <CallBackQueue> <CallBackQueueIDInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <CallBackQueueIDInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> </CallBackQueue> </CallBackEvent> <CallsRemaining>short</CallsRemaining> <NextCall>dateTime</NextCall> <Status>Active or Pending or Completed or Error or Canceled</Status> <ObjectID>long</ObjectID> <UserID>int</UserID> <Test>boolean</Test> <CallBackLog> <CallBackLogInfo> <CallBackLogID>long</CallBackLogID> <Date>dateTime</Date> <CallNumber>short</CallNumber> <ReturnCode>int</ReturnCode> <Message>string</Message> </CallBackLogInfo> <CallBackLogInfo> <CallBackLogID>long</CallBackLogID> <Date>dateTime</Date> <CallNumber>short</CallNumber> <ReturnCode>int</ReturnCode> <Message>string</Message> </CallBackLogInfo> </CallBackLog> </CallBackQueueIDInfo> <CallBackQueueIDInfo> <CallBackQueueID>long</CallBackQueueID> <Date>dateTime</Date> <CallBackEvent> <CallBackEventID>int</CallBackEventID> <NetworkID>int</NetworkID> <MailboxID>int</MailboxID> <UserID>int</UserID> <Created>dateTime</Created> <Modified>dateTime</Modified> <SystemObject>System or User or Network or Mailbox or ECGridID or Interconnect or Migration or Parcel or Interchange or CarbonCopy or CallBackEvent or AS2 or Comm or GISB 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 or Certificate</Type> <User>string</User> <Password>string</Password> </HTTPAuthentication> <CallBackQueue> <CallBackQueueIDInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <CallBackQueueIDInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> </CallBackQueue> </CallBackEvent> <CallsRemaining>short</CallsRemaining> <NextCall>dateTime</NextCall> <Status>Active or Pending or Completed or Error or Canceled</Status> <ObjectID>long</ObjectID> <UserID>int</UserID> <Test>boolean</Test> <CallBackLog> <CallBackLogInfo> <CallBackLogID>long</CallBackLogID> <Date>dateTime</Date> <CallNumber>short</CallNumber> <ReturnCode>int</ReturnCode> <Message>string</Message> </CallBackLogInfo> <CallBackLogInfo> <CallBackLogID>long</CallBackLogID> <Date>dateTime</Date> <CallNumber>short</CallNumber> <ReturnCode>int</ReturnCode> <Message>string</Message> </CallBackLogInfo> </CallBackLog> </CallBackQueueIDInfo> </ArrayOfCallBackQueueIDInfo>