POST wrapper/pairs/get

(SLGetUpdatedClients) Returns the Clients with Matches that have been updated within a Date/Time period.

Request Information

URI Parameters

None.

Body Parameters

Wrapper Request LSTServicesGetUpdatedClientsRequest

LSTServicesGetUpdatedClientsRequest
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 Application ID's for the Transaction being processed. If left blank, all Applications for which the user has access will be returned.

Collection of string

None.

excludedUsers

This will exclude Clients with matches that have only been modified by the users specified. Please note that the users specified here may still appear in the results if the Client has matches that were modified by another user. If this field is populated, the includedUsers field will be ignored.

Collection of string

None.

includedUsers

This will only include Clients that have been modified by the users specified. Please note that users other than ones specified here may still appear in the results as all matches for the Client will be returned. If the excludedUsers field is populated, this field will be ignored.

Collection of string

None.

customStatus

This field will allow the Wrapper to know how to handle Custom Statuses within FinScan. If you have added one or more Custom Statuses within FinScan

Collection of SLCustomStatus

None.

elapsedTime

The amount of time in minutes you would like for previous updates to be displayed. If this field is non-zero, that value will be used.

integer

None.

lastGetTime

The start time for which you would like updates (until the current time). This field will only be used if the elapsedTime is zero.

date

None.

Request Formats

application/json, text/json

Sample:
{
  "organizationName": "sample string 1",
  "userName": "sample string 2",
  "password": "sample string 3",
  "applicationId": [
    "sample string 1",
    "sample string 2"
  ],
  "excludedUsers": [
    "sample string 1",
    "sample string 2"
  ],
  "includedUsers": [
    "sample string 1",
    "sample string 2"
  ],
  "customStatus": [
    {
      "statusString": "sample string 1",
      "status": 0
    },
    {
      "statusString": "sample string 1",
      "status": 0
    }
  ],
  "elapsedTime": 4,
  "lastGetTime": "2021-03-04T04:50:48.6915037+00:00"
}

application/xml, text/xml

Sample:
<LSTServicesGetUpdatedClientsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LSTServicesLookupREST">
  <applicationId xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </applicationId>
  <customStatus>
    <SLCustomStatus>
      <status>SAFE</status>
      <statusString>sample string 1</statusString>
    </SLCustomStatus>
    <SLCustomStatus>
      <status>SAFE</status>
      <statusString>sample string 1</statusString>
    </SLCustomStatus>
  </customStatus>
  <elapsedTime>4</elapsedTime>
  <excludedUsers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </excludedUsers>
  <includedUsers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </includedUsers>
  <lastGetTime>2021-03-04T04:50:48.6915037+00:00</lastGetTime>
  <organizationName>sample string 1</organizationName>
  <password>sample string 3</password>
  <userName>sample string 2</userName>
</LSTServicesGetUpdatedClientsRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Match information with optional Compliance List Record details

LSTServicesGetUpdatedClientsResponse
NameDescriptionTypeAdditional information
status

The Current Status of the call [Pass, Pending or Fail]. If potential matches are found, the Status returned will be Pending until all of the potential matches have been reviewed, even if one or more matches are set as a Hit.

SLResultTypeEnum

None.

message

Information on the call results including Error details.

string

None.

version

The version of the Wrapper.

string

None.

isiReserved

A field used to return debugging information.

string

None.

lastGetTime

The time the search was performed.

date

None.

clients

The Clients that have been updated within the date/time range. There is a limit of 10,000 Client records returned in one call.

Collection of SLUpdatedClient

None.

Response Formats

application/json, text/json

