GET v1/Article/{articleKey}/Descriptions
Get the 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 |
Body Parameters
None.
Response Information
Resource Description
HTTP 200 with all document descriptions
Collection of DocumentDescription| Name | Description | 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"
},
{
"DocumentDescriptionId": 1,
"DocumentTypeId": 2,
"DocumentDescriptionText": "sample string 3"
}
]
application/xml, text/xml
Sample:
<ArrayOfDocumentDescription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bondi.Models.V3.ApiDto">
<DocumentDescription>
<DocumentDescriptionText>sample string 3</DocumentDescriptionText>
<DocumentTypeId>2</DocumentTypeId>
<DocumentDescriptionId>1</DocumentDescriptionId>
</DocumentDescription>
<DocumentDescription>
<DocumentDescriptionText>sample string 3</DocumentDescriptionText>
<DocumentTypeId>2</DocumentTypeId>
<DocumentDescriptionId>1</DocumentDescriptionId>
</DocumentDescription>
</ArrayOfDocumentDescription>