lang | string Validation default: en | required |
user_api_hash | string Validation default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS | required |
Setup
GET
/edit_setup_data
Definition
Query String
Responses application/json
object | ||
item | object | optional |
id | integer | optional |
active | integer | optional |
group_id | integer | optional |
manager_id | null | optional |
billing_plan_id | null | optional |
map_id | integer | optional |
devices_limit | null | optional |
string | optional | |
password | string | optional |
subscription_expiration | string | optional |
loged_at | string | optional |
api_hash | string | optional |
available_maps | object | optional |
1 | integer | optional |
2 | integer | optional |
3 | integer | optional |
4 | integer | optional |
5 | integer | optional |
6 | integer | optional |
7 | integer | optional |
8 | integer | optional |
9 | integer | optional |
sms_gateway_app_date | string | optional |
sms_gateway_params | object | optional |
request_method | string | optional |
authentication | string | optional |
username | string | optional |
password | null | optional |
encoding | null | optional |
open_geofence_groups | string | optional |
open_device_groups | string | optional |
created_at | string | optional |
updated_at | string | optional |
unit_of_altitude | string | optional |
lang | string | optional |
unit_of_distance | string | optional |
unit_of_capacity | string | optional |
timezone_id | string | optional |
sms_gateway | string | optional |
sms_gateway_url | string | optional |
timezones | array[object] | optional |
id | integer | optional |
value | string | optional |
units_of_distance | array[object] | optional |
id | string | optional |
value | string | optional |
units_of_capacity | array[object] | optional |
id | string | optional |
value | string | optional |
units_of_altitude | array[object] | optional |
id | string | optional |
value | string | optional |
groups | array[object] | optional |
sms_queue_count | integer | optional |
request_method_select | array[object] | optional |
id | string | optional |
value | string | optional |
encoding_select | array[object] | optional |
id | integer string | optional |
value | string | optional |
authentication_select | array[object] | optional |
id | integer | optional |
value | string | optional |
dst_types | array[object] | optional |
id | string | optional |
value | string | optional |
user_dst | null | optional |
months | array[object] | optional |
id | string | optional |
value | string | optional |
weekdays | object | optional |
monday | string | optional |
tuesday | string | optional |
wednesday | string | optional |
thursday | string | optional |
friday | string | optional |
saturday | string | optional |
sunday | string | optional |
week_pos | object | optional |
first | string | optional |
last | string | optional |
dst_countries | array[object] | optional |
id | integer | optional |
value | string | optional |
status | integer | optional |
{ "item": { "id": 2, "active": 1, "group_id": 1, "manager_id": null, "billing_plan_id": null, "map_id": 1, "devices_limit": null, "email": "admin@yourdomain.com", "password": "***", "subscription_expiration": "0000-00-00 00:00:00", "loged_at": "2016-05-27 01:10:36", "api_hash": "***", "available_maps": { "1": 1, "2": 2, "3": 3, "4": 4, "5": 5, "6": 6, "7": 7, "8": 8, "9": 9 }, "sms_gateway_app_date": "0000-00-00 00:00:00", "sms_gateway_params": { "request_method": "get", "authentication": "0", "username": "", "password": null, "encoding": null }, "open_geofence_groups": "[\"0\"]", "open_device_groups": "[\"0\"]", "created_at": "2016-04-19 16:31:00", "updated_at": "2016-06-27 01:10:36", "unit_of_altitude": "mt", "lang": "en", "unit_of_distance": "km", "unit_of_capacity": "lt", "timezone_id": "65", "sms_gateway": "0", "sms_gateway_url": "" }, "timezones": [ { "id": 1, "value": "UTC -14:00" }, { "id": 2, "value": "UTC -13:45" }, { "id": 3, "value": "UTC -13:30" }, { "id": 4, "value": "UTC -13:15" }, { "id": 5, "value": "UTC -13:00" }, { "id": 6, "value": "UTC -12:45" } ], "units_of_distance": [ { "id": "km", "value": "Kilometer" }, { "id": "mi", "value": "Mile" } ], "units_of_capacity": [ { "id": "lt", "value": "Liter" }, { "id": "gl", "value": "Gallon" } ], "units_of_altitude": [ { "id": "mt", "value": "Meter" }, { "id": "ft", "value": "Feet" } ], "groups": [], "sms_queue_count": 0, "request_method_select": [ { "id": "get", "value": "GET" }, { "id": "post", "value": "POST" }, { "id": "app", "value": "SMS gateway app" } ], "encoding_select": [ { "id": 0, "value": "No" }, { "id": "json", "value": "JSON" } ], "authentication_select": [ { "id": 0, "value": "No" }, { "id": 1, "value": "Yes" } ], "dst_types": [ { "id": "none", "value": "None" }, { "id": "exact", "value": "Exact date" }, { "id": "automatic", "value": "Automatic" }, { "id": "other", "value": "Other" } ], "user_dst": null, "months": [ { "id": "january", "value": "January" }, { "id": "february", "value": "February" }, { "id": "march", "value": "March" }, { "id": "april", "value": "April" }, { "id": "may", "value": "May" }, { "id": "june", "value": "June" }, { "id": "july", "value": "July" }, { "id": "august", "value": "August" }, { "id": "september", "value": "September" }, { "id": "october", "value": "October" }, { "id": "november", "value": "November" }, { "id": "december", "value": "December" } ], "weekdays": { "monday": "Monday", "tuesday": "Tuesday", "wednesday": "Wednesday", "thursday": "Thursday", "friday": "friday", "saturday": "Saturday", "sunday": "Sunday" }, "week_pos": { "first": "First", "last": "Last" }, "dst_countries": [ { "id": 1, "value": "Akrotiri and Dhekelia(UK)" }, { "id": 2, "value": "Albania" }, { "id": 3, "value": "Andorra" }, { "id": 4, "value": "Australia" } ], "status": 1 }
object | ||
status | integer | optional |
errors | object | optional |
{ "status": 0, "errors": {} }
object | ||
status | integer | optional |
error | string | optional |
{ "status": 0, "error": "No language selected." }
POST
/edit_setup
Definition
Query String
lang | string Validation default: en | required |
user_api_hash | string Validation default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS | required |
Request Body application/json
object | ||
unit_of_distance | string | required |
unit_of_capacity | string | required |
unit_of_altitude | string | required |
timezone_id | integer | required |
groups | array[object] | required |
id | integer | optional |
title | string | optional |
sms_gateway | integer | required |
request_method | string | optional |
encoding | integer | optional |
authentication | integer | optional |
username | string | optional |
password | string | optional |
auth_id | string | optional |
auth_token | string | optional |
senders_phone | string | optional |
sms_gateway_url | string | optional |
week_start_day | integer | optional |
dst_type |
string
Validation
exact, other, automatic |
optional |
date_from |
string
Validation
format: date-time |
optional |
date_to |
string
Validation
format: date-time |
optional |
month_from | integer | optional |
month_to | integer | optional |
week_pos_from | integer | optional |
week_pos_to | integer | optional |
week_day_from | integer | optional |
week_day_to | integer | optional |
time_from |
string
Validation
format: time |
optional |
time_to |
string
Validation
format: time |
optional |
dst_country_id | integer | optional |
GET
/get_user_data
Definition
Query String
lang | string Validation default: en | required |
user_api_hash | string Validation default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS | required |
Responses application/json
object | ||
string | optional | |
expiration_date | null string | optional |
days_left | null integer | optional |
plan | string | optional |
devices_limit | integer | optional |
group_id | integer | optional |
{ "email": "admin@yourdomain.com", "expiration_date": null, "days_left": null, "plan": "Demo", "devices_limit": 0 }
object | ||
status | integer | optional |
errors | object | optional |
{ "status": 0, "errors": {} }
object | ||
status | integer | optional |
error | string | optional |
{ "status": 0, "error": "No language selected." }
POST
/change_password
Definition
Query String
lang | string Validation default: en | required |
user_api_hash | string Validation default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS | required |
Request Body
object | ||
password | string | optional |
MODEL
user