Meeting and Event Demand Distribution

What is it?

The Meeting and Event Demand Distribution suite of APIs enables partners to integrate Rfp flow with MB. Once a channel partner is integrated, they can send Rfp into MB and they can retrieve updates on the Rfp or any related business entity like BusinessData, Proposal, etc.

How do I get it?

Minimum Requirements

1. The caller must have active integration with Amadeus Group & Event Distribution (MeetingBroker).
2. The caller must have locations that are enabled for S&C integration in MeetingBroker.

How do I use it?

The rest of this documentation gives an overview of the suggested best practice to build a powerful and effective integration with the Meeting and Event Demand Distribution APIs

Overview of Get RFP

The new modern API endpoint is available that can be utilized to Get RFPs from MeetingBroker using the new contracts.

API Workflow

The following diagram illustrates the overall flow.

1. Caller sends a GET request using a previously obtained authentication token and RFP id.
2. Amadeus System synchronously replies back with RFP information.

Note:Alternatively, a caller can also fetch a RFP as indicated below.

1. Caller sends a GET request using a previously obtained authentication token, meeting ID, type of location and location ID.
2. Amadeus System synchronously replies back with RFP information.

Note: All the RFP APIs require AHWS authentication.

Get RFP Endpoint

You can get a RFP by using this endpoint. You will need to pass a RFP ID or meeting ID - location type - location ID combination using a GET operation.

Request URL

https://api.newmarketinc.com/v2/rfp/{internalRFPID}

https://api.newmarketinc.com/v2/meeting/{meetingId}/rfp/{locationType}-{locationId}

Request Headers

Request

Required URI parameters when using internal RFP ID

https://api.newmarketinc.com/v2/rfp/{internalRFPID} 

A RFP can be accessed by specifying internal RFP ID or by specifying meeting ID - location type - location ID combination.

Required URI parameters when using a meeting ID.

 https://api.newmarketinc.com/v2/rfp/meeting/{meetingId}/rfp/{locationType}-{locationId}

Alternatively, a RFP can be accessed by specifying a meeting ID and location type - location ID combination

Models

RFP

• Rfp - contains all the information about a request for a meeting.
• AdditionalInformation - Additional information for the requested RFP.
• Address - Address information for the organization or contact.
• AnnotatedDate - Specific information about a date.
• Budget - Specific information about a budget.
• Comment - Contains name and comment text.
• Commission - Contains information about a commission.
• EventBlock - The event block is a list of events and requirements associated with an RFP.
• EventRequirement - contains information about a specific event.
• GuestRoomBlock - contains information about guest rooms for the RFP.
• GuestRoomOccupancy - contains information about the occupancy of the guest room block.
• GuestRoomRequirement - contains guest room requirements for a specific day within the guest room block.
• LocationIdentifier - contains location type information about a location in the RFP.
• MeetingInfo - Information about any included meetings, from the number of attendees to the number of events and nights.
• Organization - contains information about an agency or company associated with the RFP.
• Person - contains information aabout any people associated with the RFP.
• PhoneNumber - contains information about an organization's or person's phone or fax.
• RfpOrganization - contains organization information about the inbound RFP.
• Sender - contains information about who is sending the RFP.
• Site - contains information about the location the RFP is being sent to.

Following structures are key attributes that comprise of this request message as a part of the URI construct.

• rfpID or
• meetingID-locationIdentifier

Following structures are key attributes that comprise of this response message

• RFP

The following sections include further details about each area.

data

rfp

additionalInformation

address

annotatedDate

budget

comment

commission

eventBlock

eventRequirement

guestRoomOccupancy

guestRoomBlock

guestRoomRequirement

locationIdentifier

meetingInfo

organization

person

phoneNumber

rfpOrganization

sender

site

Overview of Get Proposal

This Proposal endpoint (GET) is a Public REST API that can be utilized to Get Proposals from MeetingBroker. The purpose is to provide channels partners/planners with near real-time proposal data associated with MeetingBroker RFP.

API Workflow

The following diagram illustrates the process for Get Proposal.

1. The caller requests the access token.
2. The system response contains the token.
3. The caller sends a GET request using a valid OAuth2 token and Proposal Guid.
4. Amadeus System synchronously replies with Proposal information with 200 ok response.

Get Proposal Endpoint

You can get Proposals by using this endpoint. You will need to pass a Proposal GUID using a GET operation.

Request URL

https://api.newmarketinc.com/proposal/v1/proposal/{id}

Request Headers

Request

https://api.newmarketinc.com/proposal/v1/proposal/{id} 

Proposals can be accessed by specifying Proposal GUID.

Required Fields

The following fields are required when submitting a request to the endpoint.

Requirements & Configuration

Models

Below is a guide to the various attributes required to build the data contract for getting a Proposal.

The GetProposal endpoint allows the user to get proposal information from MeetingBroker. The following sections describe the Proposal response returned by the GetProposal endpoint:

