A API de serviceLocalType permite interagir com a parte "Onde?" do uMov.me.
OBS: Para atualização de cadastro, somente o identificador alternativo é obrigatório.
Campo | Valor | Tam. | Obrig. | Descrição |
---|---|---|---|---|
id | numérico | Não | Identificador interno de tipo de local de atendimento no uMov.me | |
description | texto | 100 | Sim | Descrição do tipo de local de atendimento. |
alternativeIdentifier | texto | 100 | Não | Identificador que possibilita a relação com o outros sistemas(legados). |
active | true/false | Não | Indica se um tipo de local está no estado ativo ou não. Pode receber valores "true" ou "false" |
Busca por lista de Tipo de local de atendimento
GET /CenterWeb/api/{$apiKey}/serviceLocalType.xml
Se ainda preferir, pode refinar as pesquisas enviando parâmetros na requisição, para isso é necessário adicionar parâmetros igual realizamos em uma requisição HTTP:
A resposta da requisição será uma mensagem contendo o total de registro retornados e uma lista simples, sem detalhes de cada registro retornado, contendo para cada entrada, o Id do registro no uMov.me e o link que pode ser usado para recuperar os dados específicos deste registro.
Busca por um Tipo de local de atendimento específico
GET /CenterWeb/api/{$apiKey}/serviceLocalType/{$id}.xml
Este recurso serve para puxar dados de um tipo de local específico do sistema. Veja o exemplo de retorno de uma entidade abaixo (considerando uma requisição feita em XML):
GET /CenterWeb/api/{$apiKey}/serviceLocalType/alternativeIdentifier/{$alternativeId}.xml
Pode também realizar a pesquisa utilizando o id alternativo ao invés do id. Veja exemplo do retorno de uma entidade abaixo:
Inclusão de um Tipo de local de atendimento
POST /CenterWeb/api/{$apiKey}/serviceLocalType.xml
Este recurso serve para incluir um tipo de local de atendimento no sistema. Existe um mínimo de informações que o sistema espera receber para poder realizar a criação de uma novo tipo de local no ambiente em questão. Confira a descrição do tipo de local para identificar os campos obrigatórios. Veja um exemplo da requisição com dados em XML:
GET /CenterWeb/api/{$apiKey}/serviceLocalType/alternativeIdentifier{$alternative identifier}.xml
Este recurso serve para bucasdados de um tipo de local específico do sistema através do seu identificador alternativo. Veja o exemplo de retorno de uma entidade abaixo (considerando uma requisição feita em XML):
<serviceLocalType>
<id>7693</id>
<description>lazer</description>
<alternativeIdentifier>clube</alternativeIdentifier>
<active>true</active>
</serviceLocalType>
Comentários
0 comentário
Por favor, entre para comentar.