Action: | GET | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Method: | GET | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
URL: | /api/v1/static/criteria/get | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Description: | Fetch a Static Criteria record based on Identifier | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Key | DataType | Notes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Headers | api-key | String | Your Api-Key | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Params | CriteriaID | Int16 | Criteria Identifier | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Params | ReturnFormat | String | Json or Xml | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Return Data: |
Json or XML of the Static Criteria record. { "CriteriaID": 1, "Name": "Default - Person", "Description": "Default - Person", "LastNameBias": 0.95, "FirstNameBias": 0.9, "MiddleNameBias": 0.6, "EntityTypeID": 1, "EntityTypeName": "Person", "ReverseSearch": false, "Constrained": false, "IsPEP": true, "IsRCA": true, "IsWBL": true, "IsSAN": true, "IsAVM": false, "IsOTH": true, "IsUNK": true, "BumpDateExactMatch": 30, "BumpDateMonthYearMatch": 20, "BumpDateYearMatch": 10, "BumpDateMonthMatch": 5, "BumpCountryMatch": 20, "IncludeEmptyMiddleNames": true, "ExcludeDatesExceptExactMatch": false, "ExcludeMatchesOutsideYearRange": 10, "ExcludeMatchesCountryNoMatch": true "ExcludeCountryNoMatchIncludePEP": true "ExcludeCountryNoMatchIncludeSAN": false "ExcludeCountryNoMatchIncludeWBL": true } |
|
Action: | GET ALL | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Method: | GET | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
URL: | /api/v1/static/criteria/getall | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Description: | Fetch all Static Criteria records | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Key | DataType | Notes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Headers | api-key | String | Your Api-Key | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Params | ReturnFormat | String | Json or Xml | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Return Data: |
Json or XML collection of Static Criteria records. [{ "CriteriaID": 1, "Name": "Hello", "Description": "Hello", "LastNameBias": 0.95, "FirstNameBias": 0.9, "MiddleNameBias": 0.6, "EntityTypeID": 1, "EntityTypeName": "Person", "ReverseSearch": false, "Constrained": true, "IsPEP": true, "IsRCA": true, "IsWBL": true, "IsSAN": true, "IsAVM": false, "IsOTH": true, "IsUNK": true, "BumpDateExactMatch": 30, "BumpDateMonthYearMatch": 20, "BumpDateYearMatch": 10, "BumpDateMonthMatch": 5, "BumpCountryMatch": 20, "IncludeEmptyMiddleNames": true, "ExcludeDatesExceptExactMatch": false, "ExcludeMatchesOutsideYearRange": 10, "ExcludeMatchesCountryNoMatch": true "ExcludeCountryNoMatchIncludePEP": true "ExcludeCountryNoMatchIncludeSAN": false "ExcludeCountryNoMatchIncludeWBL": true }] |
|
Action: | ADD | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Method: | POST | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
URL: | /api/v1/static/criteria/add | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Description: | Add a Static Criteria and link to Client | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Key | DataType | Notes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Headers | api-key | String | Your Api-Key | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Headers | Content-Type | String | Enter value: application/x-www-form-urlencoded | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Name | String | Name | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Description | String | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | LastNameBias | Int16 | Last Name Bias [Values between 0.75 and 1.0] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | FirstNameBias | Int16 | First Name Bias [Values between 0.0 and 1.0] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | MiddleNameBias | Int16 | Middle Name Bias [Values between 0.0 and 1.0] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | EntityTypeID | Int16 | Entity Type Identifier | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | EntityTypeName | String | Entity Type Name | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ReverseSearch | Boolean | Reverse Search? | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | UnconstrainedSearch | Boolean | Unconstrained Search? | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | IsPEP | Boolean | Is PEP? | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | IsRCA | Boolean | Is RCA? | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | IsWBL | Boolean | Is WBL? | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | IsSAN | Boolean | Is SAN? | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | IsAVM | Boolean | Is AVM? | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | IsOTH | Boolean | Is OTH? | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | IsUNK | Boolean | Is UNK? | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | BumpDateExactMatch | Byte | Bump Value Date Of Birth Exact Match | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | BumpDateMonthYearMatch | Byte | Bump Value Date Of Birth Month Year | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | BumpDateYearMatch | Byte | Bump Value Date Of Birth Year | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | BumpDateMonthMatch | Byte | Bump Value Date Of Birth Month | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | BumpCountryMatch | Byte | Bump Value Country | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | IncludeEmptyMiddleNames | Boolean | Include Empty Middle Names? | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ExcludeDatesExceptExactMatch | Boolean | Exclude All Dates Except Exact Match? | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ExcludeMatchesOutsideYearRange | Boolean | Exclude Matches Outside Year Range? | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ExcludeMatchesCountryNoMatch | Boolean | Exclude Matches Country No Match? | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ExcludeCountryNoMatchIncludePEP | Boolean | Exclude Country No Match Include PEP? | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ExcludeCountryNoMatchIncludeSAN | Boolean | Exclude Country No Match Include SAN? | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ExcludeCountryNoMatchIncludeWBL | Boolean | Exclude Country No Match Include WBL? | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ActionUserID | Int16 | Identifier of the User performing action. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ReturnFormat | String | Json or Xml | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Return Data: |
Json or XML of the Static Criteria record added. { "CriteriaID": 1, "Name": "Default - Person", "Description": "Default - Person", "LastNameBias": 0.95, "FirstNameBias": 0.9, "MiddleNameBias": 0.6, "EntityTypeID": 1, "EntityTypeName": "Person", "ReverseSearch": false, "Constrained": false, "IsPEP": true, "IsRCA": true, "IsWBL": true, "IsSAN": true, "IsAVM": false, "IsOTH": true, "IsUNK": true, "BumpDateExactMatch": 30, "BumpDateMonthYearMatch": 20, "BumpDateYearMatch": 10, "BumpDateMonthMatch": 5, "BumpCountryMatch": 20, "IncludeEmptyMiddleNames": true, "ExcludeDatesExceptExactMatch": false, "ExcludeMatchesOutsideYearRange": 10, "ExcludeMatchesCountryNoMatch": true "ExcludeCountryNoMatchIncludePEP": true "ExcludeCountryNoMatchIncludeSAN": false "ExcludeCountryNoMatchIncludeWBL": true } |
|
Action: | UPDATE | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Method: | PUT | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
URL: | /api/v1/static/criteria/update | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Description: | Update an existing Static Criteria | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Key | DataType | Notes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Headers | api-key | String | Your Api-Key | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Headers | Content-Type | String | Enter value: application/x-www-form-urlencoded | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | CriteriaID | Int16 | Identifier of the Static Criteria to update | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Name | String | Name | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Description | String | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | LastNameBias | Int16 | Last Name Bias [Values between 0.75 and 1.0] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | FirstNameBias | Int16 | First Name Bias [Values between 0.0 and 1.0] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | MiddleNameBias | Int16 | Middle Name Bias [Values between 0.0 and 1.0] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | EntityTypeID | Int16 | Entity Type Identifier | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | EntityTypeName | String | Entity Type Name | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ReverseSearch | Boolean | Reverse Search? | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | UnconstrainedSearch | Boolean | Unconstrained Search? | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | IsPEP | Boolean | Is PEP? | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | IsRCA | Boolean | Is RCA? | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | IsWBL | Boolean | Is WBL? | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | IsSAN | Boolean | Is SAN? | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | IsAVM | Boolean | Is AVM? | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | IsOTH | Boolean | Is OTH? | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | IsUNK | Boolean | Is UNK? | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | BumpDateExactMatch | Byte | Bump Value Date Of Birth Exact Match | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | BumpDateMonthYearMatch | Byte | Bump Value Date Of Birth Month Year | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | BumpDateYearMatch | Byte | Bump Value Date Of Birth Year | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | BumpDateMonthMatch | Byte | Bump Value Date Of Birth Month | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | BumpCountryMatch | Byte | Bump Value Country | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | IncludeEmptyMiddleNames | Boolean | Include Empty Middle Names? | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ExcludeDatesExceptExactMatch | Boolean | Exclude All Dates Except Exact Match? | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ExcludeMatchesOutsideYearRange | Boolean | Exclude Matches Outside Year Range? | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ExcludeMatchesCountryNoMatch | Boolean | Exclude Matches Country No Match? | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ExcludeCountryNoMatchIncludePEP | Boolean | Exclude Country No Match Include PEP? | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ExcludeCountryNoMatchIncludeSAN | Boolean | Exclude Country No Match Include SAN? | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ExcludeCountryNoMatchIncludeWBL | Boolean | Exclude Country No Match Include WBL? | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ActionUserID | Int16 | Identifier of the User performing action. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ReturnFormat | String | Json or Xml | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Return Data: |
Json or XML of the Static Criteria record updated. { "CriteriaID": 1, "Name": "Default - Person", "Description": "Default - Person", "LastNameBias": 0.95, "FirstNameBias": 0.9, "MiddleNameBias": 0.6, "EntityTypeID": 1, "EntityTypeName": "Person", "ReverseSearch": false, "Constrained": false, "IsPEP": true, "IsRCA": true, "IsWBL": true, "IsSAN": true, "IsAVM": false, "IsOTH": true, "IsUNK": true, "BumpDateExactMatch": 30, "BumpDateMonthYearMatch": 20, "BumpDateYearMatch": 10, "BumpDateMonthMatch": 5, "BumpCountryMatch": 20, "IncludeEmptyMiddleNames": true, "ExcludeDatesExceptExactMatch": false, "ExcludeMatchesOutsideYearRange": 10, "ExcludeMatchesCountryNoMatch": true "ExcludeCountryNoMatchIncludePEP": true "ExcludeCountryNoMatchIncludeSAN": false "ExcludeCountryNoMatchIncludeWBL": true } |
|
Action: | DELETE | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Method: | DELETE | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
URL: | /api/v1/static/criteria/delete | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Description: | Delete an existing Static Criteria link with Client and also the Static Criteria if not linked to any other clients | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Key | DataType | Notes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Headers | api-key | String | Your Api-Key | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Headers | Content-Type | String | Enter value: application/x-www-form-urlencoded | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | CriteriaID | Int16 | Identifier of the Static Criteria to delete | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ActionUserID | Int16 | Identifier of the User performing action. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ReturnFormat | String | Json or Xml | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Return Data: |
Json or XML of the Static Criteria record deleted. { "CriteriaID": 1, "Name": "Default - Person", "Description": "Default - Person", "LastNameBias": 0.95, "FirstNameBias": 0.9, "MiddleNameBias": 0.6, "EntityTypeID": 1, "EntityTypeName": "Person", "ReverseSearch": false, "Constrained": false, "IsPEP": true, "IsRCA": true, "IsWBL": true, "IsSAN": true, "IsAVM": false, "IsOTH": true, "IsUNK": true, "BumpDateExactMatch": 30, "BumpDateMonthYearMatch": 20, "BumpDateYearMatch": 10, "BumpDateMonthMatch": 5, "BumpCountryMatch": 20, "IncludeEmptyMiddleNames": true, "ExcludeDatesExceptExactMatch": false, "ExcludeMatchesOutsideYearRange": 10, "ExcludeMatchesCountryNoMatch": true "ExcludeCountryNoMatchIncludePEP": true "ExcludeCountryNoMatchIncludeSAN": false "ExcludeCountryNoMatchIncludeWBL": true } |
|