Base de Conhecimento

A API de atividade permite consultar as atividades existentes no uMov.me.

Descrição de uma Atividade

OBS:

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

Busca por atividades

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

Esta requisição está puxando todas as atividades 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>activity</resourceName>

<size>1</size>

<entries>

<entry id="1802274" link="/activity/1802274.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.

GET /CenterWeb/api/{$apiKey}/activity.xml?initialInsertDateTime=AAAA-MM-DD HH:MM:SS&finalInsertDateTime=AAAA-MM-DD HH:MM:SS

Esta requisição filtra todos os agentes que foram inseridos neste período de data e hora.

Busca de uma Atividade específica

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

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

<activity>

<id>1802275</id>

<description>Fechamento</description>

<sections>

<section id="1782993" link="/section/1782993.xml"/>

<section id="1782994" link="/section/1782994.xml"/>

</sections>

<alternativeIdentifier>ID_Fechamento</alternativeIdentifier>

<active>true</active>

<comunicationType>0</comunicationType>

<executionType>1</executionType>

<loopExecution>false</loopExecution>

<showsSessionWebForm>false</showsSessionWebForm>

<confirmClose>1</confirmClose>

<acceleratedExecution>false</acceleratedExecution>

<confirmWithoutGPS>true</confirmWithoutGPS>

<GPSIsMandatory>false</GPSIsMandatory>

<captureGPS>false</captureGPS>

<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>

</activity>

Busca de uma Atividade específica através do identificador alternativo

GET /CenterWeb/api/{$apiKey}/activity/alternativeIdentifier/{$identificador alternativo}.xml

Este recurso serve para buscar dados de uma atividade 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):