Padrões de Respostas

Nossos EndPointsEndPoints - Pontos de acesso à funcionalidades da API. Todos seguem o padrão RESTful. dos tipos POST (envio) e PATCH (atualização) são assíncronos e resposta de aceite síncrona, com dois tipos de respostas:

  • síncrona, com o status 202 ACCEPTED
  • erro, com o status 400 BAD REQUEST

Já nossos Endpoints do tipo GET (consulta) são síncronos e possuem duas informações: processKeyprocessKey - Chave da solicitação de processamento (Guid). e createdDatecreatedDate - Data e hora da criação da resposta síncrona (Timespan)..

Quando a API retornar um erro de Status HTTP da classe 400, um objeto, com as seguintes informações, será retornado: a chave de processamento (processKey), uma lista contendo o detalhamento de todos os erros (errors) e a data e hora da criação da resposta síncrona.