DeleteRecord

The DeleteRecord method removes the specified record from the system. When deleting a record, this method also deletes the associated subform.

Note: The DeleteRecord method does not archive records, but instead removes them from Archer.

On this page

Usage

Privileges. This method requires Delete privileges.

Parameters.

The parameters for the DeleteRecord method are described in the following table.
Parameter	Data Type	Value
sessionToken	String	Valid sessionToken returned by the general.CreateUserSession method
moduleId	Integer	Internal ID of an application as specified in the Application Builder Application Detail Report
contentId	Integer	Internal ID of a record within the specified application as returned by the search.ExecuteSearch method

Output. This method returns an integer. If the method is successful, the value is 1. If there is a failure, the API issues an exception.

Samples

Sample C# Call

iReturnCode = record.DeleteRecord(sSessionToken, 17, 234);

Sample Request

The following is a sample SOAP 1.1 request and response. The placeholders shown would be replaced with actual values. SOAP 1.2 also is supported.

POST /Archer/ws/record.asmx HTTP/1.1

Host: staging

Content-Type: text/xml; charset=utf-8

Content-Length: length

SOAPAction: "http://archer-tech.com/webservices/DeleteRecord"

<?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>

<sessionToken>string</sessionToken>

</DeleteRecord>

</soap:Body>

</soap:Envelope>

Sample Response

HTTP/1.1 200 OK