Linxio API | Notion

Introduction

This document contains information regarding the Linxio API, including prerequisites for using the API and details on how to authorize and refresh tokens. Additionally, it includes information on how to get a list of vehicles, create a new vehicle, and edit an existing vehicle.

<aside> 💡 Here are the general steps involved in using the Linxio API:

Authorize by sending a login request with credentials to receive a token for API requests.
Use the token in the header for all further requests.
Send a request for the desired API endpoint with any necessary parameters.
Receive the API response in JSON format.
Parse and utilize the response data as needed.

For example, to get a list of vehicles, you would send a GET request to the api.linxio.com/api/vehicles/fields/json endpoint with the necessary parameters and your token in the header. The API would then return a JSON response containing the requested vehicle data.

</aside>

Prerequisites

Login credentials for some user from the Client team;
OTP should be disabled for the team / role;
If you want to receive notifications via web socket, these notifications should be configured at https://app.linxio.com/client/configuration/notifications-details and the user, used for integration, should be specified in Recipients;

API

Authorisation

Login

POST - api.linxio.com/api/login
BODY - JSON
{
	"email": "email",
	"password": "pass"
}

On success, token for API requests should be returned. Token should be used in a header for all further requests:

Authorization: Bearer <token>

Sample Request

POST '<https://api.linxio.com/api/login>' \\
--header 'Content-Type: application/json' \\
--data-raw '{
    "email": "[email protected]",
    "password": "LinxioPassword"
}'

Sample Response

{
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE1OTgyNjYzMjgsImVtYWlsIjoidXNlcjFAbGlueGlvLmNvbSIsImV4cCI6MTU5ODM1MjcyOH0.cPDiuCx2sHBmzbEd6kHWunPD8xlSTSdlc4WYjfU3Mpnaf_TFyeVnXGyLn6CaOCrKoK6Ul_isxGoM-3nVL1QR8yEN6f_EdTtlaJuNmtqotRRq7cCSafVj3UyioWaYudfXbtlF5f1I3q67TPD3HZ3iAt0fdx4Y9g3SpYY5YG3sZI-eg0Vl906KavbQijCso55C0yv58FcJEJ2Lq7jEk0XaMo_m0Ps63L4eq6aF4YjUeUrNG8FbNsFcZrXTS5ofPPM3PZfDOSovIAWCoP8bitS11EaDwba4_qc8AsCA6hx5_QTvlYUZ1iO9AaDk4j3b7NeGBoYybT3zAH80hJPXxx1X1UZyvipWKxUvjw1rceDyRmmk4PvqGCsCv_hamuqi2760dlZl72s1d5K3gJpZFtKsn7PQDScClR9r8BmejxuY2cw_DI8QxDWQlOtqkQyL5vp3rayzvchIiXZoQrbmT2siQ1unazLZaOPchP38huK-CVUESEAaB9ZYjdYTx7CvQX8clUNyesuCuhQvG0ixtjsw9dnanHoCv1Pjqm9NChvB9GwuXpU13NDvn_ejUcnfnefFwT3fGPnEannP3c7cIrc2PatngMGuGM7ecu75Qsl0mRuZMccVXD8obVRZThM0djS1n21fqWIlLQYhQttGQgpmtEd5l1v3wA6oiundzM-4UDs",
    "loginWithId": true,
    "refreshToken": "5ef5a469cc54a0650d71eafe72b6c989",
    "expireAt": "2020-08-25T10:52:09+00:00",
    "otp_required": false,
    "teamType": "client",
    "roleId": 7
}

Refresh token

POST - api.linxio.com/api/token/refresh
BODY - JSON
{
"refreshToken": "c9879bd0946544e6d84e204af6828994"
}

Sample Request

OST '<https://api.linxio.com/api/token/refresh>' \\
--header 'Content-Type: application/json' \\
--data-raw '{
    "refreshToken": "c9879bd0946544e6d84e204af6828994"
}'

Sample Response