• GetProposalResponse - The returned proposal.
• Proposal - Contains all the information about the proposal.
• locationIdentifier - Contains location type information about a location in the proposal.
• GuestRoomBlock - Contains information about guest rooms for the proposal.
• GuestRoomAvailablity - Contains information about the availabilty of guest room.
• GuestRoomOccupancy - Contains information about the occupancy of guest romm block.
• EventBlock - The event block is a list of events and requirements associated with a proposal.
• EventAvailablity - Contains information about the event for proposal.
• Prices - Specific information about a price.
• MeetingInfo - Information about any included meetings,from the number of attendees to the number of events and nights.
• AnnotatedDate - Specific information about a date.
• Comment - Contains name and comment text.
• Message - Contains messages about proposal.
• Attachment - Contains file and information about file.
• Questions - Contains information about any questions in the RFP.
• Answer - Specific information about an answer.
• ResponseChoices - Contains information about ResponseChoice for Question.
• ResponseUnits - Contains information about ResponseUnits for Question

The following sections include further details about each block.

getProposalResponse

Details about the getProposalResponse are listed in this section.

proposal

Details about the proposal are listed in this section.

locationIdentifier

Details about the locationIdentifier are listed in this section.

guestRoomBlock

Details about the guestRoomBlock are listed in this section.

guestRoomAvailablity

Details about the guestRoomAvailablity are listed in this section.

guestRoomOccupancy

Details about the guestRoomOccupancy are listed in this section.

eventBlock

Details about the eventBlock are listed in this section.

eventAvailablity

Details about the eventAvailablity are listed in this section.

prices

Details about the prices are listed in this section.

meetingInfo

Details about the meetingInfo are listed in this section.

annotatedDate

Details about the annotatedDate are listed in this section.

comment

Details about the comment are listed in this section.

messages

Details about the messages are listed in this section.

attachment

Details about the attachment are listed in this section.

questions

Details about the questions are listed in this section.

answer

Details about the answer are listed in this section.

responseChoice

Details about the responseChoice are listed in this section.

responseUnit

Details about the responseUnit are listed in this section.

Overview of Post Proposal

This Proposal endpoint (POST) is a Public REST API that can be utilized to post proposals to MeetingBroker. The purpose is to provide a means for MeetingBroker integrated third party systems to publish proposal response data to MeetingBroker.

API Workflow

The following diagram illustrates the process for Post Proposal.

1. The caller requests the access token.
2. The system response contains the token.
3. The caller sends a Post request using a valid OAuth2 token.
4. Amadeus System synchronously replies with a 202 accepted response.

Post Proposal Endpoint

You can post Proposals by using this endpoint. You will need to pass a Proposal payload using a POST operation.

Request URL

https://api.newmarketinc.com/proposal/v1/proposal

Request Headers

Request

https://api.newmarketinc.com/proposal/v1/proposal

Required Fields

The following fields are required when submitting a request to the endpoint.

Requirements & Configuration

Models

Below is a guide to the various attributes required to build the data contract for posting a Proposal.

The Proposal endpoint allows the user to post proposal information to MeetingBroker. The following sections describe the Proposal model:

• PostProposalParameters - The Proposal to be sent or updated provided by the integrated system.
• LocationIdentifier - Contains location type information about a location in the Proposal.
• Proposal - Contains all the information about the proposal.
• Question - Contains information about any questions in the Proposal.
• EventBlock - The event block is a list of events and requirements associated with a proposal.
• AnnotatedDate - Specific information about a date.
• Prices - Specific information about a price.
• EventAvailabilities - Contains information about the event for proposal.
• GuestRoomBlocks - Contains information about guest rooms for the proposal.
• GuestRoomAvailabilities - Contains information about the availability of guest room.
• GuestRoomOccupancies - Contains information about the occupancy of guest room block.
• Answer - Specific information about an answer.
• ResponseChoice - Contains information about ResponseChoice for Question.
• ResponseUnits - Contains information about ResponseUnits for Question.

The following sections include further details about each block.
NOTE: The Validation Rule column lists specific field specifications you must follow to ensure the data is validated.

PostProposalParameters

Details about the PostProposalParameters are listed in this section.

LocationIdentifier

Details about the LocationIdentifier are listed in this section.

Proposals

Details about the Proposal are listed in this section.

PostProposal_Question

Details about the Question are listed in this section. Currently not supported.

PostProposal_EventBlock

The Event Block is a list of of events associated with the Proposal.

PostProposal_AnnotatedDate

Details about the AnnotatedDate are listed in this section.

PostProposal_Price

Details about the PostProposal_Price are listed in this section.

PostProposal_EventAvailability

Details about the PostProposal_EventAvailability are listed in this section.

PostProposal_GuestRoomBlock

Details about the PostProposal_GuestRoomBlock are listed in this section.

PostProposal_GuestRoomAvailability

Details about the PostProposal_GuestRoomAvailability are listed in this section.

PostProposal_GuestRoomOccupancy

Details about the PostProposal_GuestRoomOccupancy are listed in this section.

PostProposal_Answer

Details about the Answer are listed in this section. Currently not supported.

PostProposal_ResponseChoice

Details about the PostProposal_ResponseChoice are listed in this section. Currently not supported.

