Base de Conhecimento

Descrição de um campo da seção

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

Busca por campos na seção

GET /CenterWeb/api/{$apiKey}/sectionField.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}/sectionField.xml?description=foto

Esta requisição está puxando todos os campos da seção em que a sua descrição(description) é igual a pedido.

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

<size>15</size>

<entries>

<entry id="545779" link="/sectionField/545779.xml"/>

<entry id="657983" link="/sectionField/657983.xml"/>

<entry id="888201" link="/sectionField/888201.xml"/>

<entry id="888202" link="/sectionField/888202.xml"/>

<entry id="1533374" link="/sectionField/1533374.xml"/>

<entry id="952519" link="/sectionField/952519.xml"/>

<entry id="545770" link="/sectionField/545770.xml"/>

<entry id="1935876" link="/sectionField/1935876.xml"/>

<entry id="1088073" link="/sectionField/1088073.xml"/>

<entry id="1533375" link="/sectionField/1533375.xml"/>

<entry id="740728" link="/sectionField/740728.xml"/>

<entry id="1088074" link="/sectionField/1088074.xml"/>

<entry id="798239" link="/sectionField/798239.xml"/>

<entry id="798240" link="/sectionField/798240.xml"/>

<entry id="1088075" link="/sectionField/1088075.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 um campo da seção específico

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

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

<sectionField>

<id>1088073</id>

<alternativeIdentifier>ft</alternativeIdentifier>

<mobilePageNumber>1</mobilePageNumber>

<order>1</order>

<nullable>true</nullable>

<description>Foto</description>

<updatable>true</updatable>

<visible>true</visible>

<tip>campo foto</tip>

<type>I</type>

<active>true</active>

<showValueInMobile>false</showValueInMobile>

<showDataCollected>true</showDataCollected>

<persistent>true</persistent>

<locked>false</locked>

<documentation>Documentação</documentation>

<mathExpressions>

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

</mathExpressions>

<logicalExpressions>

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

</logicalExpressions>

</sectionField>

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

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

Este recurso serve para buscar todos os dados de um campo customizável 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):