ECGridOS API v3 Web Service

ECGridOS API v3

Click here for a complete list of operations.

KeyList

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

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

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 /v3.0/prod/ecgridos.asmx HTTP/1.1
Host: ecgridos.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ecgridos.net/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="http://ecgridos.net/">
      <SessionID>string</SessionID>
      <SystemObject>User or Network or Mailbox or ECGridID or Interconnect or Migration or Parcel or Interchange or CarbonCopy or CallBackEvent or AS2 or GISB or ParcelNotes or InterconnectNote or PriceList or Contract or Invoice</SystemObject>
      <ObjectID>int</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="http://ecgridos.net/">
      <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 /v3.0/prod/ecgridos.asmx HTTP/1.1
Host: ecgridos.net
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="http://ecgridos.net/">
      <SessionID>string</SessionID>
      <SystemObject>User or Network or Mailbox or ECGridID or Interconnect or Migration or Parcel or Interchange or CarbonCopy or CallBackEvent or AS2 or GISB or ParcelNotes or InterconnectNote or PriceList or Contract or Invoice</SystemObject>
      <ObjectID>int</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="http://ecgridos.net/">
      <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 /v3.0/prod/ecgridos.asmx/KeyList?SessionID=string&SystemObject=string&ObjectID=string HTTP/1.1
Host: ecgridos.net

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfKeyValue xmlns="http://ecgridos.net/">
  <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 /v3.0/prod/ecgridos.asmx/KeyList HTTP/1.1
Host: ecgridos.net
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="http://ecgridos.net/">
  <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>

Parameter	Value
SessionID:
SystemObject:
ObjectID: