HostedSuite

ListReservationsRequest

Retrieve a list of reservations for the specified date range

The following routes are available for this service:
POST	/api/scheduling/reservations

**ListReservationsRequest** Parameters:
Name	Parameter	Data Type	Required	Description
MeetingRoomIds	body	List<string>	No	Specific meeting rooms. Leave blank for all
CenterId	body	string	No	Specify a center. Leave blank for all
ClientId	body	string	No	Specify a client ID. Leave blank for all
StartTime	body	string	No	Start of date range
EndTime	body	string	No	End of date range
Status	body	ReservationStatuses?	No	Filter by reservation status or null to not filter
PaymentStatus	body	PaymentStatus?	No	Filter by reservation payment status or null to not filter
LastModifiedAfter	body	string	No	Filter by only reservations that were modified after the specified date
LastModifiedBefore	body	string	No	Filter by only reservations that were modified before the specified date

**RequestBase<TResponse>** Parameters:
Name	Parameter	Data Type	Required	Description
CustomerName	form	string	Yes	The HostedSuite Customer Name
UserName	form	string	Yes	The HostedSuite User Name. Data visibility and security is based on this user's permissions.
Password	form	string	Yes	The HostedSuite User's Password

**ReservationStatuses** Enum:
Scheduled
Cancelled
PendingApproval
Denied

**PaymentStatus** Enum:
None
NotPaid
PartiallyPaid
Overdue
Paid
Included
Cancelled
NoCharge
Confirmed
BillOther
Other

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 /api/scheduling/reservations HTTP/1.1 
Host: cpo.hostedsuite.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	MeetingRoomIds: 
	[
		String
	],
	CenterId: String,
	ClientId: String,
	StartTime: String,
	EndTime: String,
	Status: Scheduled,
	PaymentStatus: None,
	LastModifiedAfter: String,
	LastModifiedBefore: String,
	CustomerName: String,
	UserName: String,
	Password: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	{
		Id: String,
		EntityStatus: String,
		CenterId: String,
		CenterName: String,
		CenterAddress: String,
		MeetingRoomId: String,
		MeetingRoomName: String,
		StartTime: String,
		EndTime: String,
		Subject: String,
		Status: String,
		Notes: String,
		PaymentStatus: String,
		ClientId: String,
		ClientName: String,
		IsRecurring: False,
		OriginalDate: String,
		DateLastModified: String,
		LastModifiedBy: String,
		Attendees: 
		[
			{
				Name: String,
				EmailAddress: String
			}
		],
		NumAttendees: 0,
		Organizer: 
		{
			Name: String,
			EmailAddress: String
		},
		CustomFields: 
		[
			{
				Name: String,
				Value: String
			}
		]
	}
]