API Overview

Version 1.01

All API methods require a token to execute. 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/v101

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/v101/authenticate

Example Request

$ curl https://mmxreservations.com/api/v101/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/v101/getevent

Example Request

$ curl https://mmxreservations.com/api/v101/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/v101/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/v101/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/v101/geteventquestions

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/v101/gethotels

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/v101/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/v101/getreservationpagecount

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/v101/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/v101/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/v101/getmailinglistoptinpagecount

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/v101/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/v101/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/v101/getattendeeanswerspagecount