local3Dimension (Grupo de local de atendimento)
A API de local3Dimension permite interagir com a parte "Onde?" do uMov.me.
Descrição de um Grupo de local de atendimento
OBS: Para atualização de cadastro, somente o identificador alternativo é obrigatório.
Busca por lista de Grupo de local de atendimento
GET /CenterWeb/api/{$apiKey}/local3Dimension.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}/local3Dimension.xml?description=xyz&active=true
Esta requisição está pedindo todos os grupos 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>local3Dimension</resourceName>
<size>2</size>
<entries>
<entry id="9630" link="/local3Dimension/9630.xml"/>
<entry id="9631" link="/local3Dimension/9631.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 Grupo de local de atendimento específico
GET /CenterWeb/api/{$apiKey}/local3Dimension/{$id}.xml
Este recurso serve para puxar dados de um grupo de local específico do sistema. Veja o exemplo de retorno de uma entidade abaixo (considerando uma requisição feita em XML):
<local3Dimension>
<id>9630</id>
<description>grupo local</description>
<alternativeIdentifier>id_alternativo</alternativeIdentifier>
<active>true</active>
</local3Dimension>
GET /CenterWeb/api/{$apiKey}/local3Dimension/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:
<local3Dimension>
<id>9630</id>
<description>grupo local</description>
<alternativeIdentifier>id_alternativo</alternativeIdentifier>
<active>true</active>
</local3Dimension>
Inclusão de um Grupo de local de atendimento
POST /CenterWeb/api/{$apiKey}/local3Dimension.xml
Este recurso serve para incluir um grupo 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 grupo de local no ambiente em questão. Confira a descrição do grupo de local para identificar os campos obrigatórios. Veja um exemplo da requisição com dados em XML:
<local3Dimension>
<description>novo grupo local</description>
<alternativeIdentifier>novo_id_alternativo</alternativeIdentifier>
<active>true</active>
</local3Dimension>
Neste caso, lendo o que está sendo pedido ao uMov.me é que seja criado um grupo de local com o campo obrigatório preenchido (descrição) e ainda, está sendo dito que o grupo de local de atendimento em questão está sendo criado ativo e com o identificador dele no sistema de origem é novo_id_alternativo.
Atualização de um Grupo de local de atendimento específico
POST /CenterWeb/api/{$apiKey}/local3Dimension/{$id}.xml
Este recurso serve para atualizar um grupo 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 grupo de local no ambiente em questão. Confira a descrição do grupo de local para identificar os campos obrigatórios. Veja um exemplo da requisição com dados em XML:
<local3Dimension>
<description>grupo local alterado</description>
</local3Dimension>
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}/local3Dimension/alternativeIdentifier/{$alternativeId}.xml
<local3Dimension>
<description>grupo local alterado</description>
</local3Dimension>
Neste caso, lendo o que está sendo pedido ao uMov.me é que seja atualizada a descrição do grupo local cujo id ou id alternativo está sendo informado.
Busca por um Grupo de local de atendimento específico por identificador alternativo
GET /CenterWeb/api/{$apiKey}/local3Dimension/alternativeIdentifier{$alternative Identifier}.xml
Este recurso serve para buscar dados de um grupo 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):
<local3Dimension>
<id>905</id>
<description>grupo teste</description>
<alternativeIdentifier>grupoLocal</alternativeIdentifier>
<active>true</active>
</local3Dimension>