Monday, November 04, 2024

Client - AVM Match Discounted [Using External Reference]
Action:
GET
Method:
GET
URL: /api/v1/client/adversemedia/matchdiscounted/get
Description: Fetch AVM Match Discounted 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 AVM Match Discounted 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-04 00:00:00",
 "Snippet": "This is an article all about Vladimir Putin",
 "SearchEngineType": 1,
 "MatchedDate": "2024-11-04 00:00:00",
 "ActionDays": 0,
 "Reason": "President of Russia",
 "MatchDiscountCategoryID": 3,
 "MatchDiscountCategoryName": "Other",
 "WebContent": [],
 "ValidToDate": "2099-12-31 00:00:00",
 "HandledByUserGroupID": "203"
 "HandledByUserGroupName": "Handler Group"
 "HandledByUserID": "105"
 "HandledByUserName": "Fred Jones"
}]
Field Data Type
ClientEntityID Int 32
ClientEntityInterfaceReference Text 50
ClientEntityLastName Text 255
ClientEntityFirstName Text 255
ClientEntityMiddleName Text 255
LinkUniqueKey Text 100
Link Text 1000
DisplayLink Text 1000
GeneratedDate Date
Snippet Text 1000
SearchEngineType Byte
MatchedDate Date
ActionDays Int 16
Reason Text 255
MatchDiscountCategoryID Int 16
MatchDiscountCategoryName Text 150
WebContent byte []
ValidToDate Date
HandledByUserGroupID Int 16
HandledByUserGroupName Text 150
HandledByUserID Int 16
HandledByUserName Text 150
Action:
GET ITEM
Method:
GET
URL: /api/v1/client/adversemedia/matchdiscounted/getitem
Description: Fetch AVM Match Discounted records 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 Discounted 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-04 00:00:00",
 "Snippet": "This is an article all about Vladimir Putin",
 "SearchEngineType": 1,
 "MatchedDate": "2024-11-04 00:00:00",
 "ActionDays": 0,
 "Reason": "President of Russia",
 "MatchDiscountCategoryID": 3,
 "MatchDiscountCategoryName": "Other",
 "WebContent": [],
 "ValidToDate": "2099-12-31 00:00:00",
 "HandledByUserGroupID": "203"
 "HandledByUserGroupName": "Handler Group"
 "HandledByUserID": "105"
 "HandledByUserName": "Fred Jones"
}
Field Data Type
ClientEntityID Int 32
ClientEntityInterfaceReference Text 50
ClientEntityLastName Text 255
ClientEntityFirstName Text 255
ClientEntityMiddleName Text 255
LinkUniqueKey Text 100
Link Text 1000
DisplayLink Text 1000
GeneratedDate Date
Snippet Text 1000
SearchEngineType Byte
MatchedDate Date
ActionDays Int 16
Reason Text 255
MatchDiscountCategoryID Int 16
MatchDiscountCategoryName Text 150
WebContent byte []
ValidToDate Date
HandledByUserGroupID Int 16
HandledByUserGroupName Text 150
HandledByUserID Int 16
HandledByUserName Text 150
Action:
DELETE
Method:
DELETE
URL: /api/v1/client/adversemedia/matchdiscounted/delete
Description: Delete a Client AVM Match Discounted 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
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 Discounted 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-04 00:00:00",
 "Snippet": "This is an article all about Vladimir Putin",
 "SearchEngineType": 1,
 "MatchedDate": "2024-11-04 00:00:00",
 "ActionDays": 0,
 "Reason": "President of Russia",
 "MatchDiscountCategoryID": 3,
 "MatchDiscountCategoryName": "Other",
 "WebContent": [],
 "ValidToDate": "2099-12-31 00:00:00",
 "HandledByUserGroupID": "203"
 "HandledByUserGroupName": "Handler Group"
 "HandledByUserID": "105"
 "HandledByUserName": "Fred Jones"
}
Field Data Type
ClientEntityID Int 32
ClientEntityInterfaceReference Text 50
ClientEntityLastName Text 255
ClientEntityFirstName Text 255
ClientEntityMiddleName Text 255
LinkUniqueKey Text 100
Link Text 1000
DisplayLink Text 1000
GeneratedDate Date
Snippet Text 1000
SearchEngineType Byte
MatchedDate Date
ActionDays Int 16
Reason Text 255
MatchDiscountCategoryID Int 16
MatchDiscountCategoryName Text 150
WebContent byte []
ValidToDate Date
HandledByUserGroupID Int 16
HandledByUserGroupName Text 150
HandledByUserID Int 16
HandledByUserName Text 150
Action:
UPDATE
Method:
PUT
URL: /api/v1/client/adversemedia/matchdiscounted/update
Description: Update a Client AVM Match Discounted record based on Interface Reference and LinkUniqueKey
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 MatchDiscountCategoryID Int16 Match Discount 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 Discounted 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-04 00:00:00",
 "Snippet": "This is an article all about Vladimir Putin",
 "SearchEngineType": 1,
 "MatchedDate": "2024-11-04 00:00:00",
 "ActionDays": 0,
 "Reason": "President of Russia",
 "MatchDiscountCategoryID": 3,
 "MatchDiscountCategoryName": "Other",
 "WebContent": [],
 "ValidToDate": "2099-12-31 00:00:00",
 "HandledByUserGroupID": "203"
 "HandledByUserGroupName": "Handler Group"
 "HandledByUserID": "105"
 "HandledByUserName": "Fred Jones"
}
Field Data Type
ClientEntityID Int 32
ClientEntityInterfaceReference Text 50
ClientEntityLastName Text 255
ClientEntityFirstName Text 255
ClientEntityMiddleName Text 255
LinkUniqueKey Text 100
Link Text 1000
DisplayLink Text 1000
GeneratedDate Date
Snippet Text 1000
SearchEngineType Byte
MatchedDate Date
ActionDays Int 16
Reason Text 255
MatchDiscountCategoryID Int 16
MatchDiscountCategoryName Text 150
WebContent byte []
ValidToDate Date
HandledByUserGroupID Int 16
HandledByUserGroupName Text 150
HandledByUserID Int 16
HandledByUserName Text 150
Client - AVM Match Discounted [Using Internal Reference]
Action:
GET INTERNAL
Method:
GET
URL: /api/v1/client/adversemedia/matchdiscounted/getinternal
Description: Fetch AVM Match Discounted 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 Discounted 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-04 00:00:00",
 "Snippet": "This is an article all about Vladimir Putin",
 "SearchEngineType": 1,
 "MatchedDate": "2024-11-04 00:00:00",
 "ActionDays": 0,
 "Reason": "President of Russia",
 "MatchDiscountCategoryID": 3,
 "MatchDiscountCategoryName": "Other",
 "WebContent": [],
 "ValidToDate": "2099-12-31 00:00:00",
 "HandledByUserGroupID": "203"
 "HandledByUserGroupName": "Handler Group"
 "HandledByUserID": "105"
 "HandledByUserName": "Fred Jones"
}]
Field Data Type
ClientEntityID Int 32
ClientEntityInterfaceReference Text 50
ClientEntityLastName Text 255
ClientEntityFirstName Text 255
ClientEntityMiddleName Text 255
LinkUniqueKey Text 100
Link Text 1000
DisplayLink Text 1000
GeneratedDate Date
Snippet Text 1000
SearchEngineType Byte
MatchedDate Date
ActionDays Int 16
Reason Text 255
MatchDiscountCategoryID Int 16
MatchDiscountCategoryName Text 150
WebContent byte []
ValidToDate Date
HandledByUserGroupID Int 16
HandledByUserGroupName Text 150
HandledByUserID Int 16
HandledByUserName Text 150
Action:
GET ITEM INTERNAL
Method:
GET
URL: /api/v1/client/adversemedia/matchdiscounted/getiteminternal
Description: Fetch AVM Match Discounted records based on Client Entity Identifier 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 Discounted 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-04 00:00:00",
 "Snippet": "This is an article all about Vladimir Putin",
 "SearchEngineType": 1,
 "MatchedDate": "2024-11-04 00:00:00",
 "ActionDays": 0,
 "Reason": "President of Russia",
 "MatchDiscountCategoryID": 3,
 "MatchDiscountCategoryName": "Other",
 "WebContent": [],
 "ValidToDate": "2099-12-31 00:00:00",
 "HandledByUserGroupID": "203"
 "HandledByUserGroupName": "Handler Group"
 "HandledByUserID": "105"
 "HandledByUserName": "Fred Jones"
}
Field Data Type
ClientEntityID Int 32
ClientEntityInterfaceReference Text 50
ClientEntityLastName Text 255
ClientEntityFirstName Text 255
ClientEntityMiddleName Text 255
LinkUniqueKey Text 100
Link Text 1000
DisplayLink Text 1000
GeneratedDate Date
Snippet Text 1000
SearchEngineType Byte
MatchedDate Date
ActionDays Int 16
Reason Text 255
MatchDiscountCategoryID Int 16
MatchDiscountCategoryName Text 150
WebContent byte []
ValidToDate Date
HandledByUserGroupID Int 16
HandledByUserGroupName Text 150
HandledByUserID Int 16
HandledByUserName Text 150
Action:
DELETE INTERNAL
Method:
DELETE
URL: /api/v1/client/adversemedia/matchdiscounted/deleteinternal
Description: Delete a Client AVM Match Discounted 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 Discounted 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-04 00:00:00",
 "Snippet": "This is an article all about Vladimir Putin",
 "SearchEngineType": 1,
 "MatchedDate": "2024-11-04 00:00:00",
 "ActionDays": 0,
 "Reason": "President of Russia",
 "MatchDiscountCategoryID": 3,
 "MatchDiscountCategoryName": "Other",
 "WebContent": [],
 "ValidToDate": "2099-12-31 00:00:00",
 "HandledByUserGroupID": "203"
 "HandledByUserGroupName": "Handler Group"
 "HandledByUserID": "105"
 "HandledByUserName": "Fred Jones"
}
Field Data Type
ClientEntityID Int 32
ClientEntityInterfaceReference Text 50
ClientEntityLastName Text 255
ClientEntityFirstName Text 255
ClientEntityMiddleName Text 255
LinkUniqueKey Text 100
Link Text 1000
DisplayLink Text 1000
GeneratedDate Date
Snippet Text 1000
SearchEngineType Byte
MatchedDate Date
ActionDays Int 16
Reason Text 255
MatchDiscountCategoryID Int 16
MatchDiscountCategoryName Text 150
WebContent byte []
ValidToDate Date
HandledByUserGroupID Int 16
HandledByUserGroupName Text 150
HandledByUserID Int 16
HandledByUserName Text 150
Action:
UPDATE INTERNAL
Method:
PUT
URL: /api/v1/client/adversemedia/matchdiscounted/updateinternal
Description: Update a Client AVM Match Discounted 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 MatchDiscountCategoryID Int16 Match Discount 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 Discounted 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-04 00:00:00",
 "Snippet": "This is an article all about Vladimir Putin",
 "SearchEngineType": 1,
 "MatchedDate": "2024-11-04 00:00:00",
 "ActionDays": 0,
 "Reason": "President of Russia",
 "MatchDiscountCategoryID": 3,
 "MatchDiscountCategoryName": "Other",
 "WebContent": [],
 "ValidToDate": "2099-12-31 00:00:00",
 "HandledByUserGroupID": "203"
 "HandledByUserGroupName": "Handler Group"
 "HandledByUserID": "105"
 "HandledByUserName": "Fred Jones"
}
Field Data Type
ClientEntityID Int 32
ClientEntityInterfaceReference Text 50
ClientEntityLastName Text 255
ClientEntityFirstName Text 255
ClientEntityMiddleName Text 255
LinkUniqueKey Text 100
Link Text 1000
DisplayLink Text 1000
GeneratedDate Date
Snippet Text 1000
SearchEngineType Byte
MatchedDate Date
ActionDays Int 16
Reason Text 255
MatchDiscountCategoryID Int 16
MatchDiscountCategoryName Text 150
WebContent byte []
ValidToDate Date
HandledByUserGroupID Int 16
HandledByUserGroupName Text 150
HandledByUserID Int 16
HandledByUserName Text 150