PostProposal_ResponseUnit

Details about the PostProposal_ResponseUnit are listed in this section. Currently not supported.

Overview of Get BusinessData

This BusinessData endpoint (GET) is a Public REST API that can be utilized to get business data information from MeetingBroker. The purpose is to provide channels partners/planners with near real-time business data associated with MeetingBroker RFP.

API Workflow

The following diagram illustrates the process for Get BusinessData.

1. The caller requests the access token.
2. The system response contains the token.
3. The caller sends a GET request using a valid OAuth2 token and RfpId or MeetingId with LocationId.
4. Amadeus System synchronously replies with business data information with 200 ok response.

Get BusinessData Endpoint

You can get business data by using this endpoint. You will need to pass a RfpId or MeetingId with LocationId using a GET operation.

Request URL

https://api.newmarketinc.com/businessdata/v2/rfp/{rfpId}/businessData[?businessDataType]

https://api.newmarketinc.com/businessdata/v2/meeting/{meetingId}/rfp/{idType}-{locationId}/businessData[?businessDataType]

Request Headers

Request

Required URI parameters when using amadeus system RFP ID

https://api.newmarketinc.com/businessdata/v2/rfp/{rfpId}/businessData[?businessDataType] 

Business data can be accessed by specifying RfpId.

Required Fields

The following fields are required when submitting a request to the endpoint.

Required URI parameters when using Meeting ID and Location ID with LocationType ID

https://api.newmarketinc.com/businessdata/v2/meeting/{meetingId}/rfp/{idType}-{locationId}/businessData[?businessDataType] 

Business data can be accessed by specifying MeetingId and LocationId with LocationTypeId.

Required Fields

The following fields are required when submitting a request to the endpoint.

Requirements & Configuration

Models

Below is a guide to the various attributes required to build the data contract for getting a business data information.

The GetBusinessData endpoint allows the user to get business data information from MeetingBroker. The following sections describe the business data response returned by the GetBusinessData endpoint:

• BusinessDataInfo - Information about the booking business services.
• EventBlock - Contains all the information about events.
• GuestRoomBlock - Contains the information about the guest room for the RFP.
• Person - Contains details of the person who is the owner of the business opportunity.
• LocationIdentifier - Contains the location type information about the location in the RFP.
• OtherIncomeItem - Details of the item requested by meeting planner beyond guest room cost and event cost.
• EventBusinessData - Detailed information about each event included in the EventBlock.
• GuestRoomBusinessData - Detailed information about each room included in the GuestRoomBlock.
• Address - Address details of the individual person.
• PhoneNumber - Phone number details of the individual person.
• GuestRoomOccupancy - Contains information about the occupancy of guest room block.
• AnnotatedDate - Specific information about a date.
• Revenue - Revenue details like food cost, beverage cost, rental cost, other cost, resource cost.

The following sections include further details about each block.

businessDataInfo

Information about the booking business services are listed in this section.

eventBlock

Information about events are listed in this section.

guestRoomBlock

Contains the information about the guest room for the RFP.

person

Contains details of the person who is the owner of the business opportunity.

locationIdentifier

Contains the location type information about the location in the RFP.

otherIncomeItem

Describes the details of the item requested by meeting planner above and beyond guestroom cost and event costs (food, beverage, function room rental and resources).

eventBusinessData

Detailed information about each event included in the event block.

guestRoomBusinessData

Detailed information about each room included in the GuestRoomBlock.

address

Address details of the individual person.

phoneNumber

Phone number details of the individual person.

guestRoomOccupancy

Contains information about the occupancy of guest room block.

annotatedDate

Specific information about a date.

revenue

Revenue details like food cost, beverage cost, rental cost, other cost, resource cost

Overview of Get Notification

The GetNotification endpoint is a Public REST API that can be utilized by demand partners and enterprise customers to retrieve notifications based on receiver actions related to RFPs they have previously submitted. For example, once a receiver has viewed the RFP, an "RFP viewed" notification will be retrieved using the GetNotification endpoint.

API Workflow

The following diagram illustrates the process for retrieving notifications.

1. User/Channel requests authentication using a UserName, Password, ClientId, and ClientSecret. Using a previously obtained authentication token, the caller submits a request to the Get Notification endpoint to retrieve notifications. Meeting Broker validates and processes the data included in the requests.
2. Amadeus' MeetingBroker returns a response indicating if the payload was accepted for processing or not.

Get Notification Endpoint

You can get notifications by using this endpoint. You can pass NotificationType, Limit, Autocommit (optional parameters) using a GET operation.

Request URL

https://api.newmarketinc.com/api/aks-notification/v1/Notification[?notificationType][&limit][&autocommit]

Request Headers

Models

Below is a guide to the various attributes contained in the retrieved notifications response.

The Get Notification endpoint allows the user to retrieve notifications using a notification type and a limit. The following sections describe the notification response returned by the Get Notification endpoint:

