KeySet - LorenData/ECGrid-API GitHub Wiki

Back To Common API Calls

Set a Persistent Key Value Attached to an Object.

  public boolean KeySet(string SessionID,
                        string Key,
                        Objects SystemObject,
                        long ObjectID,
                        KeyVisibility Visibility,
                        string Value,
                        string Meta,
                        int DaysToLive)

Parameters

Returns

boolean

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

<?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>
    <KeySet 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>long</ObjectID>
      <Visibility>Private or Shared or Public or Session</Visibility>
      <Value>string</Value>
      <Meta>string</Meta>
      <DaysToLive>int</DaysToLive>
    </KeySet>
  </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>
    <KeySetResponse xmlns="https://os.ecgrid.io/">
      <KeySetResult>boolean</KeySetResult>
    </KeySetResponse>
  </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>
    <KeySet 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>long</ObjectID>
      <Visibility>Private or Shared or Public or Session</Visibility>
      <Value>string</Value>
      <Meta>string</Meta>
      <DaysToLive>int</DaysToLive>
    </KeySet>
  </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>
    <KeySetResponse xmlns="https://os.ecgrid.io/">
      <KeySetResult>boolean</KeySetResult>
    </KeySetResponse>
  </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/KeySet?SessionID=string&Key=string&SystemObject=string&ObjectID=string&Visibility=string&Value=string&Meta=string&DaysToLive=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"?>
<boolean xmlns="https://os.ecgrid.io/">boolean</boolean>

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/KeySet 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&Value=string&Meta=string&DaysToLive=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<boolean xmlns="https://os.ecgrid.io/">boolean</boolean>

Back To Common API Calls

⚠️ **GitHub.com Fallback** ⚠️