{
   "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE2NjkzNjQzNzAsImV4cCI6MTY2OTQ1MDc3MCwic3ViIjoiMSIsImVtYWlsIjoibGlueGlvLWRldkBvY3NpY28uY29tIn0.A3Dez9Q63j-wOwBEjoLiPfGnIYqjPoVasC3CgdTzr__MrpgDNZv8nKqeapjFtdNL15L1fd6t2J-YATWrhSouijvhpt1518goPNl7BiXk7N6niOY8gzMxxQHWxzUhUFJS-6f9Qjh2n0_PgxgSPG-dOhRHSGuh6BNArcz52bXqRwP9nqqfm2bbAva_ENFIR76_ewV2NQs8Utw7TKlzXg1EIdnGnmGTRUKTxmzcKw9Y9uYruY_fXZWMLZa7b95yISd6-dG73eHgDntHyj90jN4392z-5cX0SsQsV6-KYMUOKnd39s5in9cTe9OvyRHiX-xck57K0soNHE-Dbe_6hbzsIMAjd958zyUUv6xgzfkXv7Ijn7c_VRDwF1CgyBde6Ws4CpT893XqCECWB8p7bAPtr757Ckcty6nDZtI6hpWtrK-jYZ04ZCcXz8Blu5S8T23Xra7IoK_hCr878EqOPa_Wz0OHd3QkqrByoXnkmyms3QVbd9AAfpacU40pYp3r432evjv3lBB4HR3ARZD6gyrzLtLaQQnM-CHfrfLkyyqO3ejTWFG6AxIv7ArVvJSR8s-oNb4G6Ca2G1Sxm-oKtQl4dUsFVeSO5BI4Wy9gB0GpKKVVyZ6fdzODAXd4WXU6AnbFTmh4PIA9THL3fBkrmmG0zZJMhiRiRFZyHowgbM2CMOs",
   "loginWithId": false,
   "refreshToken": "f078137bbefc62a6d5250fe92bac4420",
   "expireAt": "2022-11

Vehicles

Get a list of vehicles

GET - api.linxio.com/api/vehicles/fields/json

Parameters:

limit – results per page,
page – number of page with results,
fields – optional, - array of vehicle fields
regNo - optional, filter by regNo

For example, fields[]=id will return a JSON where each element will contain only the internal ID of the vehicle.

Sample Request

GET '<https://api.linxio.com/api/vehicles/fields/json?fields[]=id>' \\
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE1OTgyNjYzMjgsImVtYWlsIjoidXNlcjFAbGlueGlvLmNvbSIsImV4cCI6MTU5ODM1MjcyOH0.cPDiuCx2sHBmzbEd6kHWunPD8xlSTSdlc4WYjfU3Mpnaf_TFyeVnXGyLn6CaOCrKoK6Ul_isxGoM-3nVL1QR8yEN6f_EdTtlaJuNmtqotRRq7cCSafVj3UyioWaYudfXbtlF5f1I3q67TPD3HZ3iAt0fdx4Y9g3SpYY5YG3sZI-eg0Vl906KavbQijCso55C0yv58FcJEJ2Lq7jEk0XaMo_m0Ps63L4eq6aF4YjUeUrNG8FbNsFcZrXTS5ofPPM3PZfDOSovIAWCoP8bitS11EaDwba4_qc8AsCA6hx5_QTvlYUZ1iO9AaDk4j3b7NeGBoYybT3zAH80hJPXxx1X1UZyvipWKxUvjw1rceDyRmmk4PvqGCsCv_hamuqi2760dlZl72s1d5K3gJpZFtKsn7PQDScClR9r8BmejxuY2cw_DI8QxDWQlOtqkQyL5vp3rayzvchIiXZoQrbmT2siQ1unazLZaOPchP38huK-CVUESEAaB9ZYjdYTx7CvQX8clUNyesuCuhQvG0ixtjsw9dnanHoCv1Pjqm9NChvB9GwuXpU13NDvn_ejUcnfnefFwT3fGPnEannP3c7cIrc2PatngMGuGM7ecu75Qsl0mRuZMccVXD8obVRZThM0djS1n21fqWIlLQYhQttGQgpmtEd5l1v3wA6oiundzM-4UDs'

Sample Response

{
    "page": 1,
    "limit": 10,
    "total": 7,
    "data": [
        {
        	"id": 304
        },
        {
        	"id": 305
        },
        {
        	"id": 306
        },
        {
        	"id": 307
        },
        {
        	"id": 308
        },
        {
        	"id": 309
        },
        {
        	"id": 716
        }
    ],
    "aggregations": null
}

Create Vehicle

POST - api.linxio.com/api/vehicles

Sample Request

POST '<https://api.linxio.com/api/vehicles>' \\
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE2MTQ2MTkyMTUsImV4cCI6MTYxNDcwNTYxNSwiZW1haWwiOiJsaW54aW8tZGV2QG9jc2ljby5jb20ifQ.Zlmnh1zRtrcirjWoVIHpUEMaQFy705x9rcSV_3FzoPEqSaagdBSbGgtLYhvQa7m0oD10UZRCbb8FBG95I7lDu3BKWA5UjmRZQHk9-9YgZCnN3UWkX8SOwRYAUotvttgQv7c64Tg28gq1BdqYvWpN7sWrQflA1ZktzzNkEMLmKhniuAgGVVduPrwZT4ShAJGk5FIBFDT5ACYHBrx5cLxnDNYxBheJFNcIyqfItJTPSG234HHEQE8UOeEGGTffFt8V_c8pGmWGAjyj65ZIQO2-6Y0tQaNmKstqCJPLena6jGQzXfQ-ZXT0MlrB7Ct-2oU5qotBArAOkRetS7pk830HG88mmaGHboTFMGAu0gt4A7ozGvUPcn2ftmbmYVb2N26O3om4Mt5R1wp5DZu8pJNoXbFiXa0byoS3-WikyB-GwLnnHAehIeNlKub0iNuXLSaH3ChjK8QYtgoTcOHAassccn1xhdFkGebXZoZTi7BDZYMQd5lE8eTnTbsGENFTs1zTcD5UpWT7WE-5rZn_LIOv7hu5wK6utW7m7V4XTIIoGI-oBLiHxvKq6h_JuhTpkCoyJjApbk_qDNYF00Ayv87Y6-HkkrWextTFNKd5Hvq2pAStXbPbHGiHRWhjKEEKyuZTUlKLONgAk84OvqMmc6TW85OsJjoO4wSh3BNnWQg_tR0' \\
--header 'Content-Type: application/json' \\
--data-raw '{
   "type": "Car",
   "make": "make",
   "makeModel": "model",
   "defaultLabel": "title",
   "regNo": "regno123567",
   "depotId": 25,
   "vin": "vin4444",
   "regDate": "2021-03-02T00:00:00+11:00",
   "enginePower": 200,
   "engineCapacity": 200,
   "fuelType": 1,
   "fuelTankCapacity": 300,
   "averageFuel": 200,
   "emissionClass": "1",
   "co2Emissions": 33,
   "grossWeight": 1000,
   "ecoSpeed": 90,
   "excessiveIdling": 120,
   "teamId": 103
}'

