Updated all markdowns

mappls-api · Jan 17, 2025 · dcfc56d · dcfc56d
1 parent 1379e76
commit dcfc56d
Show file tree

Hide file tree

Showing 23 changed files with 461 additions and 84 deletions.
diff --git a/Alarm Webhook Configuration API/README.md b/Alarm Webhook Configuration API/README.md
@@ -14,7 +14,7 @@ This API follows OAuth2 based security. To know more on how to create your autho
 
 The API leverages OAuth 2.0 based security. Hence, the developer would need to send a request for access token using their client_id and client_secret to the OAuth API. Once validated from the OAuth API, the access_token and the token_type need to be sent as Authorization header with the value: **`"{token_type} {access_token}”`.**
 
-- **Authorization: `"{token_type} {access_token}”.`**
+- **Authorization: `{token_type} {access_token}.`**
 
 ## **Input URL:**
 

diff --git a/Intouch Alarms APIs/Alarm Configuration API.md b/Intouch Alarms APIs/Alarm Configuration API.md
@@ -14,9 +14,9 @@ This API follows OAuth2 based security. To know more on how to create your autho
 
 The API leverages OAuth 2.0 based security. Hence, the developer would need to send a request for access token using their client_id and client_secret to the OAuth API. Once validated from the OAuth API, the access_token and the token_type need to be sent as Authorization header with the value: **`"{token_type} {access_token}”`.**
 
-- **Authorization: `"{token_type} {access_token}”.`**
+- **Authorization: `{token_type} {access_token}.`**
 
-- **Content-Type: `application/form-data`**
+- **Content-Type: `multipart/form-data`**
 
 ## **Input Method:** 
 - POST
@@ -90,7 +90,7 @@ The API leverages OAuth 2.0 based security. Hence, the developer would need to s
 ```bash
 curl --location 'https://intouch.mappls.com/apis/api/alarm/' \
 --header 'Authorization: Bearer 0XXXXXXf-dXX0-4XX0-8XXa-eXXXXXXXXXX6' \
---header 'Contant-type: application/form-data' \
+--header 'Contant-type: multipart/form-data' \
 --header 'Cookie: HttpOnly' \
 --form 'alarmType="28"' \
 --form 'entityIds="10647019"' \

diff --git a/Intouch Alarms APIs/Alarm Configuration Retrieval API.md b/Intouch Alarms APIs/Alarm Configuration Retrieval API.md
@@ -15,7 +15,7 @@ This API follows OAuth2 based security. To know more on how to create your autho
 
 The API leverages OAuth 2.0 based security. Hence, the developer would need to send a request for access token using their client_id and client_secret to the OAuth API. Once validated from the OAuth API, the access_token and the token_type need to be sent as Authorization header with the value: **`"{token_type} {access_token}”`.**
 
-- **Authorization: `"{token_type} {access_token}”.`**
+- **Authorization: `{token_type} {access_token}.`**
 
 - **Content-Type: `application/json`**
 
@@ -65,12 +65,8 @@ The API leverages OAuth 2.0 based security. Hence, the developer would need to s
 
 ## **Sample cURL Request**
 
-```bash
-curl --location 'https://intouch.mappls.com/iot/api/alarm?id=13400690&deviceId=10619089&alarmType=24' \
---header 'accept: application/json' \
---header 'Authorization: Bearer 0XXXXXXf-dXX0-4XX0-8XXa-eXXXXXXXXXX6' \
---header 'Content-Type: application/json' \
---header 'Cookie: HttpOnly'
+```
+https://intouch.mappls.com/iot/api/alarm?id=13431162&deviceId=10647019&alarmType=24
 ```
 
 ## **Sample Output**
@@ -79,14 +75,14 @@ curl --location 'https://intouch.mappls.com/iot/api/alarm?id=13400690&deviceId=1
 {
     "data": [
         {
-            "id": 13400690,
+            "id": 13431162,
             "deviceId": [
-                10619089
+                10647019
             ],
             "alarmType": 24,
-            "creationTime": 1735285180,
-            "updationTime": 1735285180,
-            "severity": 0
+            "creationTime": 1736140629,
+            "updationTime": 1736140629,
+            "webhookUrl": ""
         }
     ]
 }

diff --git a/Intouch Alarms APIs/Delete Configured Alarm API.md b/Intouch Alarms APIs/Delete Configured Alarm API.md
@@ -14,9 +14,9 @@ This API follows OAuth2 based security. To know more on how to create your autho
 
 The API leverages OAuth 2.0 based security. Hence, the developer would need to send a request for access token using their client_id and client_secret to the OAuth API. Once validated from the OAuth API, the access_token and the token_type need to be sent as Authorization header with the value: **`"{token_type} {access_token}”`.**
 
