Skip to content

WS105 – Check if there is an open route to the card

Click here to see version history
Update date Service publication date Changes
03/17/2021 03/17/2021 Service creation.

Objective

Check if there is an open route for the indicated vehicle plate.

Method description
Método checkTruckStatus
Versão 2
WSDL http://soap.comprovei.com.br/exportQueue/index.php?wsdl

Important

  1. Our connections are secure using the SSL protocol. For security reasons, our certificates are constantly changed without prior notice. Therefore, it is recommended that you do not develop integrations based on a fixed certificate.
  2. We constantly (and without prior notice) add new fields and structures to both requests and responses from our web services. Anyone who uses our webservices must implement it in such a way that the programs that consume these webservices do not stop working when the mentioned field changes occur.

Features

  • Calls will be made via SOAP over HTTPS;
  • The origin of the Web Service call will be the client's system;

Authentication

  • Calls will have transport-level authentication (Basic Authentication);
  • Request user / password from the account administrator.

Request

The request for our Web Service is composed as follows:

TAG Type Description
placaVeiculo character set License plate of the vehicle that will be checked.

Request Example

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:WebServiceComprovei">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:checkTruckStatus soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <PlacaVeiculo xsi:type="xsd:string">ELW2173</PlacaVeiculo>
      </urn:checkTruckStatus>
   </soapenv:Body>
</soapenv:Envelope>

Response

Our Web Service responds to you as follows:

TAG Type Description
codigoRetorno Integer Return message code.
MensagemRetorno Character set Return message.
Rota Structure Contains all route information, if any is found.

Route

TAG Type Description
Data Date Date in 'YYYY-MM-DD' format.
Nome Character set Route name.
Numero Character set Route number.
CodigoMotorista Character set Driver linked to the route.
TelefoneMotorista Character set Driver's registered telephone number.
PlacaVeiculo Character set License plate of the vehicle associated with the route.
CodigoStatus Integer Route status.
Status Character set Route status name.
Localizacao Structure Contains the driver's last captured latitude and longitude.

Location

TAG Type Description
DataHoraUltimaLocalizacao Date and Time Date and time of the vehicle's last captured location.
Latitude Decimal Latitude position in decimal format.
Longitude Decimal Longitude position in decimal format.

Response Example

<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="urn:WebServiceComprovei" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
    <SOAP-ENV:Body>
        <ns1:checkTruckStatusResponse>
            <CodigoRetorno xsi:type="xsd:integer">1</  CodigoRetorno>
            <MensagemRetorno xsi:type="xsd:string">Veículo com rota    alocada.</MensagemRetorno>
            <Rota xsi:type="Rota">
                <Data  xsi:type="xsd:string">2021-02-18</Data>
                <Nome xsi:nil="true"/>
                <Numero    xsi:type="xsd:string">000001002</Numero>
                <CodigoMotorista       xsi:type="xsd:string">12345678912</CodigoMotorista>
                <TelefoneMotorista     xsi:type="xsd:string">11988888888</TelefoneMotorista>
                <Placa xsi:type="xsd:string">ABC1234</Placa>
                <CodigoStatus xsi:type="xsd:int">1</CodigoStatus>
                <Status    xsi:type="xsd:string">Liberado</Status>
                <Localizacao xsi:type="Localizacao">
                    <DataHoraUltimaLocalizacao xsi:type="xsd:string">2021-02-25 15:25:30</DataHoraUltimaLocalizacao>
                    <Latitude xsi:type="xsd:string">-23.5487851</Latitude>
                    <Longitude xsi:type="xsd:string">-47.1908806</Longitude>
                </Localizacao>
            </Rota>
        </ns1:checkTruckStatusResponse>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Return codes

| Code | Description | |:-------|:-----|:-----------| | 0 | Vehicle with no allocated route. | | 1 | Vehicle with allocated route. | | 998 | Input parameter was not filled. | | 999 | Unauthenticated user. |