Serviço Web

O Plamoon disponibiliza um serviço web através de uma API com requisições padrão REST.

Este serviço permite realizar a maioria das operações que um usuário normalmente realiza ao utilizar as diferentes interfaces de usuário. As requisições são identificadas através de uma chave que está vinculada a uma conta de usuário. Apenas uma chave pode ser gerada para cada usuário. Recomenda-se a criação de usuários diferentes para diferentes integrações.

Todas as operações realizadas com esta chave são identificadas como uma ação do usuário vinculado. As operações sofrem as mesmas limitações que o usuário possui em função das permissões configuradas. A visibilidade dos diferentes itens sendo requisitados respeitam o mesmo comportamento definido nesta documentação para as interfaces de usuário.

Integração

Os endpoints do serviço web são disponibilizados debaixo do endereço:

https://cliente.plamoon.com/ws

Integradores devem levar em conta que grandes frotas podem ser segregadas em diferentes servidores. Dessa forma, tanto o endereço do serviço quanto a chave de integração devem ser configuráveis visando manter a flexibilidade de integração. A chave de integração deve ser mantida de forma segura e não recomenda-se o compartilhamento da chave através de e-mail ou similares.

Para gerar uma chave de integração, acesse a página do perfil do usuário e clique em Gerar Chave e Salvar.

Gerar Token Integração

Limitações

O serviço força a utilização de criptografia através do protocolo HTTPS.

As resposta do serviço possui uma limitação de um intervalo de 5 segundos entre requisições. Essa limitação foi adicionada para evitar abusos e garantir a disponibilidade do serviço. Requisições que constantemente infrigirem as limitações terão as chaves revogadas e serão bloqueadas.

A respostas de algumas requisições terão a quantidade de resultados limitados para manter o tamanho dentro de um padrão aceitável. Recomenda-se que se aceite a compressão de dados no protocolo HTTP indicado pelo cabeçalho: Accept-Encoding: gzip.

Formatação

As mensagens em geral são formatadas usando padrão XML e codificação UTF-8.

Exemplo de requisição:

curl -X GET "https://cliente.plamoon.com/ws/endpoint?key=a7f7d58090b......2305547fe67a2eb"

Exemplo de resposta:

Headers HTTP:

Cache-Control: no-cache, no-store, no-transform, must-revalidate

Content-Type: application/xml;charset=UTF-8

Payload:

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<response xmlns="http://www.plamoon.com/ws/schema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <status>OK</status>
    <!-- Conteúdo da resposta -->
</response>

Elemento `<response.status>`:

Enumeração descrevendo o retorno do serviço web conforme:

CREATED: Objeto criado com sucesso.
DELETED: Objeto removido com sucesso
ERROR: Erro informado no elemento message.
INVALID_KEY: Chave de integração inválida.
MISSING_PARAMETER: Faltando parâmetro informado no elemento message.
MODIFIED: Objeto modificado com sucesso.
NO_PERMISSION: Sem permissão para realizar a operação. Normalmente message conterá mais informações.
NO_RESULTS: Sem resultados. Também pode significar que um objeto necessário não foi encontrado.
OK: Sucesso.

Elemento `<equipment>`

Dados de cadastro

<serialNumber>: string
<type>: enum Tipo do equipamento.
<commId>: string Id de comunicação.
<timezone>: string Id do fuso horário.
<imei>: string Código IMEI do modem.
<primarySimId>: string Código do SIM card primário.
<primarySimLine>: string Número para chamadas da SIM card primário.
<secondarySimId>: string Código do SIM card secundário.
<secondarySimLine>: string Número para chamadas do SIM card secundário.
<status>: enum Situação do equipamento.
<alloc>.<client>: string Nome do cliente ao qual o equipamento foi alocado.
<alloc<>.<datetime>: iso Data/Hora da alocação.
<alloc>.<username>: string Nome do usuário que alocou.
<vehicle>.<plate>: string Placa do veículo vinculado
<vehicle>.<datetime>: iso Data/Hora do vínculo
<vehicle>.<username>: string Usuário que efetuou o vínculou
<groups>.<group>.<description>: string Descrição do grupo ao qual o equipamento está associado.

