set user settings

PUT

/partners/users/{user_email}/settings

Set any/all user settings. All parameters are optional

Request

Path Params

user_email

string

required

Body Params multipart/form-data

dashboard_data

string

required

optional, chart data

Example:

latitude

string

required

optional, coordinate

Example:

longitude

string

required

optional, coordinate

Example:

zoom_level

string

required

optional, zoom level to see the vehicles on the map once they login

Example:

time_zone

string

required

optional, UTC

Example:

inputsensor1_active

string

required

optional, bool

Example:

inputsensor1_name

string

required

optional

Example:

inputsensor1_description

string

required

optional, str

Example:

inputsensor2_active

string

required

optional, bool

Example:

inputsensor2_name

string

required

optional

Example:

inputsensor2_description

string

required

optional, str

Example:

inputsensor3_active

string

required

optional, bool

Example:

inputsensor3_name

string

required

optional

Example:

inputsensor3_description

string

required

optional, str

Example:

inputsensor4_active

string

required

optional, bool

Example:

inputsensor4_name

string

required

optional

Example:

inputsensor4_description

string

required

optional, str

Example:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://fleet.roscolive.com/api/v1.0/partners/users//settings' \
--form 'dashboard_data="{{dashboard_data}}"' \
--form 'latitude="{{latitude}}"' \
--form 'longitude="{{longitude}}"' \
--form 'zoom_level="{{zoom_level}}"' \
--form 'time_zone="{{time_zone}}"' \
--form 'inputsensor1_active="{{inputsensor1_active}}"' \
--form 'inputsensor1_name="{{inputsensor1_name}}"' \
--form 'inputsensor1_description="{{inputsensor1_description}}"' \
--form 'inputsensor2_active="{{inputsensor2_active}}"' \
--form 'inputsensor2_name="{{inputsensor2_name}}"' \
--form 'inputsensor2_description="{{inputsensor2_description}}"' \
--form 'inputsensor3_active="{{inputsensor3_active}}"' \
--form 'inputsensor3_name="{{inputsensor3_name}}"' \
--form 'inputsensor3_description="{{inputsensor3_description}}"' \
--form 'inputsensor4_active="{{inputsensor4_active}}"' \
--form 'inputsensor4_name="{{inputsensor4_name}}"' \
--form 'inputsensor4_description="{{inputsensor4_description}}"'

Responses

🟢200valid set user settings

application/json

Body

object {0}

Example

{
    "meta": {
        "code": 200
    },
    "response": {
        "settings": {
            "dashboard_data": "str",
            "dokuwiki_company_address": none,
            "dokuwiki_company_name": none,
            "inputsensor1_active": bool,
            "inputsensor1_description": "str",
            "inputsensor1_name": "str",
            "inputsensor2_active": bool,
            "inputsensor2_description": "str",
            "inputsensor2_name": "str",
            "inputsensor3_active": bool,
            "inputsensor3_description": "str",
            "inputsensor3_name": "str",
            "inputsensor4_active": bool,
            "inputsensor4_description": "str",
            "inputsensor4_name": "str",
            "latitude": int,
            "longitude": int,
            "time_zone": "str",
            "zoom_level": int
        }
    },
    "result": "OK"
}

🟠404set user settings with none existing user email

🟠401Login Required

Modified at 2024-07-25 02:00:14

get user settings

Get application notifications