MaintenanceResponse Data Type

Response containing maintenance information

Properties
name data type constraints description
maintenance boolean required boolean True when the maintenance mode is active, false if not
banner boolean required 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" : "..."
  }
}