Sample Response

{
   "id": 1553,
   "teamId": 103,
   "team": {
       "id": 103,
       "type": "client",
       "clientId": 120,
       "clientName": "ACME1"
   },
   "depot": {
       "id": 25,
       "name": "Queensland",
       "status": 1,
       "createdAt": "2019-08-13T11:43:36+00:00",
       "color": "#e4e414"
   },
   "type": "Car",
   "model": "make model",
   "makeModel": "model",
   "make": "make",
   "unavailableMessage": null,
   "regNo": "regno123567",
   "defaultLabel": "title",
   "vin": "vin4444",
   "regDate": "2021-03-01T13:00:00+00:00",
   "regCertNo": null,
   "enginePower": 200,
   "engineCapacity": 200,
   "fuelType": 1,
   "emissionClass": "1",
   "co2Emissions": 33,
   "grossWeight": 1000,
   "groups": [],
   "status": "offline",
   "year": null,
   "fuelTankCapacity": 300,
   "driver": null,
   "createdAt": "2021-03-02T08:08:23+00:00",
   "createdBy": {
       "id": "361",
       "fullName": "Super Admin",
       "email": "[email protected]",
       "teamType": "admin"
   },
   "updatedAt": null,
   "updatedBy": null,
   "deviceId": null,
   "picture": null,
   "areas": [],
   "todayData": {
       "distance": 0,
       "duration": 0
   },
   "ecoSpeed": 90,
   "excessiveIdling": 120,
   "averageFuel": 200,
   "engineOnTime": null,
   "averageDailyMileage": null,
   "mileage": null

Edit Vehicle

POST - api.linxio.com/api/vehicles/{vehicleId}

Sample Request

POST '<https://api.linxio.com/api/vehicles/1089>' \\
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE2MTQ2MTkyMTUsImV4cCI6MTYxNDcwNTYxNSwiZW1haWwiOiJsaW54aW8tZGV2QG9jc2ljby5jb20ifQ.Zlmnh1zRtrcirjWoVIHpUEMaQFy705x9rcSV_3FzoPEqSaagdBSbGgtLYhvQa7m0oD10UZRCbb8FBG95I7lDu3BKWA5UjmRZQHk9-9YgZCnN3UWkX8SOwRYAUotvttgQv7c64Tg28gq1BdqYvWpN7sWrQflA1ZktzzNkEMLmKhniuAgGVVduPrwZT4ShAJGk5FIBFDT5ACYHBrx5cLxnDNYxBheJFNcIyqfItJTPSG234HHEQE8UOeEGGTffFt8V_c8pGmWGAjyj65ZIQO2-6Y0tQaNmKstqCJPLena6jGQzXfQ-ZXT0MlrB7Ct-2oU5qotBArAOkRetS7pk830HG88mmaGHboTFMGAu0gt4A7ozGvUPcn2ftmbmYVb2N26O3om4Mt5R1wp5DZu8pJNoXbFiXa0byoS3-WikyB-GwLnnHAehIeNlKub0iNuXLSaH3ChjK8QYtgoTcOHAassccn1xhdFkGebXZoZTi7BDZYMQd5lE8eTnTbsGENFTs1zTcD5UpWT7WE-5rZn_LIOv7hu5wK6utW7m7V4XTIIoGI-oBLiHxvKq6h_JuhTpkCoyJjApbk_qDNYF00Ayv87Y6-HkkrWextTFNKd5Hvq2pAStXbPbHGiHRWhjKEEKyuZTUlKLONgAk84OvqMmc6TW85OsJjoO4wSh3BNnWQg_tR0' \\
--header 'Content-Type: application/json' \\
--data-raw '{
   "defaultLabel": "push 121",
   "regNo": "push121",
   "type": "Truck",
   "make": "make",
   "makeModel": "model",
   "regDate": "2021-03-03T00:00:00+11:00",
   "driverStartDate": null,
   "isUnavailable": false,
   "unavailableMessage": "",
   "clientNote": "",
   "teamId": 103,
   "groupIds": [
       32
   ],
   "depotId": 25
}'

Sample Response

