RFP Demand APIs

What is it?

The RFP Demand APIs 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 RFP Demand APIs

AHWS Authentication

AHWS provides an authentication service which allows vendors to access all the other APIs. This document outlines the steps a client application would use to interact with all APIs in AHWS. You call Amadeus Hospitality authentication API to get authentication token.

 

Authenticating in for the first time

To start, you will need to authenticate with AHWS to receive an access token and a refresh token. An application needs the following items in order to interact with the authentication API:

  • client_id - Provided by Amadeus Hospitality
  • client_secret - Provided by Amadeus Hospitality
  • password - This is the password of the Amadeus Hospitality User Not your API Management password
  • username - This is the username of the Amadeus Hospitality User Not your API Management username

In order to perform the client operations, there are up to three possible actions:

  1. Acquire an access token and a refresh token
  2. Call the service while presenting the access token
  3. Refresh the access token when it expires or becomes invalid

Acquire an access token and a refresh token

In order to acquire a token, you first have to call the Authentication API with a POST request. Amadeus Hospitality recommends always passing your subscription key as a header attribute in all calls made that require it.

Type: HTTP POST

Request URL

https://api.newmarketinc.com/2.0/OAuth2/AccessToken

Request header example

    Content-Type: application/json
    Ocp-Apim-Subscription-Key: [Your-Subscription-Key]
        

Request body example (JSON)

{                     
	"client_id": "[clientidvalue]",
	"client_secret": "[clientsecretvalue]",
	"grant_type": "password",
	"password": "[passwordvalue]",
	"username": "[usernamevalue]"
}
					

Response body example (JSON)

          
{
"access_token": "1cBZBtY4Nfcrx/PlVf+nmGgiUbZdMPLWM0g4Qh4r5y5KQOoVhshYRNihi4/ja6p+CZ2hNEih2t/YR7UL6pn7iw0QisRDZKD032dSzB70DKiOWREYX+hH+IRphp8E/Ip
DUhDVHr8acEj6TH0sPoHMQr7F06WTbzcCBjomrY8YOcBs1h9pdyFS9nYXb1RARxoicX24QjkRWfjfbXmJvaJ3Rg9kNVGAVIboZWDZ6n176MSazjM0WteAs5UdsmB70qB6HHmzbF5+jmoKcqQ
1UHpjLfqxUvcOO3HyIz71tR04gldO3/e1mfOMSPTeesoAXU3quYcjcGeY2s+gf5jlURnZWosB4xyPtacXwEV0bdL+3ppi+iQRFhiDK0cvbdo/DgkwRzJm0KfJWl31WL9EsHYe2I0jv3xMByo
oIco7LH6DKsYRqW7RAXA5bZX4pFf+aVRCgV6vjXWg5WIUbnAOZnzpPUtMSJIKnEVal63e8+UHS4R9ToEI1bm7wNPxgk9O1Bf4Cw8DlsuQWTuhhXg/mVMeIMZuWlQBUkU3nZYZWtSGCZ+CRIS
BMySgFIMadxF/AVJd9Xo0uy9nck20tlBQRuprssxPd9VZI5GPOCOQkgBTOZGNdanAdVt9emZYYANnYRt5",
"expires_in": 900,
"refresh_token": "GXwOwRlXc54zVafcV8NyscDS1AvIUTHBifQwv8TDZsX3mEq1hEKjoWegwgErlhnJftoTA+FrBwb70Am07kQzD572h+mAbN\/XTMu\/eVHtQ4vwQhp7fkPwyCitAVhMs
GviQjfV4Y8AiQGIAVXPhvBVXzX7RLEds64jtBdGriNbG9twFUFfLIuBEYZuspTs3AIeUrhVjQzP8f5kYMKtir+XH4+ogrdDIMQ4u8YXuc91oseH77tS+8s0qRclDJeGVcysSR2n3gxI6TvsHW
DRI\/AEJ\/Haq\/XE5eoS1QxpDkk+kn5ciAOGd2BY58pgJnd5LwSb\/N1uFEj\/1pB4J5F1oxUt5Ruq68w\/qvVGdWorPyngKyPNKe4DjZ++SyJFbQqN75as6NCEUjdzpU\/7zyXXD5+57Okh
JFAaliraXfAz2jzUD4PW3yeEtQuIIOwL8kmjcsIm10OGfWuvl+6nLo6gg4wF+sY4MWct0Jt\/J6Mog65W4bSed8q5r2QLNrOClEJp+pwAEh9qkbtvDgVTfTJzhDrDvr0U7dyqdQEYqo4lmqGR
BJIC7QhCYN31tbYsJAVAp+UM+0G4bKY6FxlIrB7mKg\/Zm+RvUx4cBVlyuw1UtWzxV3DEwHP4pAoLFEzs6CWkgFECx8a3\/ETd86ivlMcM15Wy0mm9uXoW6Qcr3Y5hrmho\/BU9SKk2Fyq0fY
8r0hhiCGl55TU6rF8yLAEEvIdxSsHEiLynywGUhD6xAhyKYKyzk5wbp\/XzE8eneezEFWuRmUJJ",
"token_type": "bearer"
}
				

The JSON payload in the response body contains 4 elements:

  • access_token - the access token value
  • expires_in - the number of seconds until the token expires
  • token_type - this will always be "bearer"
  • refresh_token - the refresh token value

From the JSON payload, extract the access_token and refresh_token values to use with your requests to the secured service. If you are caching the token for multiple calls, use the expires_in value as the cache expiration.

Call the service while presenting the token

In order to call the service with the token, extract the access_token value from the response and pass it in the Authorization header in your request to the secured service like this OAuth [access_token].

Request header sample


    Content-Type: application/json
    Ocp-Apim-Subscription-Key: [Your-Subscription-Key]
	Authorization: OAuth 1cBZBtY4Nfcrx/PlVf+nmGgiUbZdMPLWM0g4Qh4r5y5KQOoVhshYRNihi4/ja6p+CZ2hNEih2t/YR7UL6pn7iw0QisRDZKD032dSzB70DKiOWREYX+
	hH+IRphp8E/IpDUhDVHr8acEj6TH0sPoHMQr7F06WTbzcCBjomrY8YOcBs1h9pdyFS9n
	YXb1RARxoicX24QjkRWfjfbXmJvaJ3Rg9kNVGAVIboZWDZ6n176MSazjM0WteAs5UdsmB70qB6HHmzbF5+jmoKcqQ1UHpjLfqxUvcOO3HyIz71tR04gldO3/e1mfOMSP
	TeesoAXU3quYcjcGeY2s+gf5jlURnZWosB4xyPtacXwEV0bdL+3ppi+iQRFhiDK0cvbdo/DgkwRz
	Jm0KfJWl31WL9EsHYe2I0jv3xMByooIco7LH6DKsYRqW7RAXA5bZX4pFf+aVRCgV6vjXWg5WIUbnAOZnzpPUtMSJIKnEVal63e8+UHS4R9ToEI
	1bm7wNPxgk9O1Bf4Cw8DlsuQWTuhhXg/mVMeIMZuWlQBUkU3nZYZWtSGCZ
	+CRISBMySgFIMadxF/AVJd9Xo0uy9nck20tlBQRuprssxPd9VZI5GPOCOQkgBTOZGNdanAdVt9emZYYANnYRt5
					

This header should be coupled with a body that meets the requirements of that API you are accessing. With this header, AHWS will allow you access to the products you subscribe to. This access token will expire after the expires_in timeframe is exceeded. At this point you will receive a 403 - Forbidden response from AHWS and will be required to retrieve a new access token.

Http Authorization Headers are an industry standard and adhere to the following format:

Authorization: [type] [credential]

Note that in the header we are specifying an Authorization Type of OAuth and our credential in this case is the access_token from the response payload.

If the refresh token is invalid or expired, you will receive a 403 - Forbidden. In this case, you need to present your full credentials again.

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

Content-Type String Media type of the body sent to the API. It should be "application/json" for this POST request.
Ocp-Apim-Subscription-Key String Subscription key which provides access to this API.
Authorization String Valid access token obtained from Authentication API.

Request Body

Required Fields

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

Field Type Notes
rfps List of Rfp There must be one Rfp in the list and at this time it is limited to only one Rfp.
rfp.meetingId string This is the RFP ID provided by the integrated system.
meetingInfo MeetingInfo MeetingInfo node of the incoming RFP request.
meetingInfo.meetingName string Meeting name of the incoming RFP request.
rfp.sites List of Site There must be at least one Site in this list.
site.locationIdentifier LocationIdentifier The Site.LocationIdentifier must reference an active location.

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.

 

Post RFP - Request Message

Following structures are key attributes that comprise of this request message

  • Message
  • RFPs

The following sections include further details about each area.

 

data

Field Description Example
rfps A list of RFPs
message Message being sent with this request. See Message object for more details.

rfp

