CallBackTest - LorenData/ECGrid-API GitHub Wiki

Create a test call for a specific CallBackEventID.

  public int CallBackTest(string SessionID,
                          int CallBackEventID,
                          long ParcelID,
                          long InterchangeID,
                          int UserID)

Parameters

SessionID - String - GUID
CallBackEventID - int
ParcelID - Long
InterchangeID - Long
UserID - Integer

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

<?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>
    <CallBackTest xmlns="https://os.ecgrid.io/">
      <SessionID>string</SessionID>
      <CallBackEventID>int</CallBackEventID>
      <ParcelID>long</ParcelID>
      <InterchangeID>long</InterchangeID>
      <UserID>int</UserID>
    </CallBackTest>
  </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>
    <CallBackTestResponse xmlns="https://os.ecgrid.io/">
      <CallBackTestResult>
        <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 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>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>
      </CallBackTestResult>
    </CallBackTestResponse>
  </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>
    <CallBackTest xmlns="https://os.ecgrid.io/">
      <SessionID>string</SessionID>
      <CallBackEventID>int</CallBackEventID>
      <ParcelID>long</ParcelID>
      <InterchangeID>long</InterchangeID>
      <UserID>int</UserID>
    </CallBackTest>
  </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>
    <CallBackTestResponse xmlns="https://os.ecgrid.io/">
      <CallBackTestResult>
        <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 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>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>
      </CallBackTestResult>
    </CallBackTestResponse>
  </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/CallBackTest?SessionID=string&CallBackEventID=string&ParcelID=string&InterchangeID=string&UserID=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"?>
<CallBackQueueIDInfo xmlns="https://os.ecgrid.io/">
  <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>
        <CallBackQueueID>long</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>long</ObjectID>
        <UserID>int</UserID>
        <Test>boolean</Test>
        <CallBackLog d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </CallBackQueueIDInfo>
      <CallBackQueueIDInfo>
        <CallBackQueueID>long</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>long</ObjectID>
        <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>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>

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/CallBackTest HTTP/1.1
Host: os.ecgrid.io
Content-Type: application/x-www-form-urlencoded
Content-Length: length

SessionID=string&CallBackEventID=string&ParcelID=string&InterchangeID=string&UserID=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="https://os.ecgrid.io/">
  <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>
        <CallBackQueueID>long</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>long</ObjectID>
        <UserID>int</UserID>
        <Test>boolean</Test>
        <CallBackLog d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </CallBackQueueIDInfo>
      <CallBackQueueIDInfo>
        <CallBackQueueID>long</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>long</ObjectID>
        <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>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>

Back To Common API Calls