MaintenanceResponse Data Type

Response containing maintenance information

Properties
name data type description
maintenance boolean True when the maintenance mode is active, false if not
banner boolean True when the maintenance message should be shown in the ui
message string Maintenance message
Properties inherited from GenericResponse
messages array of Message Messages contained in the response (which should be shown to the user)
responseInfo ResponseInfo

Example

{
  "maintenance" : true,
  "banner" : true,
  "message" : "...",
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}