getCompanyTags

Returns a list of TagSets with relsated Tags to be used for passing campaignTagId into the sendNotification API.

Request

GET /rest/user/company/tags

Headers

Header	Required	Description
x-nextinteract-authtoken	Yes	Auth token returned from loginUser
x-nextinteract-company-api-key	Yes	Admin-specific API key UUID provided to company

Parameters

Path Params: companyId - (long, required) the Id of the Company for which tags should be returned.

Response

200 OK

[
  {
    "tagSetId": 14,
    "tagSetName": "Doctor Campaigns",
    "tags": [
      {
        "tagId": 16,
        "tagName": "Doc Campaign 1",
        "tagOrder": 1,
        "tagColour": "0,215,0"
      },
      {
        "tagId": 17,
        "tagName": "Doc Campaign 2",
        "tagOrder": 2,
        "tagColour": "200,215,0"
      },
      {
        "tagId": 18,
        "tagName": "Doc Campaign 3",
        "tagOrder": 3,
        "tagColour": "0,215,34"
      },
      {
        "tagId": 19,
        "tagName": "Doc Campaign 4",
        "tagOrder": 4,
        "tagColour": "40,215,40"
      }
    ]
  },
  {
    "tagSetId": 13,
    "tagSetName": "Nurse Campaigns",
    "tags": [
      {
        "tagId": 15,
        "tagName": "Nurse Campaign 1",
        "tagOrder": 1,
        "tagColour": "0,215,0"
      },
      {
        "tagId": 20,
        "tagName": "Nurse Campaign 2",
        "tagOrder": 2,
        "tagColour": "200,215,0"
      },
      {
        "tagId": 21,
        "tagName": "Nurse Campaign 3",
        "tagOrder": 3,
        "tagColour": "0,215,34"
      }
    ]
  }
]

Errors

Exception	Description
WSInvalidParameterException	See Error Definitions
WSInvalidAuthTokenException	See Error Definitions
WSInsufficientPrivilegesException	See Error Definitions
WSCacheServiceException	See Error Definitions
WSCompanyServiceException	See Error Definitions
WSAuthorisationServiceException	See Error Definitions