Advanced API

Change Profile Value

GET /profile/change-value

Changes a value in the profile

Query parameters

  • settingpath string Required

    The path to the setting to change. (eg. CameraSettings-PixelSize). This refers the the profile structure like it is recieved when using /profile/show?active=true. Seperate each object with a dash (-)

  • newValue object Required

    The new value to set

Responses

  • 200 application/json

    Successful response

    Hide response attributes Show response attributes object
    • Response string
    • Error string
    • StatusCode integer
    • Success boolean
    • Type string
  • 400 application/json

    Invalid path / Invalid value

    Hide response attributes Show response attributes object
    • Response string
    • Error string

      Values are Invalid path or New value can't be null.

    • StatusCode integer
    • Success boolean
    • Type string
  • 500 application/json

    Internal server error, Unknown error

    Hide response attributes Show response attributes object
    • Response string
    • Error string
    • StatusCode integer
    • Success boolean
    • Type string
GET /profile/change-value 
curl \
 --request GET 'http://localhost:1888/v2/api/profile/change-value?settingpath=CameraSettings-PixelSize&newValue=3.2'
Response examples (200) 
{
  "Response": "Updated setting",
  "Error": "string",
  "StatusCode": 200,
  "Success": true,
  "Type": "API"
}
Response examples (400) 
{
  "Response": "string",
  "Error": "Invalid path",
  "StatusCode": 400,
  "Success": false,
  "Type": "API"
}
Response examples (500) 
{
  "Response": "string",
  "Error": "Unknown error",
  "StatusCode": 500,
  "Success": false,
  "Type": "API"
}