Change Filter | Advanced API documentation

Change Filter

GET /equipment/filterwheel/change-filter

Change Filter

Query parameters

filterId integer Required

The filter to change to.

Responses

200 application/json

Successful response
Hide response attributes Show response attributes object
- Response string
- Error string
- StatusCode integer
- Success boolean
- Type string
409 application/json

Filterwheel not connected / Filter not available
Hide response attributes Show response attributes object
- Response string
- Error string
  
  Values are Filterwheel not connected or Filter not available.
- 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 /equipment/filterwheel/change-filter

curl \
 --request GET 'http://localhost:1888/v2/api/equipment/filterwheel/change-filter?filterId=42'

Response examples (200)

{
  "Response": "Filter changed",
  "Error": "string",
  "StatusCode": 200,
  "Success": true,
  "Type": "API"
}

Response examples (409)

{
  "Response": "string",
  "Error": "Filterwheel not connected",
  "StatusCode": 409,
  "Success": false,
  "Type": "API"
}

Response examples (500)

{
  "Response": "string",
  "Error": "Unknown error",
  "StatusCode": 500,
  "Success": false,
  "Type": "API"
}