iTracksense Open REST API

Catalogue

1. The Domain and Port configuration of the device
1. Interface Explanation
1. Call url format： Domain + Relative path
1. Get login credentials by user name and password
1. Logout login credentials
1. Get your device list
1. Get current vehicle or asset status info by login credentials and vehicle plate(assets) list
1. Get current status of vehicle or assets by login credentials and device ID list
1. Get vehicle history info by login credentials, vehicle plate, start time and end time
1. Get vehicle/assets history trace by login credentials, device ID, start time and end time
1. Get the current alarm info by login credentials, device ID
1. 4003 Return vehicle address by login credential, vehicle plate in string mode
1. Get vehicle/assets’address in string mode according to login crdentials
1. Get the traveled mileage at certain period by device ID, start time and end time
1. Modify vehicle plate No by device ID
1. Modify attset name by device ID
1. Get vehicle mileage number and fuel info by login credentials, vehicle plate list, start time and end time
1. Get the region that the vehicle/assets that are located in by login credentials and vehicle plate
1. Get the records of enter or exit geo-fence by start time, end time and device ID
1. Get the vehicle enter and exit geofence records by start time, end time, vehicle plate
1. Get alarm records by start time, end time and device ID
1. Get alarm details by Start time,end time and vehicle Plate
1. Get the vehicle location by vehicle plate
1. Get vehicle location info by device ID
1. To judge whether the vehicle is inside of geofence
1. Get vehicle trace or trace after deviation correction
1. Vehicle query in zone
1. Removal alarm list
1. Get device send message records
1. Set lock switch command
1. Set Timed Unlock command
1. Get iLock event report
1. Get SIM Detail
1. Change SIM Status
1. Send SMS for SIM
1. Get SIM SMS List
1. Send Device Text Command
1. Send Device HighLevel Command
1. Send Query Device Status Command
1. Send Query Device Parameter Command
1. Send Query Device ICCID Command
1. Call URL

1. Server Address

The Domain and Port configuration of the device.

Domain: www.itracksense.com
Port: 9881

2. Interface Explanation

Illustration:
- About Token: Except for the 1st interface, each interface would need a Token, take Postman for example, when we call an interface to obtain data, it requires to pass the header info and JSON parameter to obtain:

See below example for the method of GetCurrentVehicleInfo, A complete interface calling would need:

No.	Item	Project
1	Call interface	URL
2	Request mode	HTTP POST
3	Authorization	Request header info
4	Body Content	JSON format parameter

Response:

3. Call url format： Domain + Relative path

Domain:

http://openapi.itracksense.com

Example:

http://openapi.itracksense.com/api/user/GetLoginToken

Relative url：/api/user/GetLoginToken
Request Mode：HTTP POST
Parameter

No.	Name	Type	Description
1	LoginName	string	GPS login account
2	PassWord	string	GPS login password

Request parameter

{
    "LoginName":"testLogin",
    "PassWord":"123456"
}

Success:

200 returns login credential string, the maximum valid period is 180 days, when each time call the interface, a new token will be generated and meanwhile refresh the validity period.

Reply ParameterReply parameter

{
    "Code": 200,
    "Data": "E03ABA0AE0758AFCAA311540510FB800", //Token
    "ErrMsg": null
}

Failure Detail

{
    "Code": 500,
    "Data": null,
    "ErrMsg": "User / password can’t be null "
}

Error message:

Code	Description
500	System error
4002	User expire
4003	Enterprise expire
4004	User does not exist
4005	Password error
4006	User has been deleted
4009	LoginKey does not exist
4010	Error
4011	Storage process error
4000	Service period remain time

Relative url：/api/user/LogOut
Request mode ： POST
Authorization parameter：Token Login credential string

Only need to pass Token， other parameters are not required

Reply ParameterReply parameter

Success:

{
    "Code": 200,
    "Data": " Logout success", 
    "ErrMsg": null
}

Failure Detail

{
    "Code": 500,
    "Data": null,
    "ErrMsg": null
}

Hereinafter, the relative URL for calling interfaces is: /api/vehicle or asset/+ method name

6. Get your device list

Relative url：/api/device/GetList
Request mode：POST
Authorization parameter：Token Login credentials string
JSON Parameter:

No.	Name	Type	Description
1	PageIndex	int	Page Index, Required
2	PageSize	int	Row size for Page, Required
3	Key	string	Query Device ID or Vehicle Plate
4	DeviceType	int	Query Device Type, 0 Vehicle/ 1 Person/ 2 Asset
5	Status	int	Query Status for Device, 0 All/ 1 Online/ 2 Offline/ 3 Alarm/ 4 No Used/ 5 Focus

Pass Parameter:

{
    "PageIndex": 1,
    "PageSize": 20,
    "Key": "BAC"
}

Return:

data - The list of Devices in JSON format

No.	Name	Type	Description
1	total	int	Total records

data - The list of Devices in JSON format

No.	Name	Type	Description
1	DeviceID	string	Device ID
2	VehiclePlate	string	Vehicle Plate
3	isOnline	bool	Online/Offline, true/false
4	isAlarm	bool	Alarm, true/false
5	DeviceType	int	Device Type, 0 Vehicle/ 1 Person/ 2 Asset
6	isFocus	bool	Focus, true/false
7	NoUsed	bool	No Used, true/false

Reply Parameter:

{
    "Code": 200,
    "Data": {
        "total": 8,
        "data": [
            {
                "DeviceID": "862306128008106",
                "VehiclePlate": "0592 BACKUP - CAR",
                "isOnline": true,
                "isAlarm": false,
                "DeviceType": 0,
                "isFocus": false,
                "NoUsed": false
            },
            {
                "DeviceID": "862306518008107",
                "VehiclePlate": "BAC 621(S)",
                "isOnline": true,
                "isAlarm": false,
                "DeviceType": 0,
                "isFocus": false,
                "NoUsed": false
            },
            {
                "DeviceID": "862311518008105",
                "VehiclePlate": "BAC 3661(S)",
                "isOnline": true,
                "isAlarm": false,
                "DeviceType": 0,
                "isFocus": false,
                "NoUsed": false
            },
            {
                "DeviceID": "862411518008101",
                "VehiclePlate": "Bubacar 7/6851",
                "isOnline": false,
                "isAlarm": false,
                "DeviceType": 0,
                "isFocus": false,
                "NoUsed": false
            },
            {
                "DeviceID": "862305128008102",
                "VehiclePlate": "BACBlack Bus",
                "isOnline": false,
                "isAlarm": false,
                "DeviceType": 0,
                "isFocus": false,
                "NoUsed": false
            },
            {
                "DeviceID": "358511020398122",
                "VehiclePlate": "Backhse22",
                "isOnline": false,
                "isAlarm": false,
                "DeviceType": 0,
                "isFocus": false,
                "NoUsed": false
            },
            {
                "DeviceID": "358511020488112",
                "VehiclePlate": "Backhse32",
                "isOnline": false,
                "isAlarm": false,
                "DeviceType": 0,
                "isFocus": false,
                "NoUsed": false
            },
            {
                "DeviceID": "358511020398143",
                "VehiclePlate": "Backhse34",
                "isOnline": false,
                "isAlarm": false,
                "DeviceType": 0,
                "isFocus": false,
                "NoUsed": false
            }
        ]
    },
    "ErrMsg": null
}

Relative url：/api/vehicle/GetCurrentVehicleInfo
Request mode：POST
Authorization parameter：Token Login credentials string
JSON Parameter:

