Árvore de páginas

Versões comparadas

Chave

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

...

Expandir
titleDefinição dos campos de retorno
Expandir
title200 - Ok
Expandir
titleExemplo do retorno 200

{
  "success": true,
  "message": "string",
  "data": [
    {
      "id": 0,
      "idInquilino": "string",
      "dataAtualizacao": "2024-05-03T20:52:37.521Z",
      "dataCadastro": "2024-05-03T20:52:37.521Z",
      "idRetaguardaLoja": "string",
      "tipoDado": 1,
      "numeroRegistros": 0,
      "numeroRegistrosConfirmados": 0,
      "status": 0,
      "conteudo": "string",
      "observacao": "string"
    }
  ]
}

Expandir
titleDefinições do retorno 200

Campo

Tipo

Descrição

successBooleanoIndica se a criação do compartilhamento foi feita com sucesso
messageStringCaso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo
dataLista de ObjetosLista de caixadados consolidados
data.idLong (Int64)Código Único do Dado Consolidado
data.idInquilinoStringCódigo Id do Inquilino
data.dataAtualizacaoDateTimeData de Atualização do Registro
data.dataCadastroDateTimeData de Cadastro do Registro
data.idRetaguardaLojaStringCódigo Id Retaguarda da Loja
data.tipoDadoEnumTipo do Dados Consolidado (Esse campo retorna o tipo 1 - Venda)
data.numeroRegistrosInt (Int32)Número de Registros Consolidados Enviados
data.numeroRegistrosConfirmadosInt (Int32)Número de Registros Consolidados Confirmados pela Retaguarda
data.statusInt (Int32)Status (0 - Pendente / 1 - Confirmado com Sucesso / 2 - Confirmado com Erro)
data.conteudoTextConteúdo do Consolidado em Base64
data.observacaoStringObservação (Pode ser utilizado como log)
Expandir
title400 - Bad Request

Campo

Tipo

Descrição

SuccessboolIndica se a criação do compartilhamento foi feita com sucesso
MessagestringCaso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo
DataobjetoObjeto compartilhamento criado
ErrorsListaListas com os erros encontrados no processo
TotalTimeinttempo da requisição
NumberOfRecordsintnúmero de dados inseridos

...