A API de itens de seção permite interagir com a parte "O Quê?" do uMov.me.
Descrição de um Item de Seção
OBS: Para atualização de cadastro, somente o identificador alternativo é obrigatório.
| Campo | Valor | Tam. | Obrig. | Descrição |
|---|---|---|---|---|
| item | numérico | 10 | Sim | Indica qual é o item que o item de seção pertence. |
| section | numérico | 10 | Sim | Indica qual é a seção que o item de seção pertence. |
| mandatory | true/false | Sim | Indica se o item de seção é obrigatório. | |
| order | numérico | 10 | Sim | Indica a ordenação do item de seção. |
| active | true/false | Sim | Indica se um item de seção está no estado ativo ou não. Pode receber valores "true" ou "false" | |
| id | numérico | 10 | Não | Identificador interno do item de seção no uMov.me |
Busca por lista de Itens de Seção
GET /CenterWeb/api/{$apiKey}/sectionItem.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}/sectionItem.xml?active=true
Esta requisição está pedindo todos os itens de seção disponíveis 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>sectionItem</resourceName>
<size>2</size>
<entries>
<entry id="5421" link="/sectionItem/2870.xml"/>
<entry id="5422" link="/sectionItem/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 Item de Seção específico
GET /CenterWeb/api/{$apiKey}/sectionItem/{$id}.xml
Este recurso serve para puxar dados de um item de seção específico do sistema. Veja o exemplo de retorno de uma entidade abaixo (considerando uma requisição feita em XML):
<sectionItem>
<id>123</id>
<active>true</active>
<order>0</order>
<mandatory>true</mandatory>
</sectionItem>
Inclusão de um Item de Seção
POST /CenterWeb/api/{$apiKey}/sectionItem.xml
Este recurso serve para incluir um item de seção no sistema. Existe um mínimo de informações que o sistema espera receber para poder realizar a criação de um novo item de seção no ambiente em questão. Confira a descrição do item de seção para identificar os campos obrigatórios. Veja dois exemplos da requisição com dados em XML:
<sectionItem>
<active>true</active>
<order>0</order>
<mandatory>true</mandatory>
<section>
<id>1*</id>
</section>
<item>
<id>1**</id>
</item>
</sectionItem>
Neste caso, lendo o que está sendo pedido ao uMov.me é que seja criado um item de seção com o campo obrigatório preenchido (descrição) e ainda, está sendo dito que o item de seção em questão está sendo criado ativo e com o identificador dele no sistema de origem é 33456745.
<sectionItem>
<active>true</active>
<order>0</order>
<mandatory>true</mandatory>
<section>
<alternativeIdentifier>sectionIdentifier</alternativeIdentifier>
</section>
<item>
<alternativeIdentifier>itemIdentifier</alternativeIdentifier>
</item>
</sectionItem>
Neste caso, lendo o que está sendo pedido ao uMov.me é que seja criado um item de seção com o campo obrigatório preenchido (descrição) e ainda, está sendo dito que o item com identificador alternativo 'itemIdentifier' está sendo vinculado à seção em questão com identificador alternativo 'sectionIdentifier'.
*Este identificador interno é somente como exemplo. Você deve usar a seção cadastrada em seu sistemas.
**Este identificador interno é somente como exemplo. Você deve usar o item cadastrado em seu sistemas através do http://center.umov.me/CenterWeb/item
Atualização de um Item de Seção específico
POST /CenterWeb/api/{$apiKey}/sectionItem/{$id}.xml
Este recurso serve para atualizar um item de seção específico do sistema. Existe um mínimo de informações que o sistema espera receber para poder realizar a atualização de um item de seção no ambiente em questão. Confira a descrição do item de seção para identificar os campos obrigatórios. Veja um exemplo da requisição com dados em XML:
<sectionItem>
<active>true</active>
<order>0</order>
<mandatory>true</mandatory>
<section>
<id>1</id>
</section>
<item>
<id>1</id>
</item>
</sectionItem>
Neste caso, lendo o que está sendo pedido ao uMov.me é que seja atualizada a descrição do item de seção cujo id está sendo informado.
Comentários
0 comentário
Por favor, entre para comentar.