No.	Name	Type	Description
1	VehiclePlates	string	Vehicle Plate list (Separated by comma, pass empty string to return to current login enterprise to view the status info of all vehicles or assets )

Pass Parameter:
```
{
    "VehiclePlates":"8020"
}
```
Return:

The current info of vehicles/Assets in JSON format

No.	Name	Type	Description
1	SIM	string	Device SIM card number
2	SIM2	string	Device ID
3	ObjectCode	string	Vehicle/Assets No
4	VehicleNum	string	Vehicle Plate
5	GPSTime	DateTime	GPS time
6	RcvTime	DateTime	Receive time
7	Lon	double	Longitude
8	Lat	double	Latitude
9	Speed	double	Speed
10	Direct	int	Direction
11	Mileage	string	Mileage
12	StatusDes	string	Vehicle Status
13	OilNum	string	Fuel level
14	IsOnline	int	0=Offline 1=Online
15	IsAlarm	int	Alarm status 0=Normal 1=Triggered
16	Status	int	Acc Status 0=Off 1= On
17	IsReversal	int	Please ignore

Reply Parameter:

{
    "Code": 200,
    "Data": {
        "total": 1,
        "data": [
            {
                "SIM": "1064755708",
                "SIM2": "8029999",
                "ObjectCode": "1808090123",
                "VehicleNum": "8020",
                "GPSTime": "2018-09-27 13:53:15",
                "RcvTime": "2018-09-27 13:53:16",
                "Lon": 113.940838,
                "Lat": 22.562788,
                "Speed": 0.0,
                "Direct": 189,
                "Mileage": "13.7",
                "StatusDes": "Acc idle [8 min 14 seconds],Upload [14 seconds ],GSM network strong 27, satellite weak 0,
                communication interrupted alarm , main voltage 12.1V,LBS",
                "OilNum": "0.0",
                "IsOnline": 0,
                "IsAlarm": 0,
                "Status": 0,
                "IsReversal": 0
            }
        ]
    },
    "ErrMsg": null
}

Error message:

Code	Description
500	System error
401	Dangerous value in parameters or parameter value missed

No qualified data return

{
    "Code": 200,
    "Data": {
        "total": 0,
        "data": []
    },
    "ErrMsg": null
}

Relative url: /api/vehicle/GetCurrentVehicleInfoByDeviceIDs
Request mode: POST
Authorizatio Parameter: Token login credentials string
JSON Parameters:

No.	Name	Type	Description
1	DeviceIDs	string	Device ID list (Separated by comma, pass empty strings to return to the current user to view the status of all vehicles )

Pass Parameter:
```
{
    "DeviceIDs":"80222999"
}
```
Return:

The current info of vehicles/Assets in JSON format

No.	Name	Type	Description
1	SIM	string	Device SIM card number
2	SIM2	string	Device ID
3	ObjectCode	string	Vehicle/Assets No
4	VehicleNum	string	Vehicle Plate
5	GPSTime	DateTime	GPS time
6	RcvTime	DateTime	Receive time
7	Lon	double	Longitude
8	Lat	double	Latitude
9	Speed	double	Speed
10	Direct	int	Direction
11	Mileage	string	Mileage
12	StatusDes	string	Vehicle Status
13	OilNum	string	Fuel level
14	IsOnline	int	0=Offline 1=Online
15	IsAlarm	int	Alarm status 0=Normal 1=Triggered
16	Status	int	Acc Status 0=Off 1= On
17	IsReversal	int	Please ignore

Reply Parameter:

{
    "Code": 200,
    "Data": {
        "total": 1,
        "data": [
            {
                "SIM": "1064759608",
                "SIM2": "80222299",
                "ObjectCode": "1808090123",
                "VehicleNum": "80222999",
                "GPSTime": "2018-09-27 13:53:15",
                "RcvTime": "2018-09-27 13:53:16",
                "Lon": 113.940838,
                "Lat": 22.562788,
                "Speed": 0.0,
                "Direct": 189,
                "Mileage": "13.7",
                "StatusDes": " Acc idle[8 mins 14 seconds],Upload interval[14 Seconds ],GSM network strong 27, satellite weak 0,
                communication interrupted alarm, main voltage 12.1V,LBS",
                "OilNum": "0.0",
                "IsOnline": 0,
                "IsAlarm": 0,
                "Status": 0,
                "IsReversal": 0
            }
        ]
    },
    "ErrMsg": null
}

No qualified data return

{
    "Code": 200,
    "Data": {
        "total": 0,
        "data": []
    },
    "ErrMsg": null
}

Error message:

Code	Description
500	System error
401	Risky value existed or parameter value missed

Relative url：/api/vehicle/GetHistoryVehicleInfo
Request mode ： POST
Authorization Parameters：Token Login credentials string
JSON Parameter:

No.	Name	Type	Description
1	NumberPlateLists	string	Vehicle Plate, currently only support single plate
1	StartTime	DateTime	Start time Start time
1	EndTime	DateTime	End time, If the difference is greater than one day, the records of three days will be queried by defaul

Pass parameter:

{
    "NumberPlateLists":"8022999",
    "StartTime":"2020-07-06",
    "EndTime":"2020-07-30"
}

Return:

Vehicle history info in JSON

No.	Name	Type	Description
1	ObjectCode	string	Vehicle No
2	VehicleNum	string	Vehicle Plate
3	GPSTime	DateTime	GPS TIME
4	RcvTime	DateTime	Receive time
5	Lon	double	Longitude
6	Lat	double	Latitude
7	Speed	double	Speed
8	Direct	int	Direction
9	Mileage	string	Mileage
10	StatusDes	string	Vehicle Status
11	OilNum	string	Fuel level
12	IsReversal	int	Please ignore this

Reply Parameter

{
    "Code": 200,
    "Data": {
        "total": 10,
        "data": [
            {
            "ObjectCode": "2004130036",
            "VehicleNum": "EL A3S9",
            "GPSTime": "2020-07-25 14:55:49",
            "RcvTime": "2020-07-26 11:52:40",
            "Lon": 113.942313,
            "Lat": 22.556332,
            "Speed": 0.0,
            "Direct": 0,
            "Mileage": "0.0",
            "StatusDes": " ACC idle,Upload interval [6 seconds ],GSM network weak 3, satellite 0,1# temperature 32.1℃, reupload,
            battery level 94%",
            "OilNum": "0.0",
            "IsReversal": 0
            }
        ]
    },
    "ErrMsg": null
}

No qualified data return:

{
    "Code": 200,
    "Data": {
        "total": 0,
        "data": []
    },
    "ErrMsg": null
}

Note: Consider the internet transmission factor, maximum 50000 records can be called

Error message:

Code	Description
500	System error
401	Risky value parameters or parameter missed
403	Start time can’t be greater than end Time
4001	Vehicle Plate does not exist or been deleted

Relative url: /api/vehicle/GetHistoryVehicleInfoByDeviceID
Request mode: POST
Authorization Parameters: Token Login credentials string
JSON Parameter:

No.	Name	Type	Description
1	DeviceID	string	Device ID, Only support single device ID
2	StartTime	DateTime	Start time
3	EndTime	DateTime	End time, If the difference is greater than one day, three days of records will be queried by default

Pass Parameter:

{
    "DeviceID": "8620009844",
    "StartTime": "2020-07-20",
    "EndTime": "2020-07-28"
}

Return:

JSON History data in JSON format

