| Action: | GET | |||||||||||||||||||||||||||||||||||||||||||||||||
| Method: | GET | |||||||||||||||||||||||||||||||||||||||||||||||||
| URL: | /api/v1/client/adversemedia/matchflagged/get | |||||||||||||||||||||||||||||||||||||||||||||||||
| Description: | Fetch AVM Match Flagged 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 collection of Client Match Flagged records [{ "ClientEntityID": 1234, "ClientEntityInterfaceReference": "AB1234", "ClientEntityLastName": "PUTIN", "ClientEntityFirstName": "VLADIMIR", "ClientEntityMiddleName": "", "LinkUniqueKey": "0ECB49CA06DE9F05FF8CF53D7794612588468914", "Link": "https://www.abcd.xyz/allaboutvlad", "DisplayLink": "https://www.abcd.xyz/allaboutvlad", "GeneratedDate": "2024-11-21 00:00:00", "Snippet": "This is an article all about Vladimir Putin", "SearchEngineType": 1, "MatchedDate": "2024-11-21 00:00:00", "ActionDays": 0, "Reason": "President of Russia", "MatchFlagCategoryID": 1, "MatchFlagCategoryName": "Relevant Acceptable", "WebContent": [], "ValidToDate": "2099-12-31 00:00:00", "HandledByUserGroupID": "203" "HandledByUserGroupName": "Handler Group" "HandledByUserID": "105" "HandledByUserName": "Fred Jones" }] |
|
||||||||||||||||||||||||||||||||||||||||||||||||
| Action: | GET ITEM | |||||||||||||||||||||||||||||||||||||||||||||||||
| Method: | GET | |||||||||||||||||||||||||||||||||||||||||||||||||
| URL: | /api/v1/client/adversemedia/matchflagged/getitem | |||||||||||||||||||||||||||||||||||||||||||||||||
| Description: | Fetch AVM Match Flagged record based on Interface Reference and Link Unique Key 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 | InterfaceReference | String | Interface Reference | |||||||||||||||||||||||||||||||||||||||||||||||
| Params | LinkUniqueKey | String | Link Unique Key Identifier | |||||||||||||||||||||||||||||||||||||||||||||||
| Params | ReturnFormat | String | Json or Xml | |||||||||||||||||||||||||||||||||||||||||||||||
| Return Data: |
Json or XML of the Client AVM Match Flagged record { "ClientEntityID": 1234, "ClientEntityInterfaceReference": "AB1234", "ClientEntityLastName": "PUTIN", "ClientEntityFirstName": "VLADIMIR", "ClientEntityMiddleName": "", "LinkUniqueKey": "0ECB49CA06DE9F05FF8CF53D7794612588468914", "Link": "https://www.abcd.xyz/allaboutvlad", "DisplayLink": "https://www.abcd.xyz/allaboutvlad", "GeneratedDate": "2024-11-21 00:00:00", "Snippet": "This is an article all about Vladimir Putin", "SearchEngineType": 1, "MatchedDate": "2024-11-21 00:00:00", "ActionDays": 0, "Reason": "President of Russia", "MatchFlagCategoryID": 1, "MatchFlagCategoryName": "Relevant Acceptable", "WebContent": [], "ValidToDate": "2099-12-31 00:00:00", "HandledByUserGroupID": "203" "HandledByUserGroupName": "Handler Group" "HandledByUserID": "105" "HandledByUserName": "Fred Jones" } |
|
||||||||||||||||||||||||||||||||||||||||||||||||
| Action: | DELETE | |||||||||||||||||||||||||||||||||||||||||||||||||
| Method: | DELETE | |||||||||||||||||||||||||||||||||||||||||||||||||
| URL: | /api/v1/client/adversemedia/matchflagged/delete | |||||||||||||||||||||||||||||||||||||||||||||||||
| Description: | Delete a Client AVM Match Flagged record based on Interface Reference | |||||||||||||||||||||||||||||||||||||||||||||||||
| Type | Key | DataType | Notes | |||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Headers | api-key | String | Your Api-Key | |||||||||||||||||||||||||||||||||||||||||||||||
| Headers | Content-Type | String | Enter value: application/x-www-form-urlencoded | |||||||||||||||||||||||||||||||||||||||||||||||
| Body | BusinessUnitID | Int32 | Business Unit Identifier (optional - value defaulted to 10 if not provided) | |||||||||||||||||||||||||||||||||||||||||||||||
| Body | InterfaceReference | String | Interface Reference | |||||||||||||||||||||||||||||||||||||||||||||||
| Body | LinkUniqueKey | String | Link Unique Key Identifier | |||||||||||||||||||||||||||||||||||||||||||||||
| Body | ActionUserID | Int16 | Identifier of the User performing action. | |||||||||||||||||||||||||||||||||||||||||||||||
| Body | ReturnFormat | String | Json or Xml | |||||||||||||||||||||||||||||||||||||||||||||||
| Return Data: |
Json or XML of the Client AVM Match Flagged record deleted. { "ClientEntityID": 1234, "ClientEntityInterfaceReference": "AB1234", "ClientEntityLastName": "PUTIN", "ClientEntityFirstName": "VLADIMIR", "ClientEntityMiddleName": "", "LinkUniqueKey": "0ECB49CA06DE9F05FF8CF53D7794612588468914", "Link": "https://www.abcd.xyz/allaboutvlad", "DisplayLink": "https://www.abcd.xyz/allaboutvlad", "GeneratedDate": "2024-11-21 00:00:00", "Snippet": "This is an article all about Vladimir Putin", "SearchEngineType": 1, "MatchedDate": "2024-11-21 00:00:00", "ActionDays": 0, "Reason": "President of Russia", "MatchFlagCategoryID": 1, "MatchFlagCategoryName": "Relevant Acceptable", "WebContent": [], "ValidToDate": "2099-12-31 00:00:00", "HandledByUserGroupID": "203" "HandledByUserGroupName": "Handler Group" "HandledByUserID": "105" "HandledByUserName": "Fred Jones" } |
|
||||||||||||||||||||||||||||||||||||||||||||||||
| Action: | UPDATE | |||||||||||||||||||||||||||||||||||||||||||||||||
| Method: | PUT | |||||||||||||||||||||||||||||||||||||||||||||||||
| URL: | /api/v1/client/adversemedia/matchflagged/update | |||||||||||||||||||||||||||||||||||||||||||||||||
| Description: | Update a Client AVM Match Flagged record based on Interface Reference and Link Unique Key | |||||||||||||||||||||||||||||||||||||||||||||||||
| Type | Key | DataType | Notes | |||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Headers | api-key | String | Your Api-Key | |||||||||||||||||||||||||||||||||||||||||||||||
| Headers | Content-Type | String | Enter value: application/x-www-form-urlencoded | |||||||||||||||||||||||||||||||||||||||||||||||
| Params | BusinessUnitID | Int32 | Business Unit Identifier (optional - value defaulted to 10 if not provided) | |||||||||||||||||||||||||||||||||||||||||||||||
| Params | InterfaceReference | String | Interface Reference | |||||||||||||||||||||||||||||||||||||||||||||||
| Params | LinkUniqueKey | String | Link Unique Key Identifier | |||||||||||||||||||||||||||||||||||||||||||||||
| Params | ReturnFormat | String | Json or Xml | |||||||||||||||||||||||||||||||||||||||||||||||
| Body | Reason | String | Reason | |||||||||||||||||||||||||||||||||||||||||||||||
| Body | MatchFlagCategoryID | Int16 | Match Flag Category Identifier | |||||||||||||||||||||||||||||||||||||||||||||||
| Body | ValidToDate | Date | Valid to Date yyyy-mm-dd | |||||||||||||||||||||||||||||||||||||||||||||||
| Body | ActionUserID | Int16 | Identifier of the User performing action. | |||||||||||||||||||||||||||||||||||||||||||||||
| Return Data: |
Json or XML of the Client AVM Match Flagged record you have updated. { "ClientEntityID": 1234, "ClientEntityInterfaceReference": "AB1234", "ClientEntityLastName": "PUTIN", "ClientEntityFirstName": "VLADIMIR", "ClientEntityMiddleName": "", "LinkUniqueKey": "0ECB49CA06DE9F05FF8CF53D7794612588468914", "Link": "https://www.abcd.xyz/allaboutvlad", "DisplayLink": "https://www.abcd.xyz/allaboutvlad", "GeneratedDate": "2024-11-21 00:00:00", "Snippet": "This is an article all about Vladimir Putin", "SearchEngineType": 1, "MatchedDate": "2024-11-21 00:00:00", "ActionDays": 0, "Reason": "President of Russia", "MatchFlagCategoryID": 1, "MatchFlagCategoryName": "Relevant Acceptable", "WebContent": [], "ValidToDate": "2099-12-31 00:00:00", "HandledByUserGroupID": "203" "HandledByUserGroupName": "Handler Group" "HandledByUserID": "105" "HandledByUserName": "Fred Jones" } |
|
||||||||||||||||||||||||||||||||||||||||||||||||
| Action: | GET INTERNAL | |||||||||||||||||||||||||||||||||||||||||||||||||
| Method: | GET | |||||||||||||||||||||||||||||||||||||||||||||||||
| URL: | /api/v1/client/adversemedia/matchflagged/getinternal | |||||||||||||||||||||||||||||||||||||||||||||||||
| Description: | Fetch AVM Match Flagged 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 collection of Client AVM Match Flagged records [{ "ClientEntityID": 1234, "ClientEntityInterfaceReference": "AB1234", "ClientEntityLastName": "PUTIN", "ClientEntityFirstName": "VLADIMIR", "ClientEntityMiddleName": "", "LinkUniqueKey": "0ECB49CA06DE9F05FF8CF53D7794612588468914", "Link": "https://www.abcd.xyz/allaboutvlad", "DisplayLink": "https://www.abcd.xyz/allaboutvlad", "GeneratedDate": "2024-11-21 00:00:00", "Snippet": "This is an article all about Vladimir Putin", "SearchEngineType": 1, "MatchedDate": "2024-11-21 00:00:00", "ActionDays": 0, "Reason": "President of Russia", "MatchFlagCategoryID": 1, "MatchFlagCategoryName": "Relevant Acceptable", "WebContent": [], "ValidToDate": "2099-12-31 00:00:00", "HandledByUserGroupID": "203" "HandledByUserGroupName": "Handler Group" "HandledByUserID": "105" "HandledByUserName": "Fred Jones" }] |
|
||||||||||||||||||||||||||||||||||||||||||||||||
| Action: | GET ITEM INTERNAL | |||||||||||||||||||||||||||||||||||||||||||||||||
| Method: | GET | |||||||||||||||||||||||||||||||||||||||||||||||||
| URL: | /api/v1/client/adversemedia/matchflagged/getiteminternal | |||||||||||||||||||||||||||||||||||||||||||||||||
| Description: | Fetch AVM Match Flagged records based on Client Entity and Link Unique Key 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 | LinkUniqueKey | String | Link Unique Key Identifier | |||||||||||||||||||||||||||||||||||||||||||||||
| Params | ReturnFormat | String | Json or Xml | |||||||||||||||||||||||||||||||||||||||||||||||
| Return Data: |
Json or XML Client AVM Match Flagged record { "ClientEntityID": 1234, "ClientEntityInterfaceReference": "AB1234", "ClientEntityLastName": "PUTIN", "ClientEntityFirstName": "VLADIMIR", "ClientEntityMiddleName": "", "LinkUniqueKey": "0ECB49CA06DE9F05FF8CF53D7794612588468914", "Link": "https://www.abcd.xyz/allaboutvlad", "DisplayLink": "https://www.abcd.xyz/allaboutvlad", "GeneratedDate": "2024-11-21 00:00:00", "Snippet": "This is an article all about Vladimir Putin", "SearchEngineType": 1, "MatchedDate": "2024-11-21 00:00:00", "ActionDays": 0, "Reason": "President of Russia", "MatchFlagCategoryID": 1, "MatchFlagCategoryName": "Relevant Acceptable", "WebContent": [], "ValidToDate": "2099-12-31 00:00:00", "HandledByUserGroupID": "203" "HandledByUserGroupName": "Handler Group" "HandledByUserID": "105" "HandledByUserName": "Fred Jones" } |
|
||||||||||||||||||||||||||||||||||||||||||||||||
| Action: | DELETE INTERNAL | |||||||||||||||||||||||||||||||||||||||||||||||||
| Method: | DELETE | |||||||||||||||||||||||||||||||||||||||||||||||||
| URL: | /api/v1/client/adversemedia/matchflagged/deleteinternal | |||||||||||||||||||||||||||||||||||||||||||||||||
| Description: | Delete a Client AVM Match Flagged record based on Client Entity and Link Unique Key Identifier | |||||||||||||||||||||||||||||||||||||||||||||||||
| Type | Key | DataType | Notes | |||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Headers | api-key | String | Your Api-Key | |||||||||||||||||||||||||||||||||||||||||||||||
| Headers | Content-Type | String | Enter value: application/x-www-form-urlencoded | |||||||||||||||||||||||||||||||||||||||||||||||
| Body | BusinessUnitID | Int32 | Business Unit Identifier (optional - value defaulted to 10 if not provided) | |||||||||||||||||||||||||||||||||||||||||||||||
| Body | ClientEntityID | Int32 | Client Entity Identifier | |||||||||||||||||||||||||||||||||||||||||||||||
| Body | LinkUniqueKey | String | Link Unique Key Identifier | |||||||||||||||||||||||||||||||||||||||||||||||
| Body | ActionUserID | Int16 | Identifier of the User performing action. | |||||||||||||||||||||||||||||||||||||||||||||||
| Body | ReturnFormat | String | Json or Xml | |||||||||||||||||||||||||||||||||||||||||||||||
| Return Data: |
Json or XML of the Client AVM Match Flagged record deleted. { "ClientEntityID": 1234, "ClientEntityInterfaceReference": "AB1234", "ClientEntityLastName": "PUTIN", "ClientEntityFirstName": "VLADIMIR", "ClientEntityMiddleName": "", "LinkUniqueKey": "0ECB49CA06DE9F05FF8CF53D7794612588468914", "Link": "https://www.abcd.xyz/allaboutvlad", "DisplayLink": "https://www.abcd.xyz/allaboutvlad", "GeneratedDate": "2024-11-21 00:00:00", "Snippet": "This is an article all about Vladimir Putin", "SearchEngineType": 1, "MatchedDate": "2024-11-21 00:00:00", "ActionDays": 0, "Reason": "President of Russia", "MatchFlagCategoryID": 1, "MatchFlagCategoryName": "Relevant Acceptable", "WebContent": [], "ValidToDate": "2099-12-31 00:00:00", "HandledByUserGroupID": "203" "HandledByUserGroupName": "Handler Group" "HandledByUserID": "105" "HandledByUserName": "Fred Jones" } |
|
||||||||||||||||||||||||||||||||||||||||||||||||
| Action: | UPDATE INTERNAL | |||||||||||||||||||||||||||||||||||||||||||||||||
| Method: | PUT | |||||||||||||||||||||||||||||||||||||||||||||||||
| URL: | /api/v1/client/adversemedia/matchflagged/updateinternal | |||||||||||||||||||||||||||||||||||||||||||||||||
| Description: | Update a Client AVM Match Flagged record based on Client Entity and Link Unique Key Identifier | |||||||||||||||||||||||||||||||||||||||||||||||||
| Type | Key | DataType | Notes | |||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Headers | api-key | String | Your Api-Key | |||||||||||||||||||||||||||||||||||||||||||||||
| Headers | Content-Type | String | Enter value: application/x-www-form-urlencoded | |||||||||||||||||||||||||||||||||||||||||||||||
| Params | BusinessUnitID | Int32 | Business Unit Identifier (optional - value defaulted to 10 if not provided) | |||||||||||||||||||||||||||||||||||||||||||||||
| Params | ClientEntityID | Int32 | Client Entity Identifier | |||||||||||||||||||||||||||||||||||||||||||||||
| Params | LinkUniqueKey | String | Link Unique Key Identifier | |||||||||||||||||||||||||||||||||||||||||||||||
| Params | ReturnFormat | String | Json or Xml | |||||||||||||||||||||||||||||||||||||||||||||||
| Body | Reason | String | Reason | |||||||||||||||||||||||||||||||||||||||||||||||
| Body | MatchFlagCategoryID | Int16 | Match Flag Category Identifier | |||||||||||||||||||||||||||||||||||||||||||||||
| Body | ValidToDate | Date | Valid to Date yyyy-mm-dd | |||||||||||||||||||||||||||||||||||||||||||||||
| Body | ActionUserID | Int16 | Identifier of the User performing action. | |||||||||||||||||||||||||||||||||||||||||||||||
| Return Data: |
Json or XML of the Client AVM Match Flagged record you have updated. { "ClientEntityID": 1234, "ClientEntityInterfaceReference": "AB1234", "ClientEntityLastName": "PUTIN", "ClientEntityFirstName": "VLADIMIR", "ClientEntityMiddleName": "", "LinkUniqueKey": "0ECB49CA06DE9F05FF8CF53D7794612588468914", "Link": "https://www.abcd.xyz/allaboutvlad", "DisplayLink": "https://www.abcd.xyz/allaboutvlad", "GeneratedDate": "2024-11-21 00:00:00", "Snippet": "This is an article all about Vladimir Putin", "SearchEngineType": 1, "MatchedDate": "2024-11-21 00:00:00", "ActionDays": 0, "Reason": "President of Russia", "MatchFlagCategoryID": 1, "MatchFlagCategoryName": "Relevant Acceptable", "WebContent": [], "ValidToDate": "2099-12-31 00:00:00", "HandledByUserGroupID": "203" "HandledByUserGroupName": "Handler Group" "HandledByUserID": "105" "HandledByUserName": "Fred Jones" } |
|
||||||||||||||||||||||||||||||||||||||||||||||||