Se você está nessa página, nós assumimos que:
Você já tenha um usuário e senha para acesso a sua base de dados

Tenha conhecimento sobre o funcionamento dos exemplos de código através do guia Primeiros passos;

Tenha conhecimento de XML e Web Services SOAP.

O serviço ClientDataAdmin disponibiliza através de suas operações as funcionalidades de inserção, remoção, atualização e consultas em uma base de dados mantida para o cliente Maplink.

Para utilização desta funcionalidade é necessário que o cliente tenha uma base de dados na MapLink, com um conjunto de dados para possibilitar as operações de consulta, inserção, atualização e remoção de registros. Caso você tenha interesse em utilizar este serviço, entre em contato com o gerente comercial responsável pela sua conta da MapLink.

A estrutura abaixo contém as informações de versão, endereço de acesso e contrato de operação para o serviço AddressFinder.

Nome do serviço: ClientDataAdmin
Endereço de acesso: http://services.maplink.com.br/webservices/v3.1/ClientDataAdmin/ClientDataAdmin.asmx
Versão Atual V3.1
Funcionalidade Nome da Operação
Remoção de registros DeleteData
Consulta de registros GetData
Inserção de registro InsertData
Atualização de dados de registro UpdateData

A funcionalidade de remoção de registros está disponível através da operação “DeleteData” e tem como objetivo excluir registros de uma tabela na base de dados do cliente.

Contrato de entrada – Requisição

O contrato de requisição possui os parâmetros “co” (ClientOptions), “user”, e “password”, sendo estes descritos em detalhes a seguir:

  • co

Armazena uma implementação da estrutura ClientOptions com informações da operação a ser realizada na base de dados, por exemplo, cláusula where na query, cláusula order by, campos da tabela, tabela a ser utilizada na operação e etc.

  • user

Nome de usuário para a autenticação na base de dados.

  • password

Senha de usuário para a autenticação na base de dados.

Estrutura “ClientOptions” contém informações de controle para operação a ser executada pela tabela indicada no atributo clientDataSource.
Nome do Atributo Tipo Descrição
clientDataSource Conjunto de caracteres Indica qual o nome da tabela a ser utilizada nas operações do cliente
fields Array de Estrutura Field Indica os campos da tabela a serem utilizados na operação a ser realizada
where Conjunto de caracteres Indica a cláusula where a ser utilizada na operação a ser realizada
orderBy Conjunto de caracteres Indica a cláusula Order By a ser utilizada na operação a ser realizada
resultRange Estrutura ResultRange Indica os campos da tabela a serem utilizados na operação a ser realizada
Estrutura “Field” representa um campo da tabela indicada pelo atributo clientDataSource da estrutura ClientOptions.
Nome do Atributo Tipo Descrição
name Conjunto de caracteres Indica o nome do campo
value Conjunto de caracteres Indica o valor do campo
Estrutura “ResultRange” representa informações necessárias para a montagem da paginação.
Nome do Atributo Tipo Descrição
pageIndex Número inteiro Indica índice da página de retorno
recordsPerPage Número inteiro Indica número de registros por página

Contrato de saída – Resposta

O contrato de resposta possui somente um valor booleano indicando se a operação foi executa com sucesso ou não.

A funcionalidade de consulta de registros está disponível através da operação “getData” e tem como objetivo retornar os registros de uma tabela na base de dados do cliente.

Contrato de entrada – Requisição

O contrato de requisição possui os parâmetros “co” (ClientOptions), “user”, e “password”, sendo estes descritos em detalhes a seguir:

  • co

Armazena uma implementação da estrutura ClientOptions com informações da operação a ser realizada na base de dados, por exemplo, cláusula where na query, cláusula order by, campos da tabela, tabela a ser utilizada na operação e etc.

  • user

Nome de usuário para a autenticação na base de dados.

  • password

Senha de usuário para a autenticação na base de dados.

Contrato de saída – Resposta

O contrato de resposta possui os parâmetros “resultRow” (Array de estrutura ResultRow), “recordCount” e “pageCount”, sendo estes descritos em detalhe a seguir:

  • resultRows

Armazena uma estrutura ResultRow contendo dados retornados após uma operação de busca na tabela indicada pelo atributo clientDataSource da estrutura ClientOptions.

  • recordCount

Armazena o número de registros obtidos para a busca realizada.

  • pageCount

Armazena o número da página referente ao sistema de paginação para a busca realizada.

Estrutura “ResultRow” contém dados retornados após uma operação de busca
Nome do Atributo Tipo Descrição
name Array de conjunto de caracteres Nomes dos campos retornados na busca
value Array de conjunto de caracteres Valores dos campos retornados na busca

A funcionalidade de inserção de registros está disponível através da operação “InsertData” e tem como objetivo inserir um registro na base de dados.

Contrato de entrada – Requisição

O contrato de requisição possui os parâmetros “co” (ClientOptions), “user”, e “password”, sendo estes descritos em detalhes a seguir:

  • co

Armazena uma implementação da estrutura ClientOptions com informações da operação a ser realizada na base de dados, por exemplo, cláusula where na query, cláusula order by, campos da tabela, tabela a ser utilizada na operação e etc.

  • user

Nome de usuário para a autenticação na base de dados.

  • password

Senha de usuário para a autenticação na base de dados.

Contrato de saída – Resposta

O contrato de resposta possui somente um valor booleano indicando se a operação foi executa com sucesso ou não.

A funcionalidade de atualização de dados de registros está disponível através da operação “UpdateData” e tem como objetivo atualizar dados de registros na base de dados.

Contrato de entrada – Requisição

O contrato de requisição possui os parâmetros “co” (ClientOptions), “user”, e “password”, sendo estes descritos em detalhes a seguir:

  • co

Armazena uma implementação da estrutura ClientOptions com informações da operação a ser realizada na base de dados, por exemplo, cláusula where na query, cláusula order by, campos da tabela, tabela a ser utilizada na operação e etc.

  • user

Nome de usuário para a autenticação na base de dados.

  • password

Senha de usuário para a autenticação na base de dados.

Contrato de saída – Resposta

O contrato de resposta possui somente um valor booleano indicando se a operação foi executa com sucesso ou não.