{"id":349,"date":"2024-03-14T10:49:23","date_gmt":"2024-03-14T09:49:23","guid":{"rendered":"https:\/\/kb.apptec360.com\/manual\/?post_type=knowledgebase&p=349"},"modified":"2024-04-01T07:33:13","modified_gmt":"2024-04-01T05:33:13","slug":"queries","status":"publish","type":"knowledgebase","link":"https:\/\/kb.apptec360.com\/manual\/knowledgebase\/general-settings\/role-based-access\/api-access\/queries\/","title":{"rendered":"Queries"},"content":{"rendered":"\n

List all devices<\/span><\/strong><\/p>\n\n\n\n

Functionality: Returns a list of all devices containing the Device ID, IMEI and Serial
API URI: v2\/device\/listdevices
Mandatory Parameters: none
Optional Parameters: none<\/p>\n\n\n\n

Example Request Body<\/span><\/p>\n\n\n\n

{\n\"api\": \"v2\/device\/listdevices\",\n\"time\": 1529662725\n}\n<\/code><\/pre>\n\n\n\n
Example Response Body<\/span><\/p>\n\n\n\n
{\n\"errors\": [],\n\"list\":[\n{ \"id\":\"10\",\"serial\":\"987612345\",\"imei\":\"899938455454\"},\n{ \"id\":\"11\",\"serial\":\"619723118\",\"imei\":\"713032378599\"}\n]\n}\n<\/code><\/pre>\n\n\n\n
<\/div>\n\n\n\n
Get list of (GPS) positions<\/span><\/strong><\/p>\n\n\n\n
Functionality: Returns a list of all stored position log entries for device ids
API URI: v2\/device\/listposition
Mandatory Parameters: \u201cids\u201d \u2013 Array of Device IDs
Optional Parameters: none<\/p>\n\n\n\n
Example Request Body<\/span><\/p>\n\n\n\n
{
\"api\": \"device\/listposition\",
\"params\": {
\"ids\": [10, 11]
},
\"time\": 1529662725
}<\/code><\/pre>\n\n\n\n
Example Response Body<\/span><\/p>\n\n\n\n
{
\"errors\": [],
\"list\":[
\"10\":[
{\"time\":\"1529632725\",\"pos\":\"47.5572,7.5967\"},
{\"time\":\"1529642725\",\"pos\":\"47.5572,7.5968\"},
{\"time\":\"1529652725\",\"pos\":\"47.5573,7.5969\"},
],
\"88\":[],
]
}<\/code><\/pre>\n\n\n\n
<\/div>\n\n\n\n
Get asset map<\/span><\/strong><\/p>\n\n\n\n
Functionality:
Returns a list of all stored possible assets to be requested using Get any asset data.
You can either use the human readable form or the asset tag to request the data.
API URI: v2\/device\/getassetmap
Mandatory Parameters: none
Optional Parameters: none<\/p>\n\n\n\n
Example Request Body<\/span><\/p>\n\n\n\n
{
\"api\": \"v2\/device\/getassetmap\",
\"time\": 1529662725
}<\/code><\/pre>\n\n\n\n
Example Response Body<\/span><\/p>\n\n\n\n
This response was shortened for readability.<\/p>\n\n\n\n
{
\"AssetKeys\": {
\"UDID\": \"AT001\",
\"Device Alias\": \"AT002\",
\"OS Version WinMobile iOS MacOS\": \"AT003\",
\"Model Name\": \"AT004\",
\"Serial Number\": \"AT005\",
\"Total Storage\": \"AT006\",
\"Free Storage\": \"AT007\",
\"IMEI\": \"AT008\",
\u2026
\"apptecID\": \"APPTECID\"
},
\"errors\": []
}<\/code><\/pre>\n\n\n\n
<\/div>\n\n\n\n
Get any asset data<\/span><\/strong><\/p>\n\n\n\n
Functionality: Returns a list of requested asset data for device ids
API URI: v2\/device\/getassetdata
Mandatory Parameters: \u201cids\u201d \u2013 Array of Device IDs
Optional Parameters:
\u201cassetkeys\u201d \u2013 Asset data keys to return. If not specified all available asset data will be
returned. You can get a list of asset keys using Get asset map.<\/p>\n\n\n\n
Example Request Body<\/span><\/p>\n\n\n\n
{
\"api\": \"v2\/device\/getassetdata\",
\"time\": 1529662725,
\"params\": {
\"ids\": [
26
],
\"assetkeys\": [
\"imei\"
]
}
}<\/code><\/pre>\n\n\n\n
Example Response Body<\/span><\/p>\n\n\n\n
{
\"result\": {
\"26\": {
\"imei\": \"349157642516427\u201d
}
},
\"errors\": []
}<\/code><\/pre>\n\n\n\n
<\/div>\n","protected":false},"parent":336,"menu_order":0,"template":"","class_list":["post-349","knowledgebase","type-knowledgebase","status-publish","hentry"],"acf":[],"_links":{"self":[{"href":"https:\/\/kb.apptec360.com\/manual\/wp-json\/wp\/v2\/knowledgebase\/349","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/kb.apptec360.com\/manual\/wp-json\/wp\/v2\/knowledgebase"}],"about":[{"href":"https:\/\/kb.apptec360.com\/manual\/wp-json\/wp\/v2\/types\/knowledgebase"}],"version-history":[{"count":6,"href":"https:\/\/kb.apptec360.com\/manual\/wp-json\/wp\/v2\/knowledgebase\/349\/revisions"}],"predecessor-version":[{"id":3268,"href":"https:\/\/kb.apptec360.com\/manual\/wp-json\/wp\/v2\/knowledgebase\/349\/revisions\/3268"}],"up":[{"embeddable":true,"href":"https:\/\/kb.apptec360.com\/manual\/wp-json\/wp\/v2\/knowledgebase\/336"}],"wp:attachment":[{"href":"https:\/\/kb.apptec360.com\/manual\/wp-json\/wp\/v2\/media?parent=349"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}