Itens e relacionados (ItemCategory (Categoria de Item))
A API de itemCategory permite interagir com a parte "O Quê?" do uMov.me.
Descrição de uma Categoria de Item
OBS: Para atualização de cadastro, somente o identificador alternativo é obrigatório.
Busca por lista de Categoria de Item
GET /CenterWeb/api/{$apiKey}/itemCategory.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}/itemCategory.xml?description=xyz&active=true
Esta requisição está pedindo todas as categorias de itens 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>itemCategory</resourceName>
<size>2</size>
<entries>
<entry id="5421" link="/itemCategory/2870.xml"/>
<entry id="5422" link="/itemCategory/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 uma Categoria de Item específica
GET /CenterWeb/api/{$apiKey}/itemCategory/{$id}.xml
Este recurso serve para puxar dados de uma categoria de item específica do sistema. Veja o exemplo de retorno de uma entidade abaixo (considerando uma requisição feita em XML):
<itemCategory>
<id>5421</id>
<description>xyz</description>
<active>false</active>
<alternativeIdentifier>id_alternativo</alternativeIdentifier>
</itemCategory>
Inclusão de uma Categoria de Item
POST /CenterWeb/api/{$apiKey}/itemCategory.xml
Este recurso serve para incluir uma categoria de item no sistema. Existe um mínimo de informações que o sistema espera receber para poder realizar a criação de uma nova categoria de item no ambiente em questão. Confira a descrição da categoria para identificar os campos obrigatórios. Veja um exemplo da requisição com dados em XML:
<itemCategory>
<active>true</active>
<description>Nova Categoria</description>
<alternativeIdentifier>33456745</alternativeIdentifier>
</itemCategory>
Neste caso, lendo o que está sendo pedido ao uMov.me é que seja criada uma categoria de item com o campo obrigatório preenchido (descrição) e ainda, está sendo dito que a categoria de item em questão está sendo criado ativo e com o identificador dele no sistema de origem é 33456745.
Atualização de uma Categoria de Item específica
POST /CenterWeb/api/{$apiKey}/itemCategory/{$id}.xml
Este recurso serve para atualizar uma categoria de item específica do sistema. Existe um mínimo de informações que o sistema espera receber para poder realizar a atualização de uma categoria de item no ambiente em questão. Confira a descrição da categoria para identificar os campos obrigatórios. Veja um exemplo da requisição com dados em XML:
<itemCategory>
<description>Nova Categoria</description>
</itemCategory>
Neste caso, lendo o que está sendo pedido ao uMov.me é que seja atualizada a descrição da categoria cujo id está sendo informado.
Busca por uma Categoria de Item específica através do identificador alternativo
GET /CenterWeb/api/{$apiKey}/itemCategory/alternativedentifier{$alternative identifier}.xml
Este recurso serve para buscar dados de uma categoria de item específica do sistema através do seu identificador alternativo. Veja o exemplo de retorno de uma entidade abaixo (considerando uma requisição feita em XML):
<itemCategory>
<id>427594</id>
<description>categItem</description>
<alternativeIdentifier>CAT_ID</alternativeIdentifier>
<active>true</active>
</itemCategory>