| Action: | GET | |||||||||||||||||
| Method: | GET | |||||||||||||||||
| URL: | /api/v1/static/adversemedia/matchflagcategory/get | |||||||||||||||||
| Description: | Fetch a Static AVM Match Flag Category record based on Identifier | |||||||||||||||||
| Type | Key | DataType | Notes | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Headers | api-key | String | Your Api-Key | |||||||||||||||
| Params | MatchCategoryID | Int16 | Match Flag Category Identifier | |||||||||||||||
| Params | ReturnFormat | String | Json or Xml | |||||||||||||||
| Return Data: | Json or XML of the Static AVM Match Flag Category. { "MatchFlagCategoryID": 1, "Name": "Relevant Acceptable - Generic", "Description": "Relevant Acceptable - Generic", "RequireReason": false, "Grouping": 1 "Scrape": false } |
| ||||||||||||||||
| Action: | GET ALL | |||||||||||||||||
| Method: | GET | |||||||||||||||||
| URL: | /api/v1/static/adversemedia/matchflagcategory/getall | |||||||||||||||||
| Description: | Fetch all Static AVM Match Flag 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 Flag Category records. [{ "MatchFlagCategoryID": 1, "Name": "Relevant Acceptable - Generic", "Description": "Relevant Acceptable - Generic", "RequireReason": false, "Grouping": 1 "Scrape": false, }] |
| ||||||||||||||||
| Action: | ADD | |||||||||||||||||
| Method: | POST | |||||||||||||||||
| URL: | /api/v1/static/adversemedia/matchflagcategory/add | |||||||||||||||||
| Description: | Add a Static AVM Match Flag 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 Flag Category record added. { "MatchFlagCategoryID": 1, "Name": "Relevant Acceptable - Generic", "Description": "Relevant Acceptable - Generic", "RequireReason": "false", "Grouping": 1 "Scrape": "false", } |
|
||||||||||||||||
| Action: | UPDATE | |||||||||||||||||
| Method: | PUT | |||||||||||||||||
| URL: | /api/v1/static/adversemedia/matchflagcategory/update | |||||||||||||||||
| Description: | Update an existing Static AVM Match Flag Category | |||||||||||||||||
| Type | Key | DataType | Notes | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Headers | api-key | String | Your Api-Key | |||||||||||||||
| Headers | Content-Type | String | Enter value: application/x-www-form-urlencoded | |||||||||||||||
| Body | MatchFlagCategoryID | Int16 | Identifier of the Static Match Flag 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 Flag Category record updated. { "MatchFlagCategoryID": 1, "Name": "Relevant Acceptable - Generic", "Description": "Relevant Acceptable - Generic", "RequireReason": false "Grouping": 1 "Scrape": false } |
|
||||||||||||||||
| Action: | DELETE | |||||||||||||||||
| Method: | DELETE | |||||||||||||||||
| URL: | /api/v1/static/adversemedia/matchflagcategory/delete | |||||||||||||||||
| Description: | Delete an existing Static AVM Match Flag Category | |||||||||||||||||
| Type | Key | DataType | Notes | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Headers | api-key | String | Your Api-Key | |||||||||||||||
| Headers | Content-Type | String | Enter value: application/x-www-form-urlencoded | |||||||||||||||
| Body | MatchFlagCategoryID | Int16 | Identifier of the Static Match Flag 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 Flag Category record deleted. { "MatchFlagCategoryID": 1, "Name": "Relevant Acceptable - Generic", "Description": "Relevant Acceptable - Generic", "RequireReason": false "Grouping": 1 "Scrape": false } |
|
||||||||||||||||