Tuesday, July 16, 2024

Client - Match Potential Summary
Action:
GET ROWS
Method:
GET
URL: /api/v1/client/matchpotentialsummary/getrows
Description: Fetch Client Match Potential Summary records based on Row information
Type Key DataType Notes
Headers api-key String Your Api-Key
Params BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 10 if not provided)
Params RowOffset Int32 Row Offset
Params RowsToFetch Int32 Rows to Fetch
Params ReturnFormat String Json or Xml
Return Data: Json or XML of Row Statistics and collection of Client Match Potential Summary records
{
 "RowsHeader": {
  "RowOffset": 0,
  "RowsFetched": 1,
  "RowStart": 1,
  "RowEnd": 1,
  "RowVolume": 3
 },
 "Data": [
  {
   "ClientEntityID": 1234,
   "ClientEntityInterfaceReference": "AB1234",
   "ClientEntityLastName": "PUTIN",
   "ClientEntityFirstName": "VLADIMIR",
   "ClientEntityMiddleName": "",
   "GeneratedDate": "2024-07-16 00:00:00",
   "Priority": 9,
   "MatchPotentialVolume": 2,
   "IsDateMatch": true,
   "IsCountryMatch": true,
   "IsPEPVolume": 1,
   "IsRCAVolume": 1,
   "IsWBLVolume": 0,
   "IsSANVolume": 0,
   "IsAVMVolume": 0,
   "IsOTHVolume": 0
   "IsUNKVolume": 0
   "HandledByUserGroupID": "203"
   "HandledByUserGroupName": "Handler Group"
   "HandledByUserID": "0"
   "HandledByUserName": ""
  }]
}
Field Data Type
RowsHeader Collection
 RowOffset Int 32
 RowsFetched Int 32
 RowStart Int 32
 RowEnd Int 32
 RowVolume Int 32
Data Collection
 ClientEntityID Int 32
 ClientEntityInterfaceReference Text 50
 ClientEntityLastName Text 255
 ClientEntityFirstName Text 255
 ClientEntityMiddleName Text 255
 GeneratedDate Date
 Priority Byte
 MatchPotentialVolume Int 32
 IsDateMatch Boolean
 IsCountryMatch Boolean
 IsPEPVolume Int 32
 IsRCAVolume Int 32
 IsWBLVolume Int 32
 IsSANVolume Int 32
 IsAVMVolume Int 32
 IsOTHVolume Int 32
 IsUNKVolume Int 32
 HandledByUserGroupID Int 16
 HandledByUserGroupName Text 150
 HandledByUserID Int 16
 HandledByUserName Text 150
Client - Match Potential Summary [Using External Reference]
Action:
GET
Method:
GET
URL: /api/v1/client/matchpotentialsummary/get
Description: Fetch Client Match Potential Summary records based on Interface Reference
Type Key DataType Notes
Headers api-key String Your Api-Key
Params BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 10 if not provided)
Params InterfaceReference String Interface Reference
Params ReturnFormat String Json or Xml
Return Data: Json or XML of the Client Match Potential Summary record
{
 "ClientEntityID": 1234,
 "ClientEntityInterfaceReference": "AB1234",
 "ClientEntityLastName": "PUTIN",
 "ClientEntityFirstName": "VLADIMIR",
 "ClientEntityMiddleName": "",
 "GeneratedDate": "2024-07-16 00:00:00",
 "Priority": 9,
 "MatchPotentialVolume": 2,
 "IsDateMatch": true,
 "IsCountryMatch": true,
 "IsPEPVolume": 1,
 "IsRCAVolume": 1,
 "IsWBLVolume": 0,
 "IsSANVolume": 0,
 "IsAVMVolume": 0,
 "IsOTHVolume": 0
 "IsUNKVolume": 0
 "HandledByUserGroupID": "203"
 "HandledByUserGroupName": "Handler Group"
 "HandledByUserID": "0"
 "HandledByUserName": ""
}
Field Data Type
ClientEntityID Int 32
ClientEntityInterfaceReference Text 50
ClientEntityLastName Text 255
ClientEntityFirstName Text 255
ClientEntityMiddleName Text 255
GeneratedDate Date
Priority Byte
MatchPotentialVolume Int 32
IsDateMatch Boolean
IsCountryMatch Boolean
IsPEPVolume Int 32
IsRCAVolume Int 32
IsWBLVolume Int 32
IsSANVolume Int 32
IsAVMVolume Int 32
IsOTHVolume Int 32
IsUNKVolume Int 32
HandledByUserGroupID Int 16
HandledByUserGroupName Text 150
HandledByUserID Int 16
HandledByUserName Text 150
Client - Match Potential Summary [Using Internal Reference]
Action:
GET INTERNAL
Method:
GET
URL: /api/v1/client/matchpotentialsummary/getinternal
Description: Fetch Client Match Potential Summary records based on Client Entity Identifier
Type Key DataType Notes
Headers api-key String Your Api-Key
Params BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 10 if not provided)
Params ClientEntityID Int32 Client Entity Identifier
Params ReturnFormat String Json or Xml
Return Data: Json or XML of the Client Match Potential Summary record
{
 "ClientEntityID": 1234,
 "ClientEntityInterfaceReference": "AB1234",
 "ClientEntityLastName": "PUTIN",
 "ClientEntityFirstName": "VLADIMIR",
 "ClientEntityMiddleName": "",
 "GeneratedDate": "2024-07-16 00:00:00",
 "Priority": 9,
 "MatchPotentialVolume": 2,
 "IsDateMatch": true,
 "IsCountryMatch": true,
 "IsPEPVolume": 1,
 "IsRCAVolume": 1,
 "IsWBLVolume": 0,
 "IsSANVolume": 0,
 "IsAVMVolume": 0,
 "IsOTHVolume": 0
 "IsUNKVolume": 0
 "HandledByUserGroupID": "203"
 "HandledByUserGroupName": "Handler Group"
 "HandledByUserID": "0"
 "HandledByUserName": ""
}
Field Data Type
ClientEntityID Int 32
ClientEntityInterfaceReference Text 50
ClientEntityLastName Text 255
ClientEntityFirstName Text 255
ClientEntityMiddleName Text 255
GeneratedDate Date
Priority Byte
MatchPotentialVolume Int 32
IsDateMatch Boolean
IsCountryMatch Boolean
IsPEPVolume Int 32
IsRCAVolume Int 32
IsWBLVolume Int 32
IsSANVolume Int 32
IsAVMVolume Int 32
IsOTHVolume Int 32
IsUNKVolume Int 32
HandledByUserGroupID Int 16
HandledByUserGroupName Text 150
HandledByUserID Int 16
HandledByUserName Text 150