| 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-05-20 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": "" }] } |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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-05-20 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": "" } |
|
||||||||||||||||||||||||||||||||||||||||||||||
| 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-05-20 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": "" } |
|
||||||||||||||||||||||||||||||||||||||||||||||