Dados de situação

<connected>: boolean Situação da conexão com servidor.
<lastComm>: iso Data/Hora da última comunicação.
<firmwareVersion>: string Versão do firmware do equipamento.
<batteryStatus>: enum Situação do carregamento da bateria.
<batteryLevel>: integer Nível da bateria do equipamento.
<lockState>: enum Situação da trava.
<events>.<event>: enum Último evento reportado.
<lastValidDatetime>: iso Última posição válida.
<positionSource>: enum Fonte da posição mais recente indicada no endereço.
<gpsLatitude>: string Latitude mais recente obtida por GPS.
<gpsLongitude>: enum Longitude mais recente obtida por GPS.
<lbsLatitude>: string Latitude obtida por LBS.
<lbsLongitude>: string Longitude obtida por LBS.
<address>: string Endereço da posição atual.
<locations>.<location>.<id>: string Id de integração da localidade.
<locations>.<location>.<description>: string Descrição da localidade.

Elemento `<command>`

<datetime>: iso
<type>: enum Tipo do comando.
<status>: enum Situação do comando.
<username>: string Usuário que agendou o comando.

Elemento `<vehicle>`

Dados de cadastro

<plate>: string Placa do veículo.
<id>: string Id de integração.
<type>: enum Tipo do veículo.
<fleetId>: string Identificação na frota.
<chassis>: string Número do chassis.
<manufacturer>: string Fabricante.
<model>: string Modelo.
<year>: integer Ano de fabricação.
<color>: string Cor.
<status>: enum Situação do veículo.
<vehicle>.<equipment>.<serialNumber>: string Número de série do equipamento vinculado.
<vehicle>.<equipment>.<datetime>: iso Data/Hora do vínculo
<vehicle>.<equipment>.<username>: string Usuário que efetuou o vínculou
<sensors>.<sensor>.<id>: string Id do sensor.
<sensors>.<sensor>.<name>: string Nome do sensor.
<sensors>.<sensor>.<type>: enum Tipo do sensor.
<tires>.<tire>.<id>: string Id do pneu.
<tires>.<tire>.<marking>: string Marcação do pneu.
<tires>.<tire>.<position>: string Posição do pneu.
<groups>.<group>.<description>: string Descrição do grupo ao qual o equipamento está associado.

Dados de situação

<plate>: string Placa do veículo.
<id>: string Id de integração.
<events>.<event>: enum Último evento reportado, conforme equipamento.
<ignition>: enum Estado da ignição do veículo.
<gpsValid>: boolean GPS válido no momento.
<lastValidDatetime>: iso Última posição válida.
<latitude>: string Latitude mais recente obtida por GPS.
<longitude>: enum Longitude mais recente obtida por GPS.
<direction>: integer Latitude obtida por LBS. Valor em graus.
<speed>: decimal Velocidade do veículo. Valor em Km/h.
<movementStatus>: enum Situação da movimentaçào do veículo.
<totalDistance>: integer Distância total percorrida pelo veículo (conforme odômetro ou gps). Valor em Km.
<address>: string Endereço da posição atual.
<equipments>.<equipment>.<serialNumber>: string Número de série do equipamento vinculado.
<equipments>.<equipment>.<connected>: boolean Situação da conexão do equipamento com servidor.
<equipments>.<equipment>.<lastComm>: iso Data/Hora da última comunicação do equipamento.
<equipments>.<equipment>.<batteryStatus>: enum Situação do carregamento da bateria do equipamento.
<equipments>.<equipment>.<batteryLevel>: integer Nível da bateria do equipamento. Valor em %.
<equipments>.<equipment>.<lockState>: enum Situação da trava.
<sensors>.<sensor>.<id>: string Id do sensor.
<sensors>.<sensor>.<name>: string Nome do sensor.
<sensors>.<sensor>.<type>: enum Tipo do sensor.
<sensors>.<sensor>.<updated>: iso Data/Hora atualização do sensor.
<sensors>.<sensor>.<value>: string Valor do sensor.
<sensors>.<sensor>.<status>: enum Situação do sensor.
<sensors>.<sensor>.<event>: enum Evento do sensor.
<tires>.<tire>.<id>: string Id de integração do pneu.
<tires>.<tire>.<marking>: string Marcação do pneu.
<tires>.<tire>.<position>: string Posição do pneu.
<tires>.<tire>.<updated>: iso Data/Hora atualização do sensor.
<tires>.<tire>.<pressure>: decimal Pressão do pneu. Valor em Kpa.
<tires>.<tire>.<temperature>: decimal Temperatura do pneu. Valor em Celsius.
<tires>.<tire>.<extra>: string Informações adicionais. Depende do sensor.

