Árvore de páginas

Versões comparadas

Chave

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

...

Expandir
titleExemplo de body da requisição

[
    {
        "descricao": "string",
        "tipoDadoComplementaridInquilino": 0"string",
        "obrigatorioidProprietario": 0"string",
        "tamanhoidRetaguarda": 0"string",
        "situacaoloteOrigem": 0"string",
        "idInquilinoobrigatorio": "string"0,
        "idRetaguardasituacao": "string"0,
        "idProprietariotamanho": "string"0,
        "loteOrigemtipoDadoComplementar": "string"0
    }
]

ListaSelecao
Expandir
titleDefinição dos campos de requisição

Campo

Tipo

Descrição

Observações

Obrigatório

descricaoStringDescrição do dado complementar

Obrigatório

Tamanho máximo: 30 caracteres

Não

tipoDadoComplementarIntTipo do dado
complementar (Descritivo abaixo)
complementar 
CódigoTipo
0Alfanumerico
1Numerico
2Data
3ListaSelecao
Não
Obrigatório
obrigatorioIntIndica se o dado é obrigatório
(
0 - Opcional, 1 - Obrigatório
)
Obrigatório
Sim
tamanhoIntTamanho do dado complementar
Opcional

Não
situacaoIntSituação do dado
complementar (
complementar 0 - Inativo, 1 - Ativo
)
Obrigatório
Sim
idInquilinoStringIdentificador do inquilino
Obrigatório

Sim
idRetaguardaStringIdentificador do dado complementar na retaguarda
Obrigatório

Sim
idProprietarioStringIdentificador do proprietário
Obrigatório
CódigoTipo
0Alfanumerico
1Numerico
2Data
3

Sim
loteOrigemStringIdentificador do lote em que os dados serão enviados
Obrigatório para a integração
Expandir
titleTipoDadoComplementar

Sim
Expandir
titleDefinição dos campos de retorno
Expandir
title200 - Ok

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
Expandir
title400 - Bad Request

Campo

Tipo

Descrição

codestringCódigo de erro
messagestringMensagem do erro
detailedMessagestringDetalhamento do erro
helpUrlstringurl de ajuda
TotalTimestringTempo total de busca
detailslista de objetoLista de objeto de erros
details.guidstringIdentificador do erro
details.codestringCódigo do erro
details.messagestringMensagem do erro 
details.detailedMessagestringDetalhamento do erro