The query of the related Items will be made on the ID of the Item that is sent. The idPrivacity field handles the privacy of related articles and must be filled with the following integer values:
- 0, See articles related to private status.
- 1, See articles related to public status.
- 2, See all articles regardless of their privacy.
Details of the request:
- URI: api/v8.1/article/{id}/{idPrivacity}/related/list
- Type: GET
-
Required headings:
- Content-Type: application/json
- Authorization: TOKEN
Parameters:
Name | Data type | Obligatory | Description |
---|---|---|---|
Id | Number | Yes | Article ID |
idPrivacity | Number | Yes | Item privacy id |
Body of the petition:
Empty.
Answer:
The service will return a Json with the following structure:
[
{
"Description": "Ejemplo de descripción",
"Id": 1,
"Title": "Titulo del Artículo"
}
]
Error messages:
Code | HTTP status | Error Message |
---|---|---|
400 | BadRequest | InvalidArticleId |
400 | BadRequest | InvalidIdPrivacity |
401 | Unauthorized | InvalidToken |
404 | NotFound | InvalidArticleId |
500 | InternalServerError | FailureListRelatedArticles |