Detalhes da solicitação:
- URI: api/v8.1/article/list
- Tipo: POST
-
Títulos obrigatórios:
- Tipo de conteúdo: application/json
- Autorização: TOKEN
Parâmetros:
Nome | Cara | Obrigatório | Descrição |
---|---|---|---|
ID da categoria | Numérico | Não | ID da categoria. |
Pesquisa de campo | Corda | Não | Tipo de pesquisa. |
Identificação de privacidade | Numérico | Sim | Privacidade do artigo. |
ID do projeto | Numérico | Sim | ID do projeto. |
Pesquisa de texto | Corda | Não | Texto a ser pesquisado. |
Identificação do tipo | Numérico | Não | Tipo de item de ID. |
Corpo da petição:
O corpo da solicitação deve conter os parâmetros PrivacyId e ProjectId, pelo menos para fazer a consulta e, por sua vez, ser preenchido.
O campo ProjectId recebe apenas dados inteiros e deve ser preenchido com a ID do projeto que será consultado.
O campo PrivacyId lida com a privacidade e deve ser preenchido com os seguintes valores inteiros:
- 0, Veja artigos privados e públicos.
-
- Verifique os artigos públicos.
Exemplo
{
"PrivacyId":0,
"ProjectId":1
}
Para consultas mais específicas, os seguintes parâmetros podem ser adicionados:
- ID da categoria, deve ser inserido o ID da categoria a ser consultada.
- Pesquisa de texto, ver texto específico no artigo, que deve ser colocado entre aspas “”.
- Identificação do tipo, o item “Tipo” id deve ser inserido.
-
O parâmetro Pesquisa de campo, você pode enviar mapeamentos vazios ou com os seguintes mapeamentos para realizar consultas de acordo com seu tipo:
- Última visita: Última visita.
- FavoriteByUser: Favoritos do usuário.
- Qualificado por usuário: Avaliado pelo usuário.
- MostVisitedByUser: Mais visitado pelo usuário.
- Adicionado por Projeto: Adicionado por projeto.
- MostVisitedByProject: Mais visitados por projeto.
- Qualificado por Projeto: Classificado por projeto.
- AdicionadoporCategoria: Adicionado por categoria.
- MaisVisitadoPorCategoria: Mais visitados por categoria.
- QualificadoporCategoria: Classificado por categoria.
Exemplo:
{
"CategoryId":0,
"FieldSearch":"QualifiedByUser",
"PrivacyId":1,
"ProjectId":2,
"TextSearch":"Ingresar texto",
"TypeId":3
}
Responder:
O serviço retornará um Json com a seguinte estrutura:
[
{
"Description": "Descripción del artículo",
"Id": valor numérico correspondiente al id,
"Title": "Titulo del Articulo"
}
]
Mensagens de erro:
Código | Status HTTP | Mensagem de erro |
---|---|---|
400 | Solicitação BadRequest | DataSearchIsNull |
400 | Solicitação BadRequest | PrivacyIdIsNull |
400 | Solicitação BadRequest | InvalidProjectId |
400 | Solicitação BadRequest | InvalidPrivacyId |
401 | Desautorizado | Token inválido |
500 | Erro de servidor interno | FalhaPesquisarArtigo |