Elemento `<position>`

<position>.<datetime>: timestamp Data/Hora da posição conforme equipmento.
<position>.<comm>: timestamp Data/Hora da recepção conforme servidor.
<position>.<equipment>: string Número de série de equipmento.
<position>.<plate>: string Placa do veículo.
<position>.<events>.<event>: enum Tipo do evento informado.
<position>.<valid>: bool Indicador de coordenada válida.
<position>.<source>: enum Fonte da coordenada geográfica.
<position>.<latitude>: decimal Latitude em grau decimal.
<position>.<longitude>: decimal Longitude em grau decimal.
<position>.<direction>: decimal Direção em grau decimal.
<position>.<speed>: decimal Velocidade em grau decimal.
<position>.<movementStatus>: enum Indicador de movimentação.
<position>.<navLatitude>: decimal Latitude em grau decimal com ponto projetado na via.
<position>.<navLongitude>: decimal Longitude em grau decimal com ponto projetado na via.
<position>.<address>: string Endereço para coordenada na posição.
<position>.<components>.<component>.<type>: enum Tipo de componente de dados.
<position>.<components>.<component>.<value>: Valor de componente de dados.

Listar equipamentos

GET /ws/equipment

Permissões Necessárias

Gerenciar Equipamentos

Parâmetros Necessários

key: string Chave de integração conforme cadastro do usuário.

Parâmetros Opcionais

serialNumber: string Número de série do equipamento conforme cadastro.
status: enum Situação do equipamento conforme.
linked: boolean Se está vinculado a um veículo.

Formatação elemento <equipment>

Elemento <response.equipments> contem atributos iguais aos parâmetros da requisição que foram reconhecidos.

Exemplo

curl -X GET "https://cliente.plamoon.com/ws/equipment?key=a7f7d58090b......2305547fe67a2eb&serialNumber=0042xx"

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<response xmlns="http://www.plamoon.com/ws/schema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <status>OK</status>
    <equipments serialNumber="0042xx">
        <equipment>
            <serialNumber>0042xx</serialNumber>
            <type>JOINTECH_JT709</type>
            <commId>7941040042xx</commId>
            <timezone>America/Sao_Paulo</timezone>
            <imei xsi:nil="true"/>
            <primarySimId xsi:nil="true"/>
            <primarySimLine xsi:nil="true"/>
            <secondarySimId xsi:nil="true"/>
            <secondarySimLine xsi:nil="true"/>
            <status>INACTIVE</status>
            <vehicle>
                <plate>AAA1234</plate>
                <id xsi:nil="true"/>
                <datetime>20231025T131502Z</datetime>
                <username>admin</username>
            </vehicle>
            <alloc/>
            <groups/>
        </equipment>
    </equipments>
</response>

Criar/Modificar equipamento

POST /ws/equipment

Permissões Necessárias

Gerenciar Equipamentos
Editar Equipamentos

Parâmetros Necessários

