| POST | /api/scheduling/update-payment-status |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ReservationId | body | string | No | The ID of the reservation you want to update |
| OriginalDate | body | string | No | The date of the reservation you want to update. This needs to be specified for recurring reservation instances. Check the IsRecurring property of the reservation info. |
| PaymentStatus | body | PaymentStatus | No | The payment status to use |
| 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 |
| None |
| NotPaid |
| PartiallyPaid |
| Overdue |
| Paid |
| Included |
| Cancelled |
| NoCharge |
| Confirmed |
| BillOther |
| Other |
| 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 .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/scheduling/update-payment-status HTTP/1.1
Host: cpo.hostedsuite.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<UpdatePaymentStatusRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Evo.HostedSuite.Core.ServiceModel">
<CustomerName>String</CustomerName>
<Password>String</Password>
<UserName>String</UserName>
<OriginalDate>String</OriginalDate>
<PaymentStatus>None</PaymentStatus>
<ReservationId>String</ReservationId>
</UpdatePaymentStatusRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ReservationInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Evo.HostedSuite.Core.ServiceModel">
<Attendees>
<AttendeeInfo>
<EmailAddress>String</EmailAddress>
<Name>String</Name>
</AttendeeInfo>
</Attendees>
<CenterAddress>String</CenterAddress>
<CenterId>String</CenterId>
<CenterName>String</CenterName>
<ClientId>String</ClientId>
<ClientName>String</ClientName>
<CustomFields>
<CustomFieldInfo>
<Name>String</Name>
<Value>String</Value>
</CustomFieldInfo>
</CustomFields>
<DateLastModified>String</DateLastModified>
<EndTime>String</EndTime>
<EntityStatus>String</EntityStatus>
<Id>String</Id>
<IsRecurring>false</IsRecurring>
<LastModifiedBy>String</LastModifiedBy>
<MeetingRoomId>String</MeetingRoomId>
<MeetingRoomName>String</MeetingRoomName>
<Notes>String</Notes>
<NumAttendees>0</NumAttendees>
<Organizer>
<EmailAddress>String</EmailAddress>
<Name>String</Name>
</Organizer>
<OriginalDate>String</OriginalDate>
<PaymentStatus>String</PaymentStatus>
<StartTime>String</StartTime>
<Status>String</Status>
<Subject>String</Subject>
</ReservationInfo>