{
   "id": 1089,
   "teamId": 103,
   "team": {
       "id": 103,
       "type": "client",
       "clientId": 120,
       "clientName": "ACME1"
   },
   "depot": {
       "id": 25,
       "name": "Queensland",
       "status": 1,
       "createdAt": "2019-08-13T11:43:36+00:00",
       "color": "#e4e414"
   },
   "type": "Truck",
   "model": "make model",
   "makeModel": "model",
   "make": "make",
   "unavailableMessage": null,
   "regNo": "push121",
   "defaultLabel": "push 121",
   "vin": null,
   "regDate": "2021-03-02T13:00:00+00:00",
   "regCertNo": null,
   "enginePower": 0,
   "engineCapacity": 0,
   "fuelType": null,
   "emissionClass": null,
   "co2Emissions": 0,
   "grossWeight": 0,
   "groups": [
       {
           "id": 32,
           "name": "Service Vans",
           "color": "#ffff00"
       }
   ],
   "status": "offline",
   "year": null,
   "fuelTankCapacity": null,
   "driver": null,
   "createdAt": "2019-08-13T11:43:38+00:00",
   "createdBy": null,
   "updatedAt": "2021-03-02T14:41:31+00:00",
   "updatedBy": {
       "id": "361",
       "fullName": "Super Admin",
       "email": "[email protected]",
       "teamType": "admin"
   },
   "deviceId": null,
   "picture": null,
   "areas": [],
   "todayData": {
       "distance": 0,
       "duration": 0
   },
   "ecoSpeed": 0,
   "excessiveIdling": 0,
   "averageFuel": 0,
   "engineOnTime": null,
   "averageDailyMileage": null,
   "mileage": null
}

Get Vehicle By Id

GET - api.linxio.com/api/vehicles/{vehicleId}

Sample Request

GET '<https://api.linxio.com/api/vehicles/1089>' \\
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE2MTQ2MTkyMTUsImV4cCI6MTYxNDcwNTYxNSwiZW1haWwiOiJsaW54aW8tZGV2QG9jc2ljby5jb20ifQ.Zlmnh1zRtrcirjWoVIHpUEMaQFy705x9rcSV_3FzoPEqSaagdBSbGgtLYhvQa7m0oD10UZRCbb8FBG95I7lDu3BKWA5UjmRZQHk9-9YgZCnN3UWkX8SOwRYAUotvttgQv7c64Tg28gq1BdqYvWpN7sWrQflA1ZktzzNkEMLmKhniuAgGVVduPrwZT4ShAJGk5FIBFDT5ACYHBrx5cLxnDNYxBheJFNcIyqfItJTPSG234HHEQE8UOeEGGTffFt8V_c8pGmWGAjyj65ZIQO2-6Y0tQaNmKstqCJPLena6jGQzXfQ-ZXT0MlrB7Ct-2oU5qotBArAOkRetS7pk830HG88mmaGHboTFMGAu0gt4A7ozGvUPcn2ftmbmYVb2N26O3om4Mt5R1wp5DZu8pJNoXbFiXa0byoS3-WikyB-GwLnnHAehIeNlKub0iNuXLSaH3ChjK8QYtgoTcOHAassccn1xhdFkGebXZoZTi7BDZYMQd5lE8eTnTbsGENFTs1zTcD5UpWT7WE-5rZn_LIOv7hu5wK6utW7m7V4XTIIoGI-oBLiHxvKq6h_JuhTpkCoyJjApbk_qDNYF00Ayv87Y6-HkkrWextTFNKd5Hvq2pAStXbPbHGiHRWhjKEEKyuZTUlKLONgAk84OvqMmc6TW85OsJjoO4wSh3BNnWQg_tR0'

Sample Response

{
   "id": 1089,
   "teamId": 102,
   "team": {...},
   "depot": null,
   "type": "Car",
   "model": null,
   "makeModel": null,
   "make": null,
   "unavailableMessage": null,
   "regNo": "015RSJ",
   "defaultLabel": "Jeff",
   "vin": null,
   "regDate": null,
   "regCertNo": null,
   "enginePower": 0,
   "engineCapacity": 0,
   "fuelType": null,
   "emissionClass": null,
   "co2Emissions": 0,
   "grossWeight": 0,
   "groups": [...],
   "status": "offline",
   "year": null,
   "fuelTankCapacity": null,
   "driver": null,
   "createdAt": "2019-08-13T11:43:38+00:00",
   "createdBy": null,
   "updatedAt": "2020-05-27T08:55:10+00:00",
   "updatedBy": {...},
   "deviceId": null,
   "picture": null,
   "areas": [],
   "todayData": {
       "distance": 0,
       "duration": 0
   },
   "ecoSpeed": 0,
   "excessiveIdling": 0,
   "averageFuel": 0,
   "engineOnTime": null,
   "averageDailyMileage": null,
   "mileage": null
}

Devices

Create Device

POST - api.linxio.com/api/devices

Sample Request

