Details of the request:
- URI: api/v8.1/article/list
- Type: POST
-
Required headings:
- Content-Type: application/json
- Authorization: TOKEN
Parameters:
Name | Guy | Obligatory | Description |
---|---|---|---|
CategoryId | Numerical | No | Category id. |
FieldSearch | String | No | Type of search. |
PrivacyId | Numerical | Yes | Article privacy. |
ProjectId | Numerical | Yes | Project ID. |
TextSearch | String | No | Text to search. |
TypeId | Numerical | No | Id Item type. |
Body of the petition:
The body of the request must contain the PrivacyId and ProjectId parameters, at least to make the query and in turn be filled in.
The ProjectId field only receives integer data and must be filled in with the ID of the project that will be queried.
The PrivacyId field handles privacy and must be filled in with the following integer values:
- 0, See private and public articles.
-
- Check public articles.
Example
{
"PrivacyId":0,
"ProjectId":1
}
For more specific queries, the following parameters can be added:
- CategoryId, the ID of the category to be consulted must be entered.
- TextSearch, see specific text in the Article, which should be enclosed in quotation marks “”.
- TypeId, the item “Type” id must be entered.
-
The parameter FieldSearch, you can send empty or with the following mappings to perform queries according to their type:
- LastVisited: Last visited.
- FavoriteByUser: User Favorites.
- QualifiedByUser: User-rated.
- MostVisitedByUser: Most visited by the user.
- AddedByProject: Added by project.
- MostVisitedByProject: Most visited per project.
- QualifiedByProject: Graded by project.
- AddedByCategory: Added by category.
- MostVisitedByCategory: Most visited by category.
- QualifiedByCategory: Rated by category.
Example:
{
"CategoryId":0,
"FieldSearch":"QualifiedByUser",
"PrivacyId":1,
"ProjectId":2,
"TextSearch":"Ingresar texto",
"TypeId":3
}
Answer:
The service will return a Json with the following structure:
[
{
"Description": "Descripción del artículo",
"Id": valor numérico correspondiente al id,
"Title": "Titulo del Articulo"
}
]
Error messages:
Code | HTTP status | Error Message |
---|---|---|
400 | BadRequest | DataSearchIsNull |
400 | BadRequest | PrivacyIdIsNull |
400 | BadRequest | InvalidProjectId |
400 | BadRequest | InvalidPrivacyId |
401 | Unauthorized | InvalidToken |
500 | InternalServerError | FailureSearchArticle |