A API de Itinerary é responsável pela manutenção das rotas. É nela que vamos conseguir criar uma rota e permitir vincular locais, pessoas e atividades na mesma. Através dos recursos desta API poderemos criar rotas e atualizar as mesmas.
Descrição de um Rota
OBS: Para atualização de cadastro, somente o identificador alternativo é obrigatório.
| Campo | Valor | Tam. | Obrig. | Descrição |
|---|---|---|---|---|
| active | true/false | Não | Indica se a rota está ativa ou não | |
| description | texto | 100 | Sim | Descrição para identificação da rota |
| origin | numérico | 1 | Sim | Origem das atividades da rota. 0(Atividades informadas na rota), 1(atividades do agente), 2(atividades do local de atendimento), 3 (atividades cadastradas como padrao do sistema), 5(todas as atividades). Para vincular atividades na rota, deve ser colocado o valor "0" |
| agentRelation | numérico | 1 | Sim | Pessoas que tem acesso a rota para execução no mobile. 0(Somente pessoas selecionadas), 1(Todas as pessoas). Para vincular pessoas na rota, deve ser colocado o valor "0" |
| displayOrder | numérico | 10 | Sim | Ordem de exibição da rota no mobile |
| alternativeIdentifier | texto | 100 | Não | Identificador que possibilita a relação com o outros sistemas(legados). |
| validateTaskOnField | numérico | 1 | Sim | Validação de tarefas ao executar rota: 0 (Não valida), 1 (Valida tarefas pendentes e em campo e não deixa baixar rota), 2 (Sempre cria tarefas independente se já existir tarefa para o local) |
| exclusive | true/false | Sim | Indica se as tarefas em aberto do agente serão canceladas ao baixar a rota no mobile. 0(Não), 1(Sim) | |
| itineraryDefault | true/false | Sim | Se rota default as tarefas são criadas automaticamente para os locais da rota no mobile. 0(Não cria tarefas automaticamente), 1(Sempre cria as tarefas automaticamente) , 2(Cria automaticamente as tarefas 1 vez ao dia) |
Busca Por Lista de Rotas
GET /CenterWeb/api/{$apiKey}/itinerary.xml
Veja um exemplo, do resultado de uma requisição que foi feita em XML:
<result>
<resourceName>itinerary</resourceName>
<size>2</size>
<entries>
<entry id="001" link="/itinerary/001.xml"/>
<entry id="002" link="/itinerary/002.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, Id do registro no uMov.me e o link, que pode ser usado para recuperar os dados específicos deste registro.
Busca de uma rota específica
GET /CenterWeb/api/{$apiKey}/itinerary/{$id}.xml
Esta operação serve para puxar informações de uma rota do sistema. Veja o exemplo de retorno de uma entidade abaixo (considerando uma requisição feita em XML):
Inclusão de uma rota
POST /CenterWeb/api/{$apiKey}/itinerary.xml
Esta operação serve para incluir uma rota no sistema. Existe um mínimo de informações que o sistema espera receber para poder realizar a criação de um novo registro no ambiente em questão. Confira a descrição de uma Rota para identificar os campos obrigatórios. Veja um exemplo da requisição com dados em XML:
<itinerary>
<description>Teste rota</description>
<origin>0</origin>
<agentRelation>1</agentRelation>
<displayOrder>1</displayOrder>
<alternativeIdentifier>TesteRota</alternativeIdentifier>
<validateTasksOnField>0</validateTasksOnField>
<exclusive>false</exclusive>
<active>true</active>
<itineraryDefault>false</itineraryDefault>
</itinerary>
Atualização de uma Rota
Ambas as operações abaixo permitem atualizar informações de uma rota utilizando ou o id interno ou o identificador alternativo. Assim é possível atualizar a rota enviando apenas os dados desejados conforme é demonstrado o xml de exemplo abaixo:
Utilizando id interno
POST /CenterWeb/api/{$apiKey}/itinerary/{$id}.xml
Utilizando identificador alternativo
POST /CenterWeb/api/{$apiKey}/itinerary/alternativeIdentifier/{$alternativeIdentifier}.xml
<itinerary>
<description>Teste Rota Nova</description>
</itinerary>
GET /CenterWeb/api/{$apiKey}/itinerary/alternativeIdentifier/{$alternative identifier}.xml
Esta operação serve para buscar informações de uma rota do sistema. Veja o exemplo de retorno de uma entidade abaixo (considerando uma requisição feita em XML):
Comentários
0 comentário
Por favor, entre para comentar.