Math Expressions (Fórmulas de Valor)
Descrição de uma fórmula de valor
OBS: Para atualização de cadastro, somente o identificador alternativo é obrigatório.
Busca por fórmula de valor
GET /CenterWeb/api/{$apiKey}/mathExpression.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}/mathExpression.xml?sectionField.type=L§ionField.active=true
Esta requisição filtra fórmulas de valor com base nos atribulos do campo de seção do tipo lista ativos relacionados à fórmula.
GET /CenterWeb/api/{$apiKey}/mathExpression.xml?objectCode=386789
Esta requisição está puxando todos os campos da fórmula de valor em que a sua código do objeto (objectCode) é igual a 386789.
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>mathExpression</resourceName>
<size>12</size>
<entries>
<entry id="1234768" link="/mathExpression/1234768.xml"/>
<entry id="1234767" link="/mathExpression/1234767.xml"/>
<entry id="1194885" link="/mathExpression/1194885.xml"/>
<entry id="1194813" link="/mathExpression/1194813.xml"/>
<entry id="1182968" link="/mathExpression/1182968.xml"/>
<entry id="1182961" link="/mathExpression/1182961.xml"/>
<entry id="1165524" link="/mathExpression/1165524.xml"/>
<entry id="1156643" link="/mathExpression/1156643.xml"/>
<entry id="1156642" link="/mathExpression/1156642.xml"/>
<entry id="1156641" link="/mathExpression/1156641.xml"/>
<entry id="1071423" link="/mathExpression/1071423.xml"/>
<entry id="1108821" link="/mathExpression/1108821.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 fórmula de valor específica
GET /CenterWeb/api/{$apiKey}/mathExpression/1234768.xml
Este recurso serve para puxar dados de uma fórmula de valor específica do sistema. Veja o exemplo de retorno de uma entidade abaixo (considerando uma requisição feita em XML):
<mathExpression>
<id>1234768</id>
<objectType>3</objectType>
<objectCode>3869476</objectCode>
<moment>2</moment>
<expressionForPrint>
Documentação:Custom Entity|=|Pessoa:Campo 2 da Pessoa
</expressionForPrint>
<convertEmptyValuesToZero>false</convertEmptyValuesToZero>
<ordination>1</ordination>
<documentation/>
<sectionField>
<id>3869476</id>
<alternativeIdentifier/>
<mobilePageNumber>1</mobilePageNumber>
<order>1</order>
<nullable>true</nullable>
<description>Custom Entity</description>
<updatable>true</updatable>
<visible>true</visible>
<tip/>
<type>L</type>
<active>true</active>
<listType>U</listType>
<sourceValue>2</sourceValue>
<showValueInMobile>false</showValueInMobile>
<showDataCollected>true</showDataCollected>
<persistent>true</persistent>
<customEntityFieldInternalValue>alternativeId</customEntityFieldInternalValue>
<customEntityFieldExternalValue>description</customEntityFieldExternalValue>
<locked>false</locked>
<documentation/>
</sectionField>
</mathExpression>