No.	Name	Type	Description
1	ObjectCode	string	Vehicle No
2	VehicleNum	string	Vehicle Plate
3	GPSTime	DateTime	GPS TIME
4	RcvTime	DateTime	Receive time
5	Lon	double	Longitude
6	Lat	double	Latitude
7	Speed	double	Speed
8	Direct	int	Direction
9	Mileage	string	Mileage
10	StatusDes	string	Vehicle Status
11	OilNum	string	Fuel level
12	IsReversal	int	Please ignore this

Reply Parameter:

{
    "Code": 200,
    "Data": {
        "total": 1,
        "data": [
            {
                "ObjectCode": "2004070061",
                "VehicleNum": "Zhao",
                "GPSTime": "2020-07-21 17:39:14",
                "RcvTime": "2020-07-26 17:35:14",
                "Lon": 104.899552,
                "Lat": 34.17688,
                "Speed": 0.0,
                "Direct": 70,
                "Mileage": "0.0",
                "StatusDes": " ACC idle,Return Reupload,GSM network weak 5,Satellite 0,1#temperature 28.3℃,reuppload,battery 96%",
                "OilNum": "0.0",
                "IsReversal": 0
            }
        ]
        },
        "ErrMsg": null
    }
}

No qualified data return:

{
    "Code": 200,
    "Data": {
        "total": 0,
        "data": []
    },
    "ErrMsg": null
}

Note: Consider the internet transmission factor, maximum 50000 records can be called

Error message:

Code	Description
500	System error
401	Dangerous value in parameters or parameters missed
403	startTime can’t be greather than endTime
4002	Device number does not exist or has been deleted

Relative url：/api/vehicle/GetLatestAlarmByDeviceID
Request mode ： POST
Authorization Parameter ：Token Login credentials string
JSON Parameter:

No.	Name	Type	Description
1	DeviceID	string	Device ID (Separated by comma,pass empty string to return to current user to view all status info of vehicles/assets )

Pass Parameter:

{
    "DeviceID": "95033160,8745648"
}

Return:

JSON data with current alarm info

No.	Name	Type	Description
1	GPSTime	DateTime	GPS TIME
2	RcvTime	DateTime	Receive time
3	VehicleNum	string	Vehicle Plate
4	DeviceID	string	Device ID
5	AlarmType	string	Alarm Type
6	Speed	double	Speed
7	Direct	int	Direction angle（0-359）
8	Lon	double	Longitude
9	Lat	double	Latitude

Reply Parameter:

{
    "Code": 200,
    "Data": {
        "total": 1,
        "data": [
            {
                "GPSTime": "2020-07-23 13:44:54",
                "RcvTime": "2020-07-23 13:44:58",
                "VehicleNum": "GH6378",
                "DeviceID": "95033182160",
                "AlarmType": "Arm alarm",
                "Lon": 108.223418,
                "Lat": 22.630588,
                "Speed": 0.2,
                "Direct": 259
            }
        ]
    },
    "ErrMsg": null
}

No qualified data return:

{
    "Code": 200,
    "Data": {
        "total": 0,
        "data": []
    },
    "ErrMsg": null
}

Error message:

Code	Description
500	System error
401	Dangerous value in parameters or parameters missed
4001	Get user HoldID Failure

Relative url: /api/vehicle/GetObjectAddress
Request mode: POST
Authorization Parameter: Token Login credential string
JSON Parameter:

No.	Name	Type	Description
1	VehiclePlate	string	Vehicle Plate Number

Pass Parameter:
```
{
    "VehiclePlate":"0010"
}
```

Reply Parameter:

{
    "Code": 200,
    "Data": "(2020-07-23 13:44:52) 212 meter, Kuming, Yunan ",
    "ErrMsg": null
}

Error message:

Code	Description
500	System error
401	Dangerous value in parameters or parameters missed
4001	Limited authority or vehicle/asset does not exist

Relative url: /api/vehicle/GetObjectAddressByDeviceID
Request mode: POST
Authorization Parameter: Token Login credential string
JSON Parameter:

No.	Name	Type	Description
1	DeviceID	string	Device ID

Pass Parameter:

{
    "DeviceID": "0010"
}

Reply Parameter:

{
    "Code": 200,
    "Data": "(2020-07-23 13:44:52) 212 Meters, Kuming, Yunan",
    "ErrMsg": null
}

Error message:

Code	Description
500	System error
401	Dangerous value in parameters or parameters missed
4001	Limited authority or vehicle does not exist

14. Get the traveled mileage at certain period by device ID, start time and end time

Relative url: /api/vehicle/GetMileByDeviceID
Request mode: POST
Authorization Parameter: Token Login credential string
JSON Parameter:

No.	Name	Type	Description
1	DeviceID	string	Device ID
2	StartTime	DateTime	Start time
3	EndTime	DateTime	End time

Example

Pass Parameter:

{
    "DeviceID": "8620009844",
    "StartTime": "2020-07-20",
    "EndTime": "2020-07-28"
}

Return:

Get the travel mileage at certain period, unit KM

Reply Parameter:

{
    "Code": 200,
    "Data": "187.0",
    "ErrMsg": null
}

Error message:

Code	Description
500	System error

15. Modify vehicle plate No by device ID

Relative url: /api/vehicle/UpdateNumberPlate
Request mode: POST
Authorization Parameter: Token Login credential string
JSON Parameter:

No.	Name	Type	Description
1	DeviceID	string	Device ID
2	NewVehiclePlate	string	New Vehicle Plate number

Pass Parameter:

{
    "DeviceID": "8022999",
    "NewVehiclePlate": "8022999900000"
}

Reply Parameter:

{
    "Code": 200,
    "Data": "0",
    "ErrMsg": null
}

Return Data Description:

Data	Description
0	Modify successfully
1	Invalid login credentials or expired
2	Device ID does not exist or have been deleted
3	Enterprise does not exist or have been deleted
4	Device are not under user authority to query
-1	Database error

Error message:

Code	Description
500	System error

16. Modify attset name by device ID

Relative url: /api/assets/ModifyName
Request mode: POST
Authorization Parameter: Token Login credential string
JSON Parameter:

No.	Name	Type	Description
1	DeviceID	string	Device ID
2	AssetName	string	Attset name

Pass Parameter:

{
    "DeviceID": "100118693082012",
    "AssetName": "Zome dog bk"
}

Reply Parameter:

{
    "Code": 200,
    "Data": "0",
    "ErrMsg": null
}

Return Data Description:

Data	Description
0	Modify successfully
1	Invalid login credentials or expired
2	Device ID does not exist or have been deleted
3	Enterprise does not exist or have been deleted
4	Device are not under user authority to query
-1	Database error

Error message:

Code	Description
500	System error

Relative url: /api/vehicle/GetVehicleSumInfo
Request mode: POST
Authorization parameter: Token login credential string
JSON Parameter：

No.	Name	Type	Description
1	VehiclePlate	string	Vehicle Plate(If pass empty string, return to current enterprise to check the history status info of all vehicles )
2	StartTime	DateTime	Start time
2	EndTime	DateTime	End time

Pass Parameter:

{
    "VehiclePlate": "8619127327",
    "StartTime": "2018-01-01",
    "eEndTime": "2020-08-08"
}

Return

JSON Mileage and fuel data of the vehicle in Json format

No.	Name	Type	Description
1	ObjectCode	string	Vehicle No
2	VehicleNum	string	Vehicle Plate
3	OilNum	string	Fuel consumption at certain period(L)
4	Mileage	string	Mileage Total mileage at certain period(KM)

