| Action: | GET | |||||||||||||||||
| Method: | GET | |||||||||||||||||
| URL: | api/v1/static/adversemedia/matchdiscountcategory/get | |||||||||||||||||
| Description: | Fetch a Static AVM Match Discount Category record based on Identifier | |||||||||||||||||
| Type | Key | DataType | Notes | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Headers | api-key | String | Your Api-Key | |||||||||||||||
| Params | MatchCategoryID | Int16 | AVM Match Discount Category Identifier | |||||||||||||||
| Params | ReturnFormat | String | Json or Xml | |||||||||||||||
| Return Data: | Json or XML of the Static AVM Match Discount Category. { "MatchDiscountCategoryID": 1, "Name": "Article not related to the searched individual", "Description": "Article not related to the searched individual", "RequireReason": false, "Grouping": 1 "Scrape": false } |
| ||||||||||||||||
| Action: | GET ALL | |||||||||||||||||
| Method: | GET | |||||||||||||||||
| URL: | /api/v1/static/adversemedia/matchdiscountcategory/getall | |||||||||||||||||
| Description: | Fetch all Static AVM Match Discount Category 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 Match Discount Category records. [{ "MatchDiscountCategoryID": 1, "Name": "Article not related to the searched individual", "Description": "Article not related to the searched individual", "RequireReason": false, "Grouping": 1 "Scrape": false }] |
| ||||||||||||||||
| Action: | ADD | |||||||||||||||||
| Method: | POST | |||||||||||||||||
| URL: | /api/v1/static/adversemedia/matchdiscountcategory/add | |||||||||||||||||
| Description: | Add a Static AVM Match Discount Category | |||||||||||||||||
| 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 | RequireReason | Boolean | Require Reason | |||||||||||||||
| Body | Grouping | Byte | Grouping | |||||||||||||||
| Body | Scrape | Boolean | Scrape | |||||||||||||||
| Body | ActionUserID | Int16 | Identifier of the User performing action. | |||||||||||||||
| Body | ReturnFormat | String | Json or Xml | |||||||||||||||
| Return Data: |
Json or XML of the Static AVM Match Discount Category record added. { "MatchDiscountCategoryID": 4, "Name": "Article Unrelated", "Description": "Article Unrelated", "RequireReason": "false", "Grouping": 1 "Scrape": "false", } |
|
||||||||||||||||
| Action: | UPDATE | |||||||||||||||||
| Method: | PUT | |||||||||||||||||
| URL: | /api/v1/static/adversemedia/matchdiscountcategory/update | |||||||||||||||||
| Description: | Update an existing Static AVM Match Discount Category | |||||||||||||||||
| Type | Key | DataType | Notes | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Headers | api-key | String | Your Api-Key | |||||||||||||||
| Headers | Content-Type | String | Enter value: application/x-www-form-urlencoded | |||||||||||||||
| Body | MatchDiscountCategoryID | Int16 | Identifier of the Static Match Discount Category to update | |||||||||||||||
| Body | Name | String | Name | |||||||||||||||
| Body | Description | String | Description | |||||||||||||||
| Body | RequireReason | Boolean | Require Reason | |||||||||||||||
| Body | Grouping | Byte | Grouping | |||||||||||||||
| Body | Scrape | Boolean | Scrape | |||||||||||||||
| Body | ActionUserID | Int16 | Identifier of the User performing action. | |||||||||||||||
| Body | ReturnFormat | String | Json or Xml | |||||||||||||||
| Return Data: |
Json or XML of the Static AVM Match Discount Category record updated. { "MatchDiscountCategoryID": 4, "Name": "Article Unrelated, so Discounted", "Description": "Article Unrelated, so Discounted", "RequireReason": false "Grouping": 1 "Scrape": false } |
|
||||||||||||||||
| Action: | DELETE | |||||||||||||||||
| Method: | DELETE | |||||||||||||||||
| URL: | /api/v1/static/adversemedia/matchdiscountcategory/delete | |||||||||||||||||
| Description: | Delete an existing Static AVM Match Discount Category | |||||||||||||||||
| Type | Key | DataType | Notes | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Headers | api-key | String | Your Api-Key | |||||||||||||||
| Headers | Content-Type | String | Enter value: application/x-www-form-urlencoded | |||||||||||||||
| Body | MatchDiscountCategoryID | Int16 | Identifier of the Static Match Discount Category 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 AVM Match Discount Category record deleted. { "MatchDiscountCategoryID": 4, "Name": "Article Unrelated, so Discounted", "Description": "Article Unrelated, so Discounted", "RequireReason": false "Grouping": 1 "Scrape": false } |
|
||||||||||||||||