Viviot.Api

<back to all web services

GetReservationServiceTimeslotAvailability

Requires Authentication
Requires any of the roles:Admin, TenantAdmin, MarketplaceAdmin, AvailabilityReader
The following routes are available for this service:
GET/service/{ServiceId}/availabilityGets available timeslots for a smartspace within a service on a given time period.
GetReservationServiceTimeslotAvailability Parameters:
NameParameterData TypeRequiredDescription
ServiceIdpathstringYesService ID (GUID)
ThingIdquerystringYesThing/smartspace ID (GUID)
StartquerystringYesStart date and time from when to collect available timeslots (UTC).
EndquerystringNoEnd date and time until when to collect available timeslots (UTC - 24h from start if not set).
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
VersionformintegerNoApi version
ReservationServiceTimeslotAvailabilityResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<TimeslotAvailabilityDto>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
TimeslotAvailabilityDto Parameters:
NameParameterData TypeRequiredDescription
AvailableformboolNo
TimeslotDto Parameters:
NameParameterData TypeRequiredDescription
FromformDateTime?No
ToformDateTime?No

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 /service/{ServiceId}/availability HTTP/1.1 
Host: api.4spaces.io 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	data: 
	[
		{
			available: False,
			from: -62135596800000,
			to: -62135596800000
		}
	],
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}