-- **Authorization: `"{token_type} {access_token}”.`**
+- **Authorization: `{token_type} {access_token}.`**
 
-- **Content-Type: `application/form-data`**
+- **Content-Type:** *`Optional, Not required for this API unless sending body data.`*
 
 ## **Input Method:** 
 - DELETE

diff --git a/Intouch Alarms APIs/Fetch Alarm Logs for Configured Alarms API.md b/Intouch Alarms APIs/Fetch Alarm Logs for Configured Alarms API.md
@@ -16,7 +16,7 @@ This API follows OAuth2 based security. To know more on how to create your autho
 
 The API leverages OAuth 2.0 based security. Hence, the developer would need to send a request for access token using their client_id and client_secret to the OAuth API. Once validated from the OAuth API, the access_token and the token_type need to be sent as Authorization header with the value: **`"{token_type} {access_token}”`.**
 
-- **Authorization: `"{token_type} {access_token}”.`**
+- **Authorization: `{token_type} {access_token}.`**
 - **Content-Type: `application/json`**
 
 

diff --git a/Intouch Alarms APIs/Update Alarm Configuration API.md b/Intouch Alarms APIs/Update Alarm Configuration API.md
@@ -14,7 +14,7 @@ This API follows OAuth2 based security. To know more on how to create your autho
 
 The API leverages OAuth 2.0 based security. Hence, the developer would need to send a request for access token using their client_id and client_secret to the OAuth API. Once validated from the OAuth API, the access_token and the token_type need to be sent as Authorization header with the value: **`"{token_type} {access_token}”`.**
 
-- **Authorization: `"{token_type} {access_token}”.`**
+- **Authorization: `{token_type} {access_token}.`**
 
 - **Content-Type: `application/form-data`**
 

diff --git a/Intouch Devices APIs/Get Device Live Data API.md b/Intouch Devices APIs/Get Device Live Data API.md
@@ -15,7 +15,7 @@ This API follows OAuth2 based security. To know more on how to create your autho
 
 The API leverages OAuth 2.0 based security. Hence, the developer would need to send a request for access token using their client_id and client_secret to the OAuth API. Once validated from the OAuth API, the access_token and the token_type need to be sent as Authorization header with the value: **`"{token_type} {access_token}”`.**
 
-- **Authorization: `"{token_type} {access_token}”.`**
+- **Authorization: `{token_type} {access_token}.`**
 - **Content-Type: `application/json`**
 
 

diff --git a/Intouch Devices APIs/Get Distance Traveled of the Device API.md b/Intouch Devices APIs/Get Distance Traveled of the Device API.md
@@ -14,7 +14,7 @@ This API follows OAuth2 based security. To know more on how to create your autho
 
 The API leverages OAuth 2.0 based security. Hence, the developer would need to send a request for access token using their client_id and client_secret to the OAuth API. Once validated from the OAuth API, the access_token and the token_type need to be sent as Authorization header with the value: **`"{token_type} {access_token}”`.**
 
-- **Authorization: `"{token_type} {access_token}”.`**
+- **Authorization: `{token_type} {access_token}.`**
 - **Content-Type: `application/json`**
 
 

