Status

GET /flats/status

Returns the current status of the flat taking process, Running or Finished.

Responses

200 application/json

Successful response
Hide response attributes Show response attributes object
- Response object
  
  Hide Response attributes Show Response attributes object
  
  CompletedIterations integer
  
  TotalIterations integer
  
  State string
  
  Values are Running or Finished.
- Error string
- 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 /flats/status

curl \
 --request GET 'http://localhost:1888/v2/api/flats/status'

Response examples (200)

{
  "Response": {
    "CompletedIterations": 10,
    "TotalIterations": 15,
    "State": "Running"
  },
  "Error": "string",
  "StatusCode": 200,
  "Success": true,
  "Type": "API"
}

Response examples (500)

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