Reply Parameter:

{
    "Code": 200,
    "Data": {
        "total": 1,
        "data": [
            {
                "ObjectCode": "1910235",
                "VehicleNum": "861956327",
                "OilNum": "0.0",
                "Mileage": "357.6"
            }
        ]
    },
    "ErrMsg": null
}

Error message:

Code	Description
500	System error
401	Dangerous value in parameters or parameters missed
403	startTime should not be greater than end time
4001	This vehicle plate does not exist or has been deleted

Relative url: /api/vehicle/GetCurrentRegion
Request mode: POST
Authorization Parameter: Token Login credentials
JSON Parameter:

No.	Name	Type	Description
1	VehiclePlate	string	Vehicle Plate list (Separate by comma, if pass empty string it will return to the current enterprise to view the status of all vehicles/assets )

Pass Parameter:

{
    "VehiclePlates": "1632-A75"
}

Return:

Current area of vehicle in JSON

No.	Name	Type	Description
1	VehicleNum	string	Vehicle Plate Number
2	RegionName	string	Area name
3	InRegionTime	DateTime	Enter into area time

Reply Parameter:

{
    "Code": 200,
    "Data": {
        "total": 1,
        "data": [
            {
                "VehicleNum": " 1632-A75",
                "RegionName": "Wuhan TS Region",
                "InRegionTime": "2019-08-31 20:33:33"
            }
        ]
    },
    "ErrMsg": null
}

No qualified data return:

{
    "Code": 200,
    "Data": {
        "total": 0,
        "data": []
    },
    "ErrMsg": null
}

Error message:

Code	Description
500	System error

19. Get the records of enter or exit geo-fence by start time, end time and device ID

Relative url: /api/vehicle/GetEFIObyDeviceID
Request mode: POST
Authorization parameter: Token login credentials string
JSON parameter:

No.	Name	Type	Description
1	DeviceIDs	string	Device ID(Multiple ID please use ”,”to separate, for example 1010009609, 1010009610)
2	StartTime	DateTime	Start time
3	EndTime	DateTime	End time

Reply Parameter:

{
    "DeviceIDs": "86198511",
    "StartTime": "2020-07-25",
    "EndTime": "2020-07-30"
}

Return:

The specific time that vehicle enter or exit in Json format

No.	Name	Type	Description
1	VehicleNum	string	Vehicle Plate Number
2	DeviceID	string	Device ID
3	RegionName	string	Geofence name
4	IOTime	DateTime	Enter and exit geo-fence time
5	IOType	int	Type 0=In 1=Out

Reply Parameter:

{
    "Code": 200,
    "Data": {
        "total": 8,
        "data": [
            {
                "VehicleNum": "1686-VV5 ",
                "DeviceID": "861908511",
                "RegionName": "",
                "IOTime": "2020-07-26 12:39:06",
                "IOType": 1
            }
        ]
    },
    "ErrMsg": null
}

No qualified data return:

{
    "Code": 200,
    "Data": {
        "total": 0,
        "data": []
        },
    "ErrMsg": null
}

Error message:

Code	Description
401	Token invalid
402	DeviceIDs format is incorrect, please use DeviceID,DeviceID,DeviceID,…format
403	startTime should not be greater than end time
500	System error

20. Get the vehicle enter and exit geofence records by start time, end time, vehicle plate

Relative url: /api/vehicle/GetEFIOByVehicleNum
Request mode: POST
Authorization parameter: Token login credentials string
JSON parameter:

No.	Name	Type	Description
1	VehicleNums	string	Vehicle Plate(Multiple Vehicle Plate please use ,separate, for example: testing vehicle 1, testing vehicle 2)
2	StartTime	DateTime	Start time
3	EndTime	DateTime	End time

Pass Parameter:

{
    "VehicleNums": "8812225",
    "StartTime": "2020-07-25",
    "EndTime": "2020-07-30"
}

Return:

Records of vehicle entering or exiting the geofence at a specific time in Json format

No.	Name	Type	Description
1	VehicleNum	string	Vehicle Plate
2	DeviceID	string	Device ID
3	RegionName	string	Geofence name
4	IOTime	DateTime	Time of enter or exit geo-fence
5	IOType	int	Type 0=In 1=Out

Reply Parameter:

{
    "Code": 200,
    "Data": {
        "total": 18,
        "data": [
            {
                "VehicleNum": "881205225",
                "DeviceID": "881205225",
                "RegionName": "",
                "IOTime": "2020-07-26 01:17:54",
                "IOType": 0
            }
        ]
    },
    "ErrMsg": null
}

No qualified data return:

{
    "Code": 200,
    "Data": {
        "total": 0,
        "data": []
    },
    "ErrMsg": null
}

Error message:

Code	Description
401	Token invalid
403	startTime should not be greater than end time
500	System error

21. Get alarm records by start time, end time and device ID

Relative url: /api/vehicle/GetAlarmbyDeviceID
Request mode: POST
Authorization Parameter: Token login credential
JSON Parameter:

No.	Name	Type	Description
1	DeviceIDs	string	Device ID(Multiple devices IDs please use, to separate for example DeviceID1, DeviceID2)
2	StartTime	DateTime	Start time
3	EndTime	DateTime	End time

Pass Parameter:

{
    "DeviceIDs": "8812225",
    "StartTime": "2020-07-25",
    "EndTime": "2020-07-30"
}

JSON Return:

Json which includes the alarm details at specific time

No.	Name	Type	Description
1	GPSTime	DateTime	GPS time
2	RcvTime	DateTime	Receive time
3	VehicleNum	string	Vehicle Plate
4	DeviceID	string	Device ID
5	AlarmType	string	Alarm Type
6	Lon	double	Longitude
7	Lat	double	Latitude
8	Speed	double	Speed(km/h)
9	Direct	int	Direction
10	StatusDes	string	Status Info

Reply Parameter:

{
    "Code": 200,
    "Data": {
        "total": 1,
        "data": [
            {
                "GPSTime": "2020-07-26 01:17:53",
                "RcvTime": "2020-07-26 01:17:54",
                "VehicleNum": "88125225",
                "DeviceID": "88120225",
                "AlarmType": " Enter geofence alarm[Newly built fence]",
                "Lon": 113.58522,
                "Lat": 23.13139,
                "Speed": 38.9,
                "Direct": 40,
                "StatusDes": "Moving[7 mins 30 seconds],Upload [15 seconds],GSM network middle 20,Satellite middle 5, Main voltage 
                14.5V, Enter fence alarm [Newly built alarm]"
            }
        ]
    },
    "ErrMsg": null
}

No qualified data return:

{
    "Code": 200,
    "Data": {
        "total": 0,
        "data": []
    },
    "ErrMsg": null
}

Error message:

Failure info

Code	Description
401	Token invalid
402	deviceIDs format is not correct, please deviceID,deviceID,deviceID,…format
403	startTime should not be greater than end time
500	System error

22. Get alarm details by Start time,end time and vehicle Plate

Relative url: /api/vehicle/GetAlarmByVehicleNum
Request mode: POST
Authorization parameter: Token Login credentials string
JSON Parameter:

No.	Name	Type	Description
1	VehicleNums	string	Vehicle Plate(Multiple Vehicle Plate please use ,to separate for example testing vehicle 1, testing vehicle 2 2)
2	StartTime	DateTime	Start time
3	EndTime	DateTime	End time