Field Description Example
additionalInformation List of AdditionalInformation. See Addititional Information object for more details.
meetingID Meeting Rfp Id supplied by Sender MeetingId1234
guestRoomBlocks List of Guest Room Block information. See GuestRoomBlock object for more details
eventBlocks List of Event Block information. See EventBlock object for more details.
meetingInfo Meeting information. See MeetingInfo object for more information.
questions List of Questions regarding the Rfp request. See Question object for more details.
sender Sender information. See Sender object for more details.
sites List of Sites to send the Rfp to. See Site object for more details.

 

additionalInformation

Field Description Example
category Category used to group Additional Information Items. This group may also appear in the MeetingBroker UI and integrated S&E Systems. Category1
name Name of the Additional Information value. . Additional Information
type Type of the value. Limited to Date and Text Text
value Additional Information data item. This is important additional information

 

address

Field Description Example
streetAddress Address of the account or third-party agency associated with the RFP. 75 New Hampshire Ave
cityRegion City/region of the account or third-party agency associated with the RFP. Portsmouth
postalCode The postal code of the account or third-party agency associated with the RFP. 01324
stateProvince The state/province of the account or third-party agency associated with the RFP. NH
countryCode MB code validates incoming country code based on an established standard ISO 3166 country code list. US

 

attachment

Field Description Example
contentType Type of content in the Attachment. Allowable content types are: TXT, PDF, BMP, JPEG, PNG, DOC, DOCX, XLSX, JPG, MSG, PPT, PPTX. application/msword
fileContent Content of the file
fileData Byte version of the content
fileName Name of the file used with the content AttachmentFile.txt

 

annonatedDate

Field Description Example
value Date 3/27/2019
sequence Sequence order of the date in a date list. 1

 

budget

Field Description Example
name Name of the static MB revenue budget category. Limited to: Beverage, Food, Other, Rental and Resource. Food
value Dollar value of budget item provided by the RFP sender. 100

 

comment

Field Description Example
name Name or Type of free-form comment string. Limited to General, Destination and History General
text Free-form comment text provided by RFP sender This is a general comment to be added to an RFP.

 

commission

Field Description Example
value Commission Percentage 2.2

 

eventBlock

Field Description Example
commentText Comments regarding the block of Events This is a comment about the RFP Event Block
budgets List of Budget items. Limited to 5: Beverage, Food, Other, Rental and Resource. See Budget object for more information. Food
eventRequirements List of Requirements for each event in the Rfp. See EventRequirement object for more information.
sizeUnitOfMeasure Unit of measure used for room sizing. Could be Feet ot Meters Feet
startDates List of Start Dates for the first date of the RFP. Limited to 2, Start Date and Alternate Start Date. See StartDate object for more information. 3/27/2019
totalEventBudget Total Budget for all the Events. 1001.01

 

eventRequirement

Field Description Example
attendeeQuantity Number of Attendees associated with a given event that will be at a given event. 125
commentText Comments for the specific Event Comment for RFP Event Requirement
dayNumber Within the event block this is the sequential number for any given event. 1
startTime Start time associated for the event. 9:00 AM
endTime End time associated with any given event. 11:00 AM
eventSetupTypeName Table and chair configuration associated with any given event (i.e., Theater, Conference, Classroom, Rounds of Ten). Theater
eventTypeName Event type associated with any given event (i.e., General Session, Breakout, Breakfast, Dinner). Breakout
isTwentyFourHourHold Room is on 24 hour hold so that it is not used for any other event before or after the start/end times TRUE
roomSize Size of Room Space needed for your event 2500

 

guestRoomBlock

Field Description Example
budgetedRoomRate Room rate that is budgeted for the Guest Room Block 89
commentText Comments regarding the Guest Room Block I would like a room with an Ocean view
guestRoomRequirements List of GuestRoomRequirements for this GuestRoomBlock. See GuestRoomRequirement object for more information.
startDates List of Start Dates for the first date of the RFP. Limited to 2, Start Date and Alternate Start Date. See StartDate object for more information. 3/4/2020

 

guestRoomOccupancy

Field Description Example
name Occupancy type. Limited to Single, Double, Triple or Quad. Single
occupancy Number of people per room. For Single occupancy, occupancy will be 1. For Quad occupancy, occupancy will be 4. 4
roomQuantity Number of rooms for the occupancy type. 2

 

guestRoomRequirement

Field Description Example
commentText Comments about this Guest Room Requirement. This is a comment about a Guest Room Requirement
dayNumber Sequential number of the day for this RFP. 1
guestRoomOccupancies List of GuestRoomOccupancies. Limited to up to 4 in the list: Single, Double, Triple and Quad. See GuestRoomOccupancy for more information. Single
roomTypeName Name of the Room Type. Can be one of four types. Default is Run_Of_House if the API can not map the string to one of the four types. Run Of House, Standard, Double Double, External Run_Of_House

 

locationIdentifier

Field Description Example
locationID Identifier of the Location for the RFP 10000001
locationIdentifierType Type of LocationId. Limited to MeetingBroker and External. MeetingBroker

 

meetingInfo

Field Name Description Example
attendeeQuantity Number of attendees associated with the business opportunity. 15
comments List of comments for the Meeting. Limit to 3. These could be General, Destination or Meeting History. See Comment Object for more information. Please notify us about Day 1 Meeting Info Prep
currency Currency of the RFP as specified by the account or third-party agency sending the RFP. USD
leadSource Source of RFP (e.g., channel, phone, email, etc.) Email
marketSegment Market segment associated with RFP (e.g., Corporate, Government, SMERF.) Corporate
meetingName Name of the Meeting associated with the RFP Acme Sales Quarterly Planning
meetingType Type of meeting associated with RFP (i.e., conference, wedding, meeting). Conference
numberOfAttendeesAtLargestEvent Number of attendees at the largest event. 125
numberOfEvents Total number of events for the business data. 5
numberOfNights Total number of nights for the business data. 3
peakRooms Number of peak rooms for the business data as specified by the account or third-party agency associated with the RFP. 85
promotionalCode The code associated with a discounted program or event associated with an RFP's target location. 1
organizations List of Organizations associated to the RFP. Limited to up to 2 in the list, Agency and Account. Includes name, address and contact.
referenceNumber User-specified reference number provided by the account or third-party agency associated with the RFP. 5748291
startDates List of Start Dates for the RFP. Limited to up to 3, Start Date, Alternate Start Date 1, Alternate Start Date 2, ordered by sequence number. See AnnotatedDate object for more information. 3/27/2020
meetingSeriesName Name to be used for the RFP series of events Acme Quarterly Planning Meetings
respondByDate Date that customer needs a Response by 3/1/2020
responseInstructions Instructions to the RFP receiver from RFP sender providing details on RFP response. Please respond by the Respond By Date to ensure openings.
totalBudget Total Budget for the entire RFP, includes Rooms and Events. 1250.5

 

message

Field Description Example
attachments List of Attachments to send with the Message. Limited to 3 and not more than 5 mb total. Attachment1.txt
body This is the body of the message This is the body of the message
contactCompany Contact's Company name ContactCompany Inc.
contactName Name of the Contact Chris Contact
from Who the message is from John Smith
fromEmail Email of the person or company this message is from johnsmith@email.com
marketingHtml Html version of the marketing message
marketingText Text version of the marketing message Welcome to the Global Sales Organization (GSO) process of receiving customer opportunities (leads) for your hotel.
meetingName Name of the Meeting Meeting
subject Subject of the Message Proposed Meeting Times
to Email of person or company the message to going to contactcompany@email.com

 

organization

Field Description Example
addresses List of Addresses for the Organization. Limited to 1 at this time 77 New Hampshire Ave, Apartment 1, Building A Portsmouth, NH, USA 01324
commissions List of Commissions to be paid. Limited to 1 at this time 2.2
DUNSNumber DUNS number for the Organization 12344321
email Email for the Organization organization@email.com
externalOrganizationId The External Id of the Organization provided by the Sender 159753
phoneNumbers List of Phone numbers. Limited to 2 at this time. Fax and Phone. See PhoneNumber object for more details 123-123-1234
IATANumber IATA number for the Organization 54312
name Name of the Organization Number One Organization
people List of People within the Organization. Limited to 1 at this time
SICCode SIC Code for the Organization 3746P
url Website address for the Organization organization.com

 

person

Field Description Example
addresses List of Addresses for the Person. Limited to 1 at this time. 75 New Hampshire Ave Portsmouth, NH 03801 USA
email Email address for the Person email@email.com
externalPersonId External Person Id for the Person provided by the Sender 647351
firstName First Name of the Person Frank
jobTitle Job Title of the Person Director
lastName Last Name of the Person Davidson
phoneNumbers Phone Numbers for the Person. Limited to 2, Fax or Phone. See PhoneNumber object for more details 123-123-1234
title Title of the Person Mr.
titleSuffix Title Suffix of the Person Mr.

 

phoneNumber

Field Description Example
name Limited to Fax or Phone Phone
number Fax or Phone number 123-123-1234
extension Extension of the phone if needed. For Person only, not used for Organization. 4321

 

question

Field Description Example
category Category for the Question Category1
externalQuestionId External ID for the Question 65372
isAnswerRequired Is an answer required for the Question FALSE
questionText Text for the Question Question Text
questionType Type of Question. Limited to Date, MultiSelect, Numeric, SingleSelect and Text Date
responseChoices List of ResponseChoices for the Question
responseUnits List of ResponseUnits for the Question
section Section name for the Question SectionName1

 

