Logo SOAR

Buscar Parágrafos Por Código

Descrição

Retorna uma lista paginada de parágrafos cujo código contenha o termo informado. O parâmetro code deve ter no mínimo 2 caracteres. Suporta filtro adicional por idioma. Retorna 12 registros por página por padrão.

Verbo

GET

URL Base

https://api.soargi.com

Endpoint

/paragraph/search?page=1&limit=12&code=br123&language=

Cabeçalhos

Parâmetro Valor
Authorization Bearer Token

Parâmetros de Consulta

Parâmetro Tipo Obrigatório Descrição
code string Sim Código ou parte do código do parágrafo. Mínimo de 2 caracteres.
page integer Não Número da página. Padrão: 1.
limit integer Não Quantidade de registros por página. Padrão: 12.
language integer Não Filtrar por idioma. Valores: 1 (en), 2 (pt), 3 (es).

Sucesso - 200

{
    "success": true,
    "message": "Paragraphs filtered successfully.",
    "page": 1,
    "limit": 12,
    "total": 8,
    "data": [
        {
            "paragraph_id": "1",
            "language": "pt-BR",
            "code": "br123",
            "message": "Pellentesque quis varius nisl, sit amet blandit velit. Nulla blandit facilisis enim cursus pellentesque. Cras nec ipsum pulvinar, dignissim tellus quis, finibus magna. Proin dictum nibh a ante maximus mattis quis tincidunt urna. Sed fringilla enim nec massa luctus, a varius orci iaculis. Etiam quis quam justo. Phasellus erat velit, auctor a augue eu, pharetra tempor mauris. Sed sed augue sed mi pharetra commodo ac at diam. Nam nisi arcu, placerat non condimentum ut, placerat eu metus. Maecenas placerat molestie malesuada. Praesent sed laoreet tellus, a vestibulum dui. Fusce posuere tellus dolor, vel sollicitudin turpis finibus auctor. Praesent commodo dictum condimentum.",
            "created_at": "2025-04-23 18:54:01",
            "updated_at": "2025-04-23 18:54:01"
        },
        {
            "paragraph_id": "5",
            "language": "pt-BR",
            "code": "br123",
            "message": "Vivamus a consectetur augue, in bibendum nibh. Donec tempus ipsum dui, et molestie nisi condimentum vitae. Sed auctor ante vel arcu eleifend, quis tristique sem congue. Ut viverra quis nisl eget facilisis. Vivamus eget interdum urna, eu mollis arcu. In commodo turpis lorem, at imperdiet ipsum scelerisque eget. Aliquam vehicula laoreet condimentum. Donec blandit quis urna ut pharetra. Donec vel laoreet odio, commodo condimentum enim. Cras velit ligula, sagittis at ultricies sit amet, viverra at lectus. Phasellus faucibus ut tortor vitae ultricies. Praesent vestibulum felis neque, ornare vestibulum nunc blandit id. Aliquam non orci eget eros cursus euismod ut ut nunc. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia curae; In id risus eu turpis accumsan luctus nec non sapien.",
            "created_at": "2025-04-23 18:54:21",
            "updated_at": "2025-04-23 18:54:21"
        },
        {
            "paragraph_id": "6",
            "language": "pt-BR",
            "code": "br123",
            "message": "Texto do paragrafo aqui...",
            "created_at": "2025-05-02 20:57:08",
            "updated_at": "2025-05-02 20:57:08"
        }
    ]
}

Erro - 422 (Código inválido)

{
  "status": 422,
  "error": "Please provide at least 2 characters to search by pgphkey."
}

Códigos de Resposta

  • 200 - Parágrafos encontrados com sucesso
  • 422 - Código inválido ou ausente

Observações

  • É necessário estar autenticado para acessar este endpoint.
  • O parâmetro code é obrigatório e deve ter no mínimo 2 caracteres.
  • A busca é realizada no campo pgphkey.
  • A paginação padrão retorna 12 registros por página.
  • O filtro language aceita valores: 1 (inglês), 2 (português), 3 (espanhol).
  • Todos os filtros (code, language) podem ser combinados com a paginação.
  • Os resultados são ordenados por idioma e código.