| Card |
|---|
| Requisição| Section |
|---|
| Column |
|---|
| Exemplo de body da requisição[
{
"atividade": "string",
"avatarUrl": "string",
"bairro": "string",
"celular": "string",
"cep": "string",
"cidade": "string",
"complemento": "string",
"cpfCnpj": "string",
"cracha": "string",
"dataNascimento": "2024-04-02T18:58:17.727Z",
"email": "string",
"endereco": "string",
"estado": "string",
"estadoCivil": 0,
"idInquilino": "string",
"idProprietario": "string",
"idRetaguarda": "string",
"loteOrigem": "string",
"nome": "string",
"numero": "string",
"pessoaFisica": 0,
"rgInscricao": "string",
"sexo": 0,
"situacao": 0,
"telefone": "string", "IdProfissionalRetaguarda": string"
}
] |
| Column |
|---|
| Definições dos campos do bodyCampo | Tipo | Descrição | Obrigatório | Observações |
|---|
| atividade | String | Atividade | Não | Tamanho máximo: 500 caracteres | | avatarUrl | String | Avatar do cliente | Não | Tamanho máximo: 300caracteres | | bairro | String | Bairro principal do cliente | Não | Tamanho máximo: 100 caracteres | | celular | String | Celular do cliente | Não | Tamanho máximo: 20 caracteres | | cep | String | CEP do endereço principal do cliente | Não | Tamanho máximo: 10 caracteres | | cidade | String | Cidade principal do cliente | Não | Tamanho máximo: 100 caracteres | | complemento | String | Complemente do endereço principal do cliente | Não | Tamanho máximo: 50 caracteres | | cpfCnpj | String | CPF ou CNPJ do cliente | Sim | Tamanho máximo: 14 caracteres | | cracha | String | Crachá | Não | Tamanho máximo: 20 caracteres | | dataNascimento | Datetime | Data de nascimento do cliente | Não |
| | email | String | Email do cliente | Não | Tamanho máximo: 80 caracteres | | endereco | String | Endereço principal do cliente | Não | Tamanho máximo: 150 caracteres | | estado | String | Estado principal do cliente | Não | Tamanho máximo: 30 caracteres | | estadoCivil | Int | Indica o estado civil do cliente (Descritivo abaixo) | Não | Código | Descrição |
|---|
| 0 | Não informado | | 1 | Casado | | 2 | Solteiro | | 3 | Viúvo | | 4 | Separado | | 5 | Devorciado | | 6 | Outros |
| | idInquilino | String | Identificador do inquilino | Sim |
| | idProprietario | String | Identificador do proprietário | Sim |
| | idRetaguarda | String | Identificador do cliente na retaguarda | Sim | Tamanho máximo: 100 caracteres | | loteOrigem | String | Identificador do lote em que serão enviados os dados | Sim |
| | nome | String | Nome do cliente | Sim | Tamanho máximo: 200 caracteres | | numero | String | Número do endereço principal do cliente | Não | Tamanho máximo: 15 caracteres | | pessoaFisica | Int | Indica se o cliente é uma pessoa física ou jurídica | Sim |
| | rgInscricao | String | RG do cliente | Não | Tamanho máximo: 25 caracteres | | sexo | Int | Indica o genero do cliente (Descritivo abaixo) | Não | | Código | Definição |
|---|
| 0 | Não Definido | | 1 | Masculino | | 2 | Feminino |
| | situacao | Int | Situação do cliente | Sim | 0 - Inativo, 1 - Ativo | | telefone | String | Telefone do cliente | Não | Tamanho máximo: 20 caracteres | | IdProfissionalRetaguarda | String | Id do Profissional vinculado ao cliente | Não | Tamanho máximo: 100 caracteres |
|
|
Retorno| Deck of Cards |
|---|
| | Card |
|---|
| | Column |
|---|
| Exemplo de body de retorno{
"success": true,
"message": "Requisição inserida com sucesso!",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
} |
| Column |
|---|
| Definições dos campos do retornoCampo | Tipo | Descrição |
|---|
| Success | bool | Indica se a criação do compartilhamento foi feita com sucesso | | Message | string | Caso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo | | Data | objeto | Objeto compartilhamento criado | | Errors | Lista | Listas com os erros encontrados no processo | | TotalTime | int | tempo da requisição | | NumberOfRecords | int | número de dados inseridos |
|
|
| Card |
|---|
| | Aviso |
|---|
Devido a arquitetura implentada temos dois retornos de erros que foram padronizados na versão três deste endpoint |
| Deck of Cards |
|---|
| | Card |
|---|
| | Informações |
|---|
Este retorno ocorre quando um campo enviado não passa pela validação, por exemplo, não enviar um dado obrigatório |
| Column |
|---|
| {
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "string",
"details": [
{
"guid": "string",
"code": "string",
"message": "string",
"detailedMessage": "string"
}
]
} |
| Column |
|---|
| Campo | Tipo | Descrição |
|---|
| code | string | Código de erro | | message | string | Mensagem do erro | | detailedMessage | string | Detalhamento do erro | | helpUrl | string | url de ajuda | | TotalTime | string | Tempo total de busca | | details | lista de objeto | Lista de objeto de erros | | details.guid | string | Identificador do erro | | details.code | string | Código do erro | | details.message | string | Mensagem do erro | | details.detailedMessage | string | Detalhamento do erro |
|
|
| Card |
|---|
| | Informações |
|---|
Este retorno ocorre quando algo na aplicação não ocorreu da forma esperada, por exemplo, quando uma excessão é lançada pela aplicação |
| Section |
|---|
| Column |
|---|
| {
"success": false,
"message": "",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
} |
| Column |
|---|
| Campo | Tipo | Descrição |
|---|
| Success | bool | Indica se a criação do cliente foi feita com sucesso | | Message | string | Messagem com os erros | | Data | objeto | Objeto cliente | | Errors | Lista | Listas com os erros encontrados no processo | | TotalTime | int | tempo da requisição | | NumberOfRecords | int | número de dados inseridos |
|
|
|
|
|
|
|
| Card |
|---|
| | Informações |
|---|
Este endpoint ainda está em processo de manutenção, as informações estão disponibilizadas apenas para consulta, não sendo possível realizar a requisição. |
Requisição| Section |
|---|
| Column |
|---|
| Exemplo de body da requisição[
{
"atividade": "string",
"avatarUrl": "string",
"bairro": "string",
"celular": "string",
"cep": "string",
"cidade": "string",
"complemento": "string",
"cpfCnpj": "string",
"cracha": "string",
"dataNascimento": "2024-04-02T18:58:17.727Z",
"descricao": "string",
"email": "string",
"endereco": "string",
"estado": "string",
"estadoCivil": 0,
"idInquilino": "string",
"idProprietario": "string",
"idRetaguarda": "string",
"loteOrigem": "string",
"nome": "string",
"numero": "string",
"pessoaFisica": 0,
"rgInscricao": "string",
"sexo": 0,
"situacao": 0,
"telefone": "string",
"tipoEndereco": 0, "idProfissionalRetaguarda": "string"
}
] |
| Column |
|---|
| Definições dos campos do bodyCampo | Tipo | Descrição | Obrigatório | Observações |
|---|
| nome | String | Nome do cliente | Sim | Tamanho máximo: 250 caracteres | | endereco | String | Endereço principal do cliente | Não | Tamanho máximo: 150 caracteres | | numero | String | Número do endereço principal do cliente | Não | Tamanho máximo: 15 caracteres | | complemento | String | Complemente do endereço principal do cliente | Não | Tamanho máximo: 50 caracteres | | bairro | String | Bairro principal do cliente | Não | Tamanho máximo: 100 caracteres | | cidade | String | Cidade principal do cliente | Não | Tamanho máximo: 100 caracteres | | estado | String | Estado principal do cliente | Não | Tamanho máximo: 30 caracteres | | cep | String | CEP do endereço principal do cliente | Não | Tamanho máximo: 10 caracteres | | telefone | String | Telefone do cliente | Não | Tamanho máximo: 20 caracteres | | celular | String | Celular do cliente | Não | Tamanho máximo: 20 caracteres | | email | String | Email do cliente | Não | Tamanho máximo: 80 caracteres | | dataNascimento | Datetime | Data de nascimento do cliente | Não |
| | situacao | Int | Situação do cliente | Sim | 0 - Inativo, 1 - Ativo | | pessoaFisica | Int | Indica se o cliente é uma pessoa física ou jurídica | Sim | 0 - Pessoa Física, 1 - Pessoa Jurídica | | cpfCnpj | String | CPF ou CNPJ do cliente | Não | Tamanho máximo: 25 caracteres | | rgInscricao | String | RG do cliente | Não | Tamanho máximo: 25 caracteres | | sexo | Int | Indica o genero do cliente | Não | | Descrição | Código |
|---|
| Não informado | 0 | | Masculino | 1 | | Feminino | 2 |
| | estadoCivil | Int | Indica o estado civil do cliente | Não | | Descrição | Código |
|---|
| Não informado | 0 | | Casado | 1 | | Solteiro | 2 | | Viúvo | 3 | | Separado | 4 | | Devorciado | 5 | | Outros | 6 |
| | avatarUrl | String | DEFASADO | Não | DEFASADO | | atividade | String | Atividade | Não | Tamanho máximo: 500 caracteres | | cracha | String | DEFASADO | Não | DEFASADO | | idInquilino | String | Identificador do inquilino | Sim |
| | idRetaguarda | String | Identificador do cliente na retaguarda | Sim | Tamanho máximo: 100 caracteres | | idProprietario | String | Identificador do proprietário | Sim |
| | loteOrigem | String | Identificador do lote em que serão enviados os dados | Sim |
| | tipoEndereco | Int | Tipo Endereço | Não | | Descrição | Código |
|---|
| Entrega | 0 | | Comercial | 1 | | Cobrança | 2 |
| | descricao | String | Descrição | Não | Tamanho maxímo: 100 caracteres | | idProfissionalRetaguarda | String | Id do Profissional vinculado ao cliente | Não | Tamanho maxímo: 100 caracteres |
|
|
Retornos| Deck of Cards |
|---|
| | Card |
|---|
| | Column |
|---|
| Exemplo de body de retorno{
"success": true,
"message": "Requisição inserida com sucesso!",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
} |
| Column |
|---|
| Definições dos campos do retornoCampo | Tipo | Descrição |
|---|
| Success | bool | Indica se a criação do compartilhamento foi feita com sucesso | | Message | string | Caso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo | | Data | objeto | Objeto compartilhamento criado | | Errors | Lista | Listas com os erros encontrados no processo | | TotalTime | int | tempo da requisição | | NumberOfRecords | int | número de dados inseridos |
|
|
| Card |
|---|
| | Column |
|---|
| Exemplo de body de retorno{
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "string",
"details": [
{
"guid": "string",
"code": "string",
"message": "string",
"detailedMessage": "string"
}
]
} |
| Column |
|---|
| Definições dos campos do retornoCampo | Tipo | Descrição |
|---|
| code | string | Código de erro | | message | string | Mensagem do erro | | detailedMessage | string | Detalhamento do erro | | helpUrl | string | url de ajuda | | TotalTime | string | Tempo total de busca | | details | lista de objeto | Lista de objeto de erros | | details.guid | string | Identificador do erro | | details.code | string | Código do erro | | details.message | string | Mensagem do erro | | details.detailedMessage | string | Detalhamento do erro |
|
|
|
|
|
