Base de Conhecimento

Descrição de uma seção

Busca Por Lista de seções

GET /CenterWeb/api/{$apiKey}/section.xml

Se preferir ainda, 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}/section.xml?activity.description={descrição da atividade}

Esta requisição busca todas as seções contidas na atividade requisitada.

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>section</resourceName>

<size>3</size>

<entries>

<entry id="1782990" link="/section/1782990.xml"/>

<entry id="1782991" link="/section/1782991.xml"/>

<entry id="1782992" link="/section/1782992.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 retornada o Id do registro no uMov.me e o link que possa ser usado para recuperar os dados específicos deste registro. Através desta resposta, o chamador da API pode agora buscar as informações específicas dos retornos que foram encontrados.

Busca de uma seção específica

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

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

<section>

<id>1782992</id>

<description>Total</description>

<order>2</order>

<sectionFields/>

<alternativeIdentifier/>

<active>false</active>

<mandatory>1</mandatory>

<useItem>0</useItem>

<findItemsByIdentifier>false</findItemsByIdentifier>

<itemFillMode>0</itemFillMode>

<groupingItemsTypeOnMobile>1</groupingItemsTypeOnMobile>

<activityHistoryReportType>V</activityHistoryReportType>

<displayItemsInMobile>0</displayItemsInMobile>

<seeItemsCollectedAutomatically>false</seeItemsCollectedAutomatically>

<quizMode>false</quizMode>

<locked>false</locked>

<markCompleteGroup>false</markCompleteGroup>

<documentation>Documentação</documentation>

<mathExpressions>

<mathExpression id="1156641" link="/mathExpression/1156641.xml"/>

</mathExpressions>

<logicalExpressions>

<logicalExpression id="1272199" link="/logicalExpression/1272199.xml"/>

</logicalExpressions>

</section>

Busca de uma seção específica através do identificador alternativo

GET /CenterWeb/api/{$apiKey}/section/alternativeIdentifier{$identificador alternativo}

Este recurso serve para buscar todos os dados de uma seção 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):

<section>

<id>2173315</id>

<description>Seção Padrão</description>

<order>0</order>

<sectionFields>

<sectionField id="2190245" link="/sectionField/2190245.xml"/>

<sectionField id="2190246" link="/sectionField/2190246.xml"/>

</sectionFields>

<alternativeIdentifier>SEC_ID</alternativeIdentifier>

<active>true</active>

<mandatory>1</mandatory>

<useItem>2</useItem>