Pass Parameter:

{
    "VehicleNums": "881225",
    "StartTime": "2020-07-25",
    "EndTime": "2020-07-30"
}

Return:

Vehicle alarm details at a specific time in JSON

No.	Name	Type	Description
1	GPSTime	DateTime	GPS time
2	RcvTime	DateTime	Receive time
3	VehicleNum	string	Vehicle Plate
4	DeviceID	string	Device ID
5	AlarmType	string	Alarm Type
6	Lon	string	Longitude
7	Lat	string	Latitude
8	Speed	string	Speed(km/h)
9	Direct	string	Direction
10	StatusDes	string	Status Info

Reply Parameter:

{
    "Code": 200,
    "Data": {
        "total": 1,
        "data": [
            {
                "GPSTime": "2020-07-26 01:17:53",
                "RcvTime": "2020-07-26 01:17:54",
                "VehicleNum": "88120225",
                "DeviceID": "88120625",
                "AlarmType": " Enter or leave geofence alarm [New fence build]",
                "Lon": 113.58522,
                "Lat": 23.13139,
                "Speed": 38.9,
                "Direct": 40,
                "StatusDes": "Moving [7 mins 30 seconds], Upload [15 seconds],GSM network middle 20,Satellite middle 5,Main voltage 
                14.5V, Enter and exit geofence alarm [New build fence]"
            },
        ]
    },
    "ErrMsg": null
}

No qualified data return:

{
    "Code": 200,
    "Data": {
        "total": 0,
        "data": []
    },
    "ErrMsg": null
}

Error message:

Failure info

Code	Description
401	Token invalid
403	startTime should not be greater than end time
500	System error

23. Get the vehicle location by vehicle plate

Relative url: /api/vehicle/GetLatestLocationByVehiclePlate
Request mode: POST
Authorization parameter: Token Login credentials string
JSON Parameter:

No.	Name	Type	Description
1	VehiclePlate	string	Vehicle Plate number

Pass Parameter:

{
    "VehiclePlate": "881225"
}

Return:

No.	Name	Type	Description
1	VehiclePlate	string	Vehicle Plate
2	RcvTime	DateTime	Receive time
3	GPSTime	DateTime	GPS time
4	Lon	double	Longitude(WSG84)
5	Lat	double	Latitude
6	RLon	double	Longitude(GCJ-02)
7	RLat	double	Latitude
8	StatusDes	string	Status description
9	Speed	int	Speed(km/h)
10	Mileage	string	Total Mileage value (km)
11	Location	string	Address info
12	IsReversal	int	Please ignore this

Reply Parameter:

{
    "Code": 200,
    "Data": {
        "data": {
            "VehicleNum": "88120625",
            "RcvTime": "2019-12-12 08:47:45",
            "GPSTime": "2019-12-12 08:47:05",
            "Lon": 113.941988,
            "Lat": 22.556138,
            "RLon": 113.946864,
            "RLat": 22.553121,
            "StatusDes": "Acc off [31 mins 22 seconds ],Upload [40 seconds],GSM network middle 22,Satellite middle 7, main voltage 12.1V",
            "Speed": 0,
            "Mileage": "27.4",
            "Location": "Tsinghua Information Hitech Park, Nanshan,Shenzhen,China",
            "IsReversal": 0
        }
    },
    "ErrMsg": null
}

No vehicle info has been found:

{
    "Code": 200,
    "Data": {
        "total": 0,
        "data": []
    },
    "ErrMsg": null
}

Error message:

Code	Description
401	Token invalid
404	This device does not exist
500	System error

24. Get vehicle location info by device ID

Relative url: /api/vehicle/GetLatestLocationByDeviceID
Request mode: POST
Authorization parameter: Token Login credentials string
JSON Parameter:

No.	Name	Type	Description
1	DeviceID	string	Device ID

Pass Parameter：
```
{
    "DeviceID": "8812025"
}
```
Return:

No.	Name	Type	Description
1	VehiclePlate	string	Vehicle Plate
2	RcvTime	DateTime	Receive time
3	GPSTime	DateTime	GPS time
4	Lon	double	Longitude(WSG84)
5	Lat	double	Latitude
6	RLon	double	Longitude(GCJ-02)
7	RLat	double	Latitude
8	StatusDes	string	Status description
9	Speed	int	Speed(km/h)
10	Mileage	string	Total Mileage value (km)
11	Location	string	Address info
12	IsReversal	int	Please ignore

Reply Parameter:

{
    "Code": 200,
    "Data": {
        "data": {
            "VehicleNum": "881205",
            "RcvTime": "2019-12-12 08:47:45",
            "GPSTime": "2019-12-12 08:47:05",
            "Lon": 113.941988,
            "Lat": 22.556138,
            "RLon": 113.946864,
            "RLat": 22.553121,
            "StatusDes": "ACC off [31 mins 22 seconds],upload [40 seconds ],GSM network middle 22,Satellite middle 7, main voltage 12.1V",
            "Speed": 0,
            "Mileage": "27.4",
            "Location": " Tsinghua Information Hitech Park, Nanshan,Shenzhen,China ",
            "IsReversal": 0
        }
    },
    "ErrMsg": null
}

No vehicle info has been found:

{
    "Code": 200,
    "Data": {
        "total": 0,
        "data": []
    },
    "ErrMsg": null
}

Error message:

Code	Description
401	Token invalid
404	This device does not exist
500	System error

25. To judge whether the vehicle is inside of geofence

Relative url: /api/vehicle/CheckRegionObject
Request mode: POST
Authorization parameter: Token Login credentials string
JSON Parameter:

No.	Name	Type	Description
1	VehiclePlate	string	Vehicle Plate No
2	PolygonID	int	Fence ID

Pass Parameter:

{
    "VehiclePlate": "88125225",
    "PolygonID": 937
}

Return:

No.	Name	Type	Description
1	VehiclePlate	string	Vehicle Plate number
2	InFence	int	0:Outside of the fence 1: Inside of the fence
3	IsOnline	int	0: Offline 1:online
4	GPSFlag	int	0: GPS not fixed 1:GPS fixed
5	GPSTime	DateTime	yyyy-MM-dd HH:mm:ss, null: Never come online

Reply Parameter:

(Inside geofence)

{
    "Code": 200,
    "Data": {
        "data": {
            "VehiclePlate": "881206225",
            "InFence": 1,
            "IsOnline": 1,
            "GPSFlag": 1,
            "GPSTime": "2019-12-12 08:47:05"
        }
    },
    "ErrMsg": null
}

(Outside of geofence):

{
    "Code": 200,
    "Data": {
        "data": {
            "VehiclePlate": "881206225",
            "InFence": 0,
            "IsOnline": 1,
            "GPSFlag": 1,
            "GPSTime": "2019-12-12 08:47:05"
        }
    },
    "ErrMsg": null
}

No qualified data return:

{
    "Code": 200,
    "Data": {
        "total": 0,
        "data": []
    },
    "ErrMsg": null
}

Error message:

Code	Description
401	Token invalid
404	This device does not exist
500	System error

26. Get vehicle trace or trace after deviation correction

Relative url: /api/vehicle/GetHistoryVehicleInfoAdv
Request mode: POST
Authorization parameter: Token Login credentials string
JSON Parameter:

