HostedSuite

ScheduleReservationRequest

Schedule a new reservation and returns the reservation info.

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

**ScheduleReservationRequest** Parameters:
Name	Parameter	Data Type	Required	Description
MeetingRoomId	body	string	No	The ID of the meeting room you are booking
StartTime	body	string	No	The start of the reservation
EndTime	body	string	No	The end of the reservation
Subject	body	string	No	The subject of the reservation
Notes	body	string	No	Notes for this reservation
Attendees	body	List<AttendeeInfo>	No	Attendees for this reservation
OrganizerName	body	string	No	Name of the organization
ResourceIds	body	List<string>	No	The IDs of the resources to reserve (Use the ListAvailableResources method to retrieve).
NumAttendees	body	int	No	The number of attendees expected.
ClientId	body	string	No	The client ID to associate with this reservation.
ClientEmailAddress	body	string	No	The email address of the client to associate with this reservation. Use this if you do not have the client ID. NOTE - if the email address is not associated with any clients, the reservation will be created, but not associated with a client.
PaymentStatus	body	PaymentStatus?	No	The payment status of the reservation

**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

**ReservationInfo** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
EntityStatus	form	string	No
CenterId	form	string	No
CenterName	form	string	No
CenterAddress	form	string	No
MeetingRoomId	form	string	No
MeetingRoomName	form	string	No
StartTime	form	string	No
EndTime	form	string	No
Subject	form	string	No
Status	form	string	No
Notes	form	string	No
PaymentStatus	form	string	No
ClientId	form	string	No
ClientName	form	string	No
IsRecurring	form	bool	No
OriginalDate	form	string	No
DateLastModified	form	string	No
LastModifiedBy	form	string	No
Attendees	form	List<AttendeeInfo>	No
NumAttendees	form	int	No
Organizer	form	AttendeeInfo	No
CustomFields	form	List<CustomFieldInfo>	No

**AttendeeInfo** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	No
EmailAddress	form	string	No

**CustomFieldInfo** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	No
Value	form	string	No

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

**ReservationInfo** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
EntityStatus	form	string	No
CenterId	form	string	No
CenterName	form	string	No
CenterAddress	form	string	No
MeetingRoomId	form	string	No
MeetingRoomName	form	string	No
StartTime	form	string	No
EndTime	form	string	No
Subject	form	string	No
Status	form	string	No
Notes	form	string	No
PaymentStatus	form	string	No
ClientId	form	string	No
ClientName	form	string	No
IsRecurring	form	bool	No
OriginalDate	form	string	No
DateLastModified	form	string	No
LastModifiedBy	form	string	No
Attendees	form	List<AttendeeInfo>	No
NumAttendees	form	int	No
Organizer	form	AttendeeInfo	No
CustomFields	form	List<CustomFieldInfo>	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.

POST /api/scheduling/schedule HTTP/1.1 
Host: cpo.hostedsuite.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	MeetingRoomId: String,
	StartTime: String,
	EndTime: String,
	Subject: String,
	Notes: String,
	Attendees: 
	[
		{
			Name: String,
			EmailAddress: String
		}
	],
	OrganizerName: String,
	ResourceIds: 
	[
		String
	],
	NumAttendees: 0,
	ClientId: String,
	ClientEmailAddress: String,
	PaymentStatus: None,
	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
		}
	]
}