Jump to

• Request
• Response

Enable or disable retroactive blackouts

post

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/blackouts/enableRetroactiveBlackout

Enables or disables retroactive blackouts.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Flag to set RBK enabled/disabled

Show Source

• enableRBK: boolean
  Flag to set RBK enabled/disabled

  Example: false

{
    "x-em-sdk-level":"emSDK",
    "description":"Flag to set RBK enabled/disabled",
    "type":"object",
    "properties":{
        "enableRBK":{
            "type":"boolean",
            "description":"Flag to set RBK enabled/disabled",
            "example":false
        }
    }
}

Back to Top

Response

204 Response

RBK is enabled/disabled.

401 Response

client is not authenticated

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

500 Response

internal error serving the request

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

503 Response

indicates that a required service is not available.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

Back to Top