Itens e relacionados (Group (Grupo))

A API de group permite interagir com a parte "O Quê?" do uMov.me.

Descrição de um Grupo

OBS: Para atualização de cadastro, somente o identificador alternativo é obrigatório.

Busca por lista de Grupos

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

Esta requisição está pedindo todos os grupos 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>group</resourceName>

<size>2</size>

<entries>

<entry id="5421" link="/group/2870.xml"/>

<entry id="5422" link="/group/2871.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 específico

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

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

<group>

<id>5421</id>

<description>xyz</description>

<active>false</active>

<alternativeIdentifier>id_alternativo</alternativeIdentifier>

</group>

Inclusão de um Grupo

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

Este recurso serve para incluir um grupo no sistema. Existe um mínimo de informações que o sistema espera receber para poder realizar a criação de um novo grupo no ambiente em questão. Confira a descrição do grupo para identificar os campos obrigatórios. Veja um exemplo da requisição com dados em XML:

<group>

<active>true</active>

<description>Novo Grupo</description>

<alternativeIdentifier>33456745</alternativeIdentifier>

</group>

Neste caso, lendo o que está sendo pedido ao uMov.me é que seja criado um grupo com o campo obrigatório preenchido (descrição) e ainda, está sendo dito que o grupo em questão está sendo criado ativo e com o identificador dele no sistema de origem é 33456745.

Atualização de um Grupo específico

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

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

<group>

<description>Novo Grupo</description>

</group>

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

Busca por um Grupo específico

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

Este recurso serve para bucar dados de um grupo específico do sistema através de seu identificador alternativo. Veja o exemplo de retorno de uma entidade abaixo (considerando uma requisição feita em XML):

<group>

<id>401957</id>

<description>grupo1</description>

<alternativeIdentifier>grupoItem</alternativeIdentifier>

<active>true</active>

</group>