# Mensagens de retorno

Ao efetuar a requisição à API REST, o retorno de sucesso ou erro na requisição será feito através de um código de status HTTP, sendo os principais códigos e seus significados, os listados abaixo:

200 OK (Sucesso): Identifica que a requisição foi realizada corretamente e não apresentou nenhum problema referente aos dados enviados e operações realizadas.
202 Accepted: Identifica que a requisição foi realizada com sucesso, porem pode ter ocorrido algum erro interno durante os processos realizados pela integração, como por exemplo, algum registro não encontrado na base de dados.
400 Bad Request (Solicitação inválida): Identifica que ocorreu algum problema ao executar a requisição devido a sintaxe incorreta do documento enviado ou há algum problema nas configurações do servidor. Verificar a mensagem retornada no corpo do retorno.
404 Not Found (Não encontrado): Identifica que alguma das informações chaves, necessárias para completar a requisição passaram na validação básica, mas não foi/foram encontrada(s) no banco de dados. Verificar a mensagem retornada no corpo do retorno. Pode ocorrer em casos de erros internos não esperados pelo sistema.
500 - Internal Server Error (Erro interno do servidor): Identifica que existe algum problema de conexão com o servidor ou o servidor encontrou um erro e não pode completar a solicitação.

Observações:

Para a integração das informações, primeiramente será avaliado toda as informações enviada no arquivo referente a obrigatoriedade dos dados, e se os dados enviados forem válidos será iniciado o processo de integração. Ou seja, caso apresentar algum erro de obrigatoriedade de campos, nenhuma informação do arquivo será processada até ser corrigido esse item.
Ao processar um arquivo é possível que seja retornado o código 200 OK, mas também retornar alguma mensagem de erro, isso ocorre por causa que alguns dados foram processados corretamente, mas entre eles algum apresentou algum erro.
Caso as informações enviadas tenham os seguintes caracteres em seus conteúdos " ou \ é necessário fazer o escape para que não ocorra problema no momento da integração. Para fazer o escape basta colocar um \ antes do caractere.

Exemplo de escape de caractere

Caso a razão social seja

Henry e Ricardo Financeira Ltda\Henry e Ricard"Henry

Então ao montar o JSON deve-se fazer

Henry e Ricardo Financeira Ltda\\Henry e Ricard\"Henry
Ao apresentar o código 400, será retornado uma mensagem ao usuário informando qual o erro que ocorreu e o bloco de informação que apresentou o problema, exemplo:

O bloco de informação corresponde a informação da pessoa como um todo, e está sendo representado através de um índice (sinalizado na imagem acima) que é iniciado por 0. No exemplo acima, pode ser visto que a primeira pessoa na lista apresentou erro de razão social é obrigatória (índice 0). E a terceira pessoa do arquivo processado apresentou erro de documento é obrigatório (índice 2).

# Detalhamento individual de APIs

Análises
- Análise Pedido
  - 202 - Accepted - Requisição efetuada com sucesso
  - 400 - Bad request - Modelo ou informação enviadas são inválidas
- Análise Cliente
  - 200 - Ok - Requisição efetuada com sucesso
  - 400 - Bad request - Modelo ou informação enviadas são inválidas
Consulta dados
- Consulta dados cliente V1
  - 200 - Ok - Requisição efetuada com sucesso
  - 404 - Not Found - Erro interno não esperado ou cliente não encontrado
  - 400 - Bad request - Modelo ou informação enviadas são inválidas
- Consulta dados cliente V2
  - 200 - OK - Requisição efetuada com sucesso
  - 204 - No Content - Erro interno não esperado ou cliente não encontrado
  - 202 - Accepted - Modelo ou informação enviadas são inválidas
- Consulta dados situação pedido
  - 202 - Accepted - Requisição efetuada com sucesso porem ocorreram erros internos
  - 200 - Ok - Requisição efetuada com sucesso
  - 204 - No Content - Erro interno não esperado
  - 400 - Bad Request - Modelo ou informação enviadas são inválidas
- Consulta dados negociação
  - 200 - Ok - Requisição efetuada com sucesso
  - 404 - Not Found - Erro interno não esperado
  - 202 - Accepted - Modelo ou informação enviadas são inválidas
- Detalhamento negociação
  - 200 - OK - Requisição efetuada com sucesso
  - 404 - Not Found - Erro interno não esperado
  - 202 - Accepted - Modelo ou informação enviadas são inválidas
- Titulo negativação
  - 200 - Ok - Requisição efetuada com sucesso
  - 404 - Not Found - Erro interno não esperado
  - 400 - Bad Request - Modelo ou informação enviadas são inválidas
Integrações
- Todas integrações seguem este mesmo padrão
  - 200 - Ok - Requisição efetuada com sucesso
  - 202 - Accepted - Requisição efetuada com sucesso porem ocorreram erros internos
  - 400 - Bad Request - Modelo ou informação enviadas são inválidas
Requisições
- Requisição Limite e Operação
  - 200 - Ok - Requisição efetuada com sucesso
  - 404 - Not Found - Erro interno não esperado
  - 400 - Bad Request - Modelo ou informação enviadas são inválidas
- Listar e alterar Requisição
  - 200 - Ok - Requisição efetuada com sucesso
  - 202 - Accepted - Erro interno não esperado
  - 202 - Accepted - Modelo ou informação enviadas são inválidas
Token
- 200 - Ok - Requisição efetuada com sucesso
- 202 - Accepted - Erro interno não esperado
- 202 - Accepted - Modelo ou informação enviadas são inválidas

← Token Integração de Cadastros →