API Overview

Version 1.02

All API methods require an HTTP User-Agent header and a token to execute. All requests without a user-agent header will fail with a 403 Forbidden HTTP response status code. A token is obtained by calling the authenticate method. Please check out the authentication method's documentation for instructions on its use.

If you wish to use the Meetingmax API to integrate with us, credentials must first be created by the Meetingmax licensee via the MCP application interface.

API Endpoint

https://mmxreservations.com/api/v102

Attendee Integration

The Reservation Attendee Integration is a way to provide customer details to the Meetingmax system prior to them beginning the reservation process. Systems that wish to use the Reservation Attendee Integration will need to leverage the Meetingmax API in order to provide the customer details and to generate the unique URL that the system would send customers to in order to book their reservation.

How it Works

When a customer has already provided their contact details in your own event management system, you can streamline their process when making their reservation by providing Meetingmax their contact information.

Once the customer data has been successfully inserted into the Meetingmax system, you can then generate a special URL based on their attendee identifier. When the customer goes to this URL, they will then be able to go through the reservation process, except that their contact information will already be loaded into the personal contact fields based on what was provided earlier.

Authenticate

This method assigns a token to be used for all other methods. Tokens are only active for 30 minutes, after which a new token must be acquired.

Arguments

key

required

This is the value provided to you within the MCP under the API tab.

systemIdentifier

required

The Meetingmax licensee number to create a token for.

Definition

https://mmxreservations.com/api/v102/authenticate

Example Request

$ curl https://mmxreservations.com/api/v102/authenticate /
   -d key=ABC123 /
   -d systemIdentifier=1

Example Response

{
  "token": "qt4oectadqdc6g4lalhezzk1pa5aa6iv"
}

Events

Events are core to Meetingmax. You can use the API to retrieve event information including the event name, address and start/end dates.

Get Event

This method retrieves the details for a given event.

Arguments

token

required

The token provided by the authenticate method.

eventId

required

The event ID to retrieve data for.

Definition

https://mmxreservations.com/api/v102/getevent

Example Request

$ curl https://mmxreservations.com/api/v102/getevent /
   -d token=qt4oectadqdc6g4lalhezzk1pa5aa6iv /
   -d eventId=14

Example Response

{
  "eventId": 14,
  "name": "Stanley Cup Finals",
  "city": "Vancouver",
  "state": "BC",
  "address": "800 Griffiths Way",
  "zip": "V6B 6G1",
  "startDate": "2020-02-04T00:00:00+00:00",
  "endDate": "2020-02-08T00:00:00+00:00",
  "cutOffDate": "2020-02-03T00:00:00+00:00"
}

Get Group Codes

This method will return all group codes for the specified event.

Arguments

token

required

The token provided by the authenticate method.

eventId

required

The event ID to retrieve data for.

Definition

https://mmxreservations.com/api/v102/getgroupcodes

Post Event Question

This method registers a question for an event or a default question for all events.

Arguments

`token` required	The token provided by the authenticate method.
`eventId` required	The event ID the question will be registered for. Provide an event ID of 0 to register a default question for all events.
`questionId` required	A numeric question ID assigned to the question in your system. This ID will be provided back when requesting answers to this question.
`question` required	The question that will be presented to the user during the reservation process.
`type` required	A string representing the type of input element to be provided to the user used to answer the question. Allowed types are: `1` for a text area and `2` for a select box.
`options` required for type 2	Options are only required when a select element is chosen for the type. The option list to display in the select element must be provided in JSON format. For example, provide `{1: "Yes", 0: "No"}` to show an option Yes with value 1 and an option No with value 0.
`enabled` required	A boolean `true` or `false` which will enable or disable the question.

Definition

https://mmxreservations.com/api/v102/posteventquestion

Get Event Questions

This method will retrieve the questions that have been set for an event or set as a default for all events. Providing an eventId of 0 will return only the default questions.

Arguments

token

required

The token provided by the authenticate method.

eventId

required

This is the event ID that the questions were made for. Providing an event ID of 0 will return questions that would be displayed to all events.

Definition

https://mmxreservations.com/api/v102/geteventquestions

Room Pickup

This method provides the room pickup for a given event broken down into hotels and room types.

Arguments

token

required

The token provided by the authenticate method.

eventId

required

The event ID to retrieve the room pickup information for.

Definition

https://mmxreservations.com/api/v102/getpickup

Post Event Hotel Actualized

This method allows you to provide actual pickup numbers for hotels on specific dates. These numbers can then be compared internally with the Meetingmax pickup numbers to highlight any discrepancies.

