Viviot.Api

<back to all web services

CreateBusinessUserAccess

Requires Authentication
Requires any of the roles:Admin, TenantAdmin, AccessAdmin
The following routes are available for this service:
POST/BusinessUserAccessCreates an access for a business user.
CreateBusinessUserAccess Parameters:
NameParameterData TypeRequiredDescription
AccessTemplateIdbodystringYesAccessTemplate ID
BusinessUserIdbodyintegerYesID of the business user
AccessCodeInitializationStrategybodyAccessCodeInitializationStrategyNoStrategy for initializing access codes for a new access from the template (unique per space on same one for all spaces).
PermissionbodyarrayNoList of user permissions in the organization.
BaseEditBusinessUserAccess Parameters:
NameParameterData TypeRequiredDescription
ValidFromformstringYesAccess comes into effect after this time
ValidToformstringNoTime when access stops. If you don't specify then access is active for undefined end time.
LabelformstringNoAccess label.
SpacesformList<ThingBusinessUserAccessDto>YesList of spaces that the access is granted for.
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
VersionformintegerNoApi version
ThingBusinessUserAccessDto Parameters:
NameParameterData TypeRequiredDescription
ThingIdformGuidNo
AccessCountformint?No
FromHourformTimeSpan?No
ToHourformTimeSpan?No
ExclusiveformboolNo
AccessCodeInitializationStrategy Enum:
NameValue
Unique0
Shared1
CreateBusinessUserAccessResponse Parameters:
NameParameterData TypeRequiredDescription
IdformGuid?No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo

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.

POST /BusinessUserAccess HTTP/1.1 
Host: api.4spaces.io 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	accessTemplateId: 00000000000000000000000000000000,
	businessUserId: 0,
	accessCodeInitializationStrategy: 0,
	permission: 
	[
		String
	],
	validFrom: -62135596800000,
	validTo: -62135596800000,
	label: String,
	spaces: 
	[
		{
			thingId: 00000000000000000000000000000000,
			accessCount: 0,
			fromHour: PT0S,
			toHour: PT0S,
			exclusive: False
		}
	],
	version: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	id: 00000000000000000000000000000000,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}