responseChoice

Field Description Example
externalResponseChoiceId ID associated with pre-determined answer choices for inbound RFP questions. 123341
isSelected Boolean indicating if a pre-determined answer choice has been selected (or not). TRUE
response Pre-determined answers associated with inbound RFP questions. Yes

 

responseUnit

Field Description Example
externalResponseUnitId ID associated with answers for inbound RFP questions. 654788
isSelected Boolean indicating if a pre-determined answer has been selected (or not). FALSE
unit String containing response content This is a response

 

rfpOrganization

Field Description Example
organization See Organization object for more details.
organizationRole Role of the Organization within the RFP. Limited to Account or Agency Account
isPrimaryContact Is this Agency organization the primary contact for the RFP? Only used with Agency. TRUE

 

sender

Field Description Example
locationIdentifier Identification about the Sender's location. See LocationIdentifier for more details.
userEmailAddress Sender's Email address Sender@emailaddress.com
userFirstName Sender's First name Jason
userLastName Sender's Last name Douglas

 

site

Field Description Example
allowsRedirect Determines if RFP can be redirected from original RFP receiving location to a second location (or not). TRUE
allowResponseInstructionOverride Boolean determining whether or not RFP receiving location is able to override the ResponseInstructionType field provide by the sending channel in the Post RFP workflow. TRUE
commentText Comments about the RFP for the Site This is a lovely site.
locationIdentifier Identification about the Site's location. See LocationIdentifier for more details.
responseInstructionType Type of response instruction. Limited to: None, Respond_To_Sender, Respond_To_Primary_Contact, Respond_To_Both None
salesUserEmail Email of sales user specified with receiving location kim@amadeus.com
salesUserFirstName First Name of sales user specified with receiving location Kim
salesUserLastName Last Name of sales user specified with receiving location Kelly
sendToParent This flag determines if RFP should be forwarded to an additional recipient other than the assigned RFP owner. false
startDate Start date for the RFP 8/9/2020

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 
            
or
                https://api.newmarketinc.com/v2/rfp/{rfpId}/Message 
            

Request Headers

Content-Type String Media type of the body sent to the API. It should be "application/json" for this POST request.
Ocp-Apim-Subscription-Key String Subscription key which provides access to this API.
Authorization String OAuth 2.0 access token obtained from Authentication API.

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.

Field Type Notes
meetingId string Meeting ID as in an external system. Meeting Id is equivalent to the external RFP 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

Field Type Notes
RfpID GUID Amadeus System 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.

Field Type Notes
Sites List of LocationIdentifer There must be at least one LocationIdentifer in this list.
Message Message Message being sent. See Message object for more details.

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.

Field Type Notes
Message Message Message being sent. See Message object for more details.

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.

 

RfpMessage by MeetingId - Request Message

Following structures are key attributes that comprise of this request message

  • Sites
  • Message

 

RfpMessage by RfpId - Request Message

Following structures are key attributes that comprise of this request message

  • Message

The following sections include further details about each area.

 

data

Field Description Example
sites A list of LocationIdentifers
message Message being sent with this request. See Message object for more details.

 

locationIdentifier

Field Description Example
locationID Identifier of the Location for the Meeting 10000001
locationIdentifierType Type of LocationId. Limited to 'External' or 'MeetingBroker' MeetingBroker

 

message

Field Description Example
attachments List of Attachments to send with the Message. Limited to 3 and not more than 5 mb total. Attachment1.txt
body This is the body of the message This is the body of the message
contactCompany Contact's Company name ContactCompany Inc.
contactName Name of the Contact Chris Contact
from Who the message is from John Smith
fromEmail Email of the person or company this message is from johnsmith@email.com
marketingHtml Html version of the marketing message
marketingText Text version of the marketing message Welcome to the Global Sales Organization (GSO) process of receiving customer opportunities (leads) for your hotel.
meetingName Name of the Meeting Meeting
subject Subject of the Message Proposed Meeting Times

 

attachment

Field Description Example
contentType Type of content in the Attachment txt
fileContent Content of the file
fileData Byte version of the content
fileName Name of the file used with the content AttachmentFile.txt

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:

 

 

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.

Field
Type
Length
Description
Example
Validation Rule
StartDate DateTime Start date for the Meeting. Must be a valid date, This field is required just when the Status field is set to Awarded.
Status Enum Status to be assigned to the Meeting. Awarded Valid values are Awarded, Withdrawn, and Cancelled.
LocationIdentifiers List of LocationIdentifier List of LocationIdentifier to send the Message to. Refer to the LocationIdentifier object for more information. This list must contain at least 1 Site.
Message Message Message being sent. See Message object for more details. This field must not be NULL.
StatusChangeReason String Reason why the Meeting status is being changed. Its value cannot exceed 255 characters
Return to Models

 

Message

Details about the Message are listed in this section.

Field
Type
Length
Description
Example
Validation Rule
attachments List of Attachments List of attachments for the Message. Refer to the Attachment object for more information. There is a limit of 3 entries in this list, with the Attachment.fileData size not exceeding 5MB.
body string   Body of the message.   This field must not be NULL or empty.
contactCompany string 80 Contact's company name. Contact Company Inc.
contactName string 70 Name of the contact. Joe Contact
from string 200 Who the message is from. John Smith  
fromEmail string 255 Email of the person or company the message is from. johnsmith@email.com This field should be in the format 'x@y.com'.
marketingHtml string HTML version of the marketing message. Same as marketingText, but in HTML format.
marketingText string Text version of the marketing message. Welcome to the Global Sales Organization (GSO) process of receiving customer opportunities (leads) for your hotel.  
meetingName string 80 Name of the meeting. Quarterly Meeting  
subject string 50 Subject of the message. message. Proposed Meeting Times  
Return to Models

 

LocationIdentifier

Details about the LocationIdentifier are listed in this section.

Field
Type
Length
Description
Example
Validation Rule
locationId string Identifier of the location for the RFP 10000001
locationIdentifierType LocationIdentifierType Type of LocationId. Refer to the Validation Rules column for more information. MeetingBroker Must have a value of 'External' or 'MeetingBroker'.
Return to Models

 

Attachment

Details about the Attachment are listed in this section.

Field
Type
Length
Description
Example
Validation Rule
contentType string 100 Type of content in the attachment. TXT The allowable content types are: TXT, BMP, JPEG, PNG, PDF, XLS, DOC, DOCX, XLSX, JPG, MSG, PPT, PPTX
fileContent string String version of the content.
fileData bytes Byte version of the content. File size for all attachments must be less than 5MB in size.
fileName string 200 Name of the file used with the content. AttachmentFile.txt The allowable file extensions are: .TXT, .BMP, .JPEG, .PNG, .PDF, .XLS, .DOC, .DOCX, .XLSX, .JPG, .MSG, .PPT, .PPTX
Return to Models

 

HTTP Status Codes

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

Code Description Troubleshooting
202 Success Your request has been successfully processed.
400 The message body is either missing or could not be understood. Check to make sure the payload contains the correct datatypes and any required fields are present
401 The request did not include the correct authentication. Token could have timed out.
404 The requested resource was not found.
405 The requested method is not allowed. You may have called the endpoint with the incorrect HTTP method such as GET instead of PUT or POST instead of PUT.
415 Unsupported Media Type returned when resource does not support media types in requests.
429 Rate limit is exceeded. Try resubmitting your request after a short wait.
500 Internal server error. Try submitting your request again.
503 The service is temporarily unavailable. If the length of the delay is known, a Retry-After header is given. It is recommended that you delay for this interval before sending another request to the service. If no Retry-After is provided, you should handle as a 500 error. Try submitting your request again.

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:

 

 

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.

Field
Type
Length
Description
Example
Validation Rule
StartDate DateTime Start date for the Meeting. Must be a valid date, This field is required just when the Status field is set to Awarded.
Status Enum Status to be assigned to the RFP. Awarded Valid values are Awarded, Withdrawn, and Cancelled.
Message Message Message being sent. See Message object for more details. This field must not be NULL.
StatusChangeReason String Reason why the RFP status is being changed. Its value cannot exceed 255 characters
Return to Models

 

Message

Details about the Message are listed in this section.

Field
Type
Length
Description
Example
Validation Rule
attachments List of Attachments List of attachments for the Message. Refer to the Attachment object for more information. There is a limit of 3 entries in this list, with the Attachment.fileData size not exceeding 5MB.
body string   Body of the message.   This field must not be NULL or empty.
contactCompany string 80 Contact's company name. Contact Company Inc.
contactName string 70 Name of the contact. Joe Contact
from string 200 Who the message is from. John Smith  
fromEmail string 255 Email of the person or company the message is from. johnsmith@email.com This field should be in the format 'x@y.com'.
marketingHtml string HTML version of the marketing message. Same as marketingText, but in HTML format.
marketingText string Text version of the marketing message. Welcome to the Global Sales Organization (GSO) process of receiving customer opportunities (leads) for your hotel.  
meetingName string 80 Name of the meeting. Quarterly Meeting  
subject string 50 Subject of the message. message. Proposed Meeting Times  
Return to Models

 

