HostedSuite

<back to all web services

ScheduleReservationRequest

Schedule a new reservation and returns the reservation info.

The following routes are available for this service:
POST/api/scheduling/schedule
ScheduleReservationRequest Parameters:
NameParameterData TypeRequiredDescription
MeetingRoomIdbodystringNoThe ID of the meeting room you are booking
StartTimebodystringNoThe start of the reservation
EndTimebodystringNoThe end of the reservation
SubjectbodystringNoThe subject of the reservation
NotesbodystringNoNotes for this reservation
AttendeesbodyList<AttendeeInfo>NoAttendees for this reservation
OrganizerNamebodystringNoName of the organization
ResourceIdsbodyList<string>NoThe IDs of the resources to reserve (Use the ListAvailableResources method to retrieve).
NumAttendeesbodyintNoThe number of attendees expected.
ClientIdbodystringNoThe client ID to associate with this reservation.
ClientEmailAddressbodystringNoThe 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.
PaymentStatusbodyPaymentStatus?NoThe payment status of the reservation
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
PaymentStatus Enum:
None
NotPaid
PartiallyPaid
Overdue
Paid
Included
Cancelled
NoCharge
Confirmed
BillOther
Other
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 .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.

POST /api/scheduling/schedule HTTP/1.1 
Host: evo.hostedsuite.com 
Accept: application/json
Content-Type: application/json
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: application/json
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"}]}