POST api/reviews

Add property reviews for an authorized integration partner.

Request Information

URI Parameters

None.

Body Parameters

AddPropertyReviewRequest
NameDescriptionTypeAdditional information
PropertyReview

Gets or sets PropertyReview.

PropertyReview

None.

Request Formats

application/json, text/json

Sample:
{
  "PropertyReview": {
    "ApartmentListingKey": "sample string 1",
    "PropertyAddress": {
      "PropertyName": "sample string 1",
      "StreetAddress1": "sample string 2",
      "StreetAddress2": "sample string 3",
      "City": "sample string 4",
      "StateCode": "sample string 5",
      "CountryCode": "sample string 6",
      "Zip": "sample string 7"
    },
    "Reviews": [
      {
        "VendorReviewId": 1,
        "Title": "sample string 2",
        "ReviewText": "sample string 3",
        "Rating": 4,
        "CultureCode": "sample string 5",
        "CompletedDate": "2022-01-19T06:55:00.269597-05:00"
      },
      {
        "VendorReviewId": 1,
        "Title": "sample string 2",
        "ReviewText": "sample string 3",
        "Rating": 4,
        "CultureCode": "sample string 5",
        "CompletedDate": "2022-01-19T06:55:00.269597-05:00"
      }
    ]
  }
}

application/xml, text/xml

Sample:
<AddPropertyReviewRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Apts.Api.WebApi.Models.Review">
  <PropertyReview>
    <ApartmentListingKey>sample string 1</ApartmentListingKey>
    <PropertyAddress xmlns:d3p1="http://schemas.datacontract.org/2004/07/Apts.Api.WebApi.Models.Common">
      <d3p1:City>sample string 4</d3p1:City>
      <d3p1:CountryCode>sample string 6</d3p1:CountryCode>
      <d3p1:PropertyName>sample string 1</d3p1:PropertyName>
      <d3p1:StateCode>sample string 5</d3p1:StateCode>
      <d3p1:StreetAddress1>sample string 2</d3p1:StreetAddress1>
      <d3p1:StreetAddress2>sample string 3</d3p1:StreetAddress2>
      <d3p1:Zip>sample string 7</d3p1:Zip>
    </PropertyAddress>
    <Reviews>
      <ReviewAddition>
        <CompletedDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DateTime>2022-01-19T11:55:00.269597Z</d5p1:DateTime>
          <d5p1:OffsetMinutes>-300</d5p1:OffsetMinutes>
        </CompletedDate>
        <CultureCode>sample string 5</CultureCode>
        <Rating>4</Rating>
        <ReviewText>sample string 3</ReviewText>
        <Title>sample string 2</Title>
        <VendorReviewId>1</VendorReviewId>
      </ReviewAddition>
      <ReviewAddition>
        <CompletedDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DateTime>2022-01-19T11:55:00.269597Z</d5p1:DateTime>
          <d5p1:OffsetMinutes>-300</d5p1:OffsetMinutes>
        </CompletedDate>
        <CultureCode>sample string 5</CultureCode>
        <Rating>4</Rating>
        <ReviewText>sample string 3</ReviewText>
        <Title>sample string 2</Title>
        <VendorReviewId>1</VendorReviewId>
      </ReviewAddition>
    </Reviews>
  </PropertyReview>
</AddPropertyReviewRequest>

application/x-www-form-urlencoded

Sample:
application/x-www-form-urlencoded not supported.

Response Information

Resource Description

AddPropertyReviewResponse

AddPropertyReviewResponse
NameDescriptionTypeAdditional information
ReviewAddedCount

The count of reviews got added.

integer

None.

Successful

Whether successful or not.

boolean

None.

Error

If Successful is false, the ValidationError will be populated with error details.

ValidationError

None.

Response Formats

application/json, text/json

Sample:
{
  "ReviewAddedCount": 1,
  "Successful": true,
  "Error": {
    "PropertyName": "sample string 1",
    "GeneralError": "sample string 2",
    "PropertyErrors": [
      "sample string 1",
      "sample string 2"
    ],
    "ReviewErrors": [
      {
        "VendorReviewId": 1,
        "Errors": [
          "sample string 1",
          "sample string 2"
        ]
      },
      {
        "VendorReviewId": 1,
        "Errors": [
          "sample string 1",
          "sample string 2"
        ]
      }
    ]
  }
}

application/xml, text/xml

Sample:
<AddPropertyReviewResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Apts.Api.WebApi.Models.Review">
  <Error xmlns:d2p1="http://schemas.datacontract.org/2004/07/Apts.Api.WebApi.Helper.Models">
    <d2p1:GeneralError>sample string 2</d2p1:GeneralError>
    <d2p1:PropertyErrors xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </d2p1:PropertyErrors>
    <d2p1:PropertyName>sample string 1</d2p1:PropertyName>
    <d2p1:ReviewErrors>
      <d2p1:ReviewError>
        <d2p1:Errors xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </d2p1:Errors>
        <d2p1:VendorReviewId>1</d2p1:VendorReviewId>
      </d2p1:ReviewError>
      <d2p1:ReviewError>
        <d2p1:Errors xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </d2p1:Errors>
        <d2p1:VendorReviewId>1</d2p1:VendorReviewId>
      </d2p1:ReviewError>
    </d2p1:ReviewErrors>
  </Error>
  <ReviewAddedCount>1</ReviewAddedCount>
  <Successful>true</Successful>
</AddPropertyReviewResponse>