Attachment

Details about the Attachment are listed in this section.

Field
Type
Length
Description
Example
Validation Rule
contentType string 100 Type of content in the attachment. TXT The allowable content types are: TXT, BMP, JPEG, PNG, PDF, XLS, DOC, DOCX, XLSX, JPG, MSG, PPT, PPTX
fileContent string String version of the content.
fileData bytes Byte version of the content. File size for all attachments must be less than 5MB in size.
fileName string 200 Name of the file used with the content. AttachmentFile.txt The allowable file extensions are: .TXT, .BMP, .JPEG, .PNG, .PDF, .XLS, .DOC, .DOCX, .XLSX, .JPG, .MSG, .PPT, .PPTX
Return to Models

 

HTTP Status Codes

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

Code Description Troubleshooting
202 Success Your request has been successfully processed.
400 The message body is either missing or could not be understood. Check to make sure the payload contains the correct datatypes and any required fields are present
401 The request did not include the correct authentication. Token could have timed out.
404 The requested resource was not found.
405 The requested method is not allowed. You may have called the endpoint with the incorrect HTTP method such as GET instead of PUT or POST instead of PUT.
415 Unsupported Media Type returned when resource does not support media types in requests.
429 Rate limit is exceeded. Try resubmitting your request after a short wait.
500 Internal server error. Try submitting your request again.
503 The service is temporarily unavailable. If the length of the delay is known, a Retry-After header is given. It is recommended that you delay for this interval before sending another request to the service. If no Retry-After is provided, you should handle as a 500 error. Try submitting your request again.

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}
or
https://api.newmarketinc.com/v2/meeting/{meetingId}/rfp/{locationType}-{locationId}

Request Headers

Ocp-Apim-Subscription-Key String Subscription key which provides access to this API.
Authorization String Valid access token obtained from Authentication API.

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.

Field Type Notes
rfpID GUID Amadeus System RFP ID

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

Field Type Notes
meetingID string Meeting ID as in an external system. Meeting Id is equivalent to the external RFP Id.
locationType string Type of location
locationIdentifier string External location pertaining to this RFP

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.

 

Get RFP - Request Message

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

  • rfpID or
  • meetingID-locationIdentifier

 

Get RFP - Response Message

Following structures are key attributes that comprise of this response message

  • RFP

The following sections include further details about each area.

 

data

Field Description Example
rfp Meeting information.
statusChangeReason Provides a short reason for the change in Status to Business Lost, Cancelled, or Turned Down. Price is too much

rfp

Field Description Example
rfpID Internal RFP ID. 123456789
channelName The Name representing a specific MB-integrated system and it's related collection of MB APIs. Bob's Company Channel
releaseDate Date when Rfp is released by the customers after enrichment. 2019-04-03T19:07:31.403Z
guestRoomBlocks Guest room blocks requested. See GuestRoomBlock object for more information.
rfpStatus Current status of Rfp. Awarded
meetingId Meeting Id is supplied by the Sender. MeetingId1234
additionalInformations Additional information. See AdditionalInformation object for detailed field list.
eventBlocks Event block list requested. See EventBlock object for detailed field list.
meetingInfo Meeting information. See MeetingInfo object for detailed field list.
sender Rfp sender (person). See Sender object for detailed field list.
sites List of Rfp receiving sites. See Site object for detailed field list.
businessOwner Business owner is included to allow the meeting planner to know who is working the related business in the S&C system. See BusinessOwner object for detailed field list.
businessStatus Corresponds with the status of the integrated Sales and Events booking created from the MeetingBroker RFP. Completed

additionalInformation

Field Description Example
Type Data type of the Additional Information value. Date
name Name of the Additional Information value. Additional Information
category Category used to group Additional Information Items. This group may also appear in the MeetingBroker UI and integrated S&E Systems. Category1
value Additional Information data item. This is important additional information

address

Field Description Example
name Name of the account or agency associated with the RFP.
streetAddress Address of the account or third-party agency associated with the booking. 75 New Hampshire Ave, Suite 300, 3rd Floor
cityRegion City/region of the address of the account or third-party agency associated with the booking. Portsmouth
stateProvince The state/province of the account or third-party agency associated with the booking. NH
postalCode The postal code of the account or third-party agency associated with the booking. 01234
countryCode The country of the account or third-party agency associated with the booking. US

annotatedDate

Field Description Example
name Descriptive name associated with the date specified.
sequence Sequence order of the date in a date list. 1
value Date value. 3/27/2019

budget

Field Description Example
name Name of the static MB revenue budget category. Limited to: Beverage, Food, Other, Rental and Resource. Food
value Dollar value of budget item provided by the RFP sender. 100

comment

Field Description Example
name Name or Type of free-form comment string. Limited to General, Destination and History. General
text Free-form comment text provided by RFP sender. This is a general comment to be added to an RFP.

commission

Field Description Example
value Commission Percentage. 2.2
name Name descriibing use for the Commission value.
revenueTypeName Category of commission value. Travel Agency Commission.

eventBlock

Field Description Example
startDates List of Start Dates for the first date of the Booking. Limited to 2, Start Date and Alternate Start Date. See AnnotatedDate object for more information. 3/27/2019
budgets List of Budget items. Limited to 5: Beverage, Food, Other, Rental and Resource. See Budget object for more information. Food
commentText Comments regarding the block of Events. This is a comment about the RFP Event Block
totalEventBudget Total Budget for all the Events. 1001.01
eventRequirements List of requirements for each event in the Rfp. See EventRequirement object for detailed fields.
sizeUnitOfMeasure Unit of measure associated with RFP sender. Used for room sizing. Options include Feet or Meters. Feet

eventRequirement

Field Description Example
eventTypeName Event type associated with any given event (i.e., General Session, Breakout, Breakfast, Dinner). Breakout
eventSetupTypeName Table and chair configuration associated with any given event (i.e., Theater, Conference, Classroom, Rounds of Ten). Theater
commentText Comments for the specific Event. Comment for RFP Event Requirement
isPrivateRoom Is a Private room required that will not be publicly accessible. TRUE
dayNumber Within the event block this is the sequential number for any given event. 1
startTime Start time associated for the event. 9:00 AM
endTime End time associated with any given event. 11:00 AM
roomSize Size of Room Space needed for your event. 2500
attendeeQuantity Number of Attendees associated with a given event that will be at a given event. 125
isTwentyFourHourHold Room is on 24 hour hold so that it is not used for any other event before or after the start/end times. TRUE

guestRoomOccupancy

Field Description Example
name Occupancy type. Limited to Single, Double, Triple or Quad. Single
occupancy How many rooms are need of this type. 10
bedQuantity Quantity of rooms needed of each type. 2
roomQuantity Number of rooms. 2

guestRoomBlock

Field Description Example
startDates List of Start Dates for the first date of the Booking. Limited to 2, Start Date and Alternate Start Date. See AnnotatedDate object for more information. 3/4/2020
commentText Comments regarding the Guest Room Block. I would like a room with an Ocean view
guestRoomRequirements List of GuestRoomRequirements for this GuestRoomBlock. See GuestRoomRequirement object for more information.
budgetedRoomRate Room rate that is budgeted for the Guest Room Block. 89

guestRoomRequirement

Field Description Example
roomTypeName Name of the Room Type. Can be one of five types. Default is Run Of House if the API can not map the string to one of the eight types. Roomtypes: Run Of House, Standard, Double Double, External. Run_Of_House
guestRoomOccupancies List of GuestRoomOccupancies. Limited to up to 4 in the list: Single, Double, Triple and Quad. See GuestRoomOccupancy for more information. Single
commentText Comments about this Guest Room Requirement. This is a comment about a Guest Room Requirement
dayNumber Sequential number of the day within the booking. 1

locationIdentifier

Field Description Example
locationId Identifier of the Location for the RFP. 10000001
locationIdentifierType Type of LocationId. Limited to External and MeetingBroker. MeetingBroker

meetingInfo

Field Description Example
organizations List of Organizations associated to the RFP. Limited to up to 2 in the list, Agency and Account. Includes name, address and contact.
startDates List of Start Dates for the booking. Limited to up to 3, Start Date, Alternate Start Date 1, Alternate Start Date 2, ordered by sequence number. See AnnotatedDate object for more information. 3/27/2020
comments List of Comments for the Meeting. These could be General, Destination or Meeting History. See Comment Object for more information. Please notify us about Day 1 Meeting Info Prep
currency Currency of the RFP as specified by the account or third-party agency sending the RFP. USD
leadSource Source of RFP (e.g., channel, phone, email, etc.) Email
marketSegment Market segment associated with RFP (e.g., Corporate, Government, SMERF.) Corporate
meetingType Type of meeting associated with RFP (i.e., conference, wedding, meeting). Conference
meetingSeriesName Name to be used for the RFP series of events. Acme Quarterly Planning Meetings
attendeeQuantity Number of attendees associated with the business opportunity. 15
meetingName Name of the Meeting associated with the RFP. Acme Sales Quarterly Planning
numberOfAttendeesAtLargestEvent Number of attendees at the largest event. 125
numberOfEvents Total number of events for the business data. 2
numberOfNights Total number of nights for the business data. 1
peakRooms Number of peak rooms for the business data as specified by the account or third-party agency associated with the booking. 85
promotionalCode The code associated with a discounted program or event associated with an RFP's target location. 1
referenceNumber User-specified reference number provided by the account or third-party agency associated with the booking. 5748291
respondByDate Date that customer needs a Response by. 3/1/2020
responseIntructions Instructions to the RFP receiver from RFP sender providing details on RFP response. Please respond by the Respond By Date to ensure openings.
totalBudget Total Budget for the entire Booking, includes Rooms and Events. 1250.50
currencyCode Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world. CAD

