Viviot.Api

<back to all web services

GetTagGroups

Requires Authentication
Requires any of the roles:Admin, TenantAdmin, TaskAdmin, Receptionist
The following routes are available for this service:
GET/taggroupsGets all task groups for the current user's organization.
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
VersionformintegerNoApi version
TagGroupsResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<TagGroupView>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
TagGroupView Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
NameformstringNo
OrganizationIdformGuidNo
TagsformList<TagView>No
TagView Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
NameformstringNo
TagGroupIdformGuidNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /taggroups HTTP/1.1 
Host: api.4spaces.io 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	data: 
	[
		{
			id: 00000000000000000000000000000000,
			name: String,
			organizationId: 00000000000000000000000000000000,
			tags: 
			[
				{
					id: 00000000000000000000000000000000,
					name: String,
					tagGroupId: 00000000000000000000000000000000
				}
			]
		}
	],
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}