POST wrapper/client/delete

(SLDeleteClient) Permanently Deletes a Client Record within FinScan.

Request Information

URI Parameters

None.

Body Parameters

Wrapper Request LSTServicesDeleteClientRequest

Name	Description	Type	Additional information
organizationName	The User's Organization Name.	string	None.
userName	The User's Name.	string	None.
password	The User's Password.	string	None.
clientKey	The system generated sequential number that uniquely identifies a client, used For accessing certain Reports. If provided, the Client Key will be used to delete the Client Record.	integer	None.
applicationId	The ID for the Application where the Client should be saved/accessed. The Application ID will only be used if the Client Key is not provided or is 0.	string	None.
clientId	The ID for the Client Record. The Client ID will only be used if the Client Key is not provided or is 0.	string	None.

Request Formats

application/json, text/json

Sample:

{
  "organizationName": "sample string 1",
  "userName": "sample string 2",
  "password": "sample string 3",
  "clientKey": 4,
  "applicationId": "sample string 5",
  "clientId": "sample string 6"
}

application/xml, text/xml

Sample:

<LSTServicesDeleteClientRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LSTServicesLookup">
  <applicationId>sample string 5</applicationId>
  <clientId>sample string 6</clientId>
  <clientKey>4</clientKey>
  <organizationName>sample string 1</organizationName>
  <password>sample string 3</password>
  <userName>sample string 2</userName>
</LSTServicesDeleteClientRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Result of the Client Delete

LSTServicesDeleteClientResponse

Name	Description	Type	Additional information
status	The Current Status of the Client matches within FinScan [Pass, Pending, Fail, Error or Duplicate].	SLResultTypeEnum	None.
code	A Code Value for the Status/Message returned.	SLWrapperCodes	None.
message	String containing information on the Search status/results including Error details.	string	None.
version	The version of the Wrapper.	string	None.
clientKey	The system generated sequential number that uniquely identifies a client, used For accessing certain Reports.	integer	None.
isiReserved	A field used to return debugging information.	string	None.

Response Formats

application/json, text/json

Sample:

{
  "status": 0,
  "code": 0,
  "message": "sample string 1",
  "version": "sample string 2",
  "clientKey": 3,
  "isiReserved": "sample string 4"
}

application/xml, text/xml

Sample:

<LSTServicesDeleteClientResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LSTServicesLookup">
  <clientKey>3</clientKey>
  <code>SUCCESS</code>
  <isiReserved>sample string 4</isiReserved>
  <message>sample string 1</message>
  <status>PASS</status>
  <version>sample string 2</version>
</LSTServicesDeleteClientResponse>