POST '<https://api.linxio.com/api/devices>' \\
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE2MTQ2MTkyMTUsImV4cCI6MTYxNDcwNTYxNSwiZW1haWwiOiJsaW54aW8tZGV2QG9jc2ljby5jb20ifQ.Zlmnh1zRtrcirjWoVIHpUEMaQFy705x9rcSV_3FzoPEqSaagdBSbGgtLYhvQa7m0oD10UZRCbb8FBG95I7lDu3BKWA5UjmRZQHk9-9YgZCnN3UWkX8SOwRYAUotvttgQv7c64Tg28gq1BdqYvWpN7sWrQflA1ZktzzNkEMLmKhniuAgGVVduPrwZT4ShAJGk5FIBFDT5ACYHBrx5cLxnDNYxBheJFNcIyqfItJTPSG234HHEQE8UOeEGGTffFt8V_c8pGmWGAjyj65ZIQO2-6Y0tQaNmKstqCJPLena6jGQzXfQ-ZXT0MlrB7Ct-2oU5qotBArAOkRetS7pk830HG88mmaGHboTFMGAu0gt4A7ozGvUPcn2ftmbmYVb2N26O3om4Mt5R1wp5DZu8pJNoXbFiXa0byoS3-WikyB-GwLnnHAehIeNlKub0iNuXLSaH3ChjK8QYtgoTcOHAassccn1xhdFkGebXZoZTi7BDZYMQd5lE8eTnTbsGENFTs1zTcD5UpWT7WE-5rZn_LIOv7hu5wK6utW7m7V4XTIIoGI-oBLiHxvKq6h_JuhTpkCoyJjApbk_qDNYF00Ayv87Y6-HkkrWextTFNKd5Hvq2pAStXbPbHGiHRWhjKEEKyuZTUlKLONgAk84OvqMmc6TW85OsJjoO4wSh3BNnWQg_tR0' \\
--header 'Content-Type: application/json' \\
--data-raw '{
   "vendor": 15,
   "modelId": 28,
   "sn": "80447130716",
   "port": "3434",
   "hw": "434",
   "sw": "121",
   "imei": "123456789",
   "phone": "+32423423423",
   "imsi": "3434",
   "password": "pass",
   "userName": "username",
   "clientNote": "note1",
   "adminNote": "note2",
   "blockingMessage": "",
   "status": "inStock",
   "teamId": 93
}'

Sample Response

{
   "id": 354,
   "vendor": {
       "id": 15,
       "name": "Linxio"
   },
   "model": {
       "id": 28,
       "name": "TR500",
       "protocol": null
   },
   "sn": "80447130716",
   "status": "inStock",
   "team": {
       "id": 93,
       "type": "admin",
       "clientId": null,
       "clientName": null
   },
   "port": 3434,
   "hw": "434",
   "sw": "121",
   "imei": "434343434",
   "phone": "+32423423423",
   "imsi": "3434",
   "userName": "usernameeee",
   "password": "pass",
   "installDate": null,
   "deviceInstallation": null,
   "createdAt": "2021-03-01T17:24:43+00:00",
   "createdBy": {
       "id": "361",
       "fullName": "Super Admin",
       "email": "[email protected]",
       "teamType": "admin"
   },
   "updatedAt": null,
   "updatedBy": null,
   "trackerData": null,
   "blockingMessage": null,
   "lastActiveTime": null
}

Edit Device

PATCH - api.linxio.com/api/devices/{deviceId}

Sample Request

PATCH '<https://api.linxio.com/api/devices/354>' \\
--header 'Content-Type: application/json' \\
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE2MTQ2MTkyMTUsImV4cCI6MTYxNDcwNTYxNSwiZW1haWwiOiJsaW54aW8tZGV2QG9jc2ljby5jb20ifQ.Zlmnh1zRtrcirjWoVIHpUEMaQFy705x9rcSV_3FzoPEqSaagdBSbGgtLYhvQa7m0oD10UZRCbb8FBG95I7lDu3BKWA5UjmRZQHk9-9YgZCnN3UWkX8SOwRYAUotvttgQv7c64Tg28gq1BdqYvWpN7sWrQflA1ZktzzNkEMLmKhniuAgGVVduPrwZT4ShAJGk5FIBFDT5ACYHBrx5cLxnDNYxBheJFNcIyqfItJTPSG234HHEQE8UOeEGGTffFt8V_c8pGmWGAjyj65ZIQO2-6Y0tQaNmKstqCJPLena6jGQzXfQ-ZXT0MlrB7Ct-2oU5qotBArAOkRetS7pk830HG88mmaGHboTFMGAu0gt4A7ozGvUPcn2ftmbmYVb2N26O3om4Mt5R1wp5DZu8pJNoXbFiXa0byoS3-WikyB-GwLnnHAehIeNlKub0iNuXLSaH3ChjK8QYtgoTcOHAassccn1xhdFkGebXZoZTi7BDZYMQd5lE8eTnTbsGENFTs1zTcD5UpWT7WE-5rZn_LIOv7hu5wK6utW7m7V4XTIIoGI-oBLiHxvKq6h_JuhTpkCoyJjApbk_qDNYF00Ayv87Y6-HkkrWextTFNKd5Hvq2pAStXbPbHGiHRWhjKEEKyuZTUlKLONgAk84OvqMmc6TW85OsJjoO4wSh3BNnWQg_tR0' \\
--data-raw '{
   "vendor": 15,
   "modelId": 28,
   "sn": "1232",
   "port": null,
   "hw": null,
   "sw": null,
   "imei": "8670600380281511",
   "phone": "+375445154982",
   "imsi": null,
   "password": null,
   "userName": null,
   "clientNote": "",
   "adminNote": "",
   "blockingMessage": null,
   "status": "stopped",
   "teamId": 103
}'

Sample Response

