Itens e relacionados (SubGroup (Subgrupo))

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

Descrição de um Subgrupo

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

Busca por lista de Subgrupos

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

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

<size>2</size>

<entries>

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

<entry id="5422" link="/subGroup/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 Subgrupo específico

GET /CenterWeb/api/{$apiKey}/subGroup/{$idinterno}.xml

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

<subGroup>

<id>1285088</id>

<description>000840</description>

<alternativeIdentifier>000840</alternativeIdentifier>

<group>

<id>385912</id>

<description>Grupo de Clientes</description>

<alternativeIdentifier>GRPCLI</alternativeIdentifier>

<active>true</active>

</group>

<active>true</active>

</subGroup>

Buscar itens de um determinado Subgrupo

GET /CenterWeb/api/{$apiKey}/item.xml?subGroup={$idinterno}

<result>

<resourceName>item</resourceName>

<size>5</size>

<entries>

<entry id="61797032" link="/item/61797032.xml"/>

<entry id="61797058" link="/item/61797058.xml"/>

<entry id="61797036" link="/item/61797036.xml"/>

<entry id="61797031" link="/item/61797031.xml"/>

<entry id="61797057" link="/item/61797057.xml"/>

</entries>

</result>

Inclusão de um Subgrupo

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

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

<subGroup>

<active>true</active>

<description>Novo Subgrupo</description>

<alternativeIdentifier>33456745</alternativeIdentifier>

<group><id>1234</id><group>

</subGroup>

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

Pode também ser criado um subgrupo vinculando o grupo através do identificador alternativo, conforme exemplo abaixo:

<subGroup>

<active>true</active>

<description>Novo Subgrupo</description>

<alternativeIdentifier>33456745</alternativeIdentifier>

<group><alternativeIdentifier>Grupo 1<alternativeIdentifier><group>

</subGroup>

Atualização de um Subgrupo específico

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

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

<subGroup>

<description>Novo Subgrupo</description>

</subGroup>

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

Busca por um Subgrupo específico através do identificador alternativo

GET /CenterWeb/api/{$apiKey}/subGroup/alternativeIdentifier/{$alternative identifier}.xml

Este recurso serve para buscar dados de um subgrupo 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):

<subGroup>

<id>513496</id>

<description>sub1</description>

<alternativeIdentifier>sub_ID</alternativeIdentifier>

<group>

<id>401957</id>

<description>grupo1</description>

<alternativeIdentifier>grupoItem</alternativeIdentifier>

<active>true</active>

</group>

<active>true</active>

</subGroup>