Viviot.Api

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:
Name	Parameter	Data Type	Required	Description
StartTime	query	string	Yes	Start time in UTC of the given timespan for which to aggregate reservations for.
TimeSpanHours	query	integer	Yes	The timespan (in hours) during which to aggregate reservations.

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Version	form	integer	No	Api version

**AggregatedReservationsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	ReservationOrganizationAggregationView	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No

**ReservationOrganizationAggregationView** Parameters:
Name	Parameter	Data Type	Required
Reservations	form	long	No
OrganizationParentId	form	Guid?	No
Checkins	form	long	No
Checkouts	form	long	No
SameDayCheckinsCheckouts	form	long	No
CheckinsCheckouts	form	long	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 /reservations/aggregated/ HTTP/1.1 
Host: api.4spaces.io 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}