Descargar PDF

Detalles de la petición:

• URI: api/v8.1/article/list
• Tipo: POST
• Encabezados requeridos:
  • Content-Type: application/json
  • Authorization: TOKEN

Parámetros:

Cuerpo de la petición:

En el cuerpo de la petición tienen que venir los parámetros PrivacyId y ProjectId, como mínimo para realizar la consulta y a su vez estar diligenciados.

El campo ProjectId, solo recibe datos enteros y debe ser diligenciado con el ID del proyecto que será consultado.

El campo PrivacyId, maneja la privacidad y debe ser diligenciado con los siguientes valores enteros:

• 0, Consulta los artículos privados y públicos.
• 1, Consulta los artículos públicos.

Ejemplo

{
    "PrivacyId":0,
    "ProjectId":1
}

Para consultas más específicas, se pueden adicionar los siguientes parámetros:

• CategoryId, se debe ingresar el ID de la categoría a consultar.
• TextSearch, consulta un texto en específico del Articulo, el cual debe ir entre comillas “”.
• TypeId, se debe ingresar el id del “Tipo” de artículo.

• El parámetro FieldSearch, puede envíar vacío o con las siguientes asignaciones para realizar las consultas de acuerdo a su tipo:

  • LastVisited: Últimos visitados.
  • FavoriteByUser: Favoritos del usuario.
  • QualifiedByUser: Calificados por el usuario.
  • MostVisitedByUser: Más visitados por el usuario.
  • AddedByProject: Añadidos por proyecto.
  • MostVisitedByProject: Más visitados por proyecto.
  • QualifiedByProject: Calificados por proyecto.
  • AddedByCategory: Añadidos por categoría.
  • MostVisitedByCategory: Más visitados por categoría.
  • QualifiedByCategory: Calificados por categoría.

Ejemplo:

{
     "CategoryId":0,
     "FieldSearch":"QualifiedByUser",
     "PrivacyId":1,
     "ProjectId":2,
     "TextSearch":"Ingresar texto",
     "TypeId":3
}

Respuesta:

El servicio retornará un Json con la siguiente estrutura:

[
 {
    "Description": "Descripción del artículo",
    "Id": valor numérico correspondiente al id,
    "Title": "Titulo del Articulo"
 }
]

Mensajes de error: