Locais e relacionados (ServiceLocalType (Tipo de Local de atendimento))
A API de serviceLocalType permite interagir com a parte "Onde?" do uMov.me.
Descrição de um Tipo de local de atendimento
OBS: Para atualização de cadastro, somente o identificador alternativo é obrigatório.
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:
GET /CenterWeb/api/{$apiKey}/serviceLocalType.xml?description=xyz&active=true
Esta requisição está pedindo todos os tipos de locais disponíveis cuja descrição tenha a palavra xyz presente (description=xyz) e que estejam ativos (active=true). Enviar parâmetros para a API uMov.me é simples assim. Veja um exemplo, do resultado de uma requisição que foi feita em XML:
<result>
<resourceName>serviceLocalType</resourceName>
<size>2</size>
<entries>
<entry id="8578" link="/serviceLocalType/8578.xml"/>
<entry id="8579" link="/serviceLocalType/8579.xml"/>
<entries>
</result>
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):
<serviceLocalType>
<id>8578</id>
<description>Tipo local</description>
<alternativeIdentifier>id_alternativo</alternativeIdentifier>
<active>true</active>
</serviceLocalType>
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:
<serviceLocalType>
<id>8578</id>
<description>Tipo local</description>
<alternativeIdentifier>id_alternativo</alternativeIdentifier>
<active>true</active>
</serviceLocalType>
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:
<serviceLocalType>
<description>novo tipo local</description>
<alternativeIdentifier>id_alternativo</alternativeIdentifier>
<active>true</active>
</serviceLocalType>
Neste caso, lendo o que está sendo pedido ao uMov.me é que seja criado um tipo de local com o campo obrigatório preenchido (descrição) e ainda, está sendo dito que o tipo de local de atendimento em questão está sendo criado ativo e com o identificador dele no sistema de origem é id_alternativo.
Atualização de um Tipo de local de atendimento específico
POST /CenterWeb/api/{$apiKey}/serviceLocalType/{$id}.xml
Este recurso serve para atualizar um tipo de local de atendimento específico do sistema. Existe um mínimo de informações que o sistema espera receber para poder realizar a atualização de um 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:
<serviceLocalType>
<description>tipo local alterado</description>
</serviceLocalType>
Ou pode ainda realizar a requisição usando o id alternativo ao inves do id. Confira um exemplo da requisição com os mesmos dados em XML:
POST /CenterWeb/api/{$apiKey}/serviceLocalType/alternativeIdentifier/{$alternativeId}.xml
<serviceLocalType>
<description>tipo local alterado</description>
</serviceLocalType>
Neste caso, lendo o que está sendo pedido ao uMov.me é que seja atualizada a descrição do tipo local cujo id ou id alternativo está sendo informado.
Busca por um Tipo de local de atendimento específico através do identificador alternativo
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>