Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

02.1.2 Response da requisição.


02.1.2.1 Sucesso - 200

A requisição irá retornar uma Lista com os dados da Solicitação para que o Sistema Jurídico comece a coletar as informações

...

  • response: Array com os dados das Solicitações;
  • response[n].id: Identificação da Solicitação; (Formato UUIDv4)
  • response[n].entidade: Entidade jurídica da Solicitação; (vide dicionário)
  • response[n].campoRetorno: Tag para o calculo de valor para Faturamento; (vide dicionário)
  • response[n].solicitante: Agrupamento de dados do Solicitante;
  • response[n].solicitante.nome: Nome do Solicitante;
  • response[n].solicitante.email: E-mail do Solicitante;
  • response[n].dataLog: Agrupamento de Log da Solicitação;
  • response[n].dataLog.inclusao: Data/Hora da inclusão da Solicitação;
  • response[n].dataLog.processamento: Data/Hora do resposta de processamento da Solicitação;
  • response[n].dataLog.conclusao: Data/Hora da conclusão da Solicitação;
  • response[n].contrato: Agrupamento dos dados do Contrato;
  • response[n].contrato.codigo: Código do Contrato;
  • response[n].contrato.cliente: Código do Cliente do Contrato;
  • response[n].contrato.loja: Loja do Cliente do Contrato;
  • response[n].ocorrencia: Agrupamento da Ocorrência;
  • response[n].ocorrencia.codigo: Código da Ocorrência;
  • response[n].ocorrencia.descricao: Descrição da Ocorrência;
  • response[n].dataReferencia: Agrupamento da Data de Referência;
  • response[n].dataReferencia.inicial: Data inicial para filtro dos registros;
  • response[n].dataReferencia.final: Data final para filtro dos registros;
  • response[n].filtros: Array de filtros adicionais;
  • response[n].filtros[i].campo: Campo a ser filtrado;(vide dicionário)
  • response[n].filtros[i].tipo: Tipo do Filtro; (vide dicionário)
  • response[n].filtros[i].valor: Valor a ser filtrado;
  • response[n].casos: Array de Casos do Contrato;
  • response[n].casos[i].cliente: Código do Cliente do Caso;
  • response[n].casos[i].loja: Loja do Cliente do Caso;
  • response[n].casos[i].caso: Código do Caso;
02.1.2.2 Erro Autenticação - 401

Retornará este erro quando o header de Authorization não for valido

Bloco de código
languagejs
themeRDark
titleResponse - 401
collapsetrue
{
	"mensagem": "Falha na autenticação!"
}

02.2 Método PUT - /api/ocorrencia/pending/{codigoT}/{codigoSolicitacao}

...

02.1.3 Response da requisição

Abaixo seguem as possíveis respostas do serviço

02.1.3.1 Sucesso - 200
Bloco de código
languagejs
themeRDark
titleResponse - 200
collapsetrue
{
	"mensagem": "A solicitação <id_solicitação> foi atualizada com sucesso!"
}
02.1.3.2 Erro Autenticação - 401

Retornará este erro quando o header de Authorization não for valido

Bloco de código
languagejs
themeRDark
titleResponse - 401
collapsetrue
{
	"mensagem": "Falha na autenticação!"
}
02.1.3.3Erro Autenticação - 400

Retornará este erro quando o Body passado para a requisição contiver erros de Encode ou não respeitar a estrutura esperada

Bloco de código
languagejs
themeRDark
titleResponse - 400
collapsetrue
{
	"mensagem": "Body não encontrado!"
}
02.1.3.4Erro Autenticação - 404

Retornará este erro quando ocorrer erro na atualização dos dados da Solicitação

Bloco de código
languagejs
themeRDark
titleResponse - 404
collapsetrue
{
	"mensagem": "A solicitação <id_solicitação> foi atualizada com sucesso!"
}

...