POST api/Testimonial

Creates or updates a testimonial. Will create the testimonial listing node if it does not yet exist for the branch.

Request Information

URI Parameters

None.

Body Parameters

To create or update

SerializableTestimonial
NameDescriptionTypeAdditional information
Author

Name of the author.

string

Required

AutoPublish

Whether this should be automatically published. If not, an Umbraco administrator must manually navigate to the testimonial, review and then publish it.

boolean

None.

BranchId

Branch ID.

string

Required

BrandCode

Brand code of the <see cref="P:Spicerhaart.Library.Models.SerializableTestimonial.BranchId">BranchId</see>, e.g. "HRT".

string

Required

Comment

Comment from the author.

string

Required

DateTime

Date time this testimonial was created.

date

Required

ImageName

If set, the name of the image.

string

None.

ImagePath

If set, the path to the image.

string

None.

Name

Name of the testimonial for easy access in Unbraco.

string

Required

PropertyTransactionType

The ID of the type of transaction associated with the testimonial, e.g. first-time buyer; this needs to match those set up in Umbraco.

string

Required

Rating

If set, the rating from the author.

integer

None.

TestimonialId

Unique ID assigned to the testimonial outside of Umbraco.

string

Required

Town

If set, the town in which the author resides.

string

None.

VideoAspectRatio

If set, the aspect ratio of the either supplied video.

string

None.

VimeoVideo

If set, the Vimeo video to show.

string

None.

Request Formats

application/json, text/json

Sample:
{
  "TestimonialId": "sample string 1",
  "Name": "sample string 2",
  "BrandCode": "sample string 3",
  "BranchId": "sample string 4",
  "Comment": "sample string 5",
  "DateTime": "2024-11-03T13:22:02.5933114+00:00",
  "ImagePath": "sample string 7",
  "ImageName": "sample string 8",
  "Author": "sample string 9",
  "Town": "sample string 10",
  "PropertyTransactionType": "sample string 11",
  "Rating": 12,
  "VideoAspectRatio": "sample string 13",
  "VimeoVideo": "sample string 14",
  "AutoPublish": true
}

application/xml, text/xml

Sample:
<SerializableTestimonial xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Spicerhaart.Library.Models">
  <Author>sample string 9</Author>
  <AutoPublish>true</AutoPublish>
  <BranchId>sample string 4</BranchId>
  <BrandCode>sample string 3</BrandCode>
  <Comment>sample string 5</Comment>
  <DateTime>2024-11-03T13:22:02.5933114+00:00</DateTime>
  <ImageName>sample string 8</ImageName>
  <ImagePath>sample string 7</ImagePath>
  <Name>sample string 2</Name>
  <PropertyTransactionType>sample string 11</PropertyTransactionType>
  <Rating>12</Rating>
  <TestimonialId>sample string 1</TestimonialId>
  <Town>sample string 10</Town>
  <VideoAspectRatio>sample string 13</VideoAspectRatio>
  <VimeoVideo>sample string 14</VimeoVideo>
</SerializableTestimonial>

Response Information

Resource Description

Success

HttpResponseMessage
NameDescriptionTypeAdditional information
Content

HttpContent

None.

Headers

Collection of Object

None.

IsSuccessStatusCode

boolean

None.

ReasonPhrase

string

None.

RequestMessage

HttpRequestMessage

None.

StatusCode

HttpStatusCode

None.

Version

Version

None.