Information

GET /framing/info

Get framing assistant information

Responses

200 application/json

Successful response
Hide response attributes Show response attributes object
- Response object Required
  
  Hide Response attributes Show Response attributes object
  
  BoundHeight integer Required
  
  BoundWidth integer Required
  
  CameraHeight integer Required
  
  CameraWidth integer Required
  
  CameraPixelSize integer Required
  
  DecDegrees integer Required
  
  DecMinutes integer Required
  
  DecSeconds integer Required
  
  RAHours integer Required
  
  RAMinutes integer Required
  
  RASeconds integer Required
  
  FieldOfView integer Required
  
  FocalLength integer Required
  
  HorizontalPanels integer Required
  
  VerticalPanels integer Required
  
  Rectangle object Required
  
  Hide Rectangle attributes Show Rectangle attributes object
  
  OriginalX integer Required
  
  OriginalY integer Required
  
  Id integer Required
  
  DSOPositionAngle integer Required
  
  OriginalOffset integer Required
  
  RotationOffset integer Required
  
  Rotation integer Required
  
  TotalRotation integer Required
  
  X integer Required
  
  Y integer Required
  
  Width integer Required
  
  Height integer Required
- Error string Required
- StatusCode integer Required
- Success boolean Required
- Type string Required
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 /framing/info

curl \
 --request GET 'http://localhost:1888/v2/api/framing/info'

Response examples (200)

{
  "Response": {
    "BoundHeight": 42,
    "BoundWidth": 42,
    "CameraHeight": 42,
    "CameraWidth": 42,
    "CameraPixelSize": 42,
    "DecDegrees": 42,
    "DecMinutes": 42,
    "DecSeconds": 42,
    "RAHours": 42,
    "RAMinutes": 42,
    "RASeconds": 42,
    "FieldOfView": 42,
    "FocalLength": 42,
    "HorizontalPanels": 42,
    "VerticalPanels": 42,
    "Rectangle": {
      "OriginalX": 42,
      "OriginalY": 42,
      "Id": 42,
      "DSOPositionAngle": 42,
      "OriginalOffset": 42,
      "RotationOffset": 42,
      "Rotation": 42,
      "TotalRotation": 42,
      "X": 42,
      "Y": 42,
      "Width": 42,
      "Height": 42
    }
  },
  "Error": "string",
  "StatusCode": 42,
  "Success": true,
  "Type": "string"
}

Response examples (500)

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