• NotificationReceiveRequest - The notification request data.
• NotificationResponse - The returned notification.
• Notification - contains information about the notifications.
• EventDetail - contains notification type information about the notification.
• MBNotificationEventData - a base object for the different notification type responses.
• RfpNotificationEventData - a base object for the different notification type responses.
• RfpViewedEventData - contains information about the response for the RfpViewed notification type.
• RfpCreatedEventData - contains information about the response for the RfpCreated notification type.
• ActualBusinessDataUpdatedEventData - contains information about the ActualBusinessDataUpdated notification type.
• AgreedBusinessDataUpdatedEventData - contains information about the AgreedBusinessDataUpdated notification type.
• BlockedBusinessDataUpdatedEventData - contains information about the BlockedBusinessDataUpdated notification type.
• PickedUpBusinessDataUpdatedEventData - contains information about the PickedUpBusinessDataUpdated notification type.
• BusinessStatusChangedEventData - contains information about the BusinessStatusChanged notification type.
• ProposalSentEventData - contains information about the ProposalSent notification type.
• Rfp - contains Rfp information.
• ReceiverLocation - contains information about the receiver location.
• RfpStatus - contains the possible Rfp Status values.
• BusinessStatus - contains the possible Business Status values.
• NotificationType - contains the possible Notifications Type values.
• ResourceType - contains the possible Resource Type values.

The following sections include further details about each block.

NotificationReceiveRequest

Details about the Notification Request are listed in this section.

NotificationResponse

Details about the Notification Response are listed in this section.

{
    "data": {
        "notifications": [
            {
                "id": "fce96254-bfc9-4b8f-9313-7324e5d3c57b",
                "eventDetail": {
                    "resourceId": "1cc743cc-e667-4802-9c5f-6c1ee9324a9e",
                    "resourceType": "Rfp",
                    "subject": "RfpCreated",
                    "eventData": {
                        "channelId": 50000273,
                        "locationId": "50066902",
                        "rfp": {
                            "meetingId": "PrvRst Get-aa627c95-1d98-4104-a4d7-a7be5b12a770",
                            "rfpId": "1cc743cc-e667-4802-9c5f-6c1ee9324a9e"
                        },
                        "receiverLocation": {
                            "locationId": "50066902",
                            "referenceNumber": "293"
                        },
                        "rfpStatus": "New"
                    },
                    "publishedOn": "2020-10-15T12:35:38Z"
                }
            },
            {
                "id": "934558c9-71f6-4d5b-8406-bfad9f118c94",
                "eventDetail": {
                    "resourceId": "f8794e1b-e1d7-4aff-98b1-150ed488f5c6",
                    "resourceType": "Rfp",
                    "subject": "RfpCreated",
                    "eventData": {
                        "channelId": 50000273,
                        "locationId": "50066902",
                        "rfp": {
                            "meetingId": "PrvRst-c9ef8f43-5e28-43a5-b9b8-93de65a73394",
                            "rfpId": "f8794e1b-e1d7-4aff-98b1-150ed488f5c6"
                        },
                        "receiverLocation": {
                            "locationId": "50066902",
                            "referenceNumber": "293"
                        },
                        "rfpStatus": "New"
                    },
                    "publishedOn": "2020-10-15T12:35:38Z"
                }
            }
        ]
    },
    "correlationId": "b60a1d1e-eaa9-4897-930c-87441dc26f09"
}

Notification

Details about the Notification are listed in this section.

EventDetail

Details about the EventDetail are listed in this section.

MBNotificationEventData

Details about the MBNotificationEventData are listed in this section. This is the base object for the all the other event data objects.

RfpNotificationEventData

Details about the RfpNotificationEventData are listed in this section. Inherits from MBNotificationEventData.

RfpViewedEventData

Details about the RfpViewedEventData are listed in this section. Inherits from RfpNotificationEventData.

{
    "RfpViewedEventData": 
    {
        "ChannelId": 417,
        "LocationId": 50002734,
        "Rfp": 
        {
            "MeetingId": "58750",
            "RfpId": "1cb4b3e4-f79f-4e10-9b68-b503e865edbf"
        },
        "ReceiverLocation": 
        {
            "LocationId": 50002734,
            "ReferenceNumber": null,
            "ChannelExternalLocationId": null
        },
        "RfpStatus": "New"
    }
}

Note, any empty or null JSON data will be removed prior to sending response.
        

RfpCreatedEventData

Details about the RfpCreatedEventData are listed in this section. Inherits from RfpNotificationEventData.

{
    "RfpCreatedEventData": 
    {
        "ChannelId": 50002166,
        "LocationId": 50066924,
        "Rfp": 
        {
            "MeetingId": "PerformanceTest 0ca250d8-c648-40ce-8d77-5858f84f4f",
            "RfpId": "1cb4b3e4-f79f-4e10-9b68-b503e865edbf"
        },
        "ReceiverLocation": 
        {
            "LocationId": 50066924,
            "ReferenceNumber": "3566",
            "ChannelExternalLocationId": null
        },
        "RfpStatus": "New"
    }
}

Note, any empty or null JSON data will be removed prior to sending response.
                    

ActualBusinessDataUpdatedEventData

