From fc98c7409b0c328bdbed5885e5881b87d7e633c1 Mon Sep 17 00:00:00 2001 From: Thanh Tran Date: Fri, 18 Jul 2025 08:19:05 +1000 Subject: [PATCH 1/4] IPD-17882: getAvailableFunctionSpaces --- SUMMARY.md | 415 +++++++++--------- .../get-available-function-spaces.md | 119 +++++ 2 files changed, 327 insertions(+), 207 deletions(-) create mode 100644 venues/venuedata/get-available-function-spaces.md diff --git a/SUMMARY.md b/SUMMARY.md index 6e4f7d6..595497a 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -1,209 +1,210 @@ # Table of contents -* [API Documentation](README.md) -* [Getting Started](getting-started/README.md) - * [Obtaining Keys](getting-started/obtaining-keys.md) - * [Creating the request](getting-started/creating-the-request/README.md) - * [Method/URI Header](getting-started/creating-the-request/method-uri-header.md) - * [Request Headers](getting-started/creating-the-request/request-headers/README.md) - * [Standard Headers](getting-started/creating-the-request/request-headers/standard-headers.md) - * [Custom Headers](getting-started/creating-the-request/request-headers/custom-headers.md) - * [Signing the request](getting-started/creating-the-request/signing-the-request.md) - * [Query Parameters](getting-started/creating-the-request/query-parameters.md) - * [Test Ping](getting-started/test.md) - * [Interpreting the response](getting-started/interpreting-the-response/README.md) - * [Collections](getting-started/interpreting-the-response/collections.md) - * [Pagination](getting-started/interpreting-the-response/pagination.md) - * [Filtering](getting-started/interpreting-the-response/filtering.md) - * [Exceptions](getting-started/interpreting-the-response/exceptions.md) - * [Response Headers](getting-started/interpreting-the-response/response-headers.md) - * [Dates](getting-started/interpreting-the-response/dates.md) - * [Batch](getting-started/batch/README.md) - * [Run](getting-started/batch/run.md) - * [Progress](getting-started/batch/progress.md) - * [Result](getting-started/batch/results.md) - * [Restart](getting-started/batch/restart.md) - * [Repost](getting-started/batch/repost.md) - * [Use Cases](getting-started/use-cases/README.md) - * [CRM Systems](getting-started/use-cases/crm-systems.md) - * [Financial Accounting Systems](getting-started/use-cases/accounting-systems.md) - * [Point Of Sale](getting-started/use-cases/point-of-sale.md) - * [Property Management Systems](getting-started/use-cases/property-management-systems.md) -* [Contacts & Companies](contact/README.md) - * [Get Contact List](contact/get-contact-list.md) - * [Get Contact](contact/get-contact.md) - * [Get Contact Note List](contact/get-contact-note-list.md) - * [Add or Update Contact](contact/add-or-update-contact.md) - * [Get Contact Custom Field Definition](contact/get-custom-field-definition.md) - * [Get Company Custom Field Definition](contact/get-company-custom-field-definition.md) - * [Get Subscription Group List](contact/get-subscription-group-list.md) - * [Add Contacts To Subscription Group](contact/add-contacts-to-subscription-group.md) - * [Remove Contacts From Subscription Group](contact/remove-contacts-from-subscription-group.md) - * [Get Company List](contact/get-company-list.md) - * [Get Company](contact/get-company.md) - * [Get Company Note List](contact/get-company-note-list.md) - * [Add or Update Company](contact/add-or-update-company.md) - * [Add or Update Lead](contact/add-or-update-lead.md) - * [Add or Update Contact Note](contact/add-or-update-contact-note.md) - * [Add or Update Company Note](contact/add-or-update-company-note.md) -* [Event](events/README.md) - * [Add or Update Event](events/add-or-update-event.md) - * [Get Event List](events/get-event-list.md) - * [Get Event](events/get-event.md) - * [Get Registration](events/get-registration.md) - * [Get Registration List](events/get-registration-list.md) - * [Get Attendee](events/get-attendee.md) - * [Get Attendee List](events/get-attendee-list.md) - * [Get Invited Contact List](events/get-invited-contact-list.md) - * [Invite Contacts](events/invite-contacts.md) - * [Get Sponsorship List](events/get-sponsorship-list.md) - * [Get Speaker List](events/get-speaker-list.md) - * [Get Session List](events/get-session-list.md) - * [Create Login Token](events/create-login-token.md) -* [Venue](venues/README.md) - * [Venue Setup Data](venues/venuedata/README.md) - * [Get Venue](venues/venuedata/get-venue.md) - * [Get Venue List](venues/venuedata/get-venue-list.md) - * [Get Venue Room List](venues/venuedata/get-venue-room-list.md) - * [Get Venue Room Rates](venues/venuedata/get-room-rates.md) - * [Get Venue Rate Plan Booking Rules](venues/venuedata/get-rate-plan-booking-rules.md) - * [Get Venue Room Inventory](venues/venuedata/get-room-inventory.md) - * [Get Venue Room Option List](venues/venuedata/get-venue-room-option-list.md) - * [Get Venue Rate Plan List](venues/venuedata/get-venue-rate-plan-list.md) - * [Get Venue Rate Plan Rate List](venues/venuedata/get-rate-plan-rate-list.md) - * [Get Venue Rate Plan Room Rate List](venues/venuedata/get-room-rate-list.md) - * [Get Resource List](venues/venuedata/get-resource-list.md) - * [Get Resource Availability](venues/venuedata/get-resource-availability.md) - * [Get Menu List](venues/venuedata/get-menu-list.md) - * [Get Beverage Package List](venues/venuedata/get-beverage-package-list.md) - * [Get Function Space List](venues/venuedata/get-function-space-list.md) - * [Get Space Blockout List](venues/venuedata/get-space-blockout-list.md) - * [Get Function Space Category List](venues/venuedata/get-function-space-category-list.md) - * [Get Function Space Availability](venues/venuedata/get-function-space-availability.md) - * [Get Function Space Hire Plan Rate List]() - * [Get Function Space Hire Plan Rate](venues/venuedata/get-space-hire-plan-rate.md) - * [Get Cost Center List](venues/venuedata/get-cost-center-list.md) - * [Get Session Type List](venues/venuedata/get-session-type-list.md) - * [Get Revenue Template List](venues/venuedata/get-revenue-template-list.md) - * [Get Tax List](venues/venuedata/get-tax-list.md) - * [Add or Update Function Space](venues/venuedata/add-or-update-function-space.md) - * [Get Event Type List](venues/venuedata/get-event-type-list.md) - * [Add or Update Function Space Category](venues/venuedata/add-or-update-function-space-category.md) - * [Add or Update Guest Room](venues/venuedata/add-or-update-guest-room.md) - * [Get Booking Custom Field List](venues/venuedata/get-booking-custom-field-list.md) - * [Get Space Hire Plans](venues/get-space-hire-plan-list.md) - * [Get Venue Package List](venues/venuedata/get-venue-package-list.md) - * [Get Venue Package](venues/venuedata/get-venue-package.md) - * [Booking Data](venues/getoraddbookingdata/README.md) - * [Convert Lead To Opportunity](venues/getoraddbookingdata/convert-lead-to-opportunity.md) - * [Add or Update Opportunity](venues/getoraddbookingdata/add-or-update-opportunity.md) - * [Get Booking](venues/getoraddbookingdata/get-booking.md) - * [Get Booking List](venues/getoraddbookingdata/get-booking-list.md) - * [Get Booking List For Account](venues/getoraddbookingdata/get-booking-list-for-account.md) - * [Get Booking Notes](venues/getoraddbookingdata/get-booking-note-list.md) - * [Get Booking Session List](venues/getoraddbookingdata/get-booking-session-list.md) - * [Get Booking Session Menu List](venues/getoraddbookingdata/get-booking-session-menu-list.md) - * [Get Booking Changelog List](venues/getoraddbookingdata/get-booking-changelog-list.md) - * [Get Booking Attendee (By Hash)](venues/getoraddbookingdata/get-booking-attendee-by-hash.md) - * [Get Booking Attendee List](venues/getoraddbookingdata/get-booking-attendee-list.md) - * [Get Booking Release Schedule](venues/get-booking-release-schedule.md) - * [Add or Update Booking](venues/getoraddbookingdata/add-or-update-booking.md) - * [Change Booking Status](venues/getoraddbookingdata/change-booking-status.md) - * [Add Items To Booking](venues/getoraddbookingdata/add-items-to-booking.md) - * [Add Payment To Booking](venues/getoraddbookingdata/add-payment-to-booking.md) - * [Add Refund To Booking](venues/getoraddbookingdata/add-refund-to-booking.md) - * [Add or Update Booking Attendee](venues/getoraddbookingdata/add-or-update-booking-attendee.md) - * [Add or Update Booking Note](venues/getoraddbookingdata/add-or-update-booking-note.md) - * [Add or Update Booking Session](venues/getoraddbookingdata/add-or-update-booking-session.md) - * [Add or Update Booking Session Beverage](venues/getoraddbookingdata/add-or-update-booking-session-beverage.md) - * [Add or Update Booking Session Menu](venues/getoraddbookingdata/add-or-update-booking-session-menu.md) - * [Add or Update Booking Session Resource](venues/getoraddbookingdata/add-or-update-booking-session-resource.md) - * [Remove Booking Session](venues/getoraddbookingdata/remove-booking-session.md) - * [Remove Booking Session Beverage](venues/getoraddbookingdata/remove-booking-session-beverage.md) - * [Remove Booking Session Menu](venues/getoraddbookingdata/remove-booking-session-menu.md) - * [Remove Booking Session Resource](venues/getoraddbookingdata/remove-booking-session-resource.md) - * [Get Space Blockout List](venues/venuedata/get-space-blockout-list.md) - * [Add or Update Blockout Space](venues/getoraddbookingdata/add-or-update-blockoutspace.md) - * [Remove Blockout Space](venues/getoraddbookingdata/remove-blockoutspace.md) - * [Get Booking Tax List](venues/getoraddbookingdata/get-booking-tax-list.md) - * [Add or Update Opportunity Note](venues/getoraddbookingdata/add-or-update-opp-note.md) - * [Add or Update Booking Package](venues/getoraddbookingdata/add-or-update-booking-package.md) - * [Get Booking Document List](venues/getoraddbookingdata/get-booking-document-list.md) - * [Get Booking BEO List](venues/getoraddbookingdata/get-booking-beo-list.md) - * [Get Booking BEO Version List](venues/getoraddbookingdata/get-booking-beo-version-list.md) - * [Upload Booking Document](venues/getoraddbookingdata/upload-booking-document.md) - * [Booking Accommodation Data](venues/accommodation/README.md) - * [Get Booking Accommodation List](venues/accommodation/get-booking-accommodation-list.md) - * [Add or Update Booking Accommodation](venues/accommodation/add-or-update-booking-accommodation.md) - * [Remove Booking Accommodation](venues/accommodation/remove-booking-accommodation.md) - * [Get Booking Room Reservation List](venues/accommodation/get-booking-room-reservation-list.md) - * [Add or Update Booking Room Reservation](venues/accommodation/add-or-update-booking-room-reservation.md) - * [Update Room Reservation Guest Contact](venues/accommodation/update-booking-room-reservation-guest-contact.md) - * [Remove Booking Room Reservation](venues/accommodation/remove-booking-room-reservation.md) - * [Confirm Booking Room Reservation](venues/accommodation/confirm-booking-room-reservation.md) - * [Cancel Booking Room Reservation](venues/accommodation/cancel-booking-room-reservation.md) - * [Change Status of Booking Room Reservation](venues/accommodation/change-status-of-booking-room-reservation.md) - * [Add or Update Room Counts](venues/accommodation/add-or-update-room-counts.md) - * [Add or Update Room Dynamic Rates](venues/accommodation/add-or-update-room-dynamic-rates.md) - * [Remove Room Dynamic Rates](venues/accommodation/remove-room-dynamic-rates.md) - * [Add or Update Rate Plan Booking Rules](venues/accommodation/add-or-update-rateplan-bookingrules.md) -* [Partner](partner/README.md) - * [Get Venue List](partner/get-venue-list.md) - * [Get Venue](partner/get-venue.md) -* [Invoice](invoice/README.md) - * [Get Invoice List](invoice/get-invoice-list.md) - * [Get Invoice](invoice/get-invoice.md) - * [Get Options](invoice/get-options.md) - * [Add Payment](invoice/add-payment.md) - * [Get Credit Note List](invoice/get-credit-note-list.md) - * [Get Credit Note](invoice/get-credit-note.md) -* [Account](account/README.md) - * [Add or Update Cost Center](account/add-or-update-cost-center.md) - * [Get Cost Center List](account/get-cost-center-list.md) - * [Get Email Log List](account/get-email-log-list.md) - * [Get Industry List](account/get-industry-list.md) - * [Add Error Report](account/add-error-report.md) - * [Get Account User List](account/get-user-list.md) -* [CRM](crm/README.md) - * [Get Lead List](crm/get-lead-list.md) - * [Get Opportunity List](crm/get-opportunity-list.md) - * [Get Opportunity Note List](crm/get-opportuntiy-note-list.md) - * [Get Task List](crm/get-task-list.md) - * [Get Activity List](crm/get-activity-list.md) - * [Get Lead Stage List](crm/get-lead-stage-list.md) - * [Get Lead Type List](crm/get-lead-type-list.md) - * [Get Lead Quality List](crm/get-lead-quality-list.md) - * [Get Lead Source List](crm/get-lead-source-list.md) - * [Get Lead Channel List](crm/get-lead-channel-list.md) - * [Get Lead Note List](crm/get-lead-note-list.md) - * [Add or Update Activity Purpose](crm/add-or-update-activity-purpose.md) - * [Add or Update Activity](crm/add-or-update-activity.md) - * [Add or Update Task](crm/add-or-update-task.md) - * [Add or Update Lead Quality](crm/add-or-update-lead-quality.md) - * [Add or Update Lead Stage](crm/add-or-update-lead-stage.md) - * [Add or Update Lead Channel](crm/add-or-update-lead-channel.md) - * [Add or Update Lead Type](crm/add-or-update-lead-type.md) - * [Add or Update Lead Source](crm/add-or-update-lead-source.md) - * [Add or Update Lead Note](crm/add-or-update-lead-note.md) -* [Notifications](notifications/notifications.md) - * [Company Endpoint](notifications/companies-endpoint.md) - * [Contact Endpoint](notifications/contacts-endpoint.md) - * [CRM Endpoint](notifications/crm-endpoint.md) - * [Invoice Endpoint](notifications/payments-endpoint.md) - * [Booking Endpoint](notifications/venues-endpoint.md) - * [Event Endpoint](notifications/events-endpoint.md) -* [Development Reference](development-reference/README.md) - * [Calculating md5](development-reference/calculating-md5.md) - * [HMAC-SHA1](development-reference/hmac-sha1.md) - * [JSON Encoding](development-reference/json-encoding.md) - * [Timestamp Format](development-reference/timestamp-format.md) - * [Date Format](development-reference/date-format.md) - * [Time Format](development-reference/time-format.md) - * [Address Format](development-reference/address-format.md) - * [URLEncoding](development-reference/urlencoding.md) - * [Timezone List](development-reference/timezone-list.md) -* [Announcements](announcements/README.md) - * [Room Reservation Contact Changes](announcements/venue/room-reservation-contact-update.md) - * [Contact Customfield Changes](announcements/contact/contact-customfield-update.md) - * [Booking Accommodation API Changes](announcements/venue/booking-accommodation-room-options-update.md) - * [Invoice Endpoints Changes](announcements/invoice/invoice-api-changes.md) +- [API Documentation](README.md) +- [Getting Started](getting-started/README.md) + - [Obtaining Keys](getting-started/obtaining-keys.md) + - [Creating the request](getting-started/creating-the-request/README.md) + - [Method/URI Header](getting-started/creating-the-request/method-uri-header.md) + - [Request Headers](getting-started/creating-the-request/request-headers/README.md) + - [Standard Headers](getting-started/creating-the-request/request-headers/standard-headers.md) + - [Custom Headers](getting-started/creating-the-request/request-headers/custom-headers.md) + - [Signing the request](getting-started/creating-the-request/signing-the-request.md) + - [Query Parameters](getting-started/creating-the-request/query-parameters.md) + - [Test Ping](getting-started/test.md) + - [Interpreting the response](getting-started/interpreting-the-response/README.md) + - [Collections](getting-started/interpreting-the-response/collections.md) + - [Pagination](getting-started/interpreting-the-response/pagination.md) + - [Filtering](getting-started/interpreting-the-response/filtering.md) + - [Exceptions](getting-started/interpreting-the-response/exceptions.md) + - [Response Headers](getting-started/interpreting-the-response/response-headers.md) + - [Dates](getting-started/interpreting-the-response/dates.md) + - [Batch](getting-started/batch/README.md) + - [Run](getting-started/batch/run.md) + - [Progress](getting-started/batch/progress.md) + - [Result](getting-started/batch/results.md) + - [Restart](getting-started/batch/restart.md) + - [Repost](getting-started/batch/repost.md) + - [Use Cases](getting-started/use-cases/README.md) + - [CRM Systems](getting-started/use-cases/crm-systems.md) + - [Financial Accounting Systems](getting-started/use-cases/accounting-systems.md) + - [Point Of Sale](getting-started/use-cases/point-of-sale.md) + - [Property Management Systems](getting-started/use-cases/property-management-systems.md) +- [Contacts & Companies](contact/README.md) + - [Get Contact List](contact/get-contact-list.md) + - [Get Contact](contact/get-contact.md) + - [Get Contact Note List](contact/get-contact-note-list.md) + - [Add or Update Contact](contact/add-or-update-contact.md) + - [Get Contact Custom Field Definition](contact/get-custom-field-definition.md) + - [Get Company Custom Field Definition](contact/get-company-custom-field-definition.md) + - [Get Subscription Group List](contact/get-subscription-group-list.md) + - [Add Contacts To Subscription Group](contact/add-contacts-to-subscription-group.md) + - [Remove Contacts From Subscription Group](contact/remove-contacts-from-subscription-group.md) + - [Get Company List](contact/get-company-list.md) + - [Get Company](contact/get-company.md) + - [Get Company Note List](contact/get-company-note-list.md) + - [Add or Update Company](contact/add-or-update-company.md) + - [Add or Update Lead](contact/add-or-update-lead.md) + - [Add or Update Contact Note](contact/add-or-update-contact-note.md) + - [Add or Update Company Note](contact/add-or-update-company-note.md) +- [Event](events/README.md) + - [Add or Update Event](events/add-or-update-event.md) + - [Get Event List](events/get-event-list.md) + - [Get Event](events/get-event.md) + - [Get Registration](events/get-registration.md) + - [Get Registration List](events/get-registration-list.md) + - [Get Attendee](events/get-attendee.md) + - [Get Attendee List](events/get-attendee-list.md) + - [Get Invited Contact List](events/get-invited-contact-list.md) + - [Invite Contacts](events/invite-contacts.md) + - [Get Sponsorship List](events/get-sponsorship-list.md) + - [Get Speaker List](events/get-speaker-list.md) + - [Get Session List](events/get-session-list.md) + - [Create Login Token](events/create-login-token.md) +- [Venue](venues/README.md) + - [Venue Setup Data](venues/venuedata/README.md) + - [Get Venue](venues/venuedata/get-venue.md) + - [Get Venue List](venues/venuedata/get-venue-list.md) + - [Get Venue Room List](venues/venuedata/get-venue-room-list.md) + - [Get Venue Room Rates](venues/venuedata/get-room-rates.md) + - [Get Venue Rate Plan Booking Rules](venues/venuedata/get-rate-plan-booking-rules.md) + - [Get Venue Room Inventory](venues/venuedata/get-room-inventory.md) + - [Get Venue Room Option List](venues/venuedata/get-venue-room-option-list.md) + - [Get Venue Rate Plan List](venues/venuedata/get-venue-rate-plan-list.md) + - [Get Venue Rate Plan Rate List](venues/venuedata/get-rate-plan-rate-list.md) + - [Get Venue Rate Plan Room Rate List](venues/venuedata/get-room-rate-list.md) + - [Get Resource List](venues/venuedata/get-resource-list.md) + - [Get Resource Availability](venues/venuedata/get-resource-availability.md) + - [Get Menu List](venues/venuedata/get-menu-list.md) + - [Get Beverage Package List](venues/venuedata/get-beverage-package-list.md) + - [Get Function Space List](venues/venuedata/get-function-space-list.md) + - [Get Space Blockout List](venues/venuedata/get-space-blockout-list.md) + - [Get Function Space Category List](venues/venuedata/get-function-space-category-list.md) + - [Get Function Space Availability](venues/venuedata/get-function-space-availability.md) + - [Get Available Function Spaces](venues/venuedata/get-avaialable-function-spaces.md) + - [Get Function Space Hire Plan Rate List]() + - [Get Function Space Hire Plan Rate](venues/venuedata/get-space-hire-plan-rate.md) + - [Get Cost Center List](venues/venuedata/get-cost-center-list.md) + - [Get Session Type List](venues/venuedata/get-session-type-list.md) + - [Get Revenue Template List](venues/venuedata/get-revenue-template-list.md) + - [Get Tax List](venues/venuedata/get-tax-list.md) + - [Add or Update Function Space](venues/venuedata/add-or-update-function-space.md) + - [Get Event Type List](venues/venuedata/get-event-type-list.md) + - [Add or Update Function Space Category](venues/venuedata/add-or-update-function-space-category.md) + - [Add or Update Guest Room](venues/venuedata/add-or-update-guest-room.md) + - [Get Booking Custom Field List](venues/venuedata/get-booking-custom-field-list.md) + - [Get Space Hire Plans](venues/get-space-hire-plan-list.md) + - [Get Venue Package List](venues/venuedata/get-venue-package-list.md) + - [Get Venue Package](venues/venuedata/get-venue-package.md) + - [Booking Data](venues/getoraddbookingdata/README.md) + - [Convert Lead To Opportunity](venues/getoraddbookingdata/convert-lead-to-opportunity.md) + - [Add or Update Opportunity](venues/getoraddbookingdata/add-or-update-opportunity.md) + - [Get Booking](venues/getoraddbookingdata/get-booking.md) + - [Get Booking List](venues/getoraddbookingdata/get-booking-list.md) + - [Get Booking List For Account](venues/getoraddbookingdata/get-booking-list-for-account.md) + - [Get Booking Notes](venues/getoraddbookingdata/get-booking-note-list.md) + - [Get Booking Session List](venues/getoraddbookingdata/get-booking-session-list.md) + - [Get Booking Session Menu List](venues/getoraddbookingdata/get-booking-session-menu-list.md) + - [Get Booking Changelog List](venues/getoraddbookingdata/get-booking-changelog-list.md) + - [Get Booking Attendee (By Hash)](venues/getoraddbookingdata/get-booking-attendee-by-hash.md) + - [Get Booking Attendee List](venues/getoraddbookingdata/get-booking-attendee-list.md) + - [Get Booking Release Schedule](venues/get-booking-release-schedule.md) + - [Add or Update Booking](venues/getoraddbookingdata/add-or-update-booking.md) + - [Change Booking Status](venues/getoraddbookingdata/change-booking-status.md) + - [Add Items To Booking](venues/getoraddbookingdata/add-items-to-booking.md) + - [Add Payment To Booking](venues/getoraddbookingdata/add-payment-to-booking.md) + - [Add Refund To Booking](venues/getoraddbookingdata/add-refund-to-booking.md) + - [Add or Update Booking Attendee](venues/getoraddbookingdata/add-or-update-booking-attendee.md) + - [Add or Update Booking Note](venues/getoraddbookingdata/add-or-update-booking-note.md) + - [Add or Update Booking Session](venues/getoraddbookingdata/add-or-update-booking-session.md) + - [Add or Update Booking Session Beverage](venues/getoraddbookingdata/add-or-update-booking-session-beverage.md) + - [Add or Update Booking Session Menu](venues/getoraddbookingdata/add-or-update-booking-session-menu.md) + - [Add or Update Booking Session Resource](venues/getoraddbookingdata/add-or-update-booking-session-resource.md) + - [Remove Booking Session](venues/getoraddbookingdata/remove-booking-session.md) + - [Remove Booking Session Beverage](venues/getoraddbookingdata/remove-booking-session-beverage.md) + - [Remove Booking Session Menu](venues/getoraddbookingdata/remove-booking-session-menu.md) + - [Remove Booking Session Resource](venues/getoraddbookingdata/remove-booking-session-resource.md) + - [Get Space Blockout List](venues/venuedata/get-space-blockout-list.md) + - [Add or Update Blockout Space](venues/getoraddbookingdata/add-or-update-blockoutspace.md) + - [Remove Blockout Space](venues/getoraddbookingdata/remove-blockoutspace.md) + - [Get Booking Tax List](venues/getoraddbookingdata/get-booking-tax-list.md) + - [Add or Update Opportunity Note](venues/getoraddbookingdata/add-or-update-opp-note.md) + - [Add or Update Booking Package](venues/getoraddbookingdata/add-or-update-booking-package.md) + - [Get Booking Document List](venues/getoraddbookingdata/get-booking-document-list.md) + - [Get Booking BEO List](venues/getoraddbookingdata/get-booking-beo-list.md) + - [Get Booking BEO Version List](venues/getoraddbookingdata/get-booking-beo-version-list.md) + - [Upload Booking Document](venues/getoraddbookingdata/upload-booking-document.md) + - [Booking Accommodation Data](venues/accommodation/README.md) + - [Get Booking Accommodation List](venues/accommodation/get-booking-accommodation-list.md) + - [Add or Update Booking Accommodation](venues/accommodation/add-or-update-booking-accommodation.md) + - [Remove Booking Accommodation](venues/accommodation/remove-booking-accommodation.md) + - [Get Booking Room Reservation List](venues/accommodation/get-booking-room-reservation-list.md) + - [Add or Update Booking Room Reservation](venues/accommodation/add-or-update-booking-room-reservation.md) + - [Update Room Reservation Guest Contact](venues/accommodation/update-booking-room-reservation-guest-contact.md) + - [Remove Booking Room Reservation](venues/accommodation/remove-booking-room-reservation.md) + - [Confirm Booking Room Reservation](venues/accommodation/confirm-booking-room-reservation.md) + - [Cancel Booking Room Reservation](venues/accommodation/cancel-booking-room-reservation.md) + - [Change Status of Booking Room Reservation](venues/accommodation/change-status-of-booking-room-reservation.md) + - [Add or Update Room Counts](venues/accommodation/add-or-update-room-counts.md) + - [Add or Update Room Dynamic Rates](venues/accommodation/add-or-update-room-dynamic-rates.md) + - [Remove Room Dynamic Rates](venues/accommodation/remove-room-dynamic-rates.md) + - [Add or Update Rate Plan Booking Rules](venues/accommodation/add-or-update-rateplan-bookingrules.md) +- [Partner](partner/README.md) + - [Get Venue List](partner/get-venue-list.md) + - [Get Venue](partner/get-venue.md) +- [Invoice](invoice/README.md) + - [Get Invoice List](invoice/get-invoice-list.md) + - [Get Invoice](invoice/get-invoice.md) + - [Get Options](invoice/get-options.md) + - [Add Payment](invoice/add-payment.md) + - [Get Credit Note List](invoice/get-credit-note-list.md) + - [Get Credit Note](invoice/get-credit-note.md) +- [Account](account/README.md) + - [Add or Update Cost Center](account/add-or-update-cost-center.md) + - [Get Cost Center List](account/get-cost-center-list.md) + - [Get Email Log List](account/get-email-log-list.md) + - [Get Industry List](account/get-industry-list.md) + - [Add Error Report](account/add-error-report.md) + - [Get Account User List](account/get-user-list.md) +- [CRM](crm/README.md) + - [Get Lead List](crm/get-lead-list.md) + - [Get Opportunity List](crm/get-opportunity-list.md) + - [Get Opportunity Note List](crm/get-opportuntiy-note-list.md) + - [Get Task List](crm/get-task-list.md) + - [Get Activity List](crm/get-activity-list.md) + - [Get Lead Stage List](crm/get-lead-stage-list.md) + - [Get Lead Type List](crm/get-lead-type-list.md) + - [Get Lead Quality List](crm/get-lead-quality-list.md) + - [Get Lead Source List](crm/get-lead-source-list.md) + - [Get Lead Channel List](crm/get-lead-channel-list.md) + - [Get Lead Note List](crm/get-lead-note-list.md) + - [Add or Update Activity Purpose](crm/add-or-update-activity-purpose.md) + - [Add or Update Activity](crm/add-or-update-activity.md) + - [Add or Update Task](crm/add-or-update-task.md) + - [Add or Update Lead Quality](crm/add-or-update-lead-quality.md) + - [Add or Update Lead Stage](crm/add-or-update-lead-stage.md) + - [Add or Update Lead Channel](crm/add-or-update-lead-channel.md) + - [Add or Update Lead Type](crm/add-or-update-lead-type.md) + - [Add or Update Lead Source](crm/add-or-update-lead-source.md) + - [Add or Update Lead Note](crm/add-or-update-lead-note.md) +- [Notifications](notifications/notifications.md) + - [Company Endpoint](notifications/companies-endpoint.md) + - [Contact Endpoint](notifications/contacts-endpoint.md) + - [CRM Endpoint](notifications/crm-endpoint.md) + - [Invoice Endpoint](notifications/payments-endpoint.md) + - [Booking Endpoint](notifications/venues-endpoint.md) + - [Event Endpoint](notifications/events-endpoint.md) +- [Development Reference](development-reference/README.md) + - [Calculating md5](development-reference/calculating-md5.md) + - [HMAC-SHA1](development-reference/hmac-sha1.md) + - [JSON Encoding](development-reference/json-encoding.md) + - [Timestamp Format](development-reference/timestamp-format.md) + - [Date Format](development-reference/date-format.md) + - [Time Format](development-reference/time-format.md) + - [Address Format](development-reference/address-format.md) + - [URLEncoding](development-reference/urlencoding.md) + - [Timezone List](development-reference/timezone-list.md) +- [Announcements](announcements/README.md) + - [Room Reservation Contact Changes](announcements/venue/room-reservation-contact-update.md) + - [Contact Customfield Changes](announcements/contact/contact-customfield-update.md) + - [Booking Accommodation API Changes](announcements/venue/booking-accommodation-room-options-update.md) + - [Invoice Endpoints Changes](announcements/invoice/invoice-api-changes.md) diff --git a/venues/venuedata/get-available-function-spaces.md b/venues/venuedata/get-available-function-spaces.md new file mode 100644 index 0000000..9085d17 --- /dev/null +++ b/venues/venuedata/get-available-function-spaces.md @@ -0,0 +1,119 @@ +# Get Function Space Availability + +{% swagger baseUrl="[PlatformAddress]/api/1.0/" path="venue?action=getAvailableFunctionSpaces" method="post" summary="Get Venue Function Space Availability" %} +{% swagger-description %} +Returns the availability of function spaces in a specific venue. +{% endswagger-description %} + +{% swagger-parameter name="venueId" type="integer" in="path" %} +The id of the venue +{% endswagger-parameter %} + +{% swagger-parameter name="startDatetime" type="timestamp" in="path" %} +The start date and time of the activity. Format is Y-m-d H:i:s +{% endswagger-parameter %} + +{% swagger-parameter name="endDatetime" type="timestamp" in="path" %} +The end date and time of the activity. Format is Y-m-d H:i:s. The date and time range that of availability that can be fetched is 24 hours. +{% endswagger-parameter %} + +{% swagger-parameter name="eventType" type="integer" in="path" %} +The event type id applied to the function space +{% endswagger-parameter %} + +{% swagger-parameter name="pax" type="integer" in="path" %} +The number of attendees that the function space will be used for +{% endswagger-parameter %} + +{% swagger-parameter name="layoutType" type="integer" in="path" %} +The layout type of the function space +{% endswagger-parameter %} + +{% swagger-parameter name="spaceIds" type="array" in="path" %} +Optionally the list of space ids to which availability will be limited. +{% endswagger-parameter %} + +{% swagger-response status="200" description="" %} + +``` +{ + "meta": { + "totalResults": 2, + "start": 0, + "perPage": 100, + "count": 2 + }, + "results": [ + { + "id": 5991, + "name": "Main Hall", + "isAvailable": true, + "reason": null, + "conflict": null + }, + { + "id": 6048, + "name": "Music hall", + "isAvailable": false, + "reason": null, + "conflict": { + "venueId": 1, + "bookingId": 30167, + "sessionId": 25728, + "spaceId": 6048, + "startDate": "2025-07-20 09:00:00", + "endDate": "2025-07-20 10:00:00", + "pax": 10 + } + } + ] +} +``` + +{% endswagger-response %} +{% endswagger %} + +## Example Request + +`Get Venues Function Space List` + +```javascript +{ + "venueId":1, + "startDatetime": "2025-11-26 09:00:00", + "endDatetime": "2025-11-26 10:00:00", + "eventType": 1, + "pax": 10, + "layoutType": 1, + "spaceIds": [1] +} +``` + +## Returns + +| Property | Data Type | Description | +| ----------- | --------- | ---------------------------------------------------------------------- | +| id | integer | The id of space to which the time slots belong. | +| name | string | The name of space | +| isAvailable | boolean | Whether the space is available | +| reason | integer | 1 - The reserviation is unavailable because the space has been blocked | +| conflict | object | The conflict object | + +## Conflict + +| Property | Data Type | Description | +| --------- | --------- | ---------------------------------------------------------------- | +| venueId | integer | The id of venue | +| bookingId | integer | The id of booking | +| sessionId | integer | The id of session | +| spaceId | integer | The id of space | +| startDate | string | The start date of the conflict | +| endDate | string | The end date of the conflict | +| pax | integer | The number of attendees that the function space will be used for | + +## Conflict Reason + +| Value | Description | +| ----- | ---------------------------------------------------------------------------- | +| 1 | The reservation is unavailable because the space has been blocked | +| 2 | The reservation is unavailable because the max pax on space has been crossed | From b7184b287a1b71b1c472efdbca56e155871a6c53 Mon Sep 17 00:00:00 2001 From: Thanh Tran Date: Fri, 18 Jul 2025 08:28:10 +1000 Subject: [PATCH 2/4] IPD-17882: remove formatting --- SUMMARY.md | 416 ++++++++++++++++++++++++++--------------------------- 1 file changed, 208 insertions(+), 208 deletions(-) diff --git a/SUMMARY.md b/SUMMARY.md index 595497a..32a4613 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -1,210 +1,210 @@ # Table of contents -- [API Documentation](README.md) -- [Getting Started](getting-started/README.md) - - [Obtaining Keys](getting-started/obtaining-keys.md) - - [Creating the request](getting-started/creating-the-request/README.md) - - [Method/URI Header](getting-started/creating-the-request/method-uri-header.md) - - [Request Headers](getting-started/creating-the-request/request-headers/README.md) - - [Standard Headers](getting-started/creating-the-request/request-headers/standard-headers.md) - - [Custom Headers](getting-started/creating-the-request/request-headers/custom-headers.md) - - [Signing the request](getting-started/creating-the-request/signing-the-request.md) - - [Query Parameters](getting-started/creating-the-request/query-parameters.md) - - [Test Ping](getting-started/test.md) - - [Interpreting the response](getting-started/interpreting-the-response/README.md) - - [Collections](getting-started/interpreting-the-response/collections.md) - - [Pagination](getting-started/interpreting-the-response/pagination.md) - - [Filtering](getting-started/interpreting-the-response/filtering.md) - - [Exceptions](getting-started/interpreting-the-response/exceptions.md) - - [Response Headers](getting-started/interpreting-the-response/response-headers.md) - - [Dates](getting-started/interpreting-the-response/dates.md) - - [Batch](getting-started/batch/README.md) - - [Run](getting-started/batch/run.md) - - [Progress](getting-started/batch/progress.md) - - [Result](getting-started/batch/results.md) - - [Restart](getting-started/batch/restart.md) - - [Repost](getting-started/batch/repost.md) - - [Use Cases](getting-started/use-cases/README.md) - - [CRM Systems](getting-started/use-cases/crm-systems.md) - - [Financial Accounting Systems](getting-started/use-cases/accounting-systems.md) - - [Point Of Sale](getting-started/use-cases/point-of-sale.md) - - [Property Management Systems](getting-started/use-cases/property-management-systems.md) -- [Contacts & Companies](contact/README.md) - - [Get Contact List](contact/get-contact-list.md) - - [Get Contact](contact/get-contact.md) - - [Get Contact Note List](contact/get-contact-note-list.md) - - [Add or Update Contact](contact/add-or-update-contact.md) - - [Get Contact Custom Field Definition](contact/get-custom-field-definition.md) - - [Get Company Custom Field Definition](contact/get-company-custom-field-definition.md) - - [Get Subscription Group List](contact/get-subscription-group-list.md) - - [Add Contacts To Subscription Group](contact/add-contacts-to-subscription-group.md) - - [Remove Contacts From Subscription Group](contact/remove-contacts-from-subscription-group.md) - - [Get Company List](contact/get-company-list.md) - - [Get Company](contact/get-company.md) - - [Get Company Note List](contact/get-company-note-list.md) - - [Add or Update Company](contact/add-or-update-company.md) - - [Add or Update Lead](contact/add-or-update-lead.md) - - [Add or Update Contact Note](contact/add-or-update-contact-note.md) - - [Add or Update Company Note](contact/add-or-update-company-note.md) -- [Event](events/README.md) - - [Add or Update Event](events/add-or-update-event.md) - - [Get Event List](events/get-event-list.md) - - [Get Event](events/get-event.md) - - [Get Registration](events/get-registration.md) - - [Get Registration List](events/get-registration-list.md) - - [Get Attendee](events/get-attendee.md) - - [Get Attendee List](events/get-attendee-list.md) - - [Get Invited Contact List](events/get-invited-contact-list.md) - - [Invite Contacts](events/invite-contacts.md) - - [Get Sponsorship List](events/get-sponsorship-list.md) - - [Get Speaker List](events/get-speaker-list.md) - - [Get Session List](events/get-session-list.md) - - [Create Login Token](events/create-login-token.md) -- [Venue](venues/README.md) - - [Venue Setup Data](venues/venuedata/README.md) - - [Get Venue](venues/venuedata/get-venue.md) - - [Get Venue List](venues/venuedata/get-venue-list.md) - - [Get Venue Room List](venues/venuedata/get-venue-room-list.md) - - [Get Venue Room Rates](venues/venuedata/get-room-rates.md) - - [Get Venue Rate Plan Booking Rules](venues/venuedata/get-rate-plan-booking-rules.md) - - [Get Venue Room Inventory](venues/venuedata/get-room-inventory.md) - - [Get Venue Room Option List](venues/venuedata/get-venue-room-option-list.md) - - [Get Venue Rate Plan List](venues/venuedata/get-venue-rate-plan-list.md) - - [Get Venue Rate Plan Rate List](venues/venuedata/get-rate-plan-rate-list.md) - - [Get Venue Rate Plan Room Rate List](venues/venuedata/get-room-rate-list.md) - - [Get Resource List](venues/venuedata/get-resource-list.md) - - [Get Resource Availability](venues/venuedata/get-resource-availability.md) - - [Get Menu List](venues/venuedata/get-menu-list.md) - - [Get Beverage Package List](venues/venuedata/get-beverage-package-list.md) - - [Get Function Space List](venues/venuedata/get-function-space-list.md) - - [Get Space Blockout List](venues/venuedata/get-space-blockout-list.md) - - [Get Function Space Category List](venues/venuedata/get-function-space-category-list.md) - - [Get Function Space Availability](venues/venuedata/get-function-space-availability.md) - - [Get Available Function Spaces](venues/venuedata/get-avaialable-function-spaces.md) - - [Get Function Space Hire Plan Rate List]() - - [Get Function Space Hire Plan Rate](venues/venuedata/get-space-hire-plan-rate.md) - - [Get Cost Center List](venues/venuedata/get-cost-center-list.md) - - [Get Session Type List](venues/venuedata/get-session-type-list.md) - - [Get Revenue Template List](venues/venuedata/get-revenue-template-list.md) - - [Get Tax List](venues/venuedata/get-tax-list.md) - - [Add or Update Function Space](venues/venuedata/add-or-update-function-space.md) - - [Get Event Type List](venues/venuedata/get-event-type-list.md) - - [Add or Update Function Space Category](venues/venuedata/add-or-update-function-space-category.md) - - [Add or Update Guest Room](venues/venuedata/add-or-update-guest-room.md) - - [Get Booking Custom Field List](venues/venuedata/get-booking-custom-field-list.md) - - [Get Space Hire Plans](venues/get-space-hire-plan-list.md) - - [Get Venue Package List](venues/venuedata/get-venue-package-list.md) - - [Get Venue Package](venues/venuedata/get-venue-package.md) - - [Booking Data](venues/getoraddbookingdata/README.md) - - [Convert Lead To Opportunity](venues/getoraddbookingdata/convert-lead-to-opportunity.md) - - [Add or Update Opportunity](venues/getoraddbookingdata/add-or-update-opportunity.md) - - [Get Booking](venues/getoraddbookingdata/get-booking.md) - - [Get Booking List](venues/getoraddbookingdata/get-booking-list.md) - - [Get Booking List For Account](venues/getoraddbookingdata/get-booking-list-for-account.md) - - [Get Booking Notes](venues/getoraddbookingdata/get-booking-note-list.md) - - [Get Booking Session List](venues/getoraddbookingdata/get-booking-session-list.md) - - [Get Booking Session Menu List](venues/getoraddbookingdata/get-booking-session-menu-list.md) - - [Get Booking Changelog List](venues/getoraddbookingdata/get-booking-changelog-list.md) - - [Get Booking Attendee (By Hash)](venues/getoraddbookingdata/get-booking-attendee-by-hash.md) - - [Get Booking Attendee List](venues/getoraddbookingdata/get-booking-attendee-list.md) - - [Get Booking Release Schedule](venues/get-booking-release-schedule.md) - - [Add or Update Booking](venues/getoraddbookingdata/add-or-update-booking.md) - - [Change Booking Status](venues/getoraddbookingdata/change-booking-status.md) - - [Add Items To Booking](venues/getoraddbookingdata/add-items-to-booking.md) - - [Add Payment To Booking](venues/getoraddbookingdata/add-payment-to-booking.md) - - [Add Refund To Booking](venues/getoraddbookingdata/add-refund-to-booking.md) - - [Add or Update Booking Attendee](venues/getoraddbookingdata/add-or-update-booking-attendee.md) - - [Add or Update Booking Note](venues/getoraddbookingdata/add-or-update-booking-note.md) - - [Add or Update Booking Session](venues/getoraddbookingdata/add-or-update-booking-session.md) - - [Add or Update Booking Session Beverage](venues/getoraddbookingdata/add-or-update-booking-session-beverage.md) - - [Add or Update Booking Session Menu](venues/getoraddbookingdata/add-or-update-booking-session-menu.md) - - [Add or Update Booking Session Resource](venues/getoraddbookingdata/add-or-update-booking-session-resource.md) - - [Remove Booking Session](venues/getoraddbookingdata/remove-booking-session.md) - - [Remove Booking Session Beverage](venues/getoraddbookingdata/remove-booking-session-beverage.md) - - [Remove Booking Session Menu](venues/getoraddbookingdata/remove-booking-session-menu.md) - - [Remove Booking Session Resource](venues/getoraddbookingdata/remove-booking-session-resource.md) - - [Get Space Blockout List](venues/venuedata/get-space-blockout-list.md) - - [Add or Update Blockout Space](venues/getoraddbookingdata/add-or-update-blockoutspace.md) - - [Remove Blockout Space](venues/getoraddbookingdata/remove-blockoutspace.md) - - [Get Booking Tax List](venues/getoraddbookingdata/get-booking-tax-list.md) - - [Add or Update Opportunity Note](venues/getoraddbookingdata/add-or-update-opp-note.md) - - [Add or Update Booking Package](venues/getoraddbookingdata/add-or-update-booking-package.md) - - [Get Booking Document List](venues/getoraddbookingdata/get-booking-document-list.md) - - [Get Booking BEO List](venues/getoraddbookingdata/get-booking-beo-list.md) - - [Get Booking BEO Version List](venues/getoraddbookingdata/get-booking-beo-version-list.md) - - [Upload Booking Document](venues/getoraddbookingdata/upload-booking-document.md) - - [Booking Accommodation Data](venues/accommodation/README.md) - - [Get Booking Accommodation List](venues/accommodation/get-booking-accommodation-list.md) - - [Add or Update Booking Accommodation](venues/accommodation/add-or-update-booking-accommodation.md) - - [Remove Booking Accommodation](venues/accommodation/remove-booking-accommodation.md) - - [Get Booking Room Reservation List](venues/accommodation/get-booking-room-reservation-list.md) - - [Add or Update Booking Room Reservation](venues/accommodation/add-or-update-booking-room-reservation.md) - - [Update Room Reservation Guest Contact](venues/accommodation/update-booking-room-reservation-guest-contact.md) - - [Remove Booking Room Reservation](venues/accommodation/remove-booking-room-reservation.md) - - [Confirm Booking Room Reservation](venues/accommodation/confirm-booking-room-reservation.md) - - [Cancel Booking Room Reservation](venues/accommodation/cancel-booking-room-reservation.md) - - [Change Status of Booking Room Reservation](venues/accommodation/change-status-of-booking-room-reservation.md) - - [Add or Update Room Counts](venues/accommodation/add-or-update-room-counts.md) - - [Add or Update Room Dynamic Rates](venues/accommodation/add-or-update-room-dynamic-rates.md) - - [Remove Room Dynamic Rates](venues/accommodation/remove-room-dynamic-rates.md) - - [Add or Update Rate Plan Booking Rules](venues/accommodation/add-or-update-rateplan-bookingrules.md) -- [Partner](partner/README.md) - - [Get Venue List](partner/get-venue-list.md) - - [Get Venue](partner/get-venue.md) -- [Invoice](invoice/README.md) - - [Get Invoice List](invoice/get-invoice-list.md) - - [Get Invoice](invoice/get-invoice.md) - - [Get Options](invoice/get-options.md) - - [Add Payment](invoice/add-payment.md) - - [Get Credit Note List](invoice/get-credit-note-list.md) - - [Get Credit Note](invoice/get-credit-note.md) -- [Account](account/README.md) - - [Add or Update Cost Center](account/add-or-update-cost-center.md) - - [Get Cost Center List](account/get-cost-center-list.md) - - [Get Email Log List](account/get-email-log-list.md) - - [Get Industry List](account/get-industry-list.md) - - [Add Error Report](account/add-error-report.md) - - [Get Account User List](account/get-user-list.md) -- [CRM](crm/README.md) - - [Get Lead List](crm/get-lead-list.md) - - [Get Opportunity List](crm/get-opportunity-list.md) - - [Get Opportunity Note List](crm/get-opportuntiy-note-list.md) - - [Get Task List](crm/get-task-list.md) - - [Get Activity List](crm/get-activity-list.md) - - [Get Lead Stage List](crm/get-lead-stage-list.md) - - [Get Lead Type List](crm/get-lead-type-list.md) - - [Get Lead Quality List](crm/get-lead-quality-list.md) - - [Get Lead Source List](crm/get-lead-source-list.md) - - [Get Lead Channel List](crm/get-lead-channel-list.md) - - [Get Lead Note List](crm/get-lead-note-list.md) - - [Add or Update Activity Purpose](crm/add-or-update-activity-purpose.md) - - [Add or Update Activity](crm/add-or-update-activity.md) - - [Add or Update Task](crm/add-or-update-task.md) - - [Add or Update Lead Quality](crm/add-or-update-lead-quality.md) - - [Add or Update Lead Stage](crm/add-or-update-lead-stage.md) - - [Add or Update Lead Channel](crm/add-or-update-lead-channel.md) - - [Add or Update Lead Type](crm/add-or-update-lead-type.md) - - [Add or Update Lead Source](crm/add-or-update-lead-source.md) - - [Add or Update Lead Note](crm/add-or-update-lead-note.md) -- [Notifications](notifications/notifications.md) - - [Company Endpoint](notifications/companies-endpoint.md) - - [Contact Endpoint](notifications/contacts-endpoint.md) - - [CRM Endpoint](notifications/crm-endpoint.md) - - [Invoice Endpoint](notifications/payments-endpoint.md) - - [Booking Endpoint](notifications/venues-endpoint.md) - - [Event Endpoint](notifications/events-endpoint.md) -- [Development Reference](development-reference/README.md) - - [Calculating md5](development-reference/calculating-md5.md) - - [HMAC-SHA1](development-reference/hmac-sha1.md) - - [JSON Encoding](development-reference/json-encoding.md) - - [Timestamp Format](development-reference/timestamp-format.md) - - [Date Format](development-reference/date-format.md) - - [Time Format](development-reference/time-format.md) - - [Address Format](development-reference/address-format.md) - - [URLEncoding](development-reference/urlencoding.md) - - [Timezone List](development-reference/timezone-list.md) -- [Announcements](announcements/README.md) - - [Room Reservation Contact Changes](announcements/venue/room-reservation-contact-update.md) - - [Contact Customfield Changes](announcements/contact/contact-customfield-update.md) - - [Booking Accommodation API Changes](announcements/venue/booking-accommodation-room-options-update.md) - - [Invoice Endpoints Changes](announcements/invoice/invoice-api-changes.md) +* [API Documentation](README.md) +* [Getting Started](getting-started/README.md) + * [Obtaining Keys](getting-started/obtaining-keys.md) + * [Creating the request](getting-started/creating-the-request/README.md) + * [Method/URI Header](getting-started/creating-the-request/method-uri-header.md) + * [Request Headers](getting-started/creating-the-request/request-headers/README.md) + * [Standard Headers](getting-started/creating-the-request/request-headers/standard-headers.md) + * [Custom Headers](getting-started/creating-the-request/request-headers/custom-headers.md) + * [Signing the request](getting-started/creating-the-request/signing-the-request.md) + * [Query Parameters](getting-started/creating-the-request/query-parameters.md) + * [Test Ping](getting-started/test.md) + * [Interpreting the response](getting-started/interpreting-the-response/README.md) + * [Collections](getting-started/interpreting-the-response/collections.md) + * [Pagination](getting-started/interpreting-the-response/pagination.md) + * [Filtering](getting-started/interpreting-the-response/filtering.md) + * [Exceptions](getting-started/interpreting-the-response/exceptions.md) + * [Response Headers](getting-started/interpreting-the-response/response-headers.md) + * [Dates](getting-started/interpreting-the-response/dates.md) + * [Batch](getting-started/batch/README.md) + * [Run](getting-started/batch/run.md) + * [Progress](getting-started/batch/progress.md) + * [Result](getting-started/batch/results.md) + * [Restart](getting-started/batch/restart.md) + * [Repost](getting-started/batch/repost.md) + * [Use Cases](getting-started/use-cases/README.md) + * [CRM Systems](getting-started/use-cases/crm-systems.md) + * [Financial Accounting Systems](getting-started/use-cases/accounting-systems.md) + * [Point Of Sale](getting-started/use-cases/point-of-sale.md) + * [Property Management Systems](getting-started/use-cases/property-management-systems.md) +* [Contacts & Companies](contact/README.md) + * [Get Contact List](contact/get-contact-list.md) + * [Get Contact](contact/get-contact.md) + * [Get Contact Note List](contact/get-contact-note-list.md) + * [Add or Update Contact](contact/add-or-update-contact.md) + * [Get Contact Custom Field Definition](contact/get-custom-field-definition.md) + * [Get Company Custom Field Definition](contact/get-company-custom-field-definition.md) + * [Get Subscription Group List](contact/get-subscription-group-list.md) + * [Add Contacts To Subscription Group](contact/add-contacts-to-subscription-group.md) + * [Remove Contacts From Subscription Group](contact/remove-contacts-from-subscription-group.md) + * [Get Company List](contact/get-company-list.md) + * [Get Company](contact/get-company.md) + * [Get Company Note List](contact/get-company-note-list.md) + * [Add or Update Company](contact/add-or-update-company.md) + * [Add or Update Lead](contact/add-or-update-lead.md) + * [Add or Update Contact Note](contact/add-or-update-contact-note.md) + * [Add or Update Company Note](contact/add-or-update-company-note.md) +* [Event](events/README.md) + * [Add or Update Event](events/add-or-update-event.md) + * [Get Event List](events/get-event-list.md) + * [Get Event](events/get-event.md) + * [Get Registration](events/get-registration.md) + * [Get Registration List](events/get-registration-list.md) + * [Get Attendee](events/get-attendee.md) + * [Get Attendee List](events/get-attendee-list.md) + * [Get Invited Contact List](events/get-invited-contact-list.md) + * [Invite Contacts](events/invite-contacts.md) + * [Get Sponsorship List](events/get-sponsorship-list.md) + * [Get Speaker List](events/get-speaker-list.md) + * [Get Session List](events/get-session-list.md) + * [Create Login Token](events/create-login-token.md) +* [Venue](venues/README.md) + * [Venue Setup Data](venues/venuedata/README.md) + * [Get Venue](venues/venuedata/get-venue.md) + * [Get Venue List](venues/venuedata/get-venue-list.md) + * [Get Venue Room List](venues/venuedata/get-venue-room-list.md) + * [Get Venue Room Rates](venues/venuedata/get-room-rates.md) + * [Get Venue Rate Plan Booking Rules](venues/venuedata/get-rate-plan-booking-rules.md) + * [Get Venue Room Inventory](venues/venuedata/get-room-inventory.md) + * [Get Venue Room Option List](venues/venuedata/get-venue-room-option-list.md) + * [Get Venue Rate Plan List](venues/venuedata/get-venue-rate-plan-list.md) + * [Get Venue Rate Plan Rate List](venues/venuedata/get-rate-plan-rate-list.md) + * [Get Venue Rate Plan Room Rate List](venues/venuedata/get-room-rate-list.md) + * [Get Resource List](venues/venuedata/get-resource-list.md) + * [Get Resource Availability](venues/venuedata/get-resource-availability.md) + * [Get Menu List](venues/venuedata/get-menu-list.md) + * [Get Beverage Package List](venues/venuedata/get-beverage-package-list.md) + * [Get Function Space List](venues/venuedata/get-function-space-list.md) + * [Get Space Blockout List](venues/venuedata/get-space-blockout-list.md) + * [Get Function Space Category List](venues/venuedata/get-function-space-category-list.md) + * [Get Function Space Availability](venues/venuedata/get-function-space-availability.md) + * [Get Available Function Spaces](venues/venuedata/get-available-function-spaces.md) + * [Get Function Space Hire Plan Rate List]() + * [Get Function Space Hire Plan Rate](venues/venuedata/get-space-hire-plan-rate.md) + * [Get Cost Center List](venues/venuedata/get-cost-center-list.md) + * [Get Session Type List](venues/venuedata/get-session-type-list.md) + * [Get Revenue Template List](venues/venuedata/get-revenue-template-list.md) + * [Get Tax List](venues/venuedata/get-tax-list.md) + * [Add or Update Function Space](venues/venuedata/add-or-update-function-space.md) + * [Get Event Type List](venues/venuedata/get-event-type-list.md) + * [Add or Update Function Space Category](venues/venuedata/add-or-update-function-space-category.md) + * [Add or Update Guest Room](venues/venuedata/add-or-update-guest-room.md) + * [Get Booking Custom Field List](venues/venuedata/get-booking-custom-field-list.md) + * [Get Space Hire Plans](venues/get-space-hire-plan-list.md) + * [Get Venue Package List](venues/venuedata/get-venue-package-list.md) + * [Get Venue Package](venues/venuedata/get-venue-package.md) + * [Booking Data](venues/getoraddbookingdata/README.md) + * [Convert Lead To Opportunity](venues/getoraddbookingdata/convert-lead-to-opportunity.md) + * [Add or Update Opportunity](venues/getoraddbookingdata/add-or-update-opportunity.md) + * [Get Booking](venues/getoraddbookingdata/get-booking.md) + * [Get Booking List](venues/getoraddbookingdata/get-booking-list.md) + * [Get Booking List For Account](venues/getoraddbookingdata/get-booking-list-for-account.md) + * [Get Booking Notes](venues/getoraddbookingdata/get-booking-note-list.md) + * [Get Booking Session List](venues/getoraddbookingdata/get-booking-session-list.md) + * [Get Booking Session Menu List](venues/getoraddbookingdata/get-booking-session-menu-list.md) + * [Get Booking Changelog List](venues/getoraddbookingdata/get-booking-changelog-list.md) + * [Get Booking Attendee (By Hash)](venues/getoraddbookingdata/get-booking-attendee-by-hash.md) + * [Get Booking Attendee List](venues/getoraddbookingdata/get-booking-attendee-list.md) + * [Get Booking Release Schedule](venues/get-booking-release-schedule.md) + * [Add or Update Booking](venues/getoraddbookingdata/add-or-update-booking.md) + * [Change Booking Status](venues/getoraddbookingdata/change-booking-status.md) + * [Add Items To Booking](venues/getoraddbookingdata/add-items-to-booking.md) + * [Add Payment To Booking](venues/getoraddbookingdata/add-payment-to-booking.md) + * [Add Refund To Booking](venues/getoraddbookingdata/add-refund-to-booking.md) + * [Add or Update Booking Attendee](venues/getoraddbookingdata/add-or-update-booking-attendee.md) + * [Add or Update Booking Note](venues/getoraddbookingdata/add-or-update-booking-note.md) + * [Add or Update Booking Session](venues/getoraddbookingdata/add-or-update-booking-session.md) + * [Add or Update Booking Session Beverage](venues/getoraddbookingdata/add-or-update-booking-session-beverage.md) + * [Add or Update Booking Session Menu](venues/getoraddbookingdata/add-or-update-booking-session-menu.md) + * [Add or Update Booking Session Resource](venues/getoraddbookingdata/add-or-update-booking-session-resource.md) + * [Remove Booking Session](venues/getoraddbookingdata/remove-booking-session.md) + * [Remove Booking Session Beverage](venues/getoraddbookingdata/remove-booking-session-beverage.md) + * [Remove Booking Session Menu](venues/getoraddbookingdata/remove-booking-session-menu.md) + * [Remove Booking Session Resource](venues/getoraddbookingdata/remove-booking-session-resource.md) + * [Get Space Blockout List](venues/venuedata/get-space-blockout-list.md) + * [Add or Update Blockout Space](venues/getoraddbookingdata/add-or-update-blockoutspace.md) + * [Remove Blockout Space](venues/getoraddbookingdata/remove-blockoutspace.md) + * [Get Booking Tax List](venues/getoraddbookingdata/get-booking-tax-list.md) + * [Add or Update Opportunity Note](venues/getoraddbookingdata/add-or-update-opp-note.md) + * [Add or Update Booking Package](venues/getoraddbookingdata/add-or-update-booking-package.md) + * [Get Booking Document List](venues/getoraddbookingdata/get-booking-document-list.md) + * [Get Booking BEO List](venues/getoraddbookingdata/get-booking-beo-list.md) + * [Get Booking BEO Version List](venues/getoraddbookingdata/get-booking-beo-version-list.md) + * [Upload Booking Document](venues/getoraddbookingdata/upload-booking-document.md) + * [Booking Accommodation Data](venues/accommodation/README.md) + * [Get Booking Accommodation List](venues/accommodation/get-booking-accommodation-list.md) + * [Add or Update Booking Accommodation](venues/accommodation/add-or-update-booking-accommodation.md) + * [Remove Booking Accommodation](venues/accommodation/remove-booking-accommodation.md) + * [Get Booking Room Reservation List](venues/accommodation/get-booking-room-reservation-list.md) + * [Add or Update Booking Room Reservation](venues/accommodation/add-or-update-booking-room-reservation.md) + * [Update Room Reservation Guest Contact](venues/accommodation/update-booking-room-reservation-guest-contact.md) + * [Remove Booking Room Reservation](venues/accommodation/remove-booking-room-reservation.md) + * [Confirm Booking Room Reservation](venues/accommodation/confirm-booking-room-reservation.md) + * [Cancel Booking Room Reservation](venues/accommodation/cancel-booking-room-reservation.md) + * [Change Status of Booking Room Reservation](venues/accommodation/change-status-of-booking-room-reservation.md) + * [Add or Update Room Counts](venues/accommodation/add-or-update-room-counts.md) + * [Add or Update Room Dynamic Rates](venues/accommodation/add-or-update-room-dynamic-rates.md) + * [Remove Room Dynamic Rates](venues/accommodation/remove-room-dynamic-rates.md) + * [Add or Update Rate Plan Booking Rules](venues/accommodation/add-or-update-rateplan-bookingrules.md) +* [Partner](partner/README.md) + * [Get Venue List](partner/get-venue-list.md) + * [Get Venue](partner/get-venue.md) +* [Invoice](invoice/README.md) + * [Get Invoice List](invoice/get-invoice-list.md) + * [Get Invoice](invoice/get-invoice.md) + * [Get Options](invoice/get-options.md) + * [Add Payment](invoice/add-payment.md) + * [Get Credit Note List](invoice/get-credit-note-list.md) + * [Get Credit Note](invoice/get-credit-note.md) +* [Account](account/README.md) + * [Add or Update Cost Center](account/add-or-update-cost-center.md) + * [Get Cost Center List](account/get-cost-center-list.md) + * [Get Email Log List](account/get-email-log-list.md) + * [Get Industry List](account/get-industry-list.md) + * [Add Error Report](account/add-error-report.md) + * [Get Account User List](account/get-user-list.md) +* [CRM](crm/README.md) + * [Get Lead List](crm/get-lead-list.md) + * [Get Opportunity List](crm/get-opportunity-list.md) + * [Get Opportunity Note List](crm/get-opportuntiy-note-list.md) + * [Get Task List](crm/get-task-list.md) + * [Get Activity List](crm/get-activity-list.md) + * [Get Lead Stage List](crm/get-lead-stage-list.md) + * [Get Lead Type List](crm/get-lead-type-list.md) + * [Get Lead Quality List](crm/get-lead-quality-list.md) + * [Get Lead Source List](crm/get-lead-source-list.md) + * [Get Lead Channel List](crm/get-lead-channel-list.md) + * [Get Lead Note List](crm/get-lead-note-list.md) + * [Add or Update Activity Purpose](crm/add-or-update-activity-purpose.md) + * [Add or Update Activity](crm/add-or-update-activity.md) + * [Add or Update Task](crm/add-or-update-task.md) + * [Add or Update Lead Quality](crm/add-or-update-lead-quality.md) + * [Add or Update Lead Stage](crm/add-or-update-lead-stage.md) + * [Add or Update Lead Channel](crm/add-or-update-lead-channel.md) + * [Add or Update Lead Type](crm/add-or-update-lead-type.md) + * [Add or Update Lead Source](crm/add-or-update-lead-source.md) + * [Add or Update Lead Note](crm/add-or-update-lead-note.md) +* [Notifications](notifications/notifications.md) + * [Company Endpoint](notifications/companies-endpoint.md) + * [Contact Endpoint](notifications/contacts-endpoint.md) + * [CRM Endpoint](notifications/crm-endpoint.md) + * [Invoice Endpoint](notifications/payments-endpoint.md) + * [Booking Endpoint](notifications/venues-endpoint.md) + * [Event Endpoint](notifications/events-endpoint.md) +* [Development Reference](development-reference/README.md) + * [Calculating md5](development-reference/calculating-md5.md) + * [HMAC-SHA1](development-reference/hmac-sha1.md) + * [JSON Encoding](development-reference/json-encoding.md) + * [Timestamp Format](development-reference/timestamp-format.md) + * [Date Format](development-reference/date-format.md) + * [Time Format](development-reference/time-format.md) + * [Address Format](development-reference/address-format.md) + * [URLEncoding](development-reference/urlencoding.md) + * [Timezone List](development-reference/timezone-list.md) +* [Announcements](announcements/README.md) + * [Room Reservation Contact Changes](announcements/venue/room-reservation-contact-update.md) + * [Contact Customfield Changes](announcements/contact/contact-customfield-update.md) + * [Booking Accommodation API Changes](announcements/venue/booking-accommodation-room-options-update.md) + * [Invoice Endpoints Changes](announcements/invoice/invoice-api-changes.md) From e097d46fbd33bee65b4d7c0a22c17a94638c10d7 Mon Sep 17 00:00:00 2001 From: Thanh Tran Date: Tue, 29 Jul 2025 13:11:15 +1000 Subject: [PATCH 3/4] IPD-17882: Update description --- venues/venuedata/get-available-function-spaces.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/venues/venuedata/get-available-function-spaces.md b/venues/venuedata/get-available-function-spaces.md index 9085d17..2930248 100644 --- a/venues/venuedata/get-available-function-spaces.md +++ b/venues/venuedata/get-available-function-spaces.md @@ -1,8 +1,9 @@ -# Get Function Space Availability +# Get Available Function Spaces {% swagger baseUrl="[PlatformAddress]/api/1.0/" path="venue?action=getAvailableFunctionSpaces" method="post" summary="Get Venue Function Space Availability" %} {% swagger-description %} -Returns the availability of function spaces in a specific venue. +Returns the availability of function spaces in a specific venue based on some filtering criteria. This API is different to [Get Function Space Availability](get-function-space-availability.md) in that besides allowing extra filtering, it returns the availability of function spaces for a maximum date-time range of 24 hours only. Availability timeslots are not returned. + {% endswagger-description %} {% swagger-parameter name="venueId" type="integer" in="path" %} @@ -75,7 +76,7 @@ Optionally the list of space ids to which availability will be limited. ## Example Request -`Get Venues Function Space List` +`Get Available function spaces` ```javascript { From d099e83f35458a66be351fe1d2aa8809b6deaa06 Mon Sep 17 00:00:00 2001 From: Thanh Tran Date: Wed, 30 Jul 2025 07:33:19 +1000 Subject: [PATCH 4/4] IPD-17882: Add conflict reason constant --- .../get-available-function-spaces.md | 31 ++++++++++--------- 1 file changed, 16 insertions(+), 15 deletions(-) diff --git a/venues/venuedata/get-available-function-spaces.md b/venues/venuedata/get-available-function-spaces.md index 2930248..0a4e2a2 100644 --- a/venues/venuedata/get-available-function-spaces.md +++ b/venues/venuedata/get-available-function-spaces.md @@ -56,7 +56,7 @@ Optionally the list of space ids to which availability will be limited. "id": 6048, "name": "Music hall", "isAvailable": false, - "reason": null, + "reason": 3, "conflict": { "venueId": 1, "bookingId": 30167, @@ -92,13 +92,21 @@ Optionally the list of space ids to which availability will be limited. ## Returns -| Property | Data Type | Description | -| ----------- | --------- | ---------------------------------------------------------------------- | -| id | integer | The id of space to which the time slots belong. | -| name | string | The name of space | -| isAvailable | boolean | Whether the space is available | -| reason | integer | 1 - The reserviation is unavailable because the space has been blocked | -| conflict | object | The conflict object | +| Property | Data Type | Description | +| ----------- | --------- | ---------------------------------------------------------------------------------------------------------------------------- | +| id | integer | The id of space to which the time slots belong. | +| name | string | The name of space | +| isAvailable | boolean | Whether the space is available | +| reason | integer | The [reason](get-available-function-spaces.md#conflict-reason) why the space is unavailable | +| conflict | object | The [conflict](get-available-function-spaces.md#conflict) object if there is a conflict with an existing booking reservation | + +## Conflict Reason + +| Value | Description | +| ----- | ---------------------------------------------------------------------------------------------- | +| 1 | The reservation is unavailable because the space has been blocked | +| 2 | The reservation is unavailable because the max pax on space has been crossed | +| 3 | The reservation is unavailable because there is a conflict with an exiting booking reservation | ## Conflict @@ -111,10 +119,3 @@ Optionally the list of space ids to which availability will be limited. | startDate | string | The start date of the conflict | | endDate | string | The end date of the conflict | | pax | integer | The number of attendees that the function space will be used for | - -## Conflict Reason - -| Value | Description | -| ----- | ---------------------------------------------------------------------------- | -| 1 | The reservation is unavailable because the space has been blocked | -| 2 | The reservation is unavailable because the max pax on space has been crossed |