NOTE: Because of the complexity of providing actualized values as an array, you may want to consider providing those values within a JSON payload in the body of the request.

Arguments

`token` required	The token provided by the authenticate method.
`eventId` required	The event ID to set actualized numbers for.
`hotelId` required	The hotel ID the actualized numbers are for.
`actualized` required	An array containing `date` (in the format `30-Oct-2014`) and `rooms` (integer) values. For example: `[{"date": "30-Oct-2014", "rooms": 20}, {"date": "31-Oct-2014": "rooms": 15}]`

Definition

https://mmxreservations.com/api/v102/posteventhotelactualized

Hotels

You may interact and retrieve information about your current hotel selection using the hotel methods here.

Get Hotels

This method retrieves the details of hotels that are currently assigned to an event.

Arguments

`token` required	The token provided by the authenticate method.
`eventId` required	The event ID to retrieve data for.
`simpleview` optional default: false	A boolean, if true, will respond with the Simpleview identifier for each hotel listed.
`hotelId` optional	This integer will filter the results by whichever hotel ID is provided.
`hotelName` optional	A string containing the hotel name to filter the results on.
`city` optional	String representing the city of the hotels to filter results on.
`state` optional	String representing the state or province to filter the hotel results on.
`status` optional	This is a string representing the current status of the hotels you would like returned as a result. By default, all statuses will be returned. Allowed statuses are: `enabled` and `disabled`.

Definition

https://mmxreservations.com/api/v102/gethotels

Get Shopping View Hotels

The shopping view allows your visitors to get a sense of what hotels are available before committing to making a reservation for an event.

This method retrieves the hotels to display in the shopping view. Omitting the dates will list all the hotels that have been added to the event.

The hotels in the event must have the Show Hotel Under Shopping View checkbox selected in order to be included in the list.

When dates are provided, inventory is checked for the main block, and only hotels with inventory will be included. All rooms available for the dates (and their rates) will be included.

Arguments

`token` required	The token provided by the authenticate method.
`eventId` required	The event ID to retrieve data for.
`checkInDate` optional	The check-in date for the availability search. Format must be `yyyy-mm-dd` e.g. 2010-01-31.
`checkOutDate` optional	The check-out date for the availability search. Format must be `yyyy-mm-dd` e.g. 2010-01-31.
`scope` optional default: full	This is a string used to return a condensed version or the full set of data. Allowed scopes are: `full` and `simple`.
`showPastCutoff` optional default: false	When true, include results for any hotels that are past cut-off.

Definition

https://mmxreservations.com/api/v102/getshoppingviewhotels

Reservations

When a customer books one or more rooms in the Meetingmax system, a new reservation object is created. Reservations objects can be looked up through the API method below.

Get Reservation

This method retrieves the details for reservations.

A result set larger than 1000 records will be paginated accordingly, and require the optional page parameter.

Arguments

`token` required	The token provided by the authenticate method.
`eventId` required	The event ID to retrieve data for.
`fullContactInfo` optional default: false	A boolean, when true, will provide additional information regarding the reservation contact (such as their address, company name, and preferred guest number).
`detailedEventInfo` optional default: false	If true, will provide additional event information for the reservation.
`detailedHotelInfo` optional default: false	If true, will provide additional hotel information for the reservation.
`detailedSubBlockInfo` optional default: false	If true, will provide additional sub-block information for the reservation.
`customField` optional default: false	This is a boolean value, when true, it will provide any custom fields associated with the current reservation in the results.
`simpleview` optional default: false	A boolean, if true, will respond with the Simpleview identifier for each hotel listed.
`page` optional default: 1	An integer representing the current page of results to return.
`reservationNumber` optional	An integer representing a specific reservation to return information on.
`hotelId` optional	This integer will filter the results by whichever hotel ID is provided.
`contactEmail` optional	A string containing the contact's email address that the results will be filtered on.
`contactLastName` optional	A string containing the contact's last name that the results will be filtered on.
`guestLastName` optional	A string containing the guest's last name that the results will be filtered on.
`confirmationNumber` optional	This is an optional string containing the confirmation number assigned by the hotel to filter the results on.
`groupCode` optional	A string containing the group code (assigned to a particular sub-block) to filter the results on.
`reservationStatus` optional	Reservations you would like returned as a result. By default, all statuses will be returned. Allowed statuses are: `new`, `accepted`, `cancelled`, and `declined`.
`roomStatus` optional	A string representing the status of a room in a given reservation. By default, all room statuses are allowed. Allowed statuses are: `active` and `cancelled`.
`companyName` optional	A string containing the company name to filter the results for.
`label1` optional	The value of label1 to filter the results on.
`label2` optional	The value of label2 to filter the results on.
`attendeeId` optional	This is the attendee ID that was provided to the system when the attendee was added to the system (prior to the reservation being created) and by providing this value the results will be filtered on any reservations this attendee is attached to.
`modifiedAfterDate` optional	Only fetch reservations with modifications since the given timestamp. Timestamp must be in the format: `30-Oct-2014 10:10am`