Details about the ActualBusinessDataUpdatedEventData are listed in this section. Inherits from RfpNotificationEventData.

{
    "ActualBusinessDataUpdatedEventData": 
    {
        "ChannelId": 313,
        "LocationId": 2917,
        "Rfp": 
        {
            "MeetingId": "a015000000Cb7m3AAB",
            "RfpId": "96727572-c170-49dd-a4f3-402d3c84cf83"
        },
        "ReceiverLocation": 
        {
            "LocationId": 2917,
            "ReferenceNumber": "5681",
            "ChannelExternalLocationId": null
        },
        "RfpStatus": "TurnedDown"
    }
}

Note, any empty or null JSON data will be removed prior to sending response.
                    

AgreedBusinessDataUpdatedEventData

Details about the AgreedBusinessDataUpdatedEventData are listed in this section. Inherits from RfpNotificationEventData.

{
    "AgreedBusinessDataUpdatedEventData": 
    {
        "ChannelId": 417,
        "LocationId": 2584,
        "Rfp": 
        {
            "MeetingId": "48668",
            "RfpId": "faf7b963-7222-446c-814c-5b7375bcfa09"
        },
        "ReceiverLocation": 
        {
            "LocationId": 2584,
            "ReferenceNumber": "6415",
            "ChannelExternalLocationId": null
        },
        "RfpStatus": "Cancelled"
    }
}

Note, any empty or null JSON data will be removed prior to sending response.
                    

BlockedBusinessDataUpdatedEventData

Details about the BlockedBusinessDataUpdatedEventData are listed in this section. Inherits from RfpNotificationEventData.

{
    "BlockedBusinessDataUpdatedEventData": 
    {
        "ChannelId": 313,
        "LocationId": 2917,
        "Rfp": 
        {
            "MeetingId": "a015000000Cb7m3AAB",
            "RfpId": "96727572-c170-49dd-a4f3-402d3c84cf83"
        },
        "ReceiverLocation": 
        {
            "LocationId": 2917,
            "ReferenceNumber": "5681",
            "ChannelExternalLocationId": null
        },
        "RfpStatus": "TurnedDown"
    }
}

Note, any empty or null JSON data will be removed prior to sending response.
                    

PickedUpBusinessDataUpdatedEventData

Details about the PickedUpBusinessDataUpdatedEventData are listed in this section. Inherits from RfpNotificationEventData.

{
    "PickedUpBusinessDataUpdatedEventData": 
    {
        "ChannelId": 313,
        "LocationId": 2917,
        "Rfp": 
        {
            "MeetingId": "a015000000Cmyp8AAB",
            "RfpId": "d1d2304a-783b-4a86-b909-e361b1fb8145"
        },
        "ReceiverLocation": 
        {
            "LocationId": 2917,
            "ReferenceNumber": "5681",
            "ChannelExternalLocationId": null
        },
        "RfpStatus": "TurnedDown"
    }
}

Note, any empty or null JSON data will be removed prior to sending response.
                    

BusinessStatusChangedEventData

Details about the BusinessStatusChangedEventData are listed in this section. Inherits from RfpNotificationEventData.

{
    "BusinessStatusChangedEventData":
    {
        "ChannelId": 50000203,
        "LocationId": 50002327,
        "Rfp":
        {
            "MeetingId": "1031871.2592",
            "RfpId": "7d47cded-cdd4-40a9-8e16-1e6c2e8e52da"
        },
        "ReceiverLocation":
        {
            "LocationId": 50002327,
            "ReferenceNumber": null,
            "ChannelExternalLocationId": "DAC85728-B00F-4204-BAC0-02751EE297B4"
        },
        "RfpStatus": "TurnedDown",
        "BusinessStatus": "Inquiry",
        "BusinessId": null,
        "ExternalLostBusinessReason": null
    }
}

Note, any empty or null JSON data will be removed prior to sending response.
                    

ProposalSentEventData

Details about the ProposalSentEventData are listed in this section. Inherits from RfpNotificationEventData.

{
    "ProposalSentEventData":
    {
        "ChannelId": 439,
        "LocationId": 50000423,
        "Rfp":
        {
            "MeetingId": "80978",
            "RfpId": "7d47cded-cdd4-40a9-8e16-1e6c2e8e52da"
        },
        "ProposalUrl": "https://my.mb.com/UIToolKit/?SiteId=71&PageType=Proposal&ExtProposalId=ABC123",
        "ProposalId": "DAC85728-B00F-4204-BAC0-02751EE297B4"
    }
}

Note, any empty or null JSON data will be removed prior to sending response.

Rfp

Details about the Rfp are listed in this section.

ReceiverLocation

Details about the ReceiverLocation are listed in this section.

RfpStatus Values

These are the RFP Status values.

BusinessStatus Values

These are the Business Status values.

NotificationType Values

These are the Notification Type values.

ResourceType Values

These are the Resource Type values.

Overview of Post Notification

The PostNotification endpoint is a Public REST API that can be utilized by demand partners and enterprise customers to commit notifications based on the previously Notifications obtained through the Get Notification endpoint. In this way the committed notifications will no longer be available through the Get Notification endpoint.

