POST wrapper/clients/updateid

SLUpdateClientId This service will update the information for a Client Record

Request Information

URI Parameters

None.

Body Parameters

Wrapper Update Client ID Request LSTServicesUpdateClientIdRequest

LSTServicesUpdateClientIdRequest
NameDescriptionTypeAdditional 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.

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.

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/xml, text/xml

Sample:
<LSTServicesUpdateClientIdRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LSTServicesLookupREST">
  <applicationId>sample string 4</applicationId>
  <clientId>sample string 6</clientId>
  <field>
    <SLUpdateFields>
      <field>ClientStatus</field>
      <value>sample string 1</value>
    </SLUpdateFields>
    <SLUpdateFields>
      <field>ClientStatus</field>
      <value>sample string 1</value>
    </SLUpdateFields>
  </field>
  <newApplicationId>sample string 5</newApplicationId>
  <newClientId>sample string 7</newClientId>
  <organizationName>sample string 1</organizationName>
  <password>sample string 3</password>
  <userName>sample string 2</userName>
</LSTServicesUpdateClientIdRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Client Details

LSTServicesUpdateClientIdResponse
NameDescriptionTypeAdditional information
status

The Current Status of the Client matches within FinScan (Pass/Pending/Fail).

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.

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"
}

application/xml, text/xml

Sample:
<LSTServicesUpdateClientIdResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LSTServicesLookupREST">
  <applicationId>sample string 6</applicationId>
  <clientId>sample string 3</clientId>
  <clientKey>5</clientKey>
  <isiReserved>sample string 8</isiReserved>
  <message>sample string 1</message>
  <oldApplicationId>sample string 7</oldApplicationId>
  <oldClientId>sample string 4</oldClientId>
  <status>PASS</status>
  <version>sample string 2</version>
</LSTServicesUpdateClientIdResponse>