Skip to content

CallBackAddEx

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

Back To Common API Calls

Create a CallBack Event for a specified Network/Mailbox.

  public int CallBackAddEx(string SessionID,
                           int NetworkID,
                           int MailboxID,
                           int UserID,
                           Objects SystemObject,
                           short ObjectStatus,
                           Direction Direction,
                           short Frequency,
                           short MaxRetries,
                           string URL,
                           HTTPAuthType HTTPAuthentication,
                           string HTTPUser,
                           string HTTPPassword,
                           Status Status)

Parameters

Returns

int

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

<?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>
    <CallBackAddEx xmlns="https://os.ecgrid.io/">
      <SessionID>string</SessionID>
      <NetworkID>int</NetworkID>
      <MailboxID>int</MailboxID>
      <UserID>int</UserID>
      <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>
      <Direction>NoDir or OutBox or InBox</Direction>
      <Frequency>short</Frequency>
      <MaxRetries>short</MaxRetries>
      <URL>string</URL>
      <HTTPAuthentication>None or Basic or Digest or Certificate</HTTPAuthentication>
      <HTTPUser>string</HTTPUser>
      <HTTPPassword>string</HTTPPassword>
      <Status>Development or Active or Preproduction or Suspended or Terminated</Status>
    </CallBackAddEx>
  </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>
    <CallBackAddExResponse xmlns="https://os.ecgrid.io/">
      <CallBackAddExResult>
        <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 xsi:nil="true" />
            <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 xsi:nil="true" />
          </CallBackQueueIDInfo>
          <CallBackQueueIDInfo>
            <CallBackQueueID>long</CallBackQueueID>
            <Date>dateTime</Date>
            <CallBackEvent xsi:nil="true" />
            <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 xsi:nil="true" />
          </CallBackQueueIDInfo>
        </CallBackQueue>
      </CallBackAddExResult>
    </CallBackAddExResponse>
  </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>
    <CallBackAddEx xmlns="https://os.ecgrid.io/">
      <SessionID>string</SessionID>
      <NetworkID>int</NetworkID>
      <MailboxID>int</MailboxID>
      <UserID>int</UserID>
      <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>
      <Direction>NoDir or OutBox or InBox</Direction>
      <Frequency>short</Frequency>
      <MaxRetries>short</MaxRetries>
      <URL>string</URL>
      <HTTPAuthentication>None or Basic or Digest or Certificate</HTTPAuthentication>
      <HTTPUser>string</HTTPUser>
      <HTTPPassword>string</HTTPPassword>
      <Status>Development or Active or Preproduction or Suspended or Terminated</Status>
    </CallBackAddEx>
  </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>
    <CallBackAddExResponse xmlns="https://os.ecgrid.io/">
      <CallBackAddExResult>
        <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 xsi:nil="true" />
            <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 xsi:nil="true" />
          </CallBackQueueIDInfo>
          <CallBackQueueIDInfo>
            <CallBackQueueID>long</CallBackQueueID>
            <Date>dateTime</Date>
            <CallBackEvent xsi:nil="true" />
            <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 xsi:nil="true" />
          </CallBackQueueIDInfo>
        </CallBackQueue>
      </CallBackAddExResult>
    </CallBackAddExResponse>
  </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/CallBackAddEx?SessionID=string&NetworkID=string&MailboxID=string&UserID=string&SystemObject=string&ObjectStatus=string&Direction=string&Frequency=string&MaxRetries=string&URL=string&HTTPAuthentication=string&HTTPUser=string&HTTPPassword=string&Status=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"?>
<CallBackEventIDInfo xmlns="https://os.ecgrid.io/">
  <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>
        <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 d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CallBackQueue d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </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 d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CallBackLogInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </CallBackLog>
    </CallBackQueueIDInfo>
    <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 d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CallBackQueue d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </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 d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CallBackLogInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </CallBackLog>
    </CallBackQueueIDInfo>
  </CallBackQueue>
</CallBackEventIDInfo>

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

SessionID=string&NetworkID=string&MailboxID=string&UserID=string&SystemObject=string&ObjectStatus=string&Direction=string&Frequency=string&MaxRetries=string&URL=string&HTTPAuthentication=string&HTTPUser=string&HTTPPassword=string&Status=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<CallBackEventIDInfo xmlns="https://os.ecgrid.io/">
  <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>
        <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 d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CallBackQueue d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </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 d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CallBackLogInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </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 d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CallBackQueue d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </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 d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CallBackLogInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </CallBackLog>
    </CallBackQueueIDInfo>
  </CallBackQueue>
</CallBackEventIDInfo>

Back To Common API Calls

Home

Getting Started

Updates

ECGridOS Wiki

ECGridOS API Calls

Appendix

Legacy Forum Q & A

Clone this wiki locally