organization

Field Description Example
name Name of the Organization. Eri
addresses List of Addresses for the Organization. Limited to 1 at this time. 75 New Hampshire Ave Portsmouth, NH 03801 USA
phoneNumbers List of Phone numbers. Limited to 2 at this time. Fax and Phone. See PhoneNumber object for more details. 123-123-1234
SicCode SIC Code for the Organization. 3746P
people List of People within the Organization. Limited to 1 at this time.
externalOrganizationId The External Id of the Organization provided by the Sender. 159753
url Website address for the Organization. organization.com
email Email for the Organization. organization@email.com
IATANumber IATA number for the Organization. 54312
DUNSNumber DUNS number for the Organization. 12344321
commissions List of Commissions to be paid. Limited to 1 at this time, 2.2

person

Field Description Example
addresses List of Addresses for the Person. Limited to 1 at this time. 75 New Hampshire Ave Portsmouth, NH 03801 USA
phoneNumbers Phone Numbers for the Person. Limited to 2, Fax or Phone. See PhoneNumber object for more details. 123-123-1234
externalPersonId External Person Id for the Person provided by the Sender. 647351
firstName First Name of the Person. Frank
lastName Last Name of the Person. Davidson
email Email address for the Person. email@email.com
title Title of the Person. Mr.
jobTitle Job Title of the Person. Director
titleSuffix Title Suffix of the Person. Mr.

phoneNumber

Field Description Example
name Limited to Fax or Phone. Phone
number Fax or Phone number. 123-123-1234
extension Extension of the phone if needed. For Person only, not used for Organization. 4321

rfpOrganization

Field Description Example
organization See Organization object for more details.
organizationRole Role of the Organization within the RFP. Limited to Account or Agency. Account
isPrimaryContact This is Agency or Account Primary Contact. TRUE

sender

Field Description Example
locationIdentifier Identification about the Sender's location. See LocationIdentifier for more details.
userFirstName Sender's First name. Jason
userLastName Sender's Last name. Douglas
userEmailAddress Sender's Email address. Sender@emailaddress.com

site

Field Description Example
commentText Comments about the RFP for the Site. This is a lovely site.
locationIdentifier Identification about the Site's location. See LocationIdentifier for more details.
allowsRedirect Determines if RFP can be redirected from original RFP receiving location to a second location (or not). TRUE
salesUserEmail Email of sales user specified with receiving location. kim@amadeus.com
salesUserFirstName First Name of sales user specified with receiving location. Kim
salesUserLastName Last Name of sales user specified with receiving location. Kelly
startDate Start date of the RFP. 8/9/2020
responseInstructionType Type of response instruction. Limited to: None, Respond_To_Sender, Respond_To_Primary_Contact, Respond_To_Both. None
allowResponseInstructionOverride Boolean determining whether or not RFP receiving location is able to override the ResponseInstructionType field provide by the sending channel in the Post RFP workflow. TRUE

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.

Note: All the GetProposal API require AHWS authentication. See the authentication guide for details.

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

Ocp-Apim-Subscription-Key String Subscription key which provides access to this API.
Authorization String Valid access token obtained from Authentication API.

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.

Field Type Notes
id GUID This is the ProposalId provided by the integrated system and must be a GUID.

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:

 

The following sections include further details about each block.

getProposalResponse

Details about the getProposalResponse are listed in this section.

Field
Description
Example
proposal Details of the proposal that is sent by the receiver in response to a RFP.
messages List of messages with respect to RFP and proposal.
questions List of Questions with respect to RFP and proposal.

 

proposal

Details about the proposal are listed in this section.

Field
Description
Example
meetingId External Rfp Id is provided by the RFP creator. It corresponds to the meeting name given by the creator. ExternalRfpGetProposal
locationIdentifier Identifier of the Location for the RFP. Refer locationIdentifier object.
rfpStatus Current status of the RFP(i.e., Drafted, Deleted, New, Updated, Awarded, SelfAwarded, Withdrawn, Cancelled, TurnedDown, Redirected). New
guestRoomBlocks List of guestRoomBlock. Describes all the details of the rooms requested. Refer GuestRoomBlock object.
eventBlocks List of eventBlock. Describes all the details of the events requested. Refer eventBlock object.
meetingInfo This object represnets all the info related to the meeting i.e. being scheduled.
rfpId Identifier of the RFP. 11111111
proposalId Unique Identifier of the proposal that is related to the RFP. 22222222
sendingUser Email of the sending user. john@xyz.com
sendingLocation Identifer of the location that redirected the RFP. 10000003
redirectedLocationName Name of the Location for which the RFP is routed to. Amadeus-BLR
redirectedLocationId Identifier of the Location for which the RFP is routed to. 10000002
assignedUser Email address to whom the RFP is assigned. abc@gmail.com

 

locationIdentifier

Details about the locationIdentifier are listed in this section.

Field
Description
Example
locationId Identifier of the location for the RFP 50042508
locationIdentifierType Type of LocationId. Limited to External and MeetingBroker. For GetProposal, It is limited to MeetingBroker. MeetingBroker

 

guestRoomBlock

Details about the guestRoomBlock are listed in this section.

Field
Description
Example
startDate AlternateStartDate of the meeting specified by the external user. 2020-06-09T01:58:41.28
budgetedRoomRate The rate that has been proposed for rooms. 2000
commentsText Comments about GuestRoom. Not Avaliable
guestRoomAvailabilities List all the details related to availablity of guest room. Refer GuestRoomAvailabltiy block.

 

guestRoomAvailablity

Details about the guestRoomAvailablity are listed in this section.

Field
Description
Example
dayNumber Sequential number of the day within the booking. 1
roomTypeName Name of the Room Type. Limited to : Run_Of_House, Standard, Double_Double, Suite, Complimentary_Run_Of_House, Complimentary_Standard, Complimentary_Double_Double, Complimentary_Suite, External. Run_Of_House
guestRoomOccupancies List details of the GuestRoomOccupancy. Refer GuestRoomOccupancy object.
commentsText Comments about the room availablity. Rooms are available as requested.

 

guestRoomOccupancy

Details about the guestRoomOccupancy are listed in this section.

Field
Description
Example
name Name of the GuestRoom. SinglesAvailable
roomQuantity Room Quantity that is available. 3
rate Rate of the room i.e. is available. 2500
bedQuantity Quantity of beds needed of each type. 4
occupancy Occupancy for each room 3

 

eventBlock

Details about the eventBlock are listed in this section.

Field
Description
Example
startDate StartDate of the Event as mentioned by the user. 2020-06-09T01:58:41.28
commentText Comments about events. Three events are to be conducted.
eventAvailabilities Details regarding the Availablities for the event. Refer EventAvailablity object.
prices Prices for foood, beverage etc requested for event. Refer Prices object.

 

eventAvailablity

Details about the eventAvailablity are listed in this section.

Field
Description
Example of Fieal Description
dayNumber Within the event block this is the sequential number for any given event. 2
startTime Start time associated for the event. 10:00
endTime End time associated with any given event. 17:30
eventTypeName Event type is a string field and associated with any given event (i.e., General Session, Breakout, Breakfast, Dinner). General Session
eventSetupTypeName It is a string field which indicates the table and chair configuration associated with any given event (i.e., Theater, Conference, Classroom, Rounds of Ten). Classroom
roomSize Size of Room Space needed for your event. 2500
attendeeQuantity Number of Attendees associated with a given event that will be at a given event. 125
commentsText Comments about the Event The event will take place in phases.
isPrivateRoom Specifies whether a room is private or not. TRUE
isTwentyFourHourHold Room is on 24 hour hold so that it is not used for any other event before or after the start/end times. TRUE

 

prices

Details about the prices are listed in this section.

Field
Description
Example
name Name for Costs quoted for various entities. Food Cost
value Costs quoted for various entities. 2100

 

meetingInfo

Details about the meetingInfo are listed in this section.

