POST wrapper/clients/updateid

(SLUpdateClientId) Update the information for a Client Record

Request Information

URI Parameters

None.

Body Parameters

Wrapper Update Client ID Request LSTServicesUpdateClientIdRequest

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.
applicationId	The ID for the Application where the Client should be saved/accessed (Required).	string	None.
newApplicationId	Populate this field if you wish to change the Client Record's Application ID.	string	None.
clientId	The unique and permanent ID for the Client Record. The Client ID is used by FinScan to uniquely identify a Client record within an Application.	string	None.
newClientId	Populate this field if you wish to change the unique and permanent ID for the Client Record.	string	None.
field	An array of fields to be updated within the Client Record.	Collection of SLUpdateFields	None.

Request Formats

application/json, text/json

Sample:

{
  "organizationName": "sample string 1",
  "userName": "sample string 2",
  "password": "sample string 3",
  "applicationId": "sample string 4",
  "newApplicationId": "sample string 5",
  "clientId": "sample string 6",
  "newClientId": "sample string 7",
  "field": [
    {
      "field": 0,
      "value": "sample string 1"
    },
    {
      "field": 0,
      "value": "sample string 1"
    }
  ]
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Client Details

LSTServicesUpdateClientIdResponse

Name	Description	Type	Additional information
status	The Current Status of the Client matches within FinScan [Pass, Pending, Fail, Error or Duplicate].	SLResultTypeEnum	None.
message	String containing information on the Search status/results including Error details.	string	None.
version	The version of the Wrapper.	string	None.
clientId	The unique and permanent ID for the Client Record. The Client ID is used by FinScan to uniquely identify a Client record within an Application.	string	None.
oldClientId	The previous unique and permanent ID for the Client Record (before update).	string	None.
clientKey	The unique Key within FinScan, used for accessing certain Reports.	integer	None.
applicationId	The ID for the Application where the Client should be saved/accessed.	string	None.
oldApplicationId	The previous permanent ID for the Client Record.	string	None.
isiReserved	A field used to return debugging information.	string	None.

Response Formats

application/json, text/json

Sample:

{
  "status": 0,
  "message": "sample string 1",
  "version": "sample string 2",
  "clientId": "sample string 3",
  "oldClientId": "sample string 4",
  "clientKey": 5,
  "applicationId": "sample string 6",
  "oldApplicationId": "sample string 7",
  "isiReserved": "sample string 8"
}