ServiceLocalClassification (Classificação de local de atendimento)

A API de serviceLocalClassification permite interagir com a parte "Onde?" do uMov.me.

Descrição de um Classificação de local de atendimento

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 da classificação de local de atendimento no uMov.me
description	texto	100	Sim	Descrição do classificação 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 classificação de local está no estado ativo ou não. Pode receber valores "true" ou "false"

Busca por lista de Classificação de local de atendimento

GET /CenterWeb/api/{$apiKey}/serviceLocalClassification.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}/serviceLocalClassification.xml?description=xyz&active=true

Esta requisição está pedindo todas as classificações 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:

<resourceName>serviceLocalClassification</resourceName>

</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 Classificação de local de atendimento específico

GET /CenterWeb/api/{$apiKey}/serviceLocalClassification/{$id}.xml

Este recurso serve para puxar dados de uma classificação de local específico do sistema. Veja o exemplo de retorno de uma entidade abaixo (considerando uma requisição feita em XML):

<description>classificação 1</description>

<alternativeIdentifier>id_alternativo</alternativeIdentifier>

</serviceLocalClassification>

GET /CenterWeb/api/{$apiKey}/serviceLocalClassification/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:

<description>classificação 1</description>

<alternativeIdentifier>id_alternativo</alternativeIdentifier>

</serviceLocalClassification>

Inclusão de um Classificação de local de atendimento

POST /CenterWeb/api/{$apiKey}/serviceLocalClassification.xml

Este recurso serve para incluir uma classificação 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 nova classificação de local no ambiente em questão. Confira a descrição da classificação de local para identificar os campos obrigatórios. Veja um exemplo da requisição com dados em XML:

<description>nova classificação</description>

<alternativeIdentifier>id_alternativo</alternativeIdentifier>

</serviceLocalClassification>

Neste caso, lendo o que está sendo pedido ao uMov.me é que seja criado uma classificação de local com o campo obrigatório preenchido (descrição) e ainda, está sendo dito que a classificação 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 Classificação de local de atendimento específico

POST /CenterWeb/api/{$apiKey}/serviceLocalClassification/{$id}.xml

Este recurso serve para atualizar uma classificação 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 uma classificação de local no ambiente em questão. Confira a descrição da classificação de local para identificar os campos obrigatórios. Veja um exemplo da requisição com dados em XML:

<description>classificação local alterada</description>

</serviceLocalClassification>

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}/serviceLocalClassification/alternativeIdentifier/{$alternativeId}.xml

<description>classificação local alterada</description>

</serviceLocalClassification>

Neste caso, lendo o que está sendo pedido ao uMov.me é que seja atualizada a descrição da classificação do local cujo id ou id alternativo está sendo informado.

Busca por um Classificação de local de atendimento específico através do identificador alternativo

GET /CenterWeb/api/{$apiKey}/serviceLocalClassification/alternativeIdentifier/{$alternative Identifier}.xml

Este recurso serve para puxar dados de uma classificação de local específico do sistema. Veja o exemplo de retorno de uma entidade abaixo (considerando uma requisição feita em XML):

<serviceLocalClassification>
<id>1949</id>
<description>porto alegre</description>
<alternativeIdentifier>poa</alternativeIdentifier>
<active>true</active>
</serviceLocalClassification>

Comentários

Artigos nessa seção

Artigos relacionados

Artigos nessa seção