Add or Update a Tag
Create or update a Tag which can then be later applied to an entity using Add Tag to Data Entity
Query String Parameters
Name | Type | Description | Required |
---|---|---|---|
Action | String | SaveTag | Required |
EntityType | Int | The type of entity associated with the tag. | Required |
Name | String | The name of the tag. | Required |
Color | String | The name of the color to be assigned to the tag. | Required |
Options | Int | The options associated with the tag. | Required |
TagId | Int | The unique identifier of an existing tag, provided if updating an existing tag. | Optional |
Response Codes
Code | Message | Information |
---|---|---|
0 | Response Data | See 'Response' example tab |
2 | Missing Parameter | Mandatory parameter was not supplied |
2 | TagId must be an integer value | Integer value is invalid or was not specified (when required) |
2 | EntityType value invalid | Unrecognized constant value - please verify the supported values |
2 | EntityType must be an integer value | Integer value is invalid or was not specified (when required) |
2 | Options value invalid | Unrecognized constant value - please verify the supported values |
2 | misc_noRight | You do not have the permissions to access settings for the provided Tag Entity Type. |
Example
- Request
- Response
Request URL
https://webservice.bigchange.com/v01/services.ashx?action=savetag&EntityType=3&Color=Yellow&Name=6 weekly window clean&Options=0
Response Data
{ "Code": 0, "Result": { "id": 212108, "label": "6 weekly window clean", "color": "Yellow" } }