{
   "id": 354,
   "vendor": {
       "id": 15,
       "name": "Linxio"
   },
   "model": {
       "id": 28,
       "name": "VX60",
       "protocol": null
   },
   "sn": "1232",
   "status": "stopped",
   "team": {
       "id": 103,
       "type": "client",
       "clientId": 120,
       "clientName": "ACME1"
   },
   "port": 0,
   "hw": null,
   "sw": null,
   "imei": "8670600380281511",
   "phone": "+375445154982",
   "imsi": null,
   "userName": "usernameeee",
   "password": null,
   "installDate": null,
   "deviceInstallation": null,
   "createdAt": "2021-03-01T17:24:43+00:00",
   "createdBy": {
       "id": "361",
       "fullName": "Super Admin",
       "email": "[email protected]",
       "teamType": "admin"
   },
   "updatedAt": "2021-03-02T12:21:20+00:00",
   "updatedBy": {
       "id": "361",
       "fullName": "Super Admin",
       "email": "[email protected]",
       "teamType": "admin"
   },
   "trackerData": null,
   "blockingMessage": null,
   "lastActiveTime": null
}

Get Device List

GET - api.linxio.com/api/devices

Params:

limit - optional
page - optional
imei - optional, filter by device imei
fields[]=vehicle - get vehicle data for devices
fields[]=vehicleId - get only vehicle id for devices

Sample Request

GET '<https://api.linxio.com/api/devices/json?limit=10&page=1>' \\
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE2MTQ2MTkyMTUsImV4cCI6MTYxNDcwNTYxNSwiZW1haWwiOiJsaW54aW8tZGV2QG9jc2ljby5jb20ifQ.Zlmnh1zRtrcirjWoVIHpUEMaQFy705x9rcSV_3FzoPEqSaagdBSbGgtLYhvQa7m0oD10UZRCbb8FBG95I7lDu3BKWA5UjmRZQHk9-9YgZCnN3UWkX8SOwRYAUotvttgQv7c64Tg28gq1BdqYvWpN7sWrQflA1ZktzzNkEMLmKhniuAgGVVduPrwZT4ShAJGk5FIBFDT5ACYHBrx5cLxnDNYxBheJFNcIyqfItJTPSG234HHEQE8UOeEGGTffFt8V_c8pGmWGAjyj65ZIQO2-6Y0tQaNmKstqCJPLena6jGQzXfQ-ZXT0MlrB7Ct-2oU5qotBArAOkRetS7pk830HG88mmaGHboTFMGAu0gt4A7ozGvUPcn2ftmbmYVb2N26O3om4Mt5R1wp5DZu8pJNoXbFiXa0byoS3-WikyB-GwLnnHAehIeNlKub0iNuXLSaH3ChjK8QYtgoTcOHAassccn1xhdFkGebXZoZTi7BDZYMQd5lE8eTnTbsGENFTs1zTcD5UpWT7WE-5rZn_LIOv7hu5wK6utW7m7V4XTIIoGI-oBLiHxvKq6h_JuhTpkCoyJjApbk_qDNYF00Ayv87Y6-HkkrWextTFNKd5Hvq2pAStXbPbHGiHRWhjKEEKyuZTUlKLONgAk84OvqMmc6TW85OsJjoO4wSh3BNnWQg_tR0'

Sample Response

{
   "page": 1,
   "limit": 10,
   "total": 177,
   "data": [
       {
           "id": 36,
           "vendor": {
               "id": 19,
               "name": "Linxio"
           },
           "model": {
               "id": 35,
               "name": "TLW1",
               "protocol": null
           },
           "sn": null,
           "status": "driving",
           "team": {},
           "port": 0,
           "hw": null,
           "sw": null,
           "imei": "865284042823603",
           "phone": "+375445154982",
           "imsi": null,
           "installDate": "2020-01-17T08:35:38+00:00",
           "deviceInstallation": {
               "id": 295,
               "deviceId": 36,
               "vehicleId": 1157,
               "device": {...},
               "vehicle": {...},
               "installDate": "2020-01-17T08:35:38+00:00",
               "uninstallDate": null,
               "files": [],
               "odometer": null
           },
           "createdAt": "2019-08-13T11:43:40+00:00",
           "createdBy": null,
           "updatedAt": "2020-09-11T11:40:55+00:00",
           "updatedBy": {...},
           "trackerData": null,
           "blockingMessage": null,
           "lastActiveTime": null
       }
   ],
   "aggregations": null
}

Get Device By ID

GET - api.linxio.com/api/devices/{deviceId}

Sample Request

GET '<https://api.linxio.com/api/devices/354>' \\
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE2MTQ2MTkyMTUsImV4cCI6MTYxNDcwNTYxNSwiZW1haWwiOiJsaW54aW8tZGV2QG9jc2ljby5jb20ifQ.Zlmnh1zRtrcirjWoVIHpUEMaQFy705x9rcSV_3FzoPEqSaagdBSbGgtLYhvQa7m0oD10UZRCbb8FBG95I7lDu3BKWA5UjmRZQHk9-9YgZCnN3UWkX8SOwRYAUotvttgQv7c64Tg28gq1BdqYvWpN7sWrQflA1ZktzzNkEMLmKhniuAgGVVduPrwZT4ShAJGk5FIBFDT5ACYHBrx5cLxnDNYxBheJFNcIyqfItJTPSG234HHEQE8UOeEGGTffFt8V_c8pGmWGAjyj65ZIQO2-6Y0tQaNmKstqCJPLena6jGQzXfQ-ZXT0MlrB7Ct-2oU5qotBArAOkRetS7pk830HG88mmaGHboTFMGAu0gt4A7ozGvUPcn2ftmbmYVb2N26O3om4Mt5R1wp5DZu8pJNoXbFiXa0byoS3-WikyB-GwLnnHAehIeNlKub0iNuXLSaH3ChjK8QYtgoTcOHAassccn1xhdFkGebXZoZTi7BDZYMQd5lE8eTnTbsGENFTs1zTcD5UpWT7WE-5rZn_LIOv7hu5wK6utW7m7V4XTIIoGI-oBLiHxvKq6h_JuhTpkCoyJjApbk_qDNYF00Ayv87Y6-HkkrWextTFNKd5Hvq2pAStXbPbHGiHRWhjKEEKyuZTUlKLONgAk84OvqMmc6TW85OsJjoO4wSh3BNnWQg_tR0'