Field
Description
Example
meetingName Meeting name given by the external user. BrightMinds AGM Meet -2020
referenceNumber User-specified reference number provided by the account or third-party agency associated with the booking. 5748291
startDates List of Start Dates for the booking. Limited to up to 3, Start Date, Alternate Start Date 1, Alternate Start Date 2, ordered by sequence number. See AnnotatedDate object for more information.
attendeeQuantity Number of attendees associated with the business opportunity. 15
respondByDate Date that customer needs a Response by. 2020-06-09T01:58:41.28
comments List of Comments for the Meeting. These could be ResponseInstructions or MeetingHistory comments. See Comment Object for more information. An alternate date within a week is acceptable.
meetingSeriesName Name to be used for the RFP series of events. BrightMinds AGM Meet -2020
numberOfEvents Total number of events for the business data. 10
numberOfNights Total number of nights for the business data. 7
meetingType Type of meeting associated with RFP (i.e., conference, wedding, meeting). Conference
currency Currency of the RFP as specified by the account or third-party agency sending the RFP. INR
leadSource Source of RFP (e.g., channel, phone, email, etc.) Email
marketSegment Market segment associated with RFP (e.g., Corporate, Government, SMERF.) Corporate
peakRooms Number of peak rooms for the business data as specified by the account or third-party agency associated with the booking. 3
numberOfAttendeesAtLargestEvent Number of attendees at the largest event. 500
promotionalCode The code associated with a discounted program or event associated with an RFP's target location. 1

 

annotatedDate

Details about the annotatedDate are listed in this section.

Field
Description
Example
name Descriptive name associated with the date specified. StartDate
value Sequence order of the date in a date list. 2020-06-09T01:58:41.28
sequence Sequence order of the date in a date list. 1

 

comment

Details about the comment are listed in this section.

Field
Description
Example
name Type or Name of the comment. MeetingHistoryComments
text Value for the comment. Please notify us about Day 1 Meeting Info Prep.

 

messages

Details about the messages are listed in this section.

Field
Description
Example
from Name of the sender sending the proposal. Newmarket QA Prod Sandbox GSE Channel
to User to whom the proposal is sent. hanna@gmail.com
subject Subject of the message. BrightMinds AGM Meet -2020
meetingName Name of the meeting for which proposal is sent. BrightMinds AGM
contactName Name of the contact person. John Peter
contactCompany Name of the contact company. BrightMinds
body Content of the message that is sent. This is the Automation Test text message body for Meeting : TestRfooo Sent using Newmarket.MBTestCenter.
fromEmail Email of the user sending the message. john@gmail.com
date Date on which the message is sent. 2020-06-09T01:58:41.28
marketingText Text used for marketing purpose
marketingHtml HTML for marketing.
attachments Attachments that are attached with the messsage.

 

attachment

Details about the attachment are listed in this section.

Field
Description
Example
fileName Name of the file that is attached with the attachment. BrightMindsAGM2020
contentType Type of the content that is being attached. docx
fileContent Content of the file that is being attached.
fileData Data that is being attached.

 

questions

Details about the questions are listed in this section.

Field
Description
Example
questionText Text for the Question. How Many Cuisines are available?
isAnswerRequired Is an answer required for the Question. FALSE
answer
questionId Unique identifier of the question that was posted. 1
category Category for the Question. Food Chocies
section Section name for the Question. Section One
questionType Type of Question. Limited to Date, MultiSelect, Numeric, SingleSelect and Text.

 

answer

Details about the answer are listed in this section.

Field
Description
Example
answerText Contains the answers given for a question. Cuisine Available :Italian , Indian,Continental.
selectedResponseChoices List of ResponseChoices for the Question. Refer ResponseChoice object.
selectedResponseUnits List of ResponseUnits for the Question. Refer ResposneUnit object.

 

responseChoice

Details about the responseChoice are listed in this section.

Field
Description
Example
response String containing response content. Mocktail
externalResponseChoiceId ID associated with pre-determined answer choices for inbound RFP questions.

 

responseUnit

Details about the responseUnit are listed in this section.

Field
Description
Example
unit Unit of measurement of response Litre
externalResponseUnitId ID associated with answers for inbound RFP questions.

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.

Note: The Proposal API require AHWS authentication. See the authentication guide for details.

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

Ocp-Apim-Subscription-Key String Subscription key which provides access to this API.
Authorization String Valid access token obtained from Authentication API.

Request

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

Required Fields

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

Field Type Notes
RfpId Guid This is the Rfp Guid provided by the integrated system and must be a GUID. Either a RfpId or a MeetingId must be supplied for Post Proposal.
MeetingId string This is vendor provided RFP ID (external Rfp Id). Either a RfpId or a MeetingId must be supplied for Post Proposal. MeetingIds with a '/' character are not valid and will result in an error.
LocationIdentifier LocationIdentifier LocationIdentifier must reference an active location.
Proposals List of Proposals Only a single Proposal can be in the list.

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:

 

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.

Field
Description
Example
RfpId Identifier of the RFP.
MeetingId MeetingId is equivalent to the external RFP Id. It corresponds to the meeting name given by the RFP creator.
ExternalBusinessId BusinessId in External S&C System.
LocationIdentifier Refer to the LocationIdentifier object for more information.
Proposals Refer to the Proposals object for more information.

 

LocationIdentifier

Details about the LocationIdentifier are listed in this section.

Field
Description
Example
LocationId Identifier of the location for the Proposal 10000001
locationIdentifierType Type of LocationId. Refer to the Validation Rules column for more information. MeetingBroker

 

Proposals

Details about the Proposal are listed in this section.

Field
Description
Example
ExternalProposalId ExernalId of the proposal.
ExternalProposalUrl URL of the external proposal.
Currency Currency of the Proposal as specified by the account or third-party agency sending the Proposal.
Questions Refer to the PostProposal_Question object for more information.
EventBlocks List of Event block information for the Proposal. Refer to the PostProposal_EventBlock object for more information.
GuestRoomBlocks List of Guest room block information for the Proposal. Refer to the PostProposal_GuestRoomBlock object for more information.

 

PostProposal_Question

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

Field
Description
Example
QuestionText Text for the question. Question text?
ExternalQuestionId External question ID for the question. 65372
IsAnswerRequired Is the answer for the question required. false
Answer Refer to the PostProposal_Answer object for more information.
Category Category of the question. Category1
Section Section name for the question. Section1
QuestionType Type of question. Refer to the PostProposal_QuestionType object for more information. Date

 

PostProposal_EventBlock

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

Field
Description
Example
StartDates See PostProposal_AnnotatedDate object for more information
Prices Prices for food, beverage etc requested for event. Refer to the PostProposal_Price object.
commentText Comments regarding the block of events. This is a comment about the event block.
EventAvailabilities Details regarding the Availablities for the event. Refer to the PostProposal_EventAvailability object.

 

PostProposal_AnnotatedDate

Details about the AnnotatedDate are listed in this section.

Field
Description
Example
name Descriptive name associated with the date specified.
value Date value. 03/27/2019
sequence Sequence or of the date in the date list. 1

 

PostProposal_Price

Details about the PostProposal_Price are listed in this section.

Field
Description
Example
Name Name for Costs quoted for various entities. Food
value Costs quoted for various entities. 2100.00

 

PostProposal_EventAvailability

Details about the PostProposal_EventAvailability are listed in this section.

Field
Description
Example
DayNumber Within the event block this is the sequential number for any given event. 2
StartTime Start time associated for the event. 10:00
EndTime End time associated for the event. 11:00
EventTypeName Event type is associated with any given event (i.e., General Session, Breakout, Breakfast, Dinner). General Session
EventSetupTypeName It indicates the table and chair configuration associated with any given event (i.e., Theater, Conference, Classroom, Rounds of Ten). Classroom
RoomSize Size of Room Space needed for your event. 2500
AttendeeQuantity Number of Attendees associated with a given event that will be at a given event. 125
CommentText Comments about the Event. The event will take place in phases.
IsPrivateRoom Is a Private room required that will not be publicly accessible. true
IsTwentyFourHourHold Room is on 24 hour hold so that it is not used for any other event before or after the start/end times. true

 

PostProposal_GuestRoomBlock

Details about the PostProposal_GuestRoomBlock are listed in this section.

Field
Description
Example
StartDates See PostProposal_AnnotatedDate object for more information
BudgetedRoomRate Room rate that is budgeted for the guest room block. 89.75
CommentText Comments about the guestroom block. The event will take place in phases.
GuestRoomAvailabilities Refer to the PostProposal_GuestRoomAvailability object.

 

PostProposal_GuestRoomAvailability

Details about the PostProposal_GuestRoomAvailability are listed in this section.

Field
Description
Example
DayNumber Sequential number of the day. 1
RoomTypeName Name of the room type. Run_Of_House
GuestRoomOccupancies Refer to the PostProposal_GuestRoomOccupancy object.
CommentText Comments about the guestroom availability. The event will take place in phases.

 

PostProposal_GuestRoomOccupancy

Details about the PostProposal_GuestRoomOccupancy are listed in this section.

Field
Description
Example
Name Occupancy type. Limited to Single, Double, Triple or Quad. Single
RoomQuantity Number of rooms. 2
Rate Rate for guestroom 125.00
BedQuantity Quantity of rooms needed of each type.
Occupancy How many rooms are needed of this type. 4

 

PostProposal_Answer

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