No.	Name	Type	Description
1	DeviceID	string	Device ID, only supports single ID
2	StartTime	DateTime	Start time
3	EndTime	DateTime	End time
4	ContainZeroSpeed	bool	Whether to include the trace with speed 0 False: No True:No
5	ContainLBSLocation	bool	Whether to include LBS data false:No true: Yes
6	ContainCorrectPath	bool	Whether to return the trace route after correction false:No true:Yes

Pass Parameter:

{
    "DeviceID": "8812225",
    "startTime": "2020-07-24",
    "endTime": "2020-07-25 00:02:10",
    "ContainZeroSpeed": true,
    "ContainLBSLocation": true,
    "ContainCorrectPath": true
}

Return:

Vehicle history data in Json

No.	Name	Type	Description
1	GPSTime	DateTime	GPS time
2	RcvTime	DateTime	Receive time
3	Lon	double	Longitude(GPS coordiate)
4	Lat	double	Latitude(GPS coordinate )
5	RLon	double	Longitude(WCJ-02)
6	RLat	double	Latitude(WCJ-02)
7	Speed	string	Speed(km/h)
8	Direct	string	Direction
9	Status	string	ACC Status 0:ACC Off 1:ACC On
10	Mileage	string	Mileage
11	StatusDes	string	Vehicle Status
12	GPSFlag	string	Odd number: GPS fixed Even number : LBS position or Wifi position

Reply Parameter:

{
    "Code": 200,
    "Data": {
        "total": 1,
        "data": [
            {
                "RcvTime": "2020-07-26 00:02:09",
                "GPSTime": "2020-07-26 00:02:07",
                "Lon": "113.353287",
                "Lat": "23.344890",
                "RLon": "113.358781",
                "RLat": "23.342420",
                "StatusDes": "ACC off [8 minutes 22 seconds], heartbeat ,GSM network middle 19,satellite middle 7, main voltage 
                12.7V,SIM 卡 ICCID898604121018C1040199, power save mode ",
                "Speed": "0",
                "Direct": "0",
                "Status": "0",
                "Mileage": "29460",
                "GPSFlag": "1"
            }
        ],
        "correct_path": [ // path after correction，when correction is Failure correct_path is null
             {
                "x": "113.963729739189", // Longitude(WCJ-02)
                "y": "22.6883178949356" // Latitude(WCJ-02)
             }
        ]
    },
    "ErrMsg": null
}

No qualified data return:

{
    "Code": 200,
    "Data": {
        "total": 0,
        "data": [],
        "correct_path": []
    },
    "ErrMsg": null
}

Error message:

Code	Description
401	Token invalid
404	This device does not exist
500	System error

27. Vehicle query in zone

Relative url: /api/vehicle/GetCurrentVehicleInfoByRect
Request mode: POST
Authorization parameter: Token Login credentials string
JSON Parameter:

No.	Name	Type	Description
1	MinLon	decimal	The minimum Longitude in zone
2	MinLat	decimal	The mini Latitude in zone
3	MaxLon	decimal	The maximum Longitude in zone
4	MaxLat	decimal	The maximum Latitude in zone
5	Coordsys	string	The coordinate that is used for upload the latitude wsg84 or gcj02

Pass Parameter:

{
    "MinLon": 113,
    "MinLat": "23",
    "MaxLon": 114,
    "MaxLat": 24,
    "Coordsys": "wsg84"
}

Return:

vehicle data in the zone

No.	Name	Type	Description
1	SIM	string	Device SIM No
2	SIM2	string	Device ID
3	VehicleNum	string	Vehicle Plate
4	GPSTime	DateTime	GPS time
5	RcvTime	DateTime	Receive time
6	Lon	double	Longitude
7	Lat	double	Latitude
8	Speed	double	Speed
9	Direct	int	Direction
10	Mileage	string	Mileage
11	StatusDes	string	Vehicle Status
12	IsOnline	int	Status 0=Offline 1=Online
13	IsAlarm	int	Alarm status 0=Normal 1=Alarm
14	Status	int	Acc Status 0=Off 1=On
15	IsReversal	int	Please ignore

Reply Parameter:

{
    "Code": 200,
    "Data": {
        "total": 1,
        "data": [
            {
                "SIM": "144007608",
                "SIM2": "861917935",
                "VehicleNum": " Y 513",
                "GPSTime": "2020-07-23 13:43:20",
                "RcvTime": "2020-07-23 13:44:41",
                "Lon": 113.39095036315297,
                "Lat": 23.203487084551941,
                "Speed": 0.0,
                "Direct": 0,
                "Mileage": "11885.0",
                "StatusDes": "ACC OFF [15 hours 35 mins 34 seconds],Upload [40 seconds],GSM network weak 15,satellite strong 10, main voltage 11.5V",
                "IsOnline": 1,
                "IsAlarm": 0,
                "Status": 0,
                "IsReversal": 0
            }
         ]
    },
    "ErrMsg": null
}

No qualified data return:

{
    "Code": 200,
    "Data": {
        "total": 0,
        "data": [],
        "correct_path": []
    },
    "ErrMsg": null
}

Error message:

Code	Description
401	Token invalid
500	System error

28. Removal alarm list

Relative url: /api/vehicle/GetAlarmDetailReportData
Request mode: POST
Authorization parameter: Token Login credentials string
JSON Parameter:

No.	Name	Type	Description
1	DeviceIDs	string	Device ID(Multiple ID please use ,to separate, for example DeviceID1, DeviceID2)
2	StartTime	DateTime	Start time
3	EndTime	DateTime	End time
4	AlarmType	string	Alarm Type: Removal alarm; Power off alarm; Cover open alarm
5	IsShowAddress	bool	Show location: false;No true:Yes
6	QueryType	int	Query type:0;1;2 Don’t use the query type ;Device ID;Vehicle PlateNo
7	QueryKey	string	Query type keyword，When QueryType is 0，this field is empty，when QueryType is 1，this field need to fill device ID，when QueryType is 2，this field need to fill Vehicle Plate No

Reply Parameter:

{
    "Code": 200,
    "Data": {
        "total": 147,
        "data": [
            {
                "WONO": "",
                "PeopleName": "",
                "FrameNo": "",
                "CarInstallStore": "",
                "VehicleName": "862009759",
                "SIM2": "8620059759",
                "AlarmType": " Removal alarm",
                "RcvTime": "2020-07-26 06:31:42",
                "GPSTime": "2020-07-26 06:31:39",
                "Speed": 4.3,
                "StatusDes": ACC on [12 seconds ],upload[11 seconds],GSM network middle 21,satellite middle 7,1# temperature29.2℃, upload interval 1440 mins,rest work time 1416 days,SIM card ICCID898604119195, removal alarm, battery level 97%",
                "Lon": 110.929145,
                "Lat": 21.632158,
                "Culocation": "",
                "HoldName": "3W group "
            }
        ]
    },
    "ErrMsg": null
}

No qualified data return:

{
    "Code": 200,
    "Data": {
        "total": 0,
        "data": []
    },
    "ErrMsg": null
}

Error message:

Code	Description
401	Token invalid
403	startTime should not be greater than endTime
500	System error
4001	Get the hold ID of the enterprise failure
4005	This device does not exist or has been deleted
4006	This Vehicle Plate does not exist or has been deleted

29. Get device send message records

Relative url: /api/vehicle/GetDeviceSendMsgRecords
Request mode: POST
Authorization parameter: Token Login credentials string
JSON Parameter:

No.	Name	Type	Description
1	DeviceID	string	Device ID

{
    "DeviceID": "862408518000094"
}

Reply Parameter:

{
    "Code": 200,
    "Data": [
        {
            "RecID": 22354,
            "MsgType": "Respond",
            "MsgBody": "Device respond ( PROTOCOL:3,3;1),Acc on,Idle [1 Minutes 32 Seconds],,Altitude 1200 Meters ,LTE Network  Middle 16,Satellite Strong 19,Main voltage 12.7V",
            "SendTime": "2025-03-04 07:14:54"
        },
        {
            "RecID": 22353,
            "MsgType": "Respond",
            "MsgBody": " PROTOCOL:3,3;1",
            "SendTime": "2025-03-04 07:14:52"
        },
        {
            "RecID": 22352,
            "MsgType": "Send",
            "MsgBody": "PROTOCOL,3,3;1#",
            "SendTime": "2025-03-04 07:14:50"
        },
        {
            "RecID": 22351,
            "MsgType": "Respond",
            "MsgBody": " IP:193.193.165.165:20859,T",
            "SendTime": "2025-03-04 07:14:33"
        },
        {
            "RecID": 22350,
            "MsgType": "Send",
            "MsgBody": "IP,193.193.165.165,20859,T#",
            "SendTime": "2025-03-04 07:14:30"
        }
    ],
    "ErrMsg": "Ok"
}

30. Set lock switch command

Relative url: /api/Vehicle/LockSwitchCommand
Request mode: POST
Authorization parameter: Token Login credentials string
JSON Parameter:

No.	Name	Type	Description
1	DeviceID	string	Device ID
2	Password	string	Device’s password for command
3	OpenType	string	Set command: OpenType=1 open lock, OpenType=0 close lock

{
    "DeviceID": "862408518000094",
    "Password": "628301",
    "OpenType": "1"
}

Reply Parameter:

{
    "Code": 200,
    "Data": null,
    "ErrMsg": "Success"
}

31. Set Timed Unlock command

Relative url: /api/Vehicle/LockSwitchFixedCommand
Request mode: POST
Authorization parameter: Token Login credentials string
JSON Parameter:

No.	Name	Type	Description
1	DeviceID	string	Device ID
2	Password	string	Device’s password for command
3	FixedTime	string	The time when open the lock

{
    "DeviceID": "862408518000094",
    "Password": "628301",
    "FixedTime": "2025-03-20 18:15:00"
}

Reply Parameter:

{
    "Code": 200,
    "Data": null,
    "ErrMsg": "Success"
}

32. Get iLock event report

Relative url: /api/Vehicle/GetLockEventReport
Request mode: POST
Authorization parameter: Token Login credentials string
JSON Parameter:

No.	Name	Type	Description
1	DeviceID	string	Device ID
2	StartTime	string	The begin time
3	EndTime	string	The end time

{
    "DeviceID": "862408518000094",
    "StartTime": "2025-03-20 12:05:00",
    "EndTime": "2025-03-20 17:40:00"
}

Reply Parameter:

No.	Name	Type	Description
1	DeviceID	string	Device ID
2	VehicleNum	string	Vehicle name
3	EventInfo	string	Event info
4	EventTime	string	Time for event
5	GPSTime	string	GPS time
6	GPSFlag	string	Is GPS location?
7	Lon	double	longitude
8	Lat	double	latitude
9	Address	string	address
10	Speed	double	speed
11	Direction	string	Direction
12	Mileage	string	Mileage(km)

{
    "Code": 200,
    "Data": [
        {
            "DeviceID": "862408518000094",
            "VehicleNum": "NT68_0094",
            "EventInfo": "lock off",
            "EventTime": "2025/3/20 17:06:06",
            "GPSTime": "2025/3/20 17:06:05",
            "GPSFlag": "No",
            "Lon": 113.934497,
            "Lat": 22.576603,
            "Address": null,
            "Speed": 0.0,
            "Direction": 260,
            "Mileage": 53.0
        },
        {
            "DeviceID": "862408518000094",
            "VehicleNum": "NT68_0094",
            "EventInfo": "Unlocked & Pole/Rope in Lock",
            "EventTime": "2025/3/20 16:48:18",
            "GPSTime": "2025/3/20 16:48:15",
            "GPSFlag": "Yes",
            "Lon": 113.934497,
            "Lat": 22.576603,
            "Address": null,
            "Speed": 0.0,
            "Direction": 260,
            "Mileage": 53.0
        },
        {
            "DeviceID": "862408518000094",
            "VehicleNum": "NT68_0094",
            "EventInfo": "Unlocked & Pole/Rope out Lock",
            "EventTime": "2025/3/20 16:48:17",
            "GPSTime": "2025/3/20 16:48:13",
            "GPSFlag": "Yes",
            "Lon": 113.934497,
            "Lat": 22.576603,
            "Address": null,
            "Speed": 0.0,
            "Direction": 260,
            "Mileage": 53.0
        }
    ],
    "ErrMsg": "Success"
}

33. Get SIM Detail

Relative url: /sims/api/GetBasicDetails
Request mode: POST
Authorization parameter: Token Login credentials string
JSON Parameter:

No.	Name	Type	Description
1	ICCID	string	ICCID

{
    "ICCID": "8910624085180000092"
}

Reply Parameter:

No.	Name	Type	Description
1	SIM	string	SIM number
2	ICCID	string	ICCID number
3	IMSI	string	IMSI number
4	Tag	string	Tag data
5	PackageName	string	Package Name
6	DeviceID	string	Device ID
7	Remark	string	Remark
8	Status	string	Status
9	SessionStatus	string	Session Status
10	UsageAmount	double	Usage Amount (MB)
11	UsageData	double	Usage Data (MB)
12	SMSAmount	double	SMS Amount (pcs)
13	SMSData	double	SMS Data (pcs)
14	OperatorCountry	string	Operator Country Info
15	AccessTechnology	string	Access Technology Info
16	IpAddress	string	Ip Address
17	Actived	string	Actived Date
18	EndDate	string	Expire Date
19	CreateDate	string	Create Date

{
    "Code": 200,
    "Data": {
        "SIM": "882285109030215",
        "ICCID": "8988228055509013601",
        "IMSI": "901405109066932",
        "Tag": "",
        "PackageName": "500M",
        "DeviceID": "862405517000969",
        "Remark": "",
        "Status": "Activated",
        "SessionStatus": "Online",
        "UsageAmount": 500.00,
        "UsageData": 452.42,
        "SMSAmount": 250,
        "SMSData": 250,
        "OperatorCountry": "Alfa Telecom/Kyrqyzstan",
        "AccessTechnology": "4G",
        "IpAddress": "100.107.170.217",
        "Actived": "2024-01-05",
        "EndDate": "2034-04-05",
        "CreateDate": "2024-07-10 14:24:38"
    },
    "ErrMsg": "OK"
}

34. Change SIM Status

Relative url: /sims/api/ChangeSIMStatus
Request mode: POST
Authorization parameter: Token Login credentials string
JSON Parameter:

No.	Name	Type	Description
1	ICCID	string	ICCID
2	Status	string	SIM Status, Accept value: Activate, Deactivate

{
    "ICCID": "8988228055513690686",
    "Status": "Deactivate"
}

Reply Parameter:

{
    "Code": 200,
    "Data": null,
    "ErrMsg": "OK"
}

35. Send SMS for SIM

Relative url: /sims/api/CreateSendSMS
Request mode: POST
Authorization parameter: Token Login credentials string
JSON Parameter:

No.	Name	Type	Description
1	ICCID	string	ICCID
2	Content	string	SMS Content

