{"info":{"_postman_id":"e8cc5784-100f-436e-bd6a-5c7987ef493f","name":"DPL Stream API","description":"

Rest API for reading Values, Locations, and Alarms generated from DPL Hardware.

\n

Authentication is via HTTP Basic Auth. Use your API key as the basic auth username and leave the password empty. Please contact DPL if you don't have a user set up with an API key.

\n
curl 'https://api.dplwireless.com/v1/data/alarms/?lastseenid=0&limit=100' -u [APIKEY]:\n# The colon prevents curl from asking for a password.\n

The following three api calls return JSON and are meant to fetch full fleet data for all enabled devices in a company.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"2030094","collectionId":"e8cc5784-100f-436e-bd6a-5c7987ef493f","publishedId":"TzCV24SU","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2024-02-26T20:52:50.000Z"},"item":[{"name":"Alarms","id":"683343be-2de8-4fa1-a723-8180c84336d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.dplwireless.com/v1/data/alarms/?lastseenid=0&limit=5","description":"

Request a limited set of Alarms starting from the lastseenid.

\n

Returned JSON key / value:

\n

alarmlogid: 64 bit Integer: Unique & monotonically increasing Id for each server received alarm. For any single machineid, alarms with larger alarmlogid are always newer. These IDs are not necessarily consecutive.

\n

machineid: Integer: Internal id which identifies a piece of equipment. Every piece of data gets assigned to a machineid that never changes. Other IDs are configurable, including the DPL wireless device serialnum which can be assigned to an existing machine for example after an equipment swap or RMA.

\n

serialnum: Integer: The serialnum of the DPL wireless device assigned to the machine (at the time of the API call).

\n

id: String: This is the user configurable ID column in the portal (at the time of the API call).

\n

name: String: This is the user configurable Name column in the portal (at the time of the API call).

\n

alarmnum: Integer: Internal ID for the type of alarm.

\n

datatag: String: Text tag indicating the configuration of the alarm.

\n

eventtime:ISO 8601 compatible string UTC: e.g. \"2005-04-02 15:11:26\", timestamped by wireless device clock.

\n

reasoncode: Integer: Can identify events that triggered the issuance of the data point.

\n","urlObject":{"protocol":"https","path":["v1","data","alarms",""],"host":["api","dplwireless","com"],"query":[{"description":{"content":"

Filter for alarmlogid (see bellow). The call will return rows with an alarmlogid above this, ordered by alarmlogid. The client application should remember the largest alarmlogid stored in the client Database, and use this value when calling subsequent calls to this API function.

\n","type":"text/plain"},"key":"lastseenid","value":"0"},{"description":{"content":"

This is the max number of rows returned (max 10000 * NOTE: Max is adjustable by DPL).

\n","type":"text/plain"},"key":"limit","value":"5"}],"variable":[]}},"response":[{"id":"4390e1e9-fe95-46d3-b0d4-b9b879952257","name":"DPL Stream API - Alarms","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.dplwireless.com/v1/data/alarms/?lastseenid=0&limit=5","protocol":"https","host":["api","dplwireless","com"],"path":["v1","data","alarms",""],"query":[{"key":"lastseenid","value":"0","description":"Filter for alarmlogid (see bellow). The call will return rows with an alarmlogid above this, ordered by alarmlogid. The client application should remember the largest alarmlogid stored in the client Database, and use this value when calling subsequent calls to this API function. \n"},{"key":"limit","value":"5","description":"This is the max number of rows returned (max 10000 * NOTE: Max is adjustable by DPL)."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 09 Apr 2021 14:37:28 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"735"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache/2.4.46 () OpenSSL/1.0.2k-fips mod_wsgi/3.4 Python/2.7.18 PHP/7.2.34 mod_jk/1.2.46"},{"key":"X-Powered-By","value":"Express"},{"key":"ETag","value":"W/\"2df-wwu6HgXG+FmimfIMX3Jzdx0+stU\""},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"alarmlogid\": \"238187\",\n \"machineid\": 755,\n \"serialnum\": 20276,\n \"id\": \"\",\n \"alarmnum\": 63,\n \"datatag\": \"\",\n \"eventtime\": \"2005-04-02 15:11:26\",\n \"reasoncode\": 0\n },\n {\n \"alarmlogid\": \"326438\",\n \"machineid\": 2109,\n \"serialnum\": 40271,\n \"id\": \"\",\n \"alarmnum\": 63,\n \"datatag\": \"DTA_RSET\",\n \"eventtime\": \"2005-09-28 20:22:05\",\n \"reasoncode\": 0\n },\n {\n \"alarmlogid\": \"327637\",\n \"machineid\": 2109,\n \"serialnum\": 40271,\n \"id\": \"\",\n \"alarmnum\": 1,\n \"datatag\": \"PWR_CUT\",\n \"eventtime\": \"2005-09-30 18:48:04\",\n \"reasoncode\": 0\n },\n {\n \"alarmlogid\": \"327638\",\n \"machineid\": 2109,\n \"serialnum\": 40271,\n \"id\": \"\",\n \"alarmnum\": 4,\n \"datatag\": \"TILT\",\n \"eventtime\": \"2005-09-30 18:48:09\",\n \"reasoncode\": 0\n },\n {\n \"alarmlogid\": \"327639\",\n \"machineid\": 2109,\n \"serialnum\": 40271,\n \"id\": \"\",\n \"alarmnum\": 4,\n \"datatag\": \"TILT\",\n \"eventtime\": \"2005-09-30 18:48:09\",\n \"reasoncode\": 0\n }\n]"}],"_postman_id":"683343be-2de8-4fa1-a723-8180c84336d1"},{"name":"Values","id":"0cffafe4-35e6-4619-8121-d97cc1a451ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.dplwireless.com/v1/data/values/?lastseenid=0&limit=5","description":"

Request a limited set of Values starting from the lastseenid.

\n

Returned JSON key / value:

\n

valuelogid: 64 bit Integer: Unique & monotonically increasing Id for each server received value. For any single machineid, values with larger valuelogid are always newer. These IDs are not necessarily consecutive.

\n

machineid: Integer: Internal id which identifies a piece of equipment. Every piece of data gets assigned to a machineid that never changes. Other IDs are configurable, including the DPL wireless device serialnum which can be assigned to an existing machine for example after an equipment swap or RMA.

\n

serialnum:Integer: The serialnum of the DPL wireless device assigned to the machine (at the time of the API call).

\n

id:String: This is the user configurable ID column in the portal (at the time of the API call).

\n

name: String: This is the user configurable Name column in the portal (at the time of the API call).

\n

valuenum: Integer: Internal ID for the type of value.

\n

datatag: String: Text tag indicating the configuration of the value.

\n

eventtime:ISO 8601 compatible string UTC: e.g. \"2005-04-02 15:11:26\", timestamped by wireless device clock.

\n

reasoncode: Integer: can identify events that triggered the issuance of the data point

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
CodeDescription
0UnKnown
1Sent on TimeSlot
2Sent on Switch
3Sent on System
4Sent on Page
5Sent on HAlarm
6Sent on LAlarm
8Cleared on Switch
9Cleared on System
10Cleared on Page
11Cleared on HAlarm
12Cleared on LAlarm
7Cleared on TimeSlot
13Sent on Power Save Alarm
15Sent on Panic Alarm
16Sent on Perimeter Alarm
14Sent on Power Bad Alarm
255UnKnown
\n

iscounter: Integer:Indicates value is being accumulated over time.

\n

valueval_visual: String: Value as displayed in portal

\n

valuedval_visual: String: Value delta as displayed in portal if applicable

\n

valueval_basic: Value without transformation function applied (if configured).

\n

valuedval_basic: Value delta without transformation function applied

\n

valueval_raw: String: 64 bit integer transmitted as string. Raw value without transformation function or configured adjustments.

\n

valuedval_raw: Raw delta without transformation function or configured adjustments.

\n

valueadj: Configured adjustment factor.

\n

initvalueval: Configured adjustment offset.

\n","urlObject":{"protocol":"https","path":["v1","data","values",""],"host":["api","dplwireless","com"],"query":[{"description":{"content":"

Filter for valuelogid . The call will return rows with an valuelogid above this, ordered by valuelogid. The client application should remember the largest valuelogid stored in the client Database, and use this value when calling subsequent calls to this API function.

\n","type":"text/plain"},"key":"lastseenid","value":"0"},{"description":{"content":"

This is the max number of rows returned (max 10000 * NOTE: Max is adjustable by DPL).

\n","type":"text/plain"},"key":"limit","value":"5"}],"variable":[]}},"response":[{"id":"9a55b91d-ba04-4580-b445-ad464a924e1a","name":"DPL Stream API - Values","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.dplwireless.com/v1/data/values/?lastseenid=0&limit=5","protocol":"https","host":["api","dplwireless","com"],"path":["v1","data","values",""],"query":[{"key":"lastseenid","value":"0"},{"key":"limit","value":"5"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 09 Apr 2021 14:37:46 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache/2.4.46 () OpenSSL/1.0.2k-fips mod_wsgi/3.4 Python/2.7.18 PHP/7.2.34 mod_jk/1.2.46"},{"key":"X-Powered-By","value":"Express"},{"key":"ETag","value":"W/\"6b7-rZZdBMUNceWhBhb2GmprcB9odR8\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"valuelogid\": \"2342738\",\n \"machineid\": 4969,\n \"serialnum\": 42139,\n \"id\": \"\",\n \"valuenum\": 254,\n \"datatag\": \"SLEVEL\",\n \"eventtime\": \"2007-01-15 19:39:26\",\n \"reasoncode\": 0,\n \"iscounter\": 0,\n \"valueval_visual\": \"-77 Bars(6/7)\",\n \"valuedval_visual\": null,\n \"valueval_basic\": \"37\",\n \"valuedval_basic\": null,\n \"valueval_raw\": \"37\",\n \"valuedval_raw\": \"37\",\n \"valueadj\": null,\n \"initvalueval\": \"0\"\n },\n {\n \"valuelogid\": \"2352141\",\n \"machineid\": 4969,\n \"serialnum\": 42139,\n \"id\": \"\",\n \"valuenum\": 254,\n \"datatag\": \"SLEVEL\",\n \"eventtime\": \"2007-01-16 16:38:12\",\n \"reasoncode\": 0,\n \"iscounter\": 0,\n \"valueval_visual\": \"-71 Bars(7/7)\",\n \"valuedval_visual\": null,\n \"valueval_basic\": \"43\",\n \"valuedval_basic\": null,\n \"valueval_raw\": \"43\",\n \"valuedval_raw\": \"6\",\n \"valueadj\": null,\n \"initvalueval\": \"0\"\n },\n {\n \"valuelogid\": \"2352191\",\n \"machineid\": 4969,\n \"serialnum\": 42139,\n \"id\": \"\",\n \"valuenum\": 254,\n \"datatag\": \"SLEVEL\",\n \"eventtime\": \"2007-01-16 16:49:51\",\n \"reasoncode\": 0,\n \"iscounter\": 0,\n \"valueval_visual\": \"-63 Bars(7/7)\",\n \"valuedval_visual\": null,\n \"valueval_basic\": \"51\",\n \"valuedval_basic\": null,\n \"valueval_raw\": \"51\",\n \"valuedval_raw\": \"8\",\n \"valueadj\": null,\n \"initvalueval\": \"0\"\n },\n {\n \"valuelogid\": \"2637609\",\n \"machineid\": 5252,\n \"serialnum\": 42145,\n \"id\": \"\",\n \"valuenum\": 254,\n \"datatag\": \"SLEVEL\",\n \"eventtime\": \"2007-02-15 14:35:35\",\n \"reasoncode\": 0,\n \"iscounter\": 0,\n \"valueval_visual\": \"-61 Bars(7/7)\",\n \"valuedval_visual\": null,\n \"valueval_basic\": \"53\",\n \"valuedval_basic\": null,\n \"valueval_raw\": \"53\",\n \"valuedval_raw\": \"53\",\n \"valueadj\": null,\n \"initvalueval\": \"0\"\n },\n {\n \"valuelogid\": \"2855245\",\n \"machineid\": 5252,\n \"serialnum\": 42145,\n \"id\": \"\",\n \"valuenum\": 254,\n \"datatag\": \"SLEVEL\",\n \"eventtime\": \"2007-03-08 19:14:53\",\n \"reasoncode\": 0,\n \"iscounter\": 0,\n \"valueval_visual\": \"-73 Bars(7/7)\",\n \"valuedval_visual\": null,\n \"valueval_basic\": \"41\",\n \"valuedval_basic\": null,\n \"valueval_raw\": \"41\",\n \"valuedval_raw\": \"41\",\n \"valueadj\": null,\n \"initvalueval\": \"0\"\n }\n]"}],"_postman_id":"0cffafe4-35e6-4619-8121-d97cc1a451ea"},{"name":"Locations","id":"83f8e161-faec-4e0e-a9e4-52b8ca54356e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.dplwireless.com/v1/data/locations/?lastseenid=0&limit=5","description":"

Request a limited set of Locations starting from the lastseenid.

\n

Returned JSON key / value:

\n

locationlogid: 64 bit Integer: Unique & monotonically increasing Id for each server received location. For any single machineid, locations with larger locationlogid are always newer. These IDs are not necessarily consecutive.

\n

machineid: Integer: Internal id which identifies a piece of equipment. Every piece of data gets assigned to a machineid that never changes. Other IDs are configurable, including the DPL wireless device serialnum which can be assigned to an existing machine for example after an equipment swap or RMA.

\n

serialnum: Integer: The serialnum of the DPL wireless device assigned to the machine (at the time of the API call).

\n

id: String: This is the user configurable ID column in the portal (at the time of the API call).

\n

name: String: This is the user configurable Name column in the portal (at the time of the API call).

\n

locationnum: Integer: Internal ID for the type of value.

\n

datatag: String: Text tag indicating the configuration of the value.

\n

eventtime: ISO 8601 compatible string: UTC e.g. \"2005-04-02 15:11:26\", timestamped by wireless device clock.

\n

reasoncode: Integer: Can identify events that triggered the issuance of the data point

\n

longitude: Floating point

\n

latitude: Floating point

\n

direction: Integer: Follows the following definitions:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
IdDirection
0None
1N
2S
3E
4W
5NE
6NW
7SE
8SW
9Invalid
10Stale GPS point
11Wifi Point (if available)
12Cellular Point (if available)
\n

speed: Integer: km/h

\n","urlObject":{"protocol":"https","path":["v1","data","locations",""],"host":["api","dplwireless","com"],"query":[{"description":{"content":"

Filter for locationlogid (see bellow). The call will return rows with an locationlogid above this, ordered by locationlogid. The client application should remember the largest locationlogid stored in the client Database, and use this value when calling subsequent calls to this API function.

\n","type":"text/plain"},"key":"lastseenid","value":"0"},{"description":{"content":"

This is the max number of rows returned (max 10000 * NOTE: Max is adjustable by DPL).

\n","type":"text/plain"},"key":"limit","value":"5"}],"variable":[]}},"response":[{"id":"3f11858b-c4df-424f-80eb-1e3c0377b269","name":"DPL Stream API - Locations","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.dplwireless.com/v1/data/locations/?lastseenid=0&limit=5","protocol":"https","host":["api","dplwireless","com"],"path":["v1","data","locations",""],"query":[{"key":"lastseenid","value":"0","description":"Filter for locationlogid (see bellow). The call will return rows with an locationlogid above this, ordered by locationlogid. The client application should remember the largest locationlogid stored in the client Database, and use this value when calling subsequent calls to this API function. \n"},{"key":"limit","value":"5","description":"This is the max number of rows returned (max 10000 * NOTE: Max is adjustable by DPL)."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 09 Apr 2021 14:37:58 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache/2.4.46 () OpenSSL/1.0.2k-fips mod_wsgi/3.4 Python/2.7.18 PHP/7.2.34 mod_jk/1.2.46"},{"key":"X-Powered-By","value":"Express"},{"key":"ETag","value":"W/\"4a2-IWuW1qKpCdXWRkAYqmZR5CfluRw\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"locationlogid\": \"59385714\",\n \"machineid\": 25513,\n \"serialnum\": 32545,\n \"id\": \"testing123456\",\n \"locationnum\": 0,\n \"datatag\": \"GPS\",\n \"eventtime\": \"2010-11-09 11:16:58\",\n \"reasoncode\": 8,\n \"longitude\": -86.189598,\n \"latitude\": 41.678001,\n \"direction\": \"0\",\n \"speed\": 0\n },\n {\n \"locationlogid\": \"59385715\",\n \"machineid\": 25513,\n \"serialnum\": 32545,\n \"id\": \"testing123456\",\n \"locationnum\": 0,\n \"datatag\": \"GPS\",\n \"eventtime\": \"2010-11-09 11:16:55\",\n \"reasoncode\": 2,\n \"longitude\": -86.189697,\n \"latitude\": 41.678001,\n \"direction\": \"0\",\n \"speed\": 0\n },\n {\n \"locationlogid\": \"59385813\",\n \"machineid\": 25513,\n \"serialnum\": 32545,\n \"id\": \"testing123456\",\n \"locationnum\": 0,\n \"datatag\": \"GPS\",\n \"eventtime\": \"2010-11-09 11:20:43\",\n \"reasoncode\": 3,\n \"longitude\": -86.189903,\n \"latitude\": 41.678501,\n \"direction\": \"0\",\n \"speed\": 0\n },\n {\n \"locationlogid\": \"59389874\",\n \"machineid\": 25513,\n \"serialnum\": 32545,\n \"id\": \"testing123456\",\n \"locationnum\": 0,\n \"datatag\": \"GPS\",\n \"eventtime\": \"2010-11-09 12:41:29\",\n \"reasoncode\": 8,\n \"longitude\": -86.189796,\n \"latitude\": 41.678398,\n \"direction\": \"0\",\n \"speed\": 0\n },\n {\n \"locationlogid\": \"59390128\",\n \"machineid\": 25513,\n \"serialnum\": 32545,\n \"id\": \"testing123456\",\n \"locationnum\": 0,\n \"datatag\": \"GPS\",\n \"eventtime\": \"2010-11-09 12:43:49\",\n \"reasoncode\": 2,\n \"longitude\": -86.189796,\n \"latitude\": 41.678299,\n \"direction\": \"0\",\n \"speed\": 0\n }\n]"}],"_postman_id":"83f8e161-faec-4e0e-a9e4-52b8ca54356e"}],"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"e29b9c92-db0d-42cd-86c0-b0ecba3ce3e3","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"58451661-4f87-4f15-80ec-386accd0f048","type":"text/javascript","exec":[""]}}]}