Field
Description
Example
AnswerText
SelectedResponseChoices Refer to the PostProposal_ResponseChoice object.
SelectedResponseUnits Refer to the PostProposal_ResponseUnit object.

 

PostProposal_ResponseChoice

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

Field
Description
Example
Response
ExternalResponseChoiceId

 

PostProposal_ResponseUnit

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

Field
Description
Example
Unit
ExternalResponseUnitId

 

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.

Note: All the GetBusinessData API require AHWS authentication. See the authentication guide for details.

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]
or
https://api.newmarketinc.com/businessdata/v2/meeting/{meetingId}/rfp/{idType}-{locationId}/businessData[?businessDataType]

Request Headers

Ocp-Apim-Subscription-Key String Subscription key which provides access to this API.
Authorization String Valid access token obtained from Authentication API.

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.

Field Type Notes
rfpId Guid This is the RfpId provided by the amadeus system and must be a Guid.
businessDataType String This is the type of business data like "General", "Agreed", "PickedUp", "Actual", "Blocked".

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.

Field Type Notes
meetingId String This is the MeetingId provided by the integrated system and must be a string.
locationId String This is the LocationId provided by the amadeus system and must be a string.
idType String This is the type of location and must be a string.
businessDataType String This is the type of business data like "General", "Agreed", "PickedUp", "Actual", "Blocked".

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:

 

The following sections include further details about each block.

businessDataInfo

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

Field
Description
Example
businessDataType Provides snapshot of guestroom and event data during each stage of the booking life-cycle. Options: "General", "Agreed", "PickedUp", "Actual", "Blocked". Agreed
eventBlocks List of events and requirements associated with the RFP. Refer EventBlock object.
guestRoomBlocks List of guest rooms that contains the information about the guest room for the RFP. Refer GuestRoomBlock object.
isComplete Is business completed by the integrated system or not. True
businessStatus Current status of business reflected in the integrated system. Options:"None", "Prospect", "Tentative", "Definite", "Cancelled", "Inquiry", "Completed", "TurnedDown", "BusinessLost" Definite
lostBusinessReason Indicates the reason of the business which was turned down or cancelled by the property. Proximity to Airport
businessOwner Individual assigned the business opportunity. Details of this user is stored in "Person" object.
startDate Start date of the booking. 2020-06-09T01:58:41.28
departureDate End date of the booking. 2020-06-10T01:58:41.28
meetingId External RfpId is provided by the RFP creator. It corresponds to the meeting name given by the creator. Meeting-101
rfpId Internal RfpId of the MeetingBroker. 222658
businessId Unique Id of the business data. 556688
locationIdentifier Identifier of the location for the RFP. Refer LocationIdentifier object.
commentText Business related comments provided by the RFP receiver. Please notify us one day prior to the event
isPickupComplete Completed by the integrated system. True
createDate Date on which the business is initiated. 2020-06-10T01:58:41.28
otherIncomeItems List of other income items that 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).
currency Currency of transaction. USD
commission Percentage commission to be paid to the company or to the third party agency associated with the booking. 2.200
lostToCity Name of the city to which the business is lost. Las Vegas
lostToHotel Name of the hotel to which the business is lost. Marriot
isLocked Indicates venue space has been locked for the booking or not. False

 

eventBlock

Information about events are listed in this section.

Field
Description
Example
startDates Start date of the event as mentioned by the user.Details of start date are stored in "Annotated Date" object.
revenues Revenue details like food cost, beverage cost, rental cost, other cost, resource cost.
commentText Comments about events. Event related comments
eventBusinessData List of event business data that contains information about the specific event.
sizeUnitOfMeasure Unit of measure. Feet

 

guestRoomBlock

Contains the information about the guest room for the RFP.

Field
Description
Example
startDates Alternate start date of the meeting specified by the external user.Details of start date are stored in "Annotated Date" object.
budgetedRoomRate The rate that has been proposed for rooms. 2000
commentText Comments related to guest room. Extra bed in double room
guestRoomBusinessData List all the details related to availability of guest room. Refer GuestRoomAvailability block.

 

person

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

Field
Description
Example
firstName First name of the person. Chandler
lastName Last name of the person. Bing
phoneNumbers Phone number of the person.
email Email Id of the person. chandler@bing.com
externalPersonId ExternalPersonId of the person. SOM2201
addresses List of addresses. Refer Address object.
title Title of the person. Mr
titleSuffix Title suffix of the person. Ph.D
jobTitle Job title of the person. Manager

 

locationIdentifier

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

Field
Description
Example
locationId Identifier of the location. 4554555
locationIdentifierType Type of LocationId. Limited to "External" and "MeetingBroker". It is limited to MeetingBroker. MeetingBroker

 

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).

Field
Description
Example
description Describes the item information. Extra food items
quantity Quantity of an item. 2
price Total price of an item. 10
pricingPer Price per item. 5
revenue Actual revenue earned by the hotel for all items. 500
revenueTypeName Describes the type of revenue. Food and Bevarage

 

eventBusinessData

Detailed information about each event included in the event block.

Field
Description
Example
dayNumber Within the event block this is the sequential number for any given event. 2
startTime Start time associated for the event. 10:00
endTime End time associated with any given event. 17:30
eventTypeName Event type is a string field associated with any given event (i.e., General Session, Breakout, Breakfast, Dinner). General Session
eventSetupTypeName Event SetupType Name is a string field which gives table and chair configuration associated with any given event (i.e., Theater, Conference, Classroom, Rounds of Ten). Classroom
attendeeQuantity Number of attendees that will be present at a given event. 125
revenues Revenue details like food cost, beverage cost, rental cost, other cost, resource cost

 

guestRoomBusinessData

Detailed information about each room included in the GuestRoomBlock.

Field
Description
Example
roomTypeName Name of the room type. Limited to : "Run_Of_House", "Standard", "Double_Double", "Suite", "Complimentary_Run_Of_House", "Complimentary_Standard", "Complimentary_Double_Double", "Complimentary_Suite", "External". Run Of House
dayNumber Sequential number of the day within the booking. 1
guestRoomOccupancies List details of the guest room occupancy. Refer GuestRoomOccupancy object.
commentText Comments about guest room business data. Room should be clean and hygienic.

 

address

Address details of the individual person.

Field
Description
Example
name Type of the address (Home/Work). Home/Office
streetAddress Street Address. 259, 1st Street
cityRegion City Region. Pennington
stateProvince State Province. Pennington
postalCode Postal Code. NJ 07002
countryCode Country Code. +1

 

phoneNumber

Phone number details of the individual person.

Field
Description
Example
name Name (Home/Office) Home/Office
number Number 25688
extension Extension 14589

 

guestRoomOccupancy

Contains information about the occupancy of guest room block.

Field
Description
Example
name Contains information about the guest room occupancy of the GuestRoomBlock. SinglesAvailable
roomQuantity Room quantity that is available. 3
rate Rate of the room that is available. 2500
bedQuantity Quantity of beds needed of each type. 4
occupancy Occupancy for each room. 3

 

annotatedDate

Specific information about a date.

Field
Description
Example
name Descriptive name associated with the date specified. StartDate
value Date value for the name field in concern. 2020-06-09T01:58:41.28
sequence Sequence order of the date in a date list. 1

 

revenue

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

Field
Description
Example
name Name for costs quoted for various entities. Food Cost
value Costs quoted for various entities. 2100

 

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.

Note: GetNotification API require OpenId authentication.

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

Ocp-Apim-Subscription-Key String Subscription key which provides access to this API.
Authorization String Valid access token obtained from Authentication API.

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:

 

The following sections include further details about each block.

NotificationReceiveRequest

Details about the Notification Request are listed in this section.

Field
Description
Example
limit Maximum number of notifications to return in response. This parameter is optional. If it is not present, the default value is 100. 50
notificationType Notification type by which to filter. This parameter is optional. If this parameter is not present, all available channel notifications will be retrieved for the channel ID for the user requesting the notification retrieval. RfpCreated
autocommit Indicates if notifications retrieved should be marked as read immediately. This parameter is optional. When sent in true or not sent, the notifications will be erased and no longer available. When sent in false, the notifications will remain available until commited, whether calling again this endpoint with the autocommit parameter in true, or calling the POST Notification endpoint (recomended) false

 

NotificationResponse

Details about the Notification Response are listed in this section.

