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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}