Cabeçalho padrão de inserções
Atributos padrões
| Nome | Obrigatório | Tipo de dado | Finalidade | Descrição |
|---|---|---|---|---|
| versao | Sim | Texto | Versionamento | Determina a versão do serviço a ser consumido. O retorno pode variar de acordo com o valor do atributo. |
| id_empresa | Sim | Inteiro | Filtro | ID da empresa na qual o serviço irá se basear. |
| token | Sim | Texto | Filtro | Informação única por usuário de acesso. Determina o nível de acesso das informações. |
No bloco de inserções, o cabeçalho padrão é adicionado aos atributos do XML da requisição do serviço. A cada requisição, é dentro do cabeçalho padrão que devemos informar os atributos de versão do serviço, id da empresa a ser acessada e o token de acesso.
- O cabeçalho padrão é composto por atributos que são adicionados ao XML que é passado como parâmetro em cada requisição
- Toda versão de um serviço faz o uso desses atributos
- Determinadas versões aceitam atributos adicionais
Exemplos de utilização
<financeiro versao="1.00" token="tkn-vinhasoft-001" id_empresa="1"> <id_tipo_pagamento>151</id_tipo_pagamento> <id_pedido>2773231</id_pedido> <qtd_parcelas>2</qtd_parcelas> <id_operadora_cartao>101</id_operadora_cartao> <valor_juros>0</valor_juros> <valor_total>100</valor_total> <data_pagamento>2016-02-15T08:00:10.5</data_pagamento> <doc_nsu>3657659278169872547Q</doc_nsu> <cod_autorizacao>000587</cod_autorizacao> </financeiro>
<dados_pedido versao="1.00" id_empresa="1" token="tkn-vinhasoft-001">
<pedido>
<id>500</id>
<id_status>14</id_status>
<data_entrega>2016-05-20T17:24:00</data_entrega>
</pedido>
</dados_pedido>
<entidades versao="1.00" id_empresa="1" token="tkn-vinhasoft-001" atualizar_dados="true"> <entidade id_externo="id_ext_xpto123"> <id>83511</id> <descricao>Novo nome de exemplo</descricao> <email>novo_email@vinhasoft.com.br</email> </entidade> </entidades>