Field
Description
Example
notifications This list will contain notifications retrieved using the parameters passed in.
{
    "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.

Field
Description
Example
id MeetingBroker internal NotificationGuid. 154c6e6b-3fe0-4683-90bb-56e1f4c6d2ae
eventDetail Notification event detail.

 

EventDetail

Details about the EventDetail are listed in this section.

Field
Description
Example
resourceId The resource id is the identifier (such as guid) for the resource and corresponds with the resource type. 154c6e6b-3fe0-4683-90bb-56e1f4c6d2ae
resourceType The type of resource, such as "RFP" or "PROPOSAL". RFP
subject The name of the Notification Type returned. The possible values are: "RfpCreated", "RfpViewed", "ProposalSent", "BusinessStatusChanged", "AgreedBusinessDataUpdated", "ActualBusinessDataUpdated", "BlockedBusinessDataUpdated", "PickedUpBusinessDataUpdated", "BookingStatusUpdated", "RoomBlockGroupCodeUpdated" RfpCreated
eventData The notification payload for the notification type returned. Provides attribute parity with their associated SOAP NINotifications + inclusion of the the MB ID guid attribute required by the corresponding Demand Public REST API endpoint request call.

 

MBNotificationEventData

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

Field
Description
Example
locationId The location corresponding to the notification. 5000701
channelId The channel corresponding to the notification. 439

 

RfpNotificationEventData

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

Field
Description
Example
rfp Rfp identifiers.
receiverLocation Receiver Location identifiers.
rfpStatus Status of RFP. Withdrawn

 

RfpViewedEventData

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

Field
Description
Example
The event data payload for a RfpViewed notification. The RfpId returned is a GUID.
{
    "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.

Field
Description
Example
The event data payload for a RfpCreated notification. The RfpId returned is a GUID.
{
    "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.

Field
Description
Example
The event data payload for a ActualBusinessDataUpdated notification. The RfpId returned is a GUID.
{
    "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.

Field
Description
Example
The event data payload for a AgreedBusinessDataUpdatedEventData notification. The RfpId returned is a GUID.
{
    "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.

Field
Description
Example
The event data payload for a BlockedBusinessDataUpdatedEventData notification. The RfpId returned is a GUID.
{
    "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.

Field
Description
Example
The event data payload for a PickedUpBusinessDataUpdatedEventData notification. The RfpId returned is a GUID.
{
    "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.

Field
Description
Example
The event data payload for a BusinessStatusChangedEventData notification. The RfpId returned is a GUID.
{
    "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.
                    
businessStatus
businessId Contains concatenated value of ExternalBusinessId and Guid from BusinessData object(if they are not null of empty).
externalLostBusinessReason

 

ProposalSentEventData

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

Field
Description
Example
The event data payload for a BusinessStatusChangedEventData notification. The RfpId and ProposalId returned are GUIDs.

{
    "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
proposalUrl https://my.meetingbroker.com/UIToolKit/?SiteId=71&PageType=PlannerProposal&ExtProposalId=baf9e95f-355a-4455-a84f-773a0834749d
proposalId 154c6e6b-3fe0-4683-90bb-56e1f4c6d2ae

BookingStatusUpdatedEventData

Details about the BookingStatusUpdatedEventData are listed in this section. Inherits from MbNotificationEventData.

Field
Type
Description
Example
BookingStatusUpdatedEventData The event data payload for a BookingStatusUpdatedEventData notification.

{
    "BookingStatusUpdatedEventData":
        {
        "ChannelId": 439,
        "externalId": "a0L5x00000EP7LmEAL",
        "bookingStatus": "Definite",
        "lostBusinessReason": "",
        "lostToComment": ""
        }
}

Note, any empty or null JSON data will be removed prior to sending response.
ExternalId string The id of the Booking a0L5x00000EP7LmEAL
BookingStatus BookingStatus The updated booking status Definite
LostToComment string The lost to comment Booking lost to competitor
LostBusinessReason string The lost business reason Price

 

RoomBlockGroupCodeUpdatedEventData

Details about the RoomBlockGroupCodeUpdatedEventData are listed in this section. Inherits from MbNotificationEventData.

Field
Type
Description
Example
RoomBlockGroupCodeUpdatedEventData The event data payload for a RoomBlockGroupCodeUpdatedEventData notification.

{
    "RoomBlockGroupCodeUpdatedEventData":
    {
        "ChannelId": 439,
        "externalId": "a0L5x00000EP7LmEAL",
        "externalRoomBlockId": "a0H5x00000lz6MUEAY",
        "groupCode": "NEWCODE"
    }
}

Note, any empty or null JSON data will be removed prior to sending response.
ExternalId string The id of the Booking a0L5x00000EP7LmEAL
ExternalRoomBlockId string The id of the RoomBlock a0H5x00000lz6MUEAY
GroupCode string The updated group code CODE

 

Rfp

Details about the Rfp are listed in this section.

Field
Description
Example
rfpId Guid corresponding to RFP. General
meetingId MeetingId corresponding to RFP. a015000000Cb7m3AAB

 

ReceiverLocation

Details about the ReceiverLocation are listed in this section.

Field
Description
Example
locationId The location corresponding to the receiver location. 5000701
referenceNumber The reference number corresponding to the receiver location.
channelExternalLocationId The external location corresponding to the receiver location.

 

RfpStatus Values

These are the RFP Status values.

RfpStatus Value
None
Draft
Deleted
New
Updated
Awarded
Self-Awarded
Withdrawn
Cancelled
Turned Down
Redirected
Duplicate

 

BusinessStatus Values

These are the Business Status values.

BusinessStatus Value
Prospect
Tentative
Definite
Cancelled
Inquiry
Completed
TurnedDown
BusinessLost

 

NotificationType Values

These are the Notification Type values.

NotificationType Value
RfpCreated
RfpViewed
ProposalSent
BusinessStatusChanged
AgreedBusinessDataUpdated
ActualBusinessDataUpdated
BlockedBusinessDataUpdated
PickedUpBusinessDataUpdated
BookingStatusUpdated
RoomBlockGroupCodeUpdated

 

  • ResourceType - contains the possible Resource Type values.
  • ResourceType Values

    These are the Resource Type values.

    ResourceType Value
    RFP
    PROPOSAL
    BOOKING

    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.
    2. User/Channel requests notifications using the Get Notification endpoint.
    3. 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.
    4. Meeting Broker validates and processes the data included in the requests.
    5. Amadeus' MeetingBroker returns a response indicating if the payload was accepted for processing or not.

    Note: PostNotification API require OpenId authentication.

    Post Notification Endpoint

    You can commit notifications by using this endpoint.

    Request URL

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

    Request Headers

    Ocp-Apim-Subscription-Key String Subscription key which provides access to this API.
    Authorization String Valid access token obtained from Authentication API.

    Request

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

    Required Payload

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

    Type Example
    List of Notification Ids
    ["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:

     

    The following sections include further details about each block.

    PostNotificationReceiveRequest

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

    Field
    Type
    Description
    Example
    List of Notification Ids List of Notification Ids previously obtained by the Get Notification endpoint, which will be committed.
    ["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.

    Field
    Type
    Description
    Example
    List of Notification Ids This list will be returned only if the payload list exceeds the limit of 100, so this list will contain the remainder notification Ids that were not committed.
    ["89b16aef-c769-428e-8fca-fed71d9e3a12",
    "a24edebe-9d82-435d-ba58-059c63e209a5",
    "0c3ef988-1e84-4d9a-95da-4537c3a3821e"]

    Heartbeat for RFP Demand APIs

    Note: All the RFP Demand 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 RFP Demand API services using the Heartbeat endpoint associated with the microservice.

    Request URL

    For the Rfp service which includes: Get Rfp, Get Messages, Get Attachment, Search Rfps, Turndown Rfps endpoints
    
         https://api.newmarketinc.com/api/mb/rfp/rfpheartbeatservice/heartbeat
                
    For the Business Data service which includes: Business Data Update
    
         https://api.newmarketinc.com/api/mb/booking/businessdataheartbeatservice/heartbeat
                
    For the Proposal service which includes: Get Proposal and Post Proposal endpoints
    
         https://api.newmarketinc.com/api/proposal/proposalheartbeatservice/Health/Heartbeat
                
    For the BusinessData service which includes: Get BusinessData endpoint
    
         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.

    Code Description Troubleshooting
    200 Success The server has successfully processed the request.
    202 Success Your request has been successfully processed.
    207 Success The server successfully processed the request. The recipient needs to consult the contents of the multi-status response body for further information about the success or failure of the individual resource operations.
    400 The message body is either missing or could not be understood. Check to make sure the payload contains the correct datatypes and any required fields are present
    401 The request did not include the correct authentication. Token could have timed out.
    403 The server understood the request but is not able to fulfill because of insufficient permission.

    If your call to the authentication API returns a 403 - Forbidden code, check the error property in the response body to see identify what was not accepted:

    • access_denied - There is an incorrect username/password pair. The user might not exist or the password provided was wrong.
    • unauthorized_client - 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.
    404 The requested resource was not found.
    405 The requested method is not allowed. You may have called the endpoint with the incorrect HTTP method such as GET instead of POST or POST instead of PUT.
    409 The request could not be completed due to a conflict with the current state of the target resource.
    413 The requested payload sent is too large (i.e., too many bytes).
    422 There are validation failures with the payload. (e.g., status must not be empty). Please check response status for information identifying the field that caused the validation failure.
    429 Rate limit is exceeded. Try again in 60 seconds.
    500 Internal server error. Try submitting your request again.
    503 The service is temporarily unavailable. If the length of the delay is known, a Retry-After header is given. It is recommended that you delay for this interval before sending another request to the service. If no Retry-After is provided, you should handle as a 500 error. Try submitting your request again.

    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
    These values can greatly decrease the time it will take to identify issues.

    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.