Tuesday, July 16, 2024

Static - AVM Criteria
Action:
GET
Method:
GET
URL: /api/v1/static/adversemedia/criteria/get
Description: Fetch a Static AVM 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 AVM Criteria record.
{
 "CriteriaID": 1000,
 "Name": "Default Criteria",
 "Description": "Default - Criteria",
 "TermGroupID": 100,
 "TermGroupName": "Default Term Group",
 "SearchEngineGroupID": 500,
 "SearchEngineGroupName": "Default Search Engine Group",
 "DateRangeID": 0,
 "DateRangeName": "All",
 "CountryID": 0,
 "CountryName": "",
 "FrequencyInDays": 1,
 "SearchTermOption": 3,
}
Field Data Type
CriteriaID Int 16
Name Text 150
Description Text 255
TermGroupID Int 16
TermGroupName Text 150
SearchEngineGroupID Int 16
SearchEngineGroupName Text 150
DateRangeID Int 16
DateRangeName Text 150
CountryID Int 16
CountryName Text 150
FrequencyInDays Int 32
SearchTermOption Int 16
Action:
GET ALL
Method:
GET
URL: /api/v1/static/adversemedia/criteria/getall
Description: Fetch all Static AVM 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 AVM Criteria records.
[{
 "CriteriaID": 1000,
 "Name": "Default Criteria",
 "Description": "Default - Criteria",
 "TermGroupID": 100,
 "TermGroupName": "Default Term Group",
 "SearchEngineGroupID": 500,
 "SearchEngineGroupName": "Default Search Engine Group",
 "DateRangeID": 0,
 "DateRangeName": "All",
 "CountryID": 0,
 "CountryName": "",
 "FrequencyInDays": 1,
 "SearchTermOption": 3,
}]
Field Data Type
CriteriaID Int 16
Name Text 150
Description Text 255
TermGroupID Int 16
TermGroupName Text 150
SearchEngineGroupID Int 16
SearchEngineGroupName Text 150
DateRangeID Int 16
DateRangeName Text 150
CountryID Int 16
CountryName Text 150
FrequencyInDays Int 32
SearchTermOption Int 16
Action:
GET LINKED SE CONFIGS
Method:
GET
URL: /api/v1/static/adversemedia/criteria/getlinkedseconfigs
Description: Fetch all Linked Search Engine Configurations
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 collection of Static AVM Criteria records.
[{
 "SearchEngineID": 2000,
 "SearchEngine": 2,
 "Name": "Bing Web",
 "Description": "Bing Web",
}]
Field Data Type
SearchEngineID Int 16
SearchEngine Byte
Name Text 150
Description Text 255
Action:
GET LINKED TERM SETS
Method:
GET
URL: /api/v1/static/adversemedia/criteria/getlinkedtermsets
Description: Fetch all Linked Term Sets
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 collection of Static AVM Criteria records.
[{
 "TermsSetID": 200,
 "TermsSetName": "Default Terms Set",
 "Terms": "money laundering, terrorism, tax evasion, illegal, fraud",
}]
Field Data Type
TermsSetID Int 16
TermsSetName Text 150
Terms Text 4000
Action:
ADD
Method:
POST
URL: /api/v1/static/adversemedia/criteria/add
Description: Add a Static AVM Criteria
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 DateRangeID Int16 Date Range Identifier
Body CountryID Int16 Country Identifier
Body FrequencyInDays Int32 Frequency in Days
Body SearchTermOption Int16 Search Term Option
Body SafeSearch Boolean Safe Search
Body ActionUserID Int16 Identifier of the User performing action.
Body ReturnFormat String Json or Xml
Return Data: Json or XML of the Static AVM Criteria record added.
{
 "CriteriaID": 1003,
 "Name": "Default",
 "Description": "Default",
 "TermGroupID": 101,
 "TermGroupName": "Default Term Group",
 "SearchEngineGroupID": 501,
 "SearchEngineGroupName": "Default Search Engine Group",
 "DateRangeID": 0,
 "DateRangeName": "All",
 "CountryID": 0,
 "CountryName": "",
 "FrequencyInDays": 1,
 "SearchTermOption": 3,
 "SafeSearch": true,
}
Field Data Type
CriteriaID Int 16
Name Text 150
Description Text 255
TermGroupID Int 16
TermGroupName Text 150
SearchEngineGroupID Int 16
SearchEngineGroupName Text 150
DateRangeID Int 16
DateRangeName Text 150
CountryID Int 16
CountryName Text 150
FrequencyInDays Int 32
SearchTermOption Int 16
SafeSearch Boolean
Action:
ADD LINKED TERM SET
Method:
POST
URL: /api/v1/static/adversemedia/criteria/addlinkedtermset
Description: Add a Static AVM Criteria - Linked Term Set
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 Criteria Identifier
Body TermsSetName String Term Sets Name
Body Terms String Terms
Body ActionUserID Int16 Identifier of the User performing action.
Body ReturnFormat String Json or Xml
Return Data: Json or XML of the Static AVM Criteria Term Set record added.
{
 "TermsSetID": 203,
 "TermsSetName": "Crime",
 "Terms": "fraud, crime, illegal",
}
Field Data Type
TermsSetID Int 16
TermsSetName Text 150
Terms Text 4000
Action:
UPDATE
Method:
PUT
URL: /api/v1/static/adversemedia/criteria/update
Description: Update an existing Static AVM 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 AVM Criteria to update
Body Name String Name
Body Description String Description
Body DateRangeID Int16 Date Range Identifier
Body CountryID Int16 Country Identifier
Body FrequencyInDays Int32 Frequency in Days
Body SearchTermOption Int16 Search Term Option
Body SafeSearch Boolean Safe Search
Body ActionUserID Int16 Identifier of the User performing action.
Body ReturnFormat String Json or Xml
Return Data: Json or XML of the Static AVM Criteria record updated.
{
 "CriteriaID": 1000,
 "Name": "Default Criteria",
 "Description": "Default Criteria",
 "TermGroupID": 100,
 "TermGroupName": "Default Term Group",
 "SearchEngineGroupID": 500,
 "SearchEngineGroupName": "Default Search Engine Group",
 "DateRangeID": 0,
 "DateRangeName": "All",
 "CountryID": 0,
 "CountryName": "",
 "FrequencyInDays": 2,
 "SearchTermOption": 3,
 "SafeSearch": true,
}
Field Data Type
CriteriaID Int 16
Name Text 150
Description Text 255
TermGroupID Int 16
TermGroupName Text 150
SearchEngineGroupID Int 16
SearchEngineGroupName Text 150
DateRangeID Int 16
DateRangeName Text 150
CountryID Int 16
CountryName Text 150
FrequencyInDays Int 32
SearchTermOption Int 16
SafeSearch Boolean
Action:
UPDATE LINKED TERM SET
Method:
PUT
URL: /api/v1/static/adversemedia/criteria/updatelinkedtermset
Description: Update an existing Static AVM Criteria - Linked Term Set
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 AVM Criteria to update
Body TermsSetID Int16 Identifier of the Terms Set to update
Body TermsSetName String Terms Set Name
Body Terms String Terms
Body ActionUserID Int16 Identifier of the User performing action.
Body ReturnFormat String Json or Xml
Return Data: Json or XML of the Static AVM Criteria Linked Term Set record updated.
{
 "TermsSetID": 203,
 "TermsSetName": "Default Terms Set",
 "Terms": "illegal, financial crime",
}
Field Data Type
TermsSetID Int 16
TermsSetName Text 150
Terms Text 4000
Action:
DELETE
Method:
DELETE
URL: /api/v1/static/adversemedia/criteria/delete
Description: Delete an existing Static AVM Criteria
Type Key DataType Notes
Headers api-key String Your Api-Key
Headers Content-Type String Enter value: application/x-www-form-urlencoded
Params CriteriaID Int16 Identifier of the Static AVM Criteria to delete
Params ActionUserID Int16 Identifier of the User performing action.
Params ReturnFormat String Json or Xml
Return Data: Json or XML of the Static AVM Criteria record deleted.
{
 "CriteriaID": 1000,
 "Name": "Default Criteria",
 "Description": "Default - Criteria",
 "TermGroupID": 100,
 "TermGroupName": "Default Term Group",
 "SearchEngineGroupID": 500,
 "SearchEngineGroupName": "Default Search Engine Group",
 "DateRangeID": 0,
 "DateRangeName": "All",
 "CountryID": 0,
 "CountryName": "",
 "FrequencyInDays": 1,
 "SearchTermOption": 3,
}
Field Data Type
CriteriaID Int 16
Name Text 150
Description Text 255
TermGroupID Int 16
TermGroupName Text 150
SearchEngineGroupID Int 16
SearchEngineGroupName Text 150
DateRangeID Int 16
DateRangeName Text 150
CountryID Int 16
CountryName Text 150
FrequencyInDays Int 32
SearchTermOption Int 16
Action:
DELETE LINKED TERM SET
Method:
DELETE
URL: /api/v1/static/adversemedia/criteria/deletelinkedtermset
Description: Delete an existing Static AVM Criteria Linked Term Set
Type Key DataType Notes
Headers api-key String Your Api-Key
Headers Content-Type String Enter value: application/x-www-form-urlencoded
Params CriteriaID Int16 Identifier of the Static AVM Criteria to delete
Params TermsSetID Int16 Identifier of the Terms Set to delete
Params ActionUserID Int16 Identifier of the User performing action.
Params ReturnFormat String Json or Xml
Return Data: Json or XML of the Static AVM Criteria Linked Term Set record deleted.
{
 "TermsSetID": 203,
 "TermsSetName": "Default Terms Set",
 "Terms": "illegal, financial crime",
}
Field Data Type
TermsSetID Int 16
TermsSetName Text 150
Terms Text 4000