| POST | /api/scheduling/reservations/details |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | body | string | No | The ID of the reservation you want to retrieve |
| 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 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | No | |
| EmailAddress | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | No | |
| Value | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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
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: cpo.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
}
]
}