Skip to content

CallBackPendingListEx

Jump to bottom
Greg Kolinski edited this page Sep 3, 2024 · 2 revisions

Back To Common API Calls

List of all Pending CallBackQueue records for Specified Network/Mailbox.

  public CallBackQueueIDInfo[] CallBackPendingListEx(string SessionID,
                                                     int NetworkID,
                                                     int MailboxID)

Parameters

Returns

CallBackQueueIDInfo[]

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/CallBackPendingListEx"

<?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>
    <CallBackPendingListEx xmlns="https://os.ecgrid.io/">
      <SessionID>string</SessionID>
      <NetworkID>int</NetworkID>
      <MailboxID>int</MailboxID>
    </CallBackPendingListEx>
  </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>
    <CallBackPendingListExResponse xmlns="https://os.ecgrid.io/">
      <CallBackPendingListExResult>
        <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 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 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 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 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>
      </CallBackPendingListExResult>
    </CallBackPendingListExResponse>
  </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>
    <CallBackPendingListEx xmlns="https://os.ecgrid.io/">
      <SessionID>string</SessionID>
      <NetworkID>int</NetworkID>
      <MailboxID>int</MailboxID>
    </CallBackPendingListEx>
  </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>
    <CallBackPendingListExResponse xmlns="https://os.ecgrid.io/">
      <CallBackPendingListExResult>
        <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 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 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 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 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>
      </CallBackPendingListExResult>
    </CallBackPendingListExResponse>
  </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/CallBackPendingListEx?SessionID=string&NetworkID=string&MailboxID=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>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>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 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 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 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 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/CallBackPendingListEx HTTP/1.1
Host: os.ecgrid.io
Content-Type: application/x-www-form-urlencoded
Content-Length: length

SessionID=string&NetworkID=string&MailboxID=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 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 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 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 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>

Back To Common API Calls

Home

Getting Started

Updates

ECGridOS Wiki

ECGridOS API Calls

Appendix

Legacy Forum Q & A

Clone this wiki locally