Á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 requisição

Campo

Tipo

Descrição

Observações

nomeStringNome do cliente

Obrigatório

Tamanho máximo: 200 caracteres

enderecoStringEndereço principal do cliente

Opcional

Tamanho máximo: 150 caracteres

numeroStringNúmero do endereço principal do cliente

Opcional

Tamanho máximo: 15 caracteres

complementoStringComplemente do endereço pricnipal do cliente

Opcional

Tamanho máximo: 50 caracteres

bairroStringBairro principal do cliente

Opcional

Tamanho máximo: 100 caracteres

cidadeStringCidade principal do cliente

Opcional

Tamanho máximo: 100 caracteres

estadoStringEstado principal do cliente

Opcional

Tamanho máximo: 30 caracteres

cepStringCEP do endereço principal do cliente

Opcional

Tamanho máximo: 10 caracteres

telefoneStringTelefone do cliente

Opcional

Tamanho máximo: 20 caracteres

celularStringCelular do cliente

Opcional

Tamanho máximo:  20 caracteres

emailStringEmail do cliente

Opcional

Tamanho máximo: 80 caracteres

dataNascimentoDatetime

Data de nascimento do cliente

Opcional
situacaoIntSituação do cliente (0 - Inativo, 1 - Ativo)

Obrigatório

pessoaFisicaIntIndica se o cliente é uma pessoa física ou jurídicaObrigatório
cpfCnpjStringCPF ou CNPJ do cliente

Obrigatório

Tamanho máximo: 14 caracteres

rgInscricaoStringRG do cliente

Opcional

Tamanho máximo: 250 caracteres

sexoIntIndica o genero do cliente (Descritivo abaixo)Opcional
estadoCivilIntIndica o estado civil do cliente (Descritivo abaixo)Opcional
avatarUrlStringAvatar do clienteOpcional
atividadeStringAtividade

Opcional

Tamanho máximo: 500 caracteres

crachaStringCrachá

Opcional

Tamanho máximo: 20 caracteres

idInquilinoString

Identificador do inquilino 

Obrigatório
idRetaguardaStringIdentificador do cliente na retaguardaObrigatório
idProprietarioStringIdentificador do proprietárioObrigatório
loteOrigemStringIdentificador do lote em que serão enviados os dadosObrigatório para a integração
Aviso
titleAviso ao desenvolvedor da documentação

Inserir os dados de sexo e estado civil.

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