ECGridOS API v4


Click here for a complete list of operations.

KeyGet

Get a Persistent Key Value Attached to an Object.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
SessionID:
Key:
SystemObject:
ObjectID:
Visibility:

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

<?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>
    <KeyGet xmlns="https://os.ecgrid.io/">
      <SessionID>string</SessionID>
      <Key>string</Key>
      <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>int</ObjectID>
      <Visibility>Private or Shared or Public or Session</Visibility>
    </KeyGet>
  </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>
    <KeyGetResponse xmlns="https://os.ecgrid.io/">
      <KeyGetResult>
        <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>
      </KeyGetResult>
    </KeyGetResponse>
  </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>
    <KeyGet xmlns="https://os.ecgrid.io/">
      <SessionID>string</SessionID>
      <Key>string</Key>
      <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>int</ObjectID>
      <Visibility>Private or Shared or Public or Session</Visibility>
    </KeyGet>
  </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>
    <KeyGetResponse xmlns="https://os.ecgrid.io/">
      <KeyGetResult>
        <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>
      </KeyGetResult>
    </KeyGetResponse>
  </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/KeyGet?SessionID=string&Key=string&SystemObject=string&ObjectID=string&Visibility=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"?>
<KeyValue xmlns="https://os.ecgrid.io/">
  <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>

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

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

<?xml version="1.0" encoding="utf-8"?>
<KeyValue xmlns="https://os.ecgrid.io/">
  <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>