DELETE Operation

The DELETE operation removes objects and their child objects. An object ID is required to use this operation. Only the main object and its ID need to be specified; child object IDs do not need to be specified.

Note: Using the DELETE operation has the same effect as deleting a record through the SmartOffice user interface. This means that certain types of records (contacts, carriers, policies and investment accounts) are moved to the Deleted Records area in SmartOffice. If your office has Protect Communication History enabled, contacts that have correspondence, documents or SmartPad? notes associated with them are archived instead of being deleted.

Example:

Request XML
<request version='1.0'>
  <header>
    <office>youroffice</office>
    <user>jdoe</user>
    <password>password</password>
  </header>
  <delete>
    <Contact id="Contact.1.28"/>
  </delete>
</request>

Response XML
<response version="1.0">
  <header>
    <sessionClosed/>
  </header>
  <delete>
    <Contact _status="deleted" _type="obj" id="Contact.1.28"/>
  </delete>
  <_status>OK</_status>
</response>



Topic revision: 03 Jun 2015, DinosLambropoulos
 

This site is powered by FoswikiCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding Foswiki? Send feedback