Versão 1.00
Estrutura de envio
| Nome | Nível | Obrigatório | Tipo de dado | Descrição |
|---|---|---|---|---|
| enderecos_adicionais | 0 | Sim | Estrutural | |
| endereco_adicional | 1 | Sim | Estrutural | |
| id | 1 | Sim | Inteiro | Id do registro (passar o valor 0, se quiser inserir um novo registro). |
| id_cliente | 2 | Sim | Inteiro | Id do cliente (campo obrigatório). |
| logradouro | 2 | Sim | Texto | Logradouro do endereço. |
| numero | 2 | Sim | Texto | Número do endereço. |
| endereco | 2 | Sim | Texto | Endereço. |
| bairro | 2 | Sim | Texto | Bairro do endereço. |
| cidade | 2 | Sim | Texto | Cidade do endereço. |
| estado | 2 | Sim | Texto | Sigla do estado do endereço. |
| cep | 2 | Sim | Texto | Cep do endereço. |
| complemento | 2 | Sim | Texto | Complemento do endereço. |
| id_area_entrega | 2 | Sim | Inteiro | Id da área de entrega (passar nulo ou zero se não tiver). |
| descricao | 2 | Sim | Texto | Descrição do endereço, para mostrar no cadastro da entidade. |
| ativo | 2 | Sim | Boleano | Campo para ativar ou desativar o registro no cadastro. |
Estrutura de retorno
| Nome | Nível | Tipo de dado | Descrição |
|---|---|---|---|
| retorno | 0 | Estrutural | |
| status | 1 | Inteiro | 0 - Indica que erros ocorreram em um dos registros 1 - Indica sucesso em todos os registros |
| registros | 1 | Estrutural | |
| id | 2 | Texto | Id do registro enviado (Informado pela aplicação cliente) |
| id_gerado | 2 | Inteiro | Id do registro gerado |
| status | 2 | Inteiro | 0 – Indica que algum erro impediu a atualização ou inserção do registro. 1 – Indica sucesso |
| mensagens | 2 | Estrutural | Agrupamento de mensagens que fazem referência a cada ocorrência no id_gerado/id |
| mensagem | 3 | Estrutural | |
| id | 4 | Inteiro | Id da mensagem de retorno |
| descricao | 4 | Texto | Conteúdo da mensagem de retorno |
| mensagens | 1 | Estrutural | Agrupamento de mensagens que fazem referência ao retorno em geral |
| mensagem | 2 | Estrutural | |
| id | 3 | Inteiro | Id da mensagem de retorno |
| descricao | 3 | Texto | Conteúdo da mensagem de retorno |
Exemplo de utilização
<enderecos_adicionais versao="1.00" token="tkn-vinhasoft-001" id_empresa="1">
<endereco_adicional>
<id>167811</id>
<id_cliente>4</id_cliente>
<logradouro>Rua: Maratagua, 03</logradouro>
<numero>3</numero>
<endereco>Rua: Maratagua</endereco>
<bairro>JD Monte Verdes</bairro>
<cidade>Campinas</cidade>
<estado>SP</estado>
<cep>13054578</cep>
<complemento>perto do supermercado Extra</complemento>
<id_area_entrega>0</id_area_entrega>
<descricao>Principal</descricao>
<ativo>true</ativo>
</endereco_adicional>
</enderecos_adicionais>
Exemplos de retorno
<retorno>
<registros>
<registro>
<id>167811</id>
<id_gerado>0</id_gerado>
<status>1</status>
<mensagens>
<mensagem>
<id>17</id>
<descricao>Registro atualizado com sucesso.</descricao>
</mensagem>
</mensagens>
</registro>
</registros>
<status>1</status>
</retorno>