PUT v1/Article/{articleKey}/Description/{docDescriptionId}

Updates a document description for an article. There can be multiple document descriptions for an article.

Roles Allowed

admin, editor

Request Information

URI Parameters

Name	Description	Type	Additional information
articleKey	Identifies the article the document description applies to	integer	Required
docDescriptionId		integer	Required

Body Parameters

The description associated with the article

DocumentDescriptionUpdate

Name	Description	Type	Additional information
DocumentDescriptionText		string	None.

Request Formats

application/json, text/json

Sample:

{
  "DocumentDescriptionText": "sample string 1"
}

application/xml, text/xml

Sample:

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

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HTTP 201 with Created Subtitle, HTTP 404 if article not found, HTTP 409 if validation fails

DocumentDescription

Name	Type	Additional information
DocumentDescriptionId	integer	None.
DocumentTypeId	integer	None.
DocumentDescriptionText	string	None.

Response Formats

application/json, text/json

Sample:

{
  "DocumentDescriptionId": 1,
  "DocumentTypeId": 2,
  "DocumentDescriptionText": "sample string 3"
}

application/xml, text/xml

Sample:

<DocumentDescription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bondi.Models.V3.ApiDto">
  <DocumentDescriptionText>sample string 3</DocumentDescriptionText>
  <DocumentTypeId>2</DocumentTypeId>
  <DocumentDescriptionId>1</DocumentDescriptionId>
</DocumentDescription>