key: string Chave de integração conforme cadastro do usuário.
serialNumber: string Número de série do equipamento.

Parâmetros Opcionais

type: enum Tipo do equipamento. Requerido ao criar.
commId: string Id de comunicação. Requerido ao criar.
timezone: string Id do fuso horário.
imei: string Código IMEI do modem.
primarySimId: string Código do SIM card primário.
primarySimLine: string Número para chamadas da SIM card primário.
secondarySimId: string Código do SIM card secundário.
secondarySimLine: string Número para chamadas do SIM card secundário.
status: enum Situação do equipamento.

Exemplo

curl -X POST "https://cliente.plamoon.com/ws/equipment?key=a7f7d58090b......2305547fe67a2eb&serialNumber=0042xx&status=IN_TRANSIT"

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<response xmlns="http://www.plamoon.com/ws/schema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <status>MODIFIED</status>
</response>

Remover equipamento

DELETE /ws/equipment

Permissões Necessárias

Gerenciar Equipamentos
Editar Equipamentos

Parâmetros Necessários

key: string Chave de integração conforme cadastro do usuário.
serialNumber: string Número de série do equipamento.

Exemplo

curl -X DELETE "https://cliente.plamoon.com/ws/equipment?key=a7f7d58090b......2305547fe67a2eb&serialNumber=0042xx"

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<response xmlns="http://www.plamoon.com/ws/schema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <status>DELETED</status>
</response>

Listar situação dos equipamentos

GET /ws/equipment/status

Permissões Necessárias

Gerenciar Equipamentos

Parâmetros Necessários

key: string Chave de integração conforme cadastro do usuário.

Parâmetros Opcionais

serialNumber: string Número de série do equipamento conforme cadastro.
status: enum Situação do equipamento conforme.
linked: boolean Se está vinculado a um veículo.
connected: boolean Se está online no momento.
gpsValid: boolean Com GPS válido no momento.
minBatteryLevel: integer Com nível mínimo de bateria em %.

Formatação elemento <equipment>

Elemento <response.equipments> contem atributos iguais aos parâmetros da requisição que foram reconhecidos.

Exemplo

curl -X GET "https://cliente.plamoon.com/ws/equipment/status?key=a7f7d58090b......2305547fe67a2eb&status=IN_TRANSIT"

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<response xmlns="http://www.plamoon.com/ws/schema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <status>OK</status>
    <equipments status="IN_TRANSIT">
        <equipment>
            <serialNumber>Mobile-277467</serialNumber>
            <connected>false</connected>
            <lastComm>20240212T150944Z</lastComm>
            <firmwareVersion>1.2.2;android;S2RKS32.92-11-21-20</firmwareVersion>
            <batteryStatus xsi:nil="true"/>
            <batteryLevel xsi:nil="true"/>
            <lockState xsi:nil="true"/>
            <events>
                <event>TRACKING_INTERRUPTED</event>
            </events>
            <lastValidDatetime>20240212T150900Z</lastValidDatetime>
            <gpsValid>false</gpsValid>
            <positionSource xsi:nil="true"/>
            <gpsLatitude>-23.12345</gpsLatitude>
            <gpsLongitude>-46.12345</gpsLongitude>
            <lbsLatitude xsi:nil="true"/>
            <lbsLongitude xsi:nil="true"/>
            <address>Rua, Bairro, Estado, Cidade - CEP - Brasil</address>
            <locations/>
        </equipment>
    </equipments>
</response>

Listar vínculo dos equipamentos

GET /ws/equipment/link

Permissões Necessárias

Gerenciar Equipamentos

Parâmetros Necessários

key: string Chave de integração conforme cadastro do usuário.

Parâmetros Opcionais

serialNumber: string Número de série do equipamento conforme cadastro.

Formatação elemento <equipment>

Exemplo