API Workflow

The following diagram illustrates the process to commit notifications.

1. User/Channel requests authentication using a UserName, Password, ClientId, and ClientSecret.
1. User/Channel requests notifications using the Get Notification endpoint.
2. Using a previously obtained authentication token and the Notification Ids obtained from the Get Notification endpoint, the caller submits a request to the Post Notification endpoint to commit notifications.
3. Meeting Broker validates and processes the data included in the requests.
4. Amadeus' MeetingBroker returns a response indicating if the payload was accepted for processing or not.

Post Notification Endpoint

You can commit notifications by using this endpoint.

Request URL

https://api.newmarketinc.com/api/aks-notification/v1/Notification

Request Headers

Request

Post: https://api.newmarketinc.com/aks-notification/v1/Notification

Required Payload

The following payload is required when submitting a request to the endpoint.

["89b16aef-c769-428e-8fca-fed71d9e3a12",
"a24edebe-9d82-435d-ba58-059c63e209a5",
"0c3ef988-1e84-4d9a-95da-4537c3a3821e"]

Models

Below is a guide to the various attributes contained in the commit notifications response.

The Post Notification endpoint allows the user to commit notifications previously obteined through the Get Notification endpoint using their Ids. The following sections describe the response returned by the Post Notification endpoint:

• PostNotificationReceiveRequest - The notification request data.
• PostNotificationResponse - The returned response.

The following sections include further details about each block.

PostNotificationReceiveRequest

Details about the Post Notification Request are listed in this section.

["89b16aef-c769-428e-8fca-fed71d9e3a12",
"a24edebe-9d82-435d-ba58-059c63e209a5",
"0c3ef988-1e84-4d9a-95da-4537c3a3821e"]

PostNotificationResponse

Details about the Post Notification Response are listed in this section.

["89b16aef-c769-428e-8fca-fed71d9e3a12",
"a24edebe-9d82-435d-ba58-059c63e209a5",
"0c3ef988-1e84-4d9a-95da-4537c3a3821e"]

Heartbeat for Demand Distribution APIs

Note: All the Demand Distribution APIs require AHWS authentication. See the authentication guide for details. The AHWS authentication user is required to have a Heartbeat Monitoring role in order to access this endpoint.

You can check the availability of the Demand Distribution API services using the Heartbeat endpoint associated with the microservice.

Request URL

     https://api.newmarketinc.com/api/mb/rfp/rfpheartbeatservice/heartbeat
            

     https://api.newmarketinc.com/api/mb/booking/businessdataheartbeatservice/heartbeat
            

     https://api.newmarketinc.com/api/proposal/proposalheartbeatservice/Health/Heartbeat
            

     https://api.newmarketinc.com/api/businessdata/businessdataheartbeatservice/Health/Heartbeat
            

Here is an example of what the JSON payload returned will look like

1. Data: Contains the Heartbeat information
2. CorrelationId: Is the sessionid for the call

The response body will contain basic Heatbeat "Thump. Thump."

Heartbeat response example

{
    "data": "Thump. Thump.",
    "correlationId": "a01b4847-5408-4bd7-8385-27af6e048a1e"
}
            

Errors and Troubleshooting

When you submit a request to the Business Data Update API endpoint with the correct credentials and it passes the required schema validations, an HTTP 200 - OK / 202 success response is returned. Otherwise, there is an error. Inspect the Http Status Code and the request body to determine what failed and how to correct your API call.

Error Response Example

    {
        "errors": [
            {
              "status": 404, Httpstatus corresponding to this error.
              "code": 6003, The Amadeus Hospitality error code corresponding to this error.
              "title": "Item/data not found or data not existing, "
              "detail": "Item/data cannot be found for the item presented in the request.",
              "source": {
                   "parameter": "rfp/221d5a57-ca0e-46c1-bf4d-0f8be9569edd/message/aaef41ac-6067-e911-80de-005056a15484"
                }
            }
        ]
    }
                

HTTP Status Codes

The following table lists the response codes you may encounter and how to troubleshoot problems.

Calling OAuth

These calls all use an OAuth token, not a Bearer token.

The most common error status code you will get from the OAuth service is a 403 - Forbidden. The error property in the response body will tell you what was not accepted.

• access_denied means you have an incorrect Username and Password pair. The user might not exist or the password provided was wrong.

• unauthorized_client means there is incorrect information in the client_id and client_secret fields. Ensure you are using the correct values that you received from Amadeus Hospitality when you acquired your credentials.

You may also get a 405 - Method Not Allowed if you called an endpoint with an incorrect HTTP method such as a GET instead of POST.

Troubleshooting

Most 500 status codes are temporary, and normal service should return after a few seconds or minutes. You should retry a call in these instances.

If you are consistently receiving 500 status codes, you can use information in the response to help our Support team track down the error faster. The response Header will contain the following keys:

• Ni-TrackingId
• Ni-CorrelationId

Rate Limits

What to expect?

