KeyRemove

Back To Common API Calls

---

Remove a Persistent Key Value Attached to an Object.

  public boolean KeyRemove(string SessionID,
                           string Key,
                           Objects SystemObject,
                           int ObjectID,
                           KeyVisibility Visibility)

---

Parameters

• SessionID - String - GUID
• Key - string
• SystemObject - Objects
• ObjectID - int
• Visibility - KeyVisibility

---

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

<?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>
    <KeyRemove 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>
    </KeyRemove>
  </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>
    <KeyRemoveResponse xmlns="https://os.ecgrid.io/">
      <KeyRemoveResult>boolean</KeyRemoveResult>
    </KeyRemoveResponse>
  </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>
    <KeyRemove 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>
    </KeyRemove>
  </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>
    <KeyRemoveResponse xmlns="https://os.ecgrid.io/">
      <KeyRemoveResult>boolean</KeyRemoveResult>
    </KeyRemoveResponse>
  </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/KeyRemove?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"?>
<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/KeyRemove 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"?>
<boolean xmlns="https://os.ecgrid.io/">boolean</boolean>

---

Back To Common API Calls