PUT v1/Article/{articleKey}/Subtitle/{subtitleKey}

Update a subtitle.

Roles Allowed

admin, editor

Request Information

URI Parameters

NameDescriptionTypeAdditional information
articleKey

Identifies the article the contributor applies to

integer

Required

subtitleKey

Identifies the subtitle to update

integer

Required

Body Parameters

The new subtitle text

ArticleSubtitleUpdate
NameDescriptionTypeAdditional information
Subtitle

The text of the Subtitle

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Subtitle": "sample string 1"
}

application/xml, text/xml

Sample:
<ArticleSubtitleUpdate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bondi.Models.V3.ApiDto">
  <Subtitle>sample string 1</Subtitle>
</ArticleSubtitleUpdate>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HTTP 200 with Updated Subtitle if found, HTTP 404 otherwise, HTTP 409 if validation fails

ArticleSubtitle
NameDescriptionTypeAdditional information
ArticleSubtitleKey

Unique identifier for a Subtitle

integer

None.

Subtitle

The text of the Subtitle

string

None.

Response Formats

application/json, text/json

Sample:
{
  "ArticleSubtitleKey": 1,
  "Subtitle": "sample string 2"
}

application/xml, text/xml

Sample:
<ArticleSubtitle xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bondi.Models.V3.ApiDto">
  <Subtitle>sample string 2</Subtitle>
  <ArticleSubtitleKey>1</ArticleSubtitleKey>
</ArticleSubtitle>