Sample:
{
  "status": 0,
  "message": "sample string 1",
  "version": "sample string 2",
  "isiReserved": "sample string 3",
  "lastGetTime": "2021-03-04T04:50:49.5352771+00:00",
  "clients": [
    {
      "applicationId": "sample string 1",
      "clientId": "sample string 2",
      "clientKey": 3,
      "status": 0,
      "pairs": [
        {
          "listId": "sample string 1",
          "listProfileId": "sample string 2",
          "listProfileKey": 3,
          "status": 0,
          "pairStatus": "sample string 4",
          "pairReason": "sample string 5",
          "pairComments": "sample string 6",
          "modifyDate": "2021-03-04T04:50:49.5352771+00:00",
          "modifiedByUser": "sample string 8",
          "initialUser": "sample string 9"
        },
        {
          "listId": "sample string 1",
          "listProfileId": "sample string 2",
          "listProfileKey": 3,
          "status": 0,
          "pairStatus": "sample string 4",
          "pairReason": "sample string 5",
          "pairComments": "sample string 6",
          "modifyDate": "2021-03-04T04:50:49.5352771+00:00",
          "modifiedByUser": "sample string 8",
          "initialUser": "sample string 9"
        }
      ]
    },
    {
      "applicationId": "sample string 1",
      "clientId": "sample string 2",
      "clientKey": 3,
      "status": 0,
      "pairs": [
        {
          "listId": "sample string 1",
          "listProfileId": "sample string 2",
          "listProfileKey": 3,
          "status": 0,
          "pairStatus": "sample string 4",
          "pairReason": "sample string 5",
          "pairComments": "sample string 6",
          "modifyDate": "2021-03-04T04:50:49.5352771+00:00",
          "modifiedByUser": "sample string 8",
          "initialUser": "sample string 9"
        },
        {
          "listId": "sample string 1",
          "listProfileId": "sample string 2",
          "listProfileKey": 3,
          "status": 0,
          "pairStatus": "sample string 4",
          "pairReason": "sample string 5",
          "pairComments": "sample string 6",
          "modifyDate": "2021-03-04T04:50:49.5352771+00:00",
          "modifiedByUser": "sample string 8",
          "initialUser": "sample string 9"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:
<LSTServicesGetUpdatedClientsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LSTServicesLookupREST">
  <clients>
    <SLUpdatedClient>
      <applicationId>sample string 1</applicationId>
      <clientId>sample string 2</clientId>
      <clientKey>3</clientKey>
      <pairs>
        <SLUpdatedPair>
          <initialUser>sample string 9</initialUser>
          <listId>sample string 1</listId>
          <listProfileId>sample string 2</listProfileId>
          <listProfileKey>3</listProfileKey>
          <modifiedByUser>sample string 8</modifiedByUser>
          <modifyDate>2021-03-04T04:50:49.5352771+00:00</modifyDate>
          <pairComments>sample string 6</pairComments>
          <pairReason>sample string 5</pairReason>
          <pairStatus>sample string 4</pairStatus>
          <status>PASS</status>
        </SLUpdatedPair>
        <SLUpdatedPair>
          <initialUser>sample string 9</initialUser>
          <listId>sample string 1</listId>
          <listProfileId>sample string 2</listProfileId>
          <listProfileKey>3</listProfileKey>
          <modifiedByUser>sample string 8</modifiedByUser>
          <modifyDate>2021-03-04T04:50:49.5352771+00:00</modifyDate>
          <pairComments>sample string 6</pairComments>
          <pairReason>sample string 5</pairReason>
          <pairStatus>sample string 4</pairStatus>
          <status>PASS</status>
        </SLUpdatedPair>
      </pairs>
      <status>PASS</status>
    </SLUpdatedClient>
    <SLUpdatedClient>
      <applicationId>sample string 1</applicationId>
      <clientId>sample string 2</clientId>
      <clientKey>3</clientKey>
      <pairs>
        <SLUpdatedPair>
          <initialUser>sample string 9</initialUser>
          <listId>sample string 1</listId>
          <listProfileId>sample string 2</listProfileId>
          <listProfileKey>3</listProfileKey>
          <modifiedByUser>sample string 8</modifiedByUser>
          <modifyDate>2021-03-04T04:50:49.5352771+00:00</modifyDate>
          <pairComments>sample string 6</pairComments>
          <pairReason>sample string 5</pairReason>
          <pairStatus>sample string 4</pairStatus>
          <status>PASS</status>
        </SLUpdatedPair>
        <SLUpdatedPair>
          <initialUser>sample string 9</initialUser>
          <listId>sample string 1</listId>
          <listProfileId>sample string 2</listProfileId>
          <listProfileKey>3</listProfileKey>
          <modifiedByUser>sample string 8</modifiedByUser>
          <modifyDate>2021-03-04T04:50:49.5352771+00:00</modifyDate>
          <pairComments>sample string 6</pairComments>
          <pairReason>sample string 5</pairReason>
          <pairStatus>sample string 4</pairStatus>
          <status>PASS</status>
        </SLUpdatedPair>
      </pairs>
      <status>PASS</status>
    </SLUpdatedClient>
  </clients>
  <isiReserved>sample string 3</isiReserved>
  <lastGetTime>2021-03-04T04:50:49.5352771+00:00</lastGetTime>
  <message>sample string 1</message>
  <status>PASS</status>
  <version>sample string 2</version>
</LSTServicesGetUpdatedClientsResponse>