Filter Information

GET /equipment/filterwheel/filter-info

Get Filterwheel Filter

Query parameters

filterId integer Required

The filter to get.

Responses

200 application/json

Successful response
Hide response attributes Show response attributes object
- Response object Required
  
  Hide Response attributes Show Response attributes object
  
  Name string Required
  
  FocusOffset integer Required
  
  Position integer Required
  
  AutoFocusExposureTime integer Required
  
  AutoFocusFilter boolean Required
  
  FlatWizardFilterSettings object Required
  
  Hide FlatWizardFilterSettings attributes Show FlatWizardFilterSettings attributes object
  
  FlatWizardMode integer Required
  
  HistogramMeanTarget number Required
  
  HistogramTolerance number Required
  
  MaxFlatExposureTime integer Required
  
  MinFlatExposureTime number Required
  
  MaxAbsoluteFlatDeviceBrightness integer Required
  
  MinAbsoluteFlatDeviceBrightness integer Required
  
  Gain integer Required
  
  Offset integer Required
  
  Binning object Required
  
  Hide Binning attributes Show Binning attributes object
  
  Name string Required
  
  X integer Required
  
  Y integer Required
  
  AutoFocusBinning object Required
  
  Hide AutoFocusBinning attributes Show AutoFocusBinning attributes object
  
  Name string Required
  
  X integer Required
  
  Y integer Required
  
  AutoFocusGain integer Required
  
  AutoFocusOffset integer Required
- Error string Required
- StatusCode integer Required
- Success boolean Required
- Type string Required
409 application/json

Error
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/filter-info

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

Response examples (200)

{
  "Response": {
    "Name": "string",
    "FocusOffset": 42,
    "Position": 42,
    "AutoFocusExposureTime": 42,
    "AutoFocusFilter": true,
    "FlatWizardFilterSettings": {
      "FlatWizardMode": 42,
      "HistogramMeanTarget": 42.0,
      "HistogramTolerance": 42.0,
      "MaxFlatExposureTime": 42,
      "MinFlatExposureTime": 42.0,
      "MaxAbsoluteFlatDeviceBrightness": 42,
      "MinAbsoluteFlatDeviceBrightness": 42,
      "Gain": 42,
      "Offset": 42,
      "Binning": {
        "Name": "string",
        "X": 42,
        "Y": 42
      }
    },
    "AutoFocusBinning": {
      "Name": "string",
      "X": 42,
      "Y": 42
    },
    "AutoFocusGain": 42,
    "AutoFocusOffset": 42
  },
  "Error": "string",
  "StatusCode": 42,
  "Success": true,
  "Type": "string"
}

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"
}