Viviot.Api

<back to all web services

GetAccessTemplateGroup

Requires Authentication
Requires any of the roles:Admin, TenantAdmin, AccessTemplateAdmin, AccessAdmin
The following routes are available for this service:
GET/access/templategroupGet access template group.
GetAccessTemplateGroup Parameters:
NameParameterData TypeRequiredDescription
AccessTemplateGroupIdquerystringYesAccess templateId group id (GUID)
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
VersionformintegerNoApi version
AccessTemplateGroupResponse Parameters:
NameParameterData TypeRequiredDescription
DataformAccessTemplateGroupViewNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
AccessTemplateGroupView Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
OrganizationIdformGuidNo
NameformstringNo
MembersformList<AccessTemplateView>No
AccessTemplateView Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
OrganizationIdformGuidNo
OrganizationformOrganizationBasicViewNo
NameformstringNo
PermissionformList<string>No
DescriptionformstringNo
ScopeformAccessTemplateScopeNo
AccessCodeInitializationStrategyformAccessCodeInitializationStrategyNo
OrganizationBasicView Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
NameformstringNo
TypeformOrganizationTypeNo
SubOrganizationsformList<OrganizationBasicView>No
OrganizationType Enum:
NameValue
Unknown0
Admin10
Tenant20
Location30
AccessTemplateScope Enum:
NameValue
All0
Guest1
Staff2
AccessCodeInitializationStrategy Enum:
NameValue
Unique0
Shared1

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 /access/templategroup 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,
		organizationId: 00000000000000000000000000000000,
		name: String,
		members: 
		[
			{
				id: 00000000000000000000000000000000,
				organizationId: 00000000000000000000000000000000,
				organization: 
				{
					id: 00000000000000000000000000000000,
					name: String,
					type: 0,
					organizations: 
					[
						{
							id: 00000000000000000000000000000000,
							name: String,
							type: 0,
							organizations: 
							[
								{
									id: 00000000000000000000000000000000,
									name: String,
									type: 0,
									organizations: 
									[
										{
											
										}
									]
								}
							]
						}
					]
				},
				name: String,
				permission: 
				[
					String
				],
				description: String,
				scope: 0,
				accessCodeInitializationStrategy: 0
			}
		]
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}