GET api/HA/review/{ReviewID}

Request Information

URI Parameters

Name	Description	Type	Additional information
ReviewID		integer	Required

Body Parameters

None.

Response Information

Resource Description

Review

Name	Type	Additional information
externalId	string	None.
arrivalDate	date	None.
body	Note	None.
bookingExternalId	Object	None.
entityCategorizations	Collection of EntityCategorization	None.
externalPropertyUrl	Object	None.
externalReviewUrl	Object	None.
externalStatus	ReviewExternalStatus	None.
headline	Note	None.
listingExternalId	string	None.
response	Note	None.
rating	integer	None.
ratingScale	RatingScale	None.
reviewer	HaxmlReviewer	None.
thirdPartyReviewProviderId	Object	None.
unitExternalId	string	None.
inserted	date	None.
updated	date	None.

Response Formats

application/json, text/json

Sample:

{
  "externalIdField": "sample string 1",
  "arrivalDateField": "2026-04-18T08:51:44.6099727+00:00",
  "bodyField": {
    "textsField": [
      {
        "textValueField": "sample string 1",
        "localeField": "sample string 2"
      },
      {
        "textValueField": "sample string 1",
        "localeField": "sample string 2"
      }
    ]
  },
  "bookingExternalIdField": {},
  "entityCategorizationsField": [
    0,
    0
  ],
  "externalPropertyUrlField": {},
  "externalReviewUrlField": {},
  "externalStatusField": 0,
  "headlineField": {
    "textsField": [
      {
        "textValueField": "sample string 1",
        "localeField": "sample string 2"
      },
      {
        "textValueField": "sample string 1",
        "localeField": "sample string 2"
      }
    ]
  },
  "listingExternalIdField": "sample string 6",
  "responseField": {
    "textsField": [
      {
        "textValueField": "sample string 1",
        "localeField": "sample string 2"
      },
      {
        "textValueField": "sample string 1",
        "localeField": "sample string 2"
      }
    ]
  },
  "ratingField": 7,
  "ratingScaleField": 0,
  "reviewerField": {
    "emailAddressField": "sample string 1",
    "firstNameField": "sample string 2",
    "lastNameField": "sample string 3",
    "loginNameField": "sample string 4",
    "middleNameField": "sample string 5",
    "screenLocationField": "sample string 6",
    "screenNameField": "sample string 7"
  },
  "thirdPartyReviewProviderIdField": {},
  "unitExternalIdField": "sample string 9",
  "insertedField": "2026-04-18T08:51:44.6099727+00:00",
  "updatedField": "2026-04-18T08:51:44.6099727+00:00",
  "updatedFieldSpecified": true
}

application/xml, text/xml

Sample:

<review xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <inserted>2026-04-18T08:51:44.6099727+00:00</inserted>
  <updated>2026-04-18T08:51:44.6099727+00:00</updated>
  <externalId>sample string 1</externalId>
  <arrivalDate>2026-04-18T08:51:44.6099727+00:00</arrivalDate>
  <body>
    <texts>
      <text locale="sample string 2">
        <textValue>sample string 1</textValue>
      </text>
      <text locale="sample string 2">
        <textValue>sample string 1</textValue>
      </text>
    </texts>
  </body>
  <bookingExternalId />
  <entityCategorizations>
    <entityCategorization>ADVENTURE</entityCategorization>
    <entityCategorization>ADVENTURE</entityCategorization>
  </entityCategorizations>
  <externalPropertyUrl />
  <externalReviewUrl />
  <headline>
    <texts>
      <text locale="sample string 2">
        <textValue>sample string 1</textValue>
      </text>
      <text locale="sample string 2">
        <textValue>sample string 1</textValue>
      </text>
    </texts>
  </headline>
  <listingExternalId>sample string 6</listingExternalId>
  <response>
    <texts>
      <text locale="sample string 2">
        <textValue>sample string 1</textValue>
      </text>
      <text locale="sample string 2">
        <textValue>sample string 1</textValue>
      </text>
    </texts>
  </response>
  <rating>7</rating>
  <reviewer>
    <emailAddress>sample string 1</emailAddress>
    <firstName>sample string 2</firstName>
    <lastName>sample string 3</lastName>
    <loginName>sample string 4</loginName>
    <middleName>sample string 5</middleName>
    <screenLocation>sample string 6</screenLocation>
    <screenName>sample string 7</screenName>
  </reviewer>
  <thirdPartyReviewProviderId />
  <unitExternalId>sample string 9</unitExternalId>
</review>