| Current Path : /var/www/html/inatote/api-rest/v1/docs/ |
| Current File : /var/www/html/inatote/api-rest/v1/docs/swagger07072020.json |
{
"openapi": "3.0.0",
"servers": [
{
"url": "https://app.voltswitchgps.com/rest/v1"
}
],
"paths": {
"/auth/token": {
"post": {
"tags": [
"Authentication"
],
"summary": "Get Token Using Api Email And Password",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"username": {
"type": "string"
},
"password": {
"type": "string"
}
},
"required": [
"username",
"password"
]
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/devices/getAll": {
"post": {
"tags": [
"Devices"
],
"summary": "Get All Devices (Max limit is 200)",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"token": {
"type": "string"
},
"start_limit": {
"type": "int"
}
},
"required": [
"token"
]
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/devices/getAllInactive/token": {
"get": {
"tags": [
"Devices"
],
"summary": "Get All Inactive Devices",
"parameters": [
{
"in": "query",
"name": "token",
"schema": {
"type": "string"
},
"required": true,
"description": "Token string from auth"
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/devices/getAllExpireToday/token": {
"get": {
"tags": [
"Devices"
],
"summary": "Get All Expired Devices (Today)",
"parameters": [
{
"in": "query",
"name": "token",
"schema": {
"type": "string"
},
"required": true,
"description": "Token string from auth"
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/devices/getAllNearExpire/token": {
"get": {
"tags": [
"Devices"
],
"summary": "Get All Expire in Month Devices",
"parameters": [
{
"in": "query",
"name": "token",
"schema": {
"type": "string"
},
"required": true,
"description": "Token string from auth"
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/devices/getAllExpired/token": {
"get": {
"tags": [
"Devices"
],
"summary": "Get All Expired Devices",
"parameters": [
{
"in": "query",
"name": "token",
"schema": {
"type": "string"
},
"required": true,
"description": "Token string from auth"
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/devices/details": {
"post": {
"tags": [
"Devices"
],
"summary": "Get Any Specific Device Details",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"token": {
"type": "string"
},
"imei": {
"type": "string"
}
},
"required": [
"token",
"imei"
]
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/devices/transferList/token": {
"get": {
"tags": [
"Devices"
],
"summary": "Get All Transfer Devices",
"parameters": [
{
"in": "query",
"name": "token",
"schema": {
"type": "string"
},
"required": true,
"description": "Token string from auth"
},
{
"in": "query",
"name": "from",
"schema": {
"type": "string"
},
"required": true,
"description": "Start Date (YYYY-MM-DD)"
},
{
"in": "query",
"name": "to",
"schema": {
"type": "string"
},
"required": true,
"description": "End Date (YYYY-MM-DD)"
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/devices/location": {
"post": {
"tags": [
"Devices"
],
"summary": "Get Any Specific Device Current Location",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"token": {
"type": "string"
},
"imei": {
"type": "string"
}
},
"required": [
"token",
"imei"
]
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/devices/search": {
"post": {
"tags": [
"Devices"
],
"summary": "Search Devices By Owner, Device, Imei or Vin",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"token": {
"type": "string"
},
"field": {
"enum": [
"imei",
"device_name",
"owner_name",
"vin"
]
},
"keyword": {
"type": "string"
}
},
"required": [
"token",
"field",
"keyword"
]
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/devices/history": {
"post": {
"tags": [
"Devices"
],
"summary": "Get Any Specific Device History (Only 7 days Date Difference Is Allowed)",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"token": {
"type": "string"
},
"imei": {
"type": "string"
},
"from": {
"format": "YYYY-MM-DD"
},
"to": {
"format": "YYYY-MM-DD"
}
},
"required": [
"token",
"imei",
"from",
"to"
]
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/devices/recovery": {
"post": {
"tags": [
"Devices"
],
"summary": "Set Any Specific Vehicle On Recovery!",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"token": {
"type": "string"
},
"imei": {
"type": "string"
},
"agent_email": {
"type": "string"
},
"expire_date": {
"type": "string"
}
},
"required": [
"token",
"imei",
"agent_email",
"expire_date"
]
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/devices/locationguide": {
"post": {
"tags": [
"Devices"
],
"summary": "Get Any Specific Device Location And Its Event",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"token": {
"type": "string"
},
"imei": {
"type": "string"
},
"from": {
"format": "YYYY-MM-DD"
},
"to": {
"format": "YYYY-MM-DD"
}
},
"required": [
"token",
"imei"
]
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/devices/locationguidehourly": {
"post": {
"tags": [
"Devices"
],
"summary": "Get Any Specific Device Location And Its Event By Hour",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"token": {
"type": "string"
},
"imei": {
"type": "string"
},
"from": {
"format": "YYYY-MM-DD"
},
"to": {
"format": "YYYY-MM-DD"
}
},
"required": [
"token",
"imei"
]
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/devices/locationguideweekly": {
"post": {
"tags": [
"Devices"
],
"summary": "Get Any Specific Device Location And Its Event Weekly",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"token": {
"type": "string"
},
"imei": {
"type": "string"
}
},
"required": [
"token",
"imei"
]
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/devices/locationguideweeklyhourly": {
"post": {
"tags": [
"Devices"
],
"summary": "Get Any Specific Device Location And Its Event Weekly Hour",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"token": {
"type": "string"
},
"imei": {
"type": "string"
}
},
"required": [
"token",
"imei"
]
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/devices/mileslog": {
"post": {
"tags": [
"Devices"
],
"summary": "Get Any Specific Device Miles Log",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"token": {
"type": "string"
},
"imei": {
"type": "string"
},
"from": {
"format": "YYYY-MM-DD"
},
"to": {
"format": "YYYY-MM-DD"
}
},
"required": [
"token",
"imei",
"from",
"to"
]
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/devices/milesloghourly": {
"post": {
"tags": [
"Devices"
],
"summary": "Get Any Specific Device Miles Log By Hour",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"token": {
"type": "string"
},
"imei": {
"type": "string"
},
"date": {
"type": "string"
}
},
"required": [
"token",
"imei",
"date"
]
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/devices/alertlog": {
"post": {
"tags": [
"Devices"
],
"summary": "Get Any Specific Device Alert Log",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"token": {
"type": "string"
},
"imei": {
"type": "string"
},
"from": {
"format": "YYYY-MM-DD"
},
"to": {
"format": "YYYY-MM-DD"
}
},
"required": [
"token",
"imei",
"from",
"to"
]
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/devices/stopengine": {
"post": {
"tags": [
"Devices"
],
"summary": "Stop Vehicle Engine",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"token": {
"type": "string"
},
"imei": {
"type": "string"
}
},
"required": [
"token",
"imei"
]
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/devices/startengine": {
"post": {
"tags": [
"Devices"
],
"summary": "Start Vehicle Engine",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"token": {
"type": "string"
},
"imei": {
"type": "string"
}
},
"required": [
"token",
"imei"
]
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/users/getAll": {
"post": {
"tags": [
"Users"
],
"summary": "Get All Users",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"token": {
"type": "string"
}
},
"required": [
"token"
]
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/users/details": {
"post": {
"tags": [
"Users"
],
"summary": "Get Any Specific User Details",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"token": {
"type": "string"
},
"userid": {
"type": "string"
}
},
"required": [
"token",
"userid"
]
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
}
}
}