HostedSuite

<back to all web services

GetReservationRequest

Retrieve a specific reservation

The following routes are available for this service:
POST/api/scheduling/reservations/details
GetReservationRequest Parameters:
NameParameterData TypeRequiredDescription
IdbodystringNoThe ID of the reservation you want to retrieve
RequestBase<TResponse> Parameters:
NameParameterData TypeRequiredDescription
CustomerNameformstringYesThe HostedSuite Customer Name
UserNameformstringYesThe HostedSuite User Name. Data visibility and security is based on this user's permissions.
PasswordformstringYesThe HostedSuite User's Password
ReservationInfo Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
EntityStatusformstringNo
CenterIdformstringNo
CenterNameformstringNo
CenterAddressformstringNo
MeetingRoomIdformstringNo
MeetingRoomNameformstringNo
StartTimeformstringNo
EndTimeformstringNo
SubjectformstringNo
StatusformstringNo
NotesformstringNo
PaymentStatusformstringNo
ClientIdformstringNo
ClientNameformstringNo
IsRecurringformboolNo
OriginalDateformstringNo
DateLastModifiedformstringNo
LastModifiedByformstringNo
AttendeesformList<AttendeeInfo>No
NumAttendeesformintNo
OrganizerformAttendeeInfoNo
CustomFieldsformList<CustomFieldInfo>No
AttendeeInfo Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
EmailAddressformstringNo
CustomFieldInfo Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
ValueformstringNo
ReservationInfo Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
EntityStatusformstringNo
CenterIdformstringNo
CenterNameformstringNo
CenterAddressformstringNo
MeetingRoomIdformstringNo
MeetingRoomNameformstringNo
StartTimeformstringNo
EndTimeformstringNo
SubjectformstringNo
StatusformstringNo
NotesformstringNo
PaymentStatusformstringNo
ClientIdformstringNo
ClientNameformstringNo
IsRecurringformboolNo
OriginalDateformstringNo
DateLastModifiedformstringNo
LastModifiedByformstringNo
AttendeesformList<AttendeeInfo>No
NumAttendeesformintNo
OrganizerformAttendeeInfoNo
CustomFieldsformList<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/reservations/details HTTP/1.1 
Host: evo.hostedsuite.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Id: 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
		}
	]
}