# Get settings

API call format

GET /images/settings              //Use token autorization
GET /images/private/settings      //Use Api Key

Description

Get settings

Precondition:

  • Authorization token/Api key is needed.

Postcondition

  • On success response code should be 200
  • On success settings details are returned (face detection analysis,celebrities analysis,text detection analysis etc.).
  • On failure an error will be returned with the right error code and description.

Example:

[Request] GET https://<base_api_url>/images/settings         
[Request] GET https://<base_api_url>/private/settings        
[Request Headers] {"Content-Type":"application/json","Accept":"application/json","Authorization":"<IdToken>"} //Use token autorization
[Request Headers] {"Content-Type":"application/json","Accept":"application/json","X-Api-Key":"<api_key>"}     //Use Api Key

[Response] 200
[Response Headers] {"Content-Type":["application/json"],"Content-Length":["..."],"Connection":["keep-alive"],"Date":["..... GMT"],"x-amzn-RequestId":["....."],....]}
[Response] 
{
  "status": true,
  "data": {
    "rekognition": {
      "faceDetection": true,        //Is face detection analysis active.
      "celebrities": true,          //Is celebrities analysis active.
      "text": true,                 //Is text detection analysis active.
      "isActive": true,             //Is machine learning analysis active.
      "labels": true,               //Is labels analysis active.
      "faceSearch": true            //Is face search analysis active.
    }
  }
}