curl -X GET "https://cliente.plamoon.com/ws/equipment/link?key=a7f7d58090b......2305547fe67a2eb"

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<response xmlns="http://www.plamoon.com/ws/schema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <status>OK</status>
    <equipments>
        <equipment>
            <serialNumber>0042xx</serialNumber>
            <vehicle>
                <vehicleId xsi:nil="true"/>
                <plate>AAA1234</plate>
                <datetime>20231025T131502Z</datetime>
                <username>admin</username>
            </vehicle>
        </equipment>
    </equipments>
</response>

Vincular equipamento

POST /ws/equipment/link

Permissões Necessárias

Gerenciar Equipamentos
Editar Equipamentos

Parâmetros Necessários

key: string Chave de integração conforme cadastro do usuário.
serialNumber: string Número de série do equipamento.
plate: string Placa do veículo.

O equipamento precisa pertencer ou estar alocado ao cliente do usuário. A operação irá desvincular o equipamento do veículo anterior caso esteja vinculado.

Exemplo

curl -X POST "https://cliente.plamoon.com/ws/equipment/link?key=a7f7d58090b......2305547fe67a2eb&serialNumber=0042xx&plate=AAA1234"

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<response xmlns="http://www.plamoon.com/ws/schema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <status>MODIFIED</status>
</response>

Desvincular equipamento

DELETE /ws/equipment/link

Permissões Necessárias

Gerenciar Equipamentos
Editar Equipamentos

Parâmetros Necessários

key: string Chave de integração conforme cadastro do usuário.
serialNumber: string Número de série do equipamento.

Exemplo

curl -X DELETE "https://cliente.plamoon.com/ws/equipment/link?key=a7f7d58090b......2305547fe67a2eb&serialNumber=0042xx"

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<response xmlns="http://www.plamoon.com/ws/schema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <status>DELETED</status>
</response>

Listar comandos pendentes

GET /ws/equipment/command

Permissões Necessárias

Gerenciar Equipamentos
Enviar comandos personalizados

Parâmetros Necessários

key: string Chave de integração conforme cadastro do usuário.
serialNumber: string Número de série do equipamento conforme cadastro.

Formatação elemento <command>

Exemplo

curl -X GET "https://cliente.plamoon.com/ws/equipment/command?key=a7f7d58090b......2305547fe67a2eb&serialNumber=0042xx"

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<response xmlns="http://www.plamoon.com/ws/schema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <status>OK</status>
    <commands serialNumber="0042xx">
        <command>
            <datetime>20231025T131502Z</datetime>
            <type>UNLOCK</type>
            <status>WAITING</status>
            <username>admin</username>
        </command>
    </commands>
</response>

Envio de comando

POST /ws/equipment/command

Permissões Necessárias

Enviar comandos personalizados

Parâmetros Necessários

key: string Chave de integração conforme cadastro do usuário.
serialNumber: string Número de série do equipamento.
type: enum Tipo do comando.

Parâmetros Opcionais

expiration: integer Tempo em segundos para expiração do comando. Padrão: 900 segundos.
tries: integer Quantidade de tentativas de entrega. Padrão: 1 tentativa.
port: integer Índice da porta de dados do equipamento, útil para comunicação com periféricos.
data: string Dados a serem enviados, formatação depende do tipo do comando.
time: integer Tempo em segundos, função depende do tipo do comando enviado.

Formatação elemento <command>

Alguns parâmetros opcionais podem ser requeridos dependendo do tipo de comando enviado.

Exemplo

curl -X POST "https://cliente.plamoon.com/ws/equipment/command?key=a7f7d58090b......2305547fe67a2eb&serialNumber=0042xx&type=UNLOCK"

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<response xmlns="http://www.plamoon.com/ws/schema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <status>CREATED</status>
</response>

Listar veículos

GET /ws/vehicle

Permissões Necessárias

Gerenciar Veículos

Parâmetros Necessários

key: string Chave de integração conforme cadastro do usuário.

Parâmetros Opcionais

plate: string Placa do equipamento conforme cadastro.
vehicleId: string Id de integração conforme cadastro.
status: enum Situação do veículo.

