Respostas de erro

Esta página descreve o formato das respostas de erro comuns a todos os endpoints. Os códigos específicos de cada endpoint estão na página dele.

warning

As respostas 400, 404 e 409 descritas abaixo estão em desenvolvimento e ainda não estão disponíveis em produção. Até a publicação, esses casos retornam o formato genérico {"status": <código>, "error": "None"}, e erros de corpo da requisição retornam 500.

401 - Credenciais inválidas

Headers x-client-id, x-api-key ou x-api-secret ausentes ou inválidos, ou usuário da chave inativo.

{
    "error": "Invalid Client ID, API Key or Secret"
}

Formato dos erros 400, 404 e 409

A chave do erro vem em errors[].attribute. Quando houver detalhe adicional, ele vem em errors[].message. Campos sem valor não aparecem na resposta.

{
    "errors": [
        {
            "attribute": "corpo.invalido",
            "message": "telefones[0]"
        }
    ]
}

info

Alguns endpoints mais antigos usam um formato próprio, como {"status": "erro.criar.solicitacao"} em Criar Solicitação. Consulte a página de cada endpoint.

400 - Requisição inválida

Chave	Quando
corpo.invalido	JSON com formato inválido, tipo de campo diferente do esperado (ex.: texto no lugar de objeto) ou valor inexistente em um campo de lista fixa (ex.: tipoAtendimento com TELEFONICO). message indica o campo, ex.: telefones[0]
parametro.obrigatorio	Parâmetro obrigatório não informado. message indica o parâmetro
Outras chaves	Validações específicas do endpoint, descritas na página dele (ex.: protocolo.atendimento.invalido, cpf.invalido)

404 - Não encontrado

O registro não existe. A chave indica o recurso:

Chave	Recurso
atendimento.nao.encontrado	Atendimento
pessoa.nao.encontrada	Pessoa
tipo.solicitacao.nao.encontrado	Tipo solicitação

409 - Conflito

A operação não é possível no estado atual do registro.

Chave	Quando
atendimento.encerrado	Finalizar ou cancelar um atendimento que já foi finalizado ou cancelado
cpf.existente	Cadastrar uma pessoa com CPF já cadastrado

500 - Erro interno

Uma solicitação inexistente em Consultar solicitação retorna 500.

{
    "status": 500,
    "error": "None"
}