Skip to content

KeyList

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

Back To Common API Calls

Get a list of all Persistent Key Values Attached to an Object.

  public KeyValue[] KeyList(string SessionID,
                            Objects SystemObject,
                            long ObjectID)

Parameters

Returns

KeyValue[]

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

<?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>
    <KeyList xmlns="https://os.ecgrid.io/">
      <SessionID>string</SessionID>
      <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>
      <ObjectID>long</ObjectID>
    </KeyList>
  </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>
    <KeyListResponse xmlns="https://os.ecgrid.io/">
      <KeyListResult>
        <KeyValue>
          <Key>string</Key>
          <Value>string</Value>
          <Meta>string</Meta>
          <Created>dateTime</Created>
          <Expires>dateTime</Expires>
          <Visibility>Private or Shared or Public or Session</Visibility>
          <NetworkID>int</NetworkID>
          <MailboxID>int</MailboxID>
          <UserID>int</UserID>
          <SessionID>string</SessionID>
        </KeyValue>
        <KeyValue>
          <Key>string</Key>
          <Value>string</Value>
          <Meta>string</Meta>
          <Created>dateTime</Created>
          <Expires>dateTime</Expires>
          <Visibility>Private or Shared or Public or Session</Visibility>
          <NetworkID>int</NetworkID>
          <MailboxID>int</MailboxID>
          <UserID>int</UserID>
          <SessionID>string</SessionID>
        </KeyValue>
      </KeyListResult>
    </KeyListResponse>
  </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>
    <KeyList xmlns="https://os.ecgrid.io/">
      <SessionID>string</SessionID>
      <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>
      <ObjectID>long</ObjectID>
    </KeyList>
  </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>
    <KeyListResponse xmlns="https://os.ecgrid.io/">
      <KeyListResult>
        <KeyValue>
          <Key>string</Key>
          <Value>string</Value>
          <Meta>string</Meta>
          <Created>dateTime</Created>
          <Expires>dateTime</Expires>
          <Visibility>Private or Shared or Public or Session</Visibility>
          <NetworkID>int</NetworkID>
          <MailboxID>int</MailboxID>
          <UserID>int</UserID>
          <SessionID>string</SessionID>
        </KeyValue>
        <KeyValue>
          <Key>string</Key>
          <Value>string</Value>
          <Meta>string</Meta>
          <Created>dateTime</Created>
          <Expires>dateTime</Expires>
          <Visibility>Private or Shared or Public or Session</Visibility>
          <NetworkID>int</NetworkID>
          <MailboxID>int</MailboxID>
          <UserID>int</UserID>
          <SessionID>string</SessionID>
        </KeyValue>
      </KeyListResult>
    </KeyListResponse>
  </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/KeyList?SessionID=string&SystemObject=string&ObjectID=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"?>
<ArrayOfKeyValue xmlns="https://os.ecgrid.io/">
  <KeyValue>
    <Key>string</Key>
    <Value>string</Value>
    <Meta>string</Meta>
    <Created>dateTime</Created>
    <Expires>dateTime</Expires>
    <Visibility>Private or Shared or Public or Session</Visibility>
    <NetworkID>int</NetworkID>
    <MailboxID>int</MailboxID>
    <UserID>int</UserID>
    <SessionID>string</SessionID>
  </KeyValue>
  <KeyValue>
    <Key>string</Key>
    <Value>string</Value>
    <Meta>string</Meta>
    <Created>dateTime</Created>
    <Expires>dateTime</Expires>
    <Visibility>Private or Shared or Public or Session</Visibility>
    <NetworkID>int</NetworkID>
    <MailboxID>int</MailboxID>
    <UserID>int</UserID>
    <SessionID>string</SessionID>
  </KeyValue>
</ArrayOfKeyValue>

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

SessionID=string&SystemObject=string&ObjectID=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfKeyValue xmlns="https://os.ecgrid.io/">
  <KeyValue>
    <Key>string</Key>
    <Value>string</Value>
    <Meta>string</Meta>
    <Created>dateTime</Created>
    <Expires>dateTime</Expires>
    <Visibility>Private or Shared or Public or Session</Visibility>
    <NetworkID>int</NetworkID>
    <MailboxID>int</MailboxID>
    <UserID>int</UserID>
    <SessionID>string</SessionID>
  </KeyValue>
  <KeyValue>
    <Key>string</Key>
    <Value>string</Value>
    <Meta>string</Meta>
    <Created>dateTime</Created>
    <Expires>dateTime</Expires>
    <Visibility>Private or Shared or Public or Session</Visibility>
    <NetworkID>int</NetworkID>
    <MailboxID>int</MailboxID>
    <UserID>int</UserID>
    <SessionID>string</SessionID>
  </KeyValue>
</ArrayOfKeyValue>

Back To Common API Calls

Home

Getting Started

Updates

ECGridOS Wiki

ECGridOS API Calls

Appendix

Legacy Forum Q & A

Clone this wiki locally