Sample Response

{
   "id": 354,
   "vendor": {...},
   "model": {...},
   "sn": "1232",
   "status": "stopped",
   "team": {...},
   "port": 0,
   "hw": null,
   "sw": null,
   "imei": "8670600380281511",
   "phone": "+375445154982",
   "imsi": null,
   "userName": "usernameeee",
   "password": null,
   "installDate": null,
   "deviceInstallation": null,
   "createdAt": "2021-03-01T17:24:43+00:00",
   "createdBy": {...},
   "updatedAt": "2021-03-02T12:21:20+00:00",
   "updatedBy": {...},
   "trackerData": null,
   "blockingMessage": null,
   "lastActiveTime": null
}

Install Device

POST - api.linxio.com/api/devices/{deviceId}/install

Sample Request

POST '0.0.0.0:8099/api/devices/354/install' \\
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE2MTQ2MTkyMTUsImV4cCI6MTYxNDcwNTYxNSwiZW1haWwiOiJsaW54aW8tZGV2QG9jc2ljby5jb20ifQ.Zlmnh1zRtrcirjWoVIHpUEMaQFy705x9rcSV_3FzoPEqSaagdBSbGgtLYhvQa7m0oD10UZRCbb8FBG95I7lDu3BKWA5UjmRZQHk9-9YgZCnN3UWkX8SOwRYAUotvttgQv7c64Tg28gq1BdqYvWpN7sWrQflA1ZktzzNkEMLmKhniuAgGVVduPrwZT4ShAJGk5FIBFDT5ACYHBrx5cLxnDNYxBheJFNcIyqfItJTPSG234HHEQE8UOeEGGTffFt8V_c8pGmWGAjyj65ZIQO2-6Y0tQaNmKstqCJPLena6jGQzXfQ-ZXT0MlrB7Ct-2oU5qotBArAOkRetS7pk830HG88mmaGHboTFMGAu0gt4A7ozGvUPcn2ftmbmYVb2N26O3om4Mt5R1wp5DZu8pJNoXbFiXa0byoS3-WikyB-GwLnnHAehIeNlKub0iNuXLSaH3ChjK8QYtgoTcOHAassccn1xhdFkGebXZoZTi7BDZYMQd5lE8eTnTbsGENFTs1zTcD5UpWT7WE-5rZn_LIOv7hu5wK6utW7m7V4XTIIoGI-oBLiHxvKq6h_JuhTpkCoyJjApbk_qDNYF00Ayv87Y6-HkkrWextTFNKd5Hvq2pAStXbPbHGiHRWhjKEEKyuZTUlKLONgAk84OvqMmc6TW85OsJjoO4wSh3BNnWQg_tR0' \\
--header 'Content-Type: application/json' \\
--data-raw '{
   "vehicleId": 1553
}'

Sample Response