Formatação elemento <vehicle>

Elemento <response.vehicles> contem atributos iguais aos parâmetros da requisição que foram reconhecidos.

Exemplo

curl -X GET "https://cliente.plamoon.com/ws/vehicle?key=a7f7d58090b......2305547fe67a2eb&plate=AAA1234"

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<response xmlns="http://www.plamoon.com/ws/schema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <status>OK</status>
    <vehicles plate="AAA1234">
        <vehicle>
            <type>TRANSPORTATION_TRUCK_LORRY</type>
            <plate>AAA1234</plate>
            <fleetId xsi:nil="true"/>
            <chassis xsi:nil="true"/>
            <manufacturer xsi:nil="true"/>
            <model xsi:nil="true"/>
            <year xsi:nil="true"/>
            <color xsi:nil="true"/>
            <status>INACTIVE</status>
            <equipments>
                <equipment>
                    <serialNumber>Mobile-245799</serialNumber>
                    <datetime>20240304T221427Z</datetime>
                    <username>admin</username>
                </equipment>
            </equipments>
            <sensors/>
            <tires/>
            <groups/>
        </vehicle>
    </vehicles>
</response>

Criar/Modificar veículo

POST /ws/vehicle

Permissões Necessárias

Gerenciar Veículos
Editar Veículos

Parâmetros Necessários

key: string Chave de integração conforme cadastro do usuário.
plate: string Placa do veículo.

Parâmetros Opcionais

vehicleId: string Id de integração do veículo.
type: enum Tipo do veículo. Requerido ao criar.
commId: enum Cor do ícone.
fleetId: string Identificação na frota.
chassis: string Número do chassis.
manufacturer: string Fabricante.
model: integer Ano de fabricação
color: string Cor
status: enum Situação do veículo.

Exemplo

curl -X POST "https://cliente.plamoon.com/ws/vehicle?key=a7f7d58090b......2305547fe67a2eb&plate=ABC1234&status=INACTIVE"

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<response xmlns="http://www.plamoon.com/ws/schema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <status>MODIFIED</status>
</response>

Remover veículo

DELETE /ws/vehicle

Permissões Necessárias

Gerenciar Veículos
Editar Veículos

Parâmetros Necessários

key: string Chave de integração conforme cadastro do usuário.
plate: string Placa do veículo.
vehicleId: string Id de integração.

Exemplo

curl -X DELETE "https://cliente.plamoon.com/ws/equipment?key=a7f7d58090b......2305547fe67a2eb&serialNumber=0042xx"

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<response xmlns="http://www.plamoon.com/ws/schema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <status>DELETED</status>
</response>

Listar situação dos veículos

GET /ws/vehicle/status

Permissões Necessárias

Gerenciar Veículos

Parâmetros Necessários

key: string Chave de integração conforme cadastro do usuário.

Parâmetros Opcionais

plate: string Placa conforme cadastro.
vehicleId: string Id de integração conforme cadastro.
status: enum Situação do veículo.

Formatação elemento <vehicle>

Elemento <response.vehicles> contem atributos iguais aos parâmetros da requisição que foram reconhecidos.

Exemplo

curl -X GET "https://cliente.plamoon.com/ws/vehicle/status?key=a7f7d58090b......2305547fe67a2eb"

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<response xmlns="http://www.plamoon.com/ws/schema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <status>OK</status>
    <vehicles>
        <vehicle>
            <plate>AAA3232</plate>
            <id xsi:nil="true"/>
            <events>
                <event>REQUEST_ERROR</event>
            </events>
            <ignition>OFF</ignition>
            <valid>false</valid>
            <lastValidDatetime>20230825T171836Z</lastValidDatetime>
            <latitude>-23.12345</latitude>
            <longitude>-46.12345</longitude>
            <direction>0</direction>
            <speed>0.0</speed>
            <movementStatus>PARKED</movementStatus>
            <address>Rua, Bairro, Estado, Cidade - CEP - Brasil</address>
            <equipments>
                <equipment>
                    <serialNumber>0042xx</serialNumber>
                    <connected>false</connected>
                    <lastComm>20240212T150944Z</lastComm>
                    <batteryStatus xsi:nil="true"/>
                    <batteryLevel xsi:nil="true"/>
                    <lockState xsi:nil="true"/>
                </equipment>
            </equipments>
            <sensors/>
            <tires/>
        </vehicle>
    </vehicles>