There is a Rate Limit across the product as a whole, for any single subscription key being used of 500 calls in 60 seconds. Heartbeat has a limit of 4 calls in 60 seconds. Once this limit is reached any subsequent calls will be rejected with a status of 429 with the below response body:

{ 
    "statusCode": 429, 
    "message": "Rate limit is exceeded. Try again in 60 seconds." 
}
            

Once the provided wait time has been reached, calls will be processed again as normal.

Overview of POST Meeting

This RFP endpoint (POST) is a Public REST API to support sending in a Meeting by any authorized S&E system. The purpose is to allow S&E systems to provide planners with near real-time requests associated with MeetingBroker RFP

API Workflow

The following diagram illustrates the process for sending or updating a RFP.

1. Sender sends an RFP to Amadeus System.
2. Amadeus System receives this request and sends an acknowledgment back.
3. Amadeus System processes this request asynchrnously and generates notifictions.
4. Sender polls for notifications. Amadeus System replies with notifications if any.
5. When a Sender does receive a notification it commits of receiving these notifications to Amadeus System.

Note: All the RFP APIs require AHWS authentication.

Post Meeting Endpoint

You can send a RFP by using this endpoint. You will need to pass an Id: RfpPayLoad and perform the POST.

Request URL

            https://api.newmarketinc.com/v2/meeting          
            

Request Headers

Request Body

Required Fields

The following fields are required when submitting a request to the endpoint.

Requirements & Configuration

• All sent RFPs require a full overlay of the RFP. When sending RFPs using this API, all fields must be passed in with values. Submission of a partial overlay of the RFP data model is not allowed and will not result in a successfully sent RFPs.

Models

The Post Meeting endpoint includes the fields necessary for planners to request meeting proposal responses from hotel sales managers.

The API includes the RFP fields which you can send or update with the Post Meeting API. These are included in the PostRfp section of the JSON. When you look at the JSON, notice that there are the following blocks of fields for which values can be sent or updated:

• PostRfps - The RFPs to be sent or updated provided by the integrated system.
• Rfp - contains all the information about a request for a meeting.
• AdditionalInformation - Additional information the user might want to save with the RFP.
• Address - Address information for the organization or contact.
• Attachment - Contains information about an attachment to a message.
• AnnotatedDate - Specific information about a date.
• Budget - Specific information about a budget.
• Comment - Contains name and comment text.
• Commission - Contains information about a commission.
• EventBlock - The event block is a list of events and requirements associated with an RFP.
• EventRequirement - contains information about a specific event.
• GuestRoomBlock - contains information about guest rooms for the RFP.
• GuestRoomOccupancy - contains information about the occupancy of the guest room block.
• GuestRoomRequirement - contains guest room requirements for a specific day within the guest room block.
• LocationIdentifier - contains location type information about a location in the RFP.
• MeetingInfo - Information about any included meetings, from the number of attendees to the number of events and nights.
• Message - contains message information sent to one or more people.
• Organization - contains information about an agency or company associated with the RFP.
• Person - contains information aabout any people associated with the RFP.
• PhoneNumber - contains information about an organization's or person's phone or fax.
• Question - contains information about any questions in the RFP.
• ResponseChoice - pre-determined answer choices for inbound RFP questions.
• ResponseUnit - answers for inbound RFP questions.
• RfpOrganization - contains organization information about the inbound RFP.
• Sender - contains information about who is sending the RFP.
• Site - contains information about the location the RFP is being sent to.

Following structures are key attributes that comprise of this request message

• Message
• RFPs

The following sections include further details about each area.

data

rfp

additionalInformation

address

attachment

annonatedDate

budget

comment

commission

eventBlock

eventRequirement

guestRoomBlock

guestRoomOccupancy

guestRoomRequirement

locationIdentifier

meetingInfo

message

organization

person

phoneNumber

question

responseChoice

responseUnit

rfpOrganization

sender

site

RFP Status by RFP Id Overview

API Workflow

The following diagram illustrates the process for changing an RFP Status by RFP Id.

1. Using a previously obtained authentication token, the caller submits a request to the RFP Status by RFP Id endpoint to change the satus of an RFP.
2. Amadeus' MeetingBroker returns a response indicating if the payload was accepted for processing or not.
3. MeetingBroker validates and processes the data included in the requests.

PUT RFP Endpoint

You can update a RFP by using this endpoint. You will need to pass a RFP ID using a PUT operation.

Request URL

https://api.newmarketinc.com/v2/rfp/{rfpId}/Status

Terminology

Usage

The user can change the status of an RFP by providing the RfpId and Statuschange request. A new RFP Status by RFP Id endpoint has been created to facilitate the change of an RFP Status by any authorized system. The user receives success response when MeetingBroker processes the request successfully.

Required Fields

The following fields are required when submitting a request to the endpoint.

Field	Type	Notes
Status	Enum	Status to be assigned to the RFP.
StartDate	DateTime	This field is required just when the Status field is set to Awarded.
Message	Message	Message being sent. See Message object for more details.

Models

Below is a guide to the various attributes required to build the data contract for changing the status of an RFP.