diff --git a/Intouch Devices APIs/Nearby Device Locator API.md b/Intouch Devices APIs/Nearby Device Locator API.md
@@ -14,7 +14,7 @@ This API follows OAuth2 based security. To know more on how to create your autho
 
 The API leverages OAuth 2.0 based security. Hence, the developer would need to send a request for access token using their client_id and client_secret to the OAuth API. Once validated from the OAuth API, the access_token and the token_type need to be sent as Authorization header with the value: **`"{token_type} {access_token}”`.**
 
-- **Authorization: `"{token_type} {access_token}”.`**
+- **Authorization: `{token_type} {access_token}.`**
 - **Content-Type: `application/json`**
 
 

diff --git a/Intouch Devices APIs/Retrieve Basic Information of Device API.md b/Intouch Devices APIs/Retrieve Basic Information of Device API.md
@@ -15,7 +15,7 @@ This API follows OAuth2 based security. To know more on how to create your autho
 
 The API leverages OAuth 2.0 based security. Hence, the developer would need to send a request for access token using their client_id and client_secret to the OAuth API. Once validated from the OAuth API, the access_token and the token_type need to be sent as Authorization header with the value: **`"{token_type} {access_token}”`.**
 
-- **Authorization: `"{token_type} {access_token}”.`**
+- **Authorization: `{token_type} {access_token}.`**
 - **Content-Type: `application/json`**
 
 

diff --git a/Intouch Devices APIs/Retrieve Device Hardware Information API.md b/Intouch Devices APIs/Retrieve Device Hardware Information API.md
@@ -15,7 +15,7 @@ This API follows OAuth2 based security. To know more on how to create your autho
 
 The API leverages OAuth 2.0 based security. Hence, the developer would need to send a request for access token using their client_id and client_secret to the OAuth API. Once validated from the OAuth API, the access_token and the token_type need to be sent as Authorization header with the value: **`"{token_type} {access_token}”`.**
 
-- **Authorization: `"{token_type} {access_token}”.`**
+- **Authorization: `{token_type} {access_token}.`**
 - **Content-Type: `application/json`**
 
 

diff --git a/Intouch Drives APIs/Fetch Device Drive Details API.md b/Intouch Drives APIs/Fetch Device Drive Details API.md
@@ -14,7 +14,7 @@ This API follows OAuth2 based security. To know more on how to create your autho
 
 The API leverages OAuth 2.0 based security. Hence, the developer would need to send a request for access token using their client_id and client_secret to the OAuth API. Once validated from the OAuth API, the access_token and the token_type need to be sent as Authorization header with the value: **`"{token_type} {access_token}”`.**
 
-- **Authorization: `"{token_type} {access_token}”.`**
+- **Authorization: `{token_type} {access_token}.`**
 - **Content-Type: `application/json`**
 
 
@@ -82,7 +82,34 @@ https://intouch.mappls.com/iot/api/device/drive?deviceId=10807208&startTime=1736
 
 ```json
 {
-    "data": []
+    "data": [
+        {
+            "deviceId": 10807208,
+            "location": {
+                "startAddress": "Acharya Shree Tulsi Das Marg, Aravalli Biodiversity Park, Gurugram, Haryana. 2 m from Metro Pillar No 9, Pin-122002 (India)",
+                "endAddress": "Lado Sarai, New Delhi, Delhi. 248 m from Delhi Jal Board Government of NCT (India)",
+                "startTimestamp": 1736388443,
+                "endTimestamp": 1736389221,
+                "avgSpeed": 42.39,
+                "startLat": 28.4816017,
+                "startLon": 77.112845,
+                "endlat": 28.515034,
+                "endLon": 77.1923069
+            },
+            "movement": {
+                "duration": 778,
+                "distance": 12.71,
+                "idleTime": 130,
+                "movementTime": 466,
+                "stoppageTime": 182
+            },
+            "drivingBehaviourCount": {
+                "haCount": 0,
+                "hbCount": 0,
+                "hcCount": 0
+            }
+        }
+    ]
 }
 ```