Definition

https://mmxreservations.com/api/v102/getreservation

Get Reservation Page Count

This method retrieves the number of pages in the reservation result set paginated every 1000 records.

Arguments

`token` required	The token provided by the authenticate method.
`eventId` required	The event ID to retrieve data for.
`reservationNumber` optional	An integer representing a specific reservation to return information on.
`hotelId` optional	This integer will filter the results by whichever hotel ID is provided.
`contactEmail` optional	A string containing the contact's email address that the results will be filtered on.
`contactLastName` optional	A string containing the contact's last name that the results will be filtered on.
`guestLastName` optional	A string containing the guest's last name that the results will be filtered on.
`confirmationNumber` optional	This is an optional string containing the confirmation number assigned by the hotel to filter the results on.
`groupCode` optional	A string containing the group code (assigned to a particular sub-block) to filter the results on.
`reservationStatus` optional	This is a specific string representing the status of the reservations you would like returned as a result. By default, all statuses will be returned. Allowed statuses are: `new`, `accepted`, `cancelled`, and `declined`.
`roomStatus` optional	A string representing the status of a room in a given reservation. By default, all room statuses are allowed. Allowed statuses are: `active` and `cancelled`.
`companyName` optional	A string containing the company name to filter the results for.
`label1` optional	The value of label1 to filter the results on.
`label2` optional	The value of label2 to filter the results on.
`attendeeId` optional	This is the attendee ID that was provided to the system when the attendee was added to the system (prior to the reservation being created) and by providing this value the results will be filtered on any reservations this attendee is attached to.
`modifiedAfterDate` optional	Only fetch reservations with modifications since the given timestamp. Timestamp must be in the format: `30-Oct-2014 10:10am`

Definition

https://mmxreservations.com/api/v102/getreservationpagecount

Get Event Link

This method generates the link to make a reservation for an event. If the attendee ID and registration system event ID are provided, that attendee's data will be automatically populated in the reservation process.

Arguments

`token` required	The token provided by the authenticate method.
`eventId` optional	The event ID to generate the link for. If not provided, a link to the event selection page will be returned.
`attendeeId` optional; required if providing registrationEventId	The reference to the attendee to automatically populate fields in the registration process with. If providing the attendee ID you must also provide the registration event ID.
`registrationEventId` optional; required if providing attendeeId	The registration system's event ID that is associated with the provided attendee ID.

Definition

https://mmxreservations.com/api/v102/geteventlink

Get Group Code Link

This method generates the link to make a reservation for an event specific to a group code for its special inventory.

Arguments

`token` required	The token provided by the authenticate method.
`eventId` required	The event ID to create the registration link for.
`groupCode` required	The group code that will be used to generate the reservation link for. This will allow access to its special inventory.
`attendeeId` required	The reference to the attendee to automatically populate fields in the registration process with.
`registrationEventId` required	The registration system's event ID that is associated with the provided attendee ID.

Definition

https://mmxreservations.com/api/v102/getgroupcodelink

Get Edit Reservation Link

Retrieves the link to edit a particular reservation based on the provided reservation number.

Arguments

token

required

The token provided by the authenticate method.

reservationNumber

required

The reservation number to retrieve the link for.

https://mmxreservations.com/api/v102/geteditreservationlink

Post Mailing List Opt-In

Due to the General Data Protection Regulation (GDPR) the Mailing List Opt-in functionality is no longer available.

Definition

https://mmxreservations.com/api/v102/postmailinglistoptin

Get Mailing List Opt-In

Due to the General Data Protection Regulation (GDPR) the Mailing List Opt-in functionality is no longer available.

Definition

https://mmxreservations.com/api/v102/getmailinglistoptin

Get Mailing List Opt-In Page Count

Due to the General Data Protection Regulation (GDPR) the Mailing List Opt-in functionality is no longer available.

Definition

https://mmxreservations.com/api/v102/getmailinglistoptinpagecount

Post Custom Field

This method allows you to add additional fields to be associated with a reservation or attendee.

Arguments

token

required

