AgentType (Tipo de Agente)

A API de AgentType permite interagir com a parte "Quem?" do uMov.me

Descrição de um Tipo de Agente

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

Busca por lista de Tipo de Agente

GET /CenterWeb/api/{$apiKey}/agentType.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}/agentType.xml?description=xyz&active=true

Esta requisição está pedindo todos os tipos de agente disponíveis cuja descrição tenha a palavra xyz presente (description=xyz) e 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>agentType</resourceName>

<size>2</size>

<entries>

<entry id="5421" link="/agentType/2870.xml"/>

<entry id="5422" link="/agentType/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 Tipo de Agente específico

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

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

<agentType>

<id>5421</id>

<description>xyz</description>

<alternativeIdentifier>id_alternativo</alternativeIdentifier>

<active>false</active>

</agentType>

Inclusão de um Tipo de Agente

POST /CenterWeb/api/{$apiKey}/agentType.xml

Este recurso serve para incluir um tipo de agente no sistema. Existe um mínimo de informações que o sistema espera receber para poder realizar a criação de um novo tipo de agente no ambiente em questão. Confira a descrição do tipo de agente para identificar os campos obrigatórios. Veja um exemplo da requisição com dados em XML:

<agentType>

<active>true</active>

<description>Novo Tipo de Agente</description>

<alternativeIdentifier>33456745</alternativeIdentifier>

</agentType>

Neste caso, lendo o que está sendo pedido ao uMov.me é que seja criado um tipo de agente com o campo obrigatório preenchido (descrição) e ainda, está sendo dito que o tipo de agente em questão está sendo criado ativo e que o identificador dele no sistema de origem é 33456745.

Atualização de um Tipo de Agente específico

POST /CenterWeb/api/{$apiKey}/agentType/{$id}.xml

Este recurso serve para atualizar um tipo de agente específico do sistema. Existe um mínimo de informações que o sistema espera receber para poder realizar a atualização de um tipo de agente no ambiente em questão. Confira a descrição do tipo de agente para identificar os campos obrigatórios. Veja um exemplo da requisição com dados em XML:

<agentType>

<description>Nova Descrição para Tipo de Agente Existente</description>

</agentType>

Neste caso, lendo o que está sendo pedido ao uMov.me é que seja atualizada a descrição do tipo de agente cujo id está sendo informado.

Busca por um Tipo de Agente específico através do identificador alternativo

GET /CenterWeb/api/{$apiKey}/agentType/alternativeIdentifier/{$alternativeIdentifier}.xml

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

<agentType>

<id>102496</id>

<description>Tipo Agente Padrão</description>

<alternativeIdentifier>tipo</alternativeIdentifier>

<active>true</active>

</agentType>