</response>

Desvincular equipamentos do veículo

DELETE /ws/vehicle/link

Permissões Necessárias

Gerenciar Veículos
Editar Veículos
Editar Equipamentos

Parâmetros Necessários

key: string Chave de integração conforme cadastro do usuário.
plate: string Placa do veículo.
vehicleId: string Id de integração do veículo.

Parâmetros Opcionais

serialNumber: string Número de série do equipamento.

Exemplo

curl -X DELETE "https://cliente.plamoon.com/ws/vehicle/link?key=a7f7d58090b......2305547fe67a2eb&plate=ABC1234&serialNumber=0042xx"

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<response xmlns="http://www.plamoon.com/ws/schema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <status>DELETED</status>
</response>

Histórico de posições

GET /ws/position

Permissões Necessárias

Gerenciar Equipamentos (utilizando parâmetro serialNumber)
Gerenciar Veículos (utilizando parâmetros plate ou vehicleId)

Parâmetros Necessários

key: string Chave de integração conforme cadastro do usuário.
serialNumber: string Número de série do equipamento conforme cadastro. -ou-
plate: string Placa do veículo conforme cadastro. -ou-
vehicleId: string Id de integração do veículo conforme cadastro.
start: timestamp Data/hora início das posições.
end: timestamp Data/hora fim das posições.

Formatação elemento <position>

Elemento <response.positions> contem atributos iguais aos parâmetros da requisição que foram reconhecidos.

Exemplo

curl -X GET "https://cliente.plamoon.com/ws/position?key=a7f7d58090b......2305547fe67a2eb&serialNumber=0042xx&start=1716854400&end=1716897600"

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<response xmlns="http://www.plamoon.com/ws/schema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <status>OK</status>
    <positions serialNumber="0042xx" start="2024-05-28T00:00:00.000Z" end="2024-05-28T12:00:00.000Z">
      <position>
        <datetime>1716901140</datetime>
        <comm>1716901140</comm>
        <equipment>0042xx</equipment>
        <plate>ABC1D23</plate>
        <events>
          <event>SENSOR_INFO</event>
        </events>
        <valid>true</valid>
        <source>GPS</source>
        <latitude>-12.12345</latitude>
        <longitude>-12.12345</longitude>
        <direction>160</direction>
        <speed>6.0</speed>
        <movementStatus>UNKNOWN</movementStatus>
        <navLatitude xsi:nil="true"/>
        <navLongitude xsi:nil="true"/>
        <address>Rua, Bairro, Cidade, Estado - CEP - País</address>
        <components>
          <component>
            <type>EVENTS</type>
            <value>29</value>
          </component>
        </components>
      </position>
    </positions>
</response>

Serviço Web

Operações

Integração

Limitações

Formatação

Elemento <response.status>:

Elemento <equipment>

Elemento <command>

Elemento <vehicle>

Elemento <position>

Listar equipamentos

Criar/Modificar equipamento

Remover equipamento

Listar situação dos equipamentos

Listar vínculo dos equipamentos

Vincular equipamento

Desvincular equipamento

Listar comandos pendentes

Envio de comando

Listar veículos

Criar/Modificar veículo

Remover veículo

Listar situação dos veículos

Desvincular equipamentos do veículo

Histórico de posições

Elemento `<response.status>`:

Elemento `<equipment>`

Elemento `<command>`

Elemento `<vehicle>`

Elemento `<position>`