The token provided by the authenticate method.

name

required

This is a string representing the name of the custom field to be added. It will also appear within the MCP's advanced search form as a field name.

eventId

optional

Providing the event ID will associate the custom field with that particular event and not allow it to be displayed for reservations of other events.

Definition

https://mmxreservations.com/api/v102/postcustomfield

Get Custom Fields

This method returns all the custom fields registered for all events.

If an event ID is provided, only those custom fields specific to that event will be returned.

Arguments

token

required

The token provided by the authenticate method.

eventId

required

If provided, the results will be filtered on the event ID specified here.

Definition

https://mmxreservations.com/api/v102/getcustomfields

Post Custom Field Values

This method will register a value to an existing custom field for an attendee or reservation.

This method requires either the reservation ID or the registration system event ID and the attendee ID.

Arguments

`token` required	The token provided by the authenticate method.
`customFieldId` required	The ID of the custom field to register a value for.
`value` required	The value to register for the specified custom field.
`reservationId` required if not providing attendeeId and registrationEventId	This is the reservation ID of the reservation to apply the custom field value to.
`attendeeId` required if not providing reservationId	This is the attendee ID to apply the custom field value to.
`registrationEventId` required if not providing reservationId	This is the registration system's event ID (external to the Meetingmax system) to apply the custom field value to.

Definition

https://mmxreservations.com/api/v102/postcustomfieldvalue

Get Transfer Link

This method generates a link to transfer a given reservation to a new attendee.

Arguments

`token` required	The token provided by the authenticate method.
`reservationId` required	The reservation ID to generate the link for.
`attendeeId` required	The reference to the attendee that you wish to transfer the reservation to.
`registrationEventId` required	The registration system's event ID that is associated with the provided attendee ID.

Definition

https://mmxreservations.com/api/v102/gettransferlink

Example Request

$ curl https://mmxreservations.com/api/v102/gettransferlink /
   -d token=qt4oectadqdc6g4lalhezzk1pa5aa6iv /
   -d reservationId=1234 /
   -d attendeeId=1 /
   -d registrationEventId=1

Example Response

{
  "url": "https:\/\/mmxreservations.com\/development123\/admin\/reservation\/transfer\/reservationId\/1234\/attendeeId\/1\/registrationEventId\/1"
}

Attendees

Attendees are those who end up making the reservations for your event. You can get attendee information and anything presented to attendees (like questions) through this API.

Post Attendee

This method creates an attendee in the Meetingmax system which is then used to pre-populate fields during the registration process. This method is also used to perform updates on existing attendees (as long as the attendee ID and registration event ID match a record in the system).

Due to the Meetingmax personal information policy, the data provided through this API call will be scrubbed from the system 90 days after the event it's attached to has ended, or 90 days after the last time that this record has been updated.

Arguments

`token` required	The token provided by the authenticate method.
`attendeeId` required	The attendee ID that is assigned to the registration. This ID is an external value that is used to reference the attendee in original system.
`registrationEventId` required	This is the event ID assigned to the registration in the registration system. This ID is an external value provided by the registration system and should not be confused with a Meetingmax event ID.
`updateReservation` optional default: false	When updating an existing attendee, this parameter can be used to push the data to the linked reservation, if one exists.
`email` optional	The email address for the contact.
`ccemail` optional	The contact's credit card email address (use a comma-separated list for more than one).
`salutation` optional	The salutation for the contact.
`firstName` optional	The first name for the contact.
`lastName` optional	The last name for the contact.
`companyName` optional	The company name for the contact.
`address` optional	First line of the contact's address.
`address2` optional	Second line of the contact's address.
`city` optional	The city for the contact.
`state` optional	The state or province for the contact.
`zip` optional	The zip or postal code for the contact.
`country` optional	The country for the contact. This can be its full name, or be in either ISO2 or ISO3 format.
`phone` optional	The phone number for the contact.

Definition

https://mmxreservations.com/api/v102/postattendee

Get Attendee Answers

This method will retrieve answers provided by customers during the reservation process for the any event questions provided.

Arguments

token

required

The token provided by the authenticate method.

eventId

required

The event ID to retrieve data for.

page

optional

default: 1

An integer representing the current page of results to return.

Definition

https://mmxreservations.com/api/v102/getattendeeanswers

Get Attendee Answers Page Count

This method retrieves the number of pages in the result set paginated every 1000 records.

Arguments

token

required

The token provided by the authenticate method.

eventId

required

The event ID to retrieve data for.

Definition

https://mmxreservations.com/api/v102/getattendeeanswerspagecount