{
    "ICCID": "8988228055513690686",
    "Content": "STATUS#"
}

Reply Parameter:

{
    "Code": 200,
    "Data": null,
    "ErrMsg": "OK"
}

36. Get SIM SMS List

Relative url: /sims/api/GetSMSList
Request mode: POST
Authorization parameter: Token Login credentials string
JSON Parameter:

No.	Name	Type	Description
1	ICCID	string	ICCID
2	StartTime	string	Start Time
3	EndTime	string	End Time

{
    "ICCID": "8988228055513690686",
    "StartTime": "2025-05-07 00:30:20",
    "EndTime": "2025-05-07 12:30:20"
}

Reply Parameter:

No.	Name	Type	Description
1	Total_Records	int	Total for records
2	List	string	data

List data

No.	Name	Type	Description
1	CreateTime	string	Create Time
2	SIM	string	SIM
3	ICCID	string	ICCID
4	Content	string	SMS Content
5	SourceAddress	string	SourceAddress info
6	MType	string	MType
7	Status	string	Status for send

{
    "Code": 200,
    "Data": {
        "Total_Records": 6,
        "List": [
            {
                "CreateTime": "2025-05-07 04:46:28",
                "SIM": "882285118762008",
                "ICCID": "8988228066618621513",
                "Content": "PARAM#",
                "SourceAddress": "882285118762008",
                "MType": "MT",
                "Status": "Delivered"
            },
            {
                "CreateTime": "2025-05-07 04:46:29",
                "SIM": "882285118762008",
                "ICCID": "8988228066618621513",
                "Content": "PARAM#",
                "SourceAddress": "882285118762008",
                "MType": "MT",
                "Status": "Delivered"
            },
            {
                "CreateTime": "2025-05-07 04:47:59",
                "SIM": "882285118762008",
                "ICCID": "8988228066618621513",
                "Content": "APN setting OK,APN:iot.1nce.net,Username:webgprs,Password:,now will restart to make effect...",
                "SourceAddress": "882285118762008",
                "MType": "MO",
                "Status": "Reply"
            }
        ]
    },
    "ErrMsg": "OK"
}

37. Send Device Text Command

Relative url: /api/SetCommand/SendTextCmd
Request mode: POST
Authorization parameter: Token Login credentials string
JSON Parameter:

No.	Name	Type	Description
1	DeviceID	string	Device ID
2	TextCommand	string	Command content

{
    "DeviceID": "5622035000015",
    "TextCommand": "Hello"
}

Reply Parameter:

{
    "Code": 200,
    "Data": null,
    "ErrMsg": "OK"
}

38. Send Device HighLevel Command

Relative url: /api/SetCommand/SendHighLevelCmd
Request mode: POST
Authorization parameter: Token Login credentials string
JSON Parameter:

No.	Name	Type	Description
1	DeviceID	string	Device ID
2	TextCommand	string	Command content

{
    "DeviceID": "5622035000015",
    "TextCommand": "Hello High Level"
}

Reply Parameter:

{
    "Code": 200,
    "Data": null,
    "ErrMsg": "OK"
}

39. Send Query Device Status Command

Relative url: /api/SetCommand/SendQueryStatusCmd
Request mode: POST
Authorization parameter: Token Login credentials string
JSON Parameter:

No.	Name	Type	Description
1	DeviceID	string	Device ID

{
    "DeviceID": "5622035000015"
}

Reply Parameter:

{
    "Code": 200,
    "Data": null,
    "ErrMsg": "OK"
}

40. Send Query Device Parameter Command

Relative url: /api/SetCommand/SendQueryParamCmd
Request mode: POST
Authorization parameter: Token Login credentials string
JSON Parameter:

No.	Name	Type	Description
1	DeviceID	string	Device ID

{
    "DeviceID": "5622035000015"
}

Reply Parameter:

{
    "Code": 200,
    "Data": null,
    "ErrMsg": "OK"
}

41. Send Query Device ICCID Command

Relative url: /api/SetCommand/SendQueryICCIDCmd
Request mode: POST
Authorization parameter: Token Login credentials string
JSON Parameter:

No.	Name	Type	Description
1	DeviceID	string	Device ID

{
    "DeviceID": "5622035000015"
}

Reply Parameter:

{
    "Code": 200,
    "Data": null,
    "ErrMsg": "OK"
}

42. Call URL

Call URL：
```
http://openapi.itracksense.com/
```
Parameter list:

Index	Explanation	Value	Default value	Mandatory
key	Login credential	-	Empty	*
fun	Page function, valid when 1st time enter	1. Online Monitor 2.Map monitor 3. History trace 4. Report 5.Login interface	2	-
ids	ID list（vehicle list ），use comma to separate	-	-	-
type	ID list parameter type	0:Device ID 1.Vehicle Plate	0	-

Example

1. To check the device ID 80222000000 position on map

http://openapi.itracksense.com/api?key=XXXXXXXXXXXXXXXXXX&ids=80222000000

1. To check the vehicle plate A0001 positon on map

http://openapi.itracksense.com/api?key=XXXXXXXXXXXXXXXXXX&ids=A0001&type=1

1. To check online monitor of vehicle plate A0001

http://openapi.itracksense.com/api?key=XXXXXXXXXXXXXXXXXXX&ids=A0001&type=1&fun=1

1. To check the history trace of vehicle plate A0001

http://openapi.itracksense.com/api?key=XXXXXXXXXXXXXXXXXXX&ids=A0001&type=1&fun=3

1. To use key to login platform

http://openapi.itracksense.com/api?key=XXXXXXXXXXXXXXXXXXX&fun=5

iTracksense Open REST API

Catalogue

1. Server Address

2. Interface Explanation

3. Call url format： Domain + Relative path

4 Get login credentials by user name and password

5. Logout login credentials

6. Get your device list

7. Get current vehicle or asset status info by login credentials and vehicle plate(assets) list

8. Get current status of vehicle or assets by login credentials and device ID list

9. Get vehicle history info by login credentials, vehicle plate, start time and end time

10. Get vehicle/assets history trace by login credentials, device ID, start time and end time

11. Get the current alarm info by login credentials, device ID

12. 4003 Return vehicle address by login credential, vehicle plate in string mode

13. Get vehicle/assets’address in string mode according to login crdentials

14. Get the traveled mileage at certain period by device ID, start time and end time

15. Modify vehicle plate No by device ID

16. Modify attset name by device ID

17. Get vehicle mileage number and fuel info by login credentials, vehicle plate list, start time and end time

18. Get the region that the vehicle/assets that are located in by login credentials and vehicle plate

19. Get the records of enter or exit geo-fence by start time, end time and device ID

20. Get the vehicle enter and exit geofence records by start time, end time, vehicle plate

21. Get alarm records by start time, end time and device ID

22. Get alarm details by Start time,end time and vehicle Plate

23. Get the vehicle location by vehicle plate

24. Get vehicle location info by device ID

25. To judge whether the vehicle is inside of geofence

26. Get vehicle trace or trace after deviation correction

27. Vehicle query in zone

28. Removal alarm list

29. Get device send message records

30. Set lock switch command

31. Set Timed Unlock command

32. Get iLock event report

33. Get SIM Detail

34. Change SIM Status

35. Send SMS for SIM

36. Get SIM SMS List

37. Send Device Text Command

38. Send Device HighLevel Command

39. Send Query Device Status Command

40. Send Query Device Parameter Command

41. Send Query Device ICCID Command

42. Call URL