{
   "id": 354,
   "vendor": {
       "id": 15,
       "name": "Linxio"
   },
   "model": {
       "id": 28,
       "name": "TR500",
       "protocol": null
   },
   "sn": "80447130716",
   "status": "offline",
   "team": {
       "id": 103,
       "type": "client",
       "clientId": 120,
       "clientName": "ACME1"
   },
   "port": 3434,
   "hw": "434",
   "sw": "121",
   "imei": "434343434",
   "phone": "+32423423423",
   "imsi": "3434",
   "installDate": "2021-03-02T09:09:03+00:00",
   "deviceInstallation": {
       "id": 666,
       "deviceId": 354,
       "vehicleId": 1553,
       "device": {
           "id": 354,
           "vendor": {
               "id": 15,
               "name": "Linxio"
           },
           "model": {
               "id": 28,
               "name": "TR500",
               "protocol": null
           },
           "sn": "80447130716",
           "status": "offline",
           "team": {
               "id": 103,
               "type": "client",
               "clientId": 120,
               "clientName": "ACME1"
           },
           "port": 3434,
           "hw": "434",
           "sw": "121",
           "imei": "434343434",
           "phone": "+32423423423",
           "imsi": "3434",
           "createdAt": "2021-03-01T17:24:43+00:00",
           "updatedAt": "2021-03-02T09:09:03+00:00",
           "blockingMessage": null
       },
       "vehicle": {
           "id": 1553,
           "team": {
               "id": 103,
               "type": "client",
               "clientId": 120,
               "clientName": "ACME1"
           },
           "type": "Car",
           "model": "make model",
           "makeModel": "model",
           "make": "make",
           "unavailableMessage": null,
           "regNo": "regno123567",
           "defaultLabel": "title",
           "vin": "vin4444",
           "regDate": "2021-03-01T13:00:00+00:00",
           "regCertNo": null,
           "enginePower": 200,
           "engineCapacity": 200,
           "fuelType": 1,
           "emissionClass": "1",
           "co2Emissions": 33,
           "grossWeight": 1000,
           "status": "online",
           "year": null,
           "fuelTankCapacity": 300,
           "createdAt": "2021-03-02T08:08:23+00:00",
           "updatedAt": null,
           "picture": null,
           "areas": [],
           "todayData": {
               "distance": 0,
               "duration": 0
           },
           "ecoSpeed": 90,
           "excessiveIdling": 120,
           "averageFuel": 200,
           "engineOnTime": null,
           "averageDailyMileage": null
       },
       "installDate": "2021-03-02T09:09:03+00:00",
       "uninstallDate": null,
       "files": [],
       "odometer": null
   },
   "createdAt": "2021-03-01T17:24:43+00:00",
   "createdBy": {
       "id": "361",
       "fullName": "Super Admin",
       "email": "[email protected]",
       "teamType": "admin"
   },
   "updatedAt": "2021-03-02T09:09:03+00:00",
   "updatedBy": {
       "id": "361",
       "fullName": "Super Admin",
       "email": "[email protected]",
       "teamType": "admin"
   },
   "trackerData": null,
   "blockingMessage": null,
   "lastActiveTime": null
}

Uninstall Device

POST - api.linxio.com/api/devices/{deviceId}/uninstall

Sample Request

POST '0.0.0.0:8099/api/devices/354/uninstall' \\
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE2MTQ2MTkyMTUsImV4cCI6MTYxNDcwNTYxNSwiZW1haWwiOiJsaW54aW8tZGV2QG9jc2ljby5jb20ifQ.Zlmnh1zRtrcirjWoVIHpUEMaQFy705x9rcSV_3FzoPEqSaagdBSbGgtLYhvQa7m0oD10UZRCbb8FBG95I7lDu3BKWA5UjmRZQHk9-9YgZCnN3UWkX8SOwRYAUotvttgQv7c64Tg28gq1BdqYvWpN7sWrQflA1ZktzzNkEMLmKhniuAgGVVduPrwZT4ShAJGk5FIBFDT5ACYHBrx5cLxnDNYxBheJFNcIyqfItJTPSG234HHEQE8UOeEGGTffFt8V_c8pGmWGAjyj65ZIQO2-6Y0tQaNmKstqCJPLena6jGQzXfQ-ZXT0MlrB7Ct-2oU5qotBArAOkRetS7pk830HG88mmaGHboTFMGAu0gt4A7ozGvUPcn2ftmbmYVb2N26O3om4Mt5R1wp5DZu8pJNoXbFiXa0byoS3-WikyB-GwLnnHAehIeNlKub0iNuXLSaH3ChjK8QYtgoTcOHAassccn1xhdFkGebXZoZTi7BDZYMQd5lE8eTnTbsGENFTs1zTcD5UpWT7WE-5rZn_LIOv7hu5wK6utW7m7V4XTIIoGI-oBLiHxvKq6h_JuhTpkCoyJjApbk_qDNYF00Ayv87Y6-HkkrWextTFNKd5Hvq2pAStXbPbHGiHRWhjKEEKyuZTUlKLONgAk84OvqMmc6TW85OsJjoO4wSh3BNnWQg_tR0' \\
--header 'Content-Type: application/json' \\
--data-raw '{
   "vehicleId": 1553
}'

Sample Response

{
   "id": 354,
   "vendor": {
       "id": 15,
       "name": "Linxio"
   },
   "model": {
       "id": 28,
       "name": "TR500",
       "protocol": null
   },
   "sn": "80447130716",
   "status": "inStock",
   "team": {
       "id": 103,
       "type": "client",
       "clientId": 120,
       "clientName": "ACME1"
   },
   "port": 3434,
   "hw": "434",
   "sw": "121",
   "imei": "434343434",
   "phone": "+32423423423",
   "imsi": "3434",
   "installDate": null,
   "deviceInstallation": null,
   "createdAt": "2021-03-01T17:24:43+00:00",
   "createdBy": {
       "id": "361",
       "fullName": "Super Admin",
       "email": "[email protected]",
       "teamType": "admin"
   },
   "updatedAt": "2021-03-02T09:18:13+00:00",
   "updatedBy": {
       "id": "361",
       "fullName": "Super Admin",
       "email": "[email protected]",
       "teamType": "admin"
   },
   "trackerData": null,
   "blockingMessage": null,
   "lastActiveTime": null
}

Sensors

Get temperature and humidity sensors list

GET /api/devices/sensors/report/temp-and-humidity

Parameters:

page [int] – number of page with results,
limit [int] – results per page,
fields [array] – optional,
startDate [string] - start date range,
endDate [string] - end date range,
label [string] - optional, sensor label,
sensorId [int] - optional, sensor id,
deviceId [int] - optional, device id,
sensorBLEId [string] - optional, BLE sensor id