The Change RFP Status endpoint allows the user to change the status of an RFP using an RfpId. The following sections describe the different request and response models being used by the Change RFP Status endpoint:

• PutStatusChangeParameters - Fields required to perform the status change.
• Message - Contains message information.
• Attachments - A list of attachments for the Message.

The following sections include further details about each block.
NOTE: The Validation Rule column lists specific field specifications you must follow to ensure the data is validated.

PutStatusChangeParameters

Details about the PutStatusChangeParameters are listed in this section.

Message

Details about the Message are listed in this section.

Attachment

Details about the Attachment are listed in this section.

HTTP Status Codes

The following table lists the response codes you may encounter and how to troubleshoot problems.

RFP Status by Meeting Id Overview

API Workflow

The following diagram illustrates the process for changing a RFP Status by Meeting Id.

1. Using a previously obtained authentication token, the caller submits a request to the RFP Status by Meeting Id endpoint to change the satus of a Meeting.
2. Amadeus' MeetingBroker returns a response indicating if the payload was accepted for processing or not.
3. MeetingBroker validates and processes the data included in the requests.

PUT Meeting Endpoint

You can update a RFP by using this endpoint. You will need to pass a meeting ID using a PUT operation.

Request URL

https://api.newmarketinc.com/v2/meeting/{meetingId}/Status

Terminology

Usage

The user can change the status of a Meeting by providing the MeetingId and Statuschange request. A new RFP Status by Meeting Id endpoint has been created to facilitate the change of a Meeting Status by any authorized system. The user receives success response when MeetingBroker processes the request successfully.

Required Fields

The following fields are required when submitting a request to the endpoint.

Field	Type	Notes
Status	Enum	Status to be assigned to the Meeting.
StartDate	DateTime	This field is required just when the Status field is set to Awarded.
Sites	List of LocationIdentifers	There must be at least one LocationIdentifer in this list.
Message	Message	Message being sent. See Message object for more details.

Models

Below is a guide to the various attributes required to build the data contract for changing the status of a Meeting.

The Change Meeting Status endpoint allows the user to change the status of a Meeting using a MeetingID. The following sections describe the different request and response models being used by the Change Meeting Status endpoint:

• PutStatusChangeParameters - Fields required to perform the status change.
• Message - Contains message information.
• Sites - A list of LocationIdentifers.
• Attachments - A list of attachments for the Message.

The following sections include further details about each block.
NOTE: The Validation Rule column lists specific field specifications you must follow to ensure the data is validated.

PutStatusChangeParameters

Details about the PutStatusChangeParameters are listed in this section.

Message

Details about the Message are listed in this section.

LocationIdentifier

Details about the LocationIdentifier are listed in this section.

Attachment

Details about the Attachment are listed in this section.

HTTP Status Codes

The following table lists the response codes you may encounter and how to troubleshoot problems.

Overview of RFP Message

API Workflow

The following diagram illustrates the process for sending an RFP Message.

1. Using a previously obtained authentication token, the caller submits a request to the RfpMessage by MeetingId endpoint to send the RFP Message.
2. Amadeus' MeetingBroker returns a response indicating if the payload was accepted for processing or not.
3. MeetingBroker validates and processes the data included in the request.

Note:Alternatively, a caller can also post an RFP Message as indicated below.

1. Using a previously obtained authentication token, the caller submits a request to the RfpMessage by RfpId endpoint to send the RFP Message.
2. Amadeus' MeetingBroker returns a response indicating if the payload was accepted for processing or not.
3. MeetingBroker validates and processes the data included in the request.

Note: All the RFP APIs require AHWS authentication. See the authentication guide for details.

RFP Message Endpoint

You can send an RFP Message by using these endpoints. You will need to pass a Id: PostTextMessageParameters and perform the POST.

Request URL

                https://api.newmarketinc.com/v2/meeting/{meetingId}/Message 
            

                https://api.newmarketinc.com/v2/rfp/{rfpId}/Message 
            

Request Headers

Request

Required URI parameters when using MeetingId.

https://api.newmarketinc.com/v2/meeting/{meetingId}/Message 

A RFP Message can be created by specifying a meeting ID.

Required URI parameters when using RfpId.

https://api.newmarketinc.com/v2/rfp/{RfpId}/Message 

Alternatively, an RFP Message can be created by specifying internal RFP ID

Request Body

Required Fields when using a Meeting Id

The following fields are required in the request body when submitting a request to the RfpMessage by MeetingId endpoint.

Required Fields when using a Rfp Id

The following fields are required in the request body when submitting a request to the RfpMessage by RfpId endpoint.

Models

RFP Message

The RFP Message endpoint allows the user to send an RFP Message using an Meeting ID. The following sections describe the RFP Message response returned by the RFP Message endpoint:

• PostTextMessageParameters - The message and sites to be sent.
• Sites - A list of LocationIdentifers.
• Message - Contains message information.
• Attachments - A list of attachments for the Message.

Following structures are key attributes that comprise of this request message

• Sites
• Message

Following structures are key attributes that comprise of this request message

• Message

The following sections include further details about each area.

data

locationIdentifier

message

attachment