Viviot.Api

<back to all web services

GetAggregatedReservations

Requires Authentication
Requires any of the roles:Admin, TenantAdmin, AccessAdmin, Receptionist
The following routes are available for this service:
GET/reservations/aggregated/Returns the reservation count during a timespan following a given datetime at the organization of the current user.
GetAggregatedReservations Parameters:
NameParameterData TypeRequiredDescription
StartTimequerystringYesStart time in UTC of the given timespan for which to aggregate reservations for.
TimeSpanHoursqueryintegerYesThe timespan (in hours) during which to aggregate reservations.
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
VersionformintegerNoApi version
AggregatedReservationsResponse Parameters:
NameParameterData TypeRequiredDescription
DataformReservationOrganizationAggregationViewNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ReservationOrganizationAggregationView Parameters:
NameParameterData TypeRequiredDescription
ReservationsformlongNo
OrganizationParentIdformGuid?No
CheckinsformlongNo
CheckoutsformlongNo
SameDayCheckinsCheckoutsformlongNo
CheckinsCheckoutsformlongNo

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 /reservations/aggregated/ HTTP/1.1 
Host: api.4spaces.io 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"data":{"reservations":0,"organizationParentId":"00000000000000000000000000000000","checkins":0,"checkouts":0,"sameDayCheckinsCheckouts":0,"checkinsCheckouts":0},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}