Base de Conhecimento

Inclusão de atividades das rotas em lote

POST /CenterWeb/api/{$apiKey}/batch/itineraryActivities.xml

Este recurso permite fazer a criação e atualização de atividades de rotas em lote, sem que haja a necessidade de fazer inúmeras requisições para a API.

<itineraryActivities>

<itineraryActivity>

<activity>

<id>9</id>

</activity>

<itinerary>

<id>25156</id>

</itinerary>

</itineraryActivity>

<itineraryActivity>

<activity>

<id>10</id>

</activity>

<itinerary>

<id>25156</id>

</itinerary>

</itineraryActivity>

</itineraryActivities>

A seção "<itineraryActivity></itineraryActivity>" representa cada atividade de rota a ser inserida, limitando em 100 o número máximo de atividades de rotas por requisição.

Caso algum erro ocorra, toda a operação será abortada e nenhuma atividade de rota será inserida.

Como retorno a esta chamada o sistema apresenta os o link de acesso a cada agente criado.

<result>

<resourceName>itineraryActivities</resourceName>

<size>2</size>

<entries>

<entry id="1803794" link="/itineraryActivity/1803794.xml" />

<entry id="1803795" link="/itineraryActivity/1803795.xml" />

</entries>

</result>

Busca Por Lista de atividades de Rotas

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

activity: pesquisar por uma determinada atividade nas rotas

GET /CenterWeb/api/{$apiKey}/itineraryActivity.xml?itinerary=5421

itinerary: pesquisar as atividades de uma determinada rota

GET /CenterWeb/api/{$apiKey}/itineraryActivity.xml?itinerary.alternativeIdentifier=TesteRota

Filtrar atividades das rotas com base em atributos das entidades vinculadas as atividades das rotas

Busca por uma Atividade da Rota em específico

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

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

<itineraryActivity>

<id>53218</id>

<itinerary>

<id>25156</id>

<description>Teste Rota</description>

<origin>0</origin>

<agentRelation>1</agentRelation>

<displayOrder>1</displayOrder>

<alternativeIdentifier>TesteRota</alternativeIdentifier>

<active>true</active>

<validateTasksOnField>0</validateTasksOnField>

<exclusive>false</exclusive>

<itineraryDefault>false</itineraryDefault>

</itinerary>

<activity>

<id>10</id>

<description>Atividade 1</description>

<alternativeIdentifier>Atividade1</alternativeIdentifier>

<displayOrder>2</displayOrder>

<active>true</active>

<comunicationType>0</comunicationType>

<executionType>0</executionType>

<loopExecution>false</loopExecution>

<showsSessionWebForm>false</showsSessionWebForm>

<confirmClose>2</confirmClose>

<acceleratedExecution>false</acceleratedExecution>

<confirmWithoutGPS>true</confirmWithoutGPS>

<GPSIsMandatory>false</GPSIsMandatory>

<captureGPS>false</captureGPS>

</activity>

</itineraryActivity>

Remoção de uma Atividade de Rota em específico

Usando o Id:

DELETE /CenterWeb/api/{$apiKey}/itineraryActivity/{$id}.xml

{$id} = Identificador interno da atividade da rota

Usando o Identificador Alternativo:

DELETE /CenterWeb/api/{$apiKey}/itineraryActivity/itinerary/{$itineraryAltId}/activity{$activityAltId}.xml

{$itineraryAltId} = Identificador alternativo da Rota

{$activityAltId} = Identificador alternativo da Atividade

Itinerary Activity (Atividades das Rotas)