| Action: | GET | |||||||||||||||
| Method: | GET | |||||||||||||||
| URL: | /api/v1/static/matchflagcategory/get | |||||||||||||||
| Description: | Fetch a Static 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 Match Flag Category. { "MatchFlagCategoryID": 1, "Name": "Relevant Acceptable - Generic", "Description": "Relevant Acceptable - Generic", "RequireReason": false, "Grouping": 1 } |
| ||||||||||||||
| Action: | GET ALL | |||||||||||||||
| Method: | GET | |||||||||||||||
| URL: | /api/v1/static/matchflagcategory/getall | |||||||||||||||
| Description: | Fetch all Static 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 Match Flag Category records. [{ "MatchFlagCategoryID": 1, "Name": "Relevant Acceptable - Generic", "Description": "Relevant Acceptable - Generic", "RequireReason": false, "Grouping": 1 }] |
| ||||||||||||||
| Action: | ADD | |||||||||||||||
| Method: | POST | |||||||||||||||
| URL: | /api/v1/static/matchflagcategory/add | |||||||||||||||
| Description: | Add a Static Match Flag Category and link to Client | |||||||||||||||
| 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 | Grouping | Byte | Grouping | |||||||||||||
| Body | ActionUserID | Int16 | Identifier of the User performing action. | |||||||||||||
| Body | ReturnFormat | String | Json or Xml | |||||||||||||
| Return Data: |
Json or XML of the Static Match Flag Category record added. { "MatchFlagCategoryID": 1, "Name": "Relevant Acceptable - Generic", "Description": "Relevant Acceptable - Generic", "Grouping": 1 } |
|
||||||||||||||
| Action: | UPDATE | |||||||||||||||
| Method: | PUT | |||||||||||||||
| URL: | /api/v1/static/matchflagcategory/update | |||||||||||||||
| Description: | Update an existing Static 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 | ActionUserID | Int16 | Identifier of the User performing action. | |||||||||||||
| Body | ReturnFormat | String | Json or Xml | |||||||||||||
| Return Data: |
Json or XML of the Static Match Flag Category record updated. { "MatchFlagCategoryID": 1, "Name": "Relevant Acceptable - Generic", "Description": "Relevant Acceptable - Generic", "RequireReason": false "Grouping": 1 } |
|
||||||||||||||
| Action: | DELETE | |||||||||||||||
| Method: | DELETE | |||||||||||||||
| URL: | /api/v1/static/matchflagcategory/delete | |||||||||||||||
| Description: | Delete an existing Static Match Flag Category link with Client and also the Static Match Flag Category if not linked to any other clients | |||||||||||||||
| 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 Match Flag Category record deleted. { "MatchFlagCategoryID": 1, "Name": "Relevant Acceptable - Generic", "Description": "Relevant Acceptable - Generic", "RequireReason": false "Grouping": 1 } |
|
||||||||||||||