XML element PutRunningStateResponse

Reference for RimuHosting's Data Structures (as used in our REST-ful APIs)

These data structures are used in our REST-ful APIs.
These data structures and their fields are in beta and subject to change. If you need to rely on them being stable, please contact RimuHosting so we can advise.

Name: PutRunningStateResponse

XML Example:

<PutRunningStateResponse>
  <error_info>IErrorInfo</error_info>
  zero or N[<extended_error_infos>IErrorInfo</extended_error_infos>]
  <host_server_info>HostServerInfo</host_server_info>
  <human_readable_message>xsd:string</human_readable_message>
  <is_pinging>xsd:boolean</is_pinging>
  <is_restarted>xsd:boolean</is_restarted>
  <redirect_uri>xsd:string</redirect_uri>
  <request>RunningStateChangeRequest</request>
  <response_display_duration_type>SHORT | REGULAR | PERMANENT</response_display_duration_type>
  <response_type>OK | ERROR</response_type>
  zero or N[<running_state_messages>xsd:string</running_state_messages>]
  <running_vps_info>RunningVPSInfo</running_vps_info>
  <status_code>xsd:int</status_code>
  <status_message>xsd:string</status_message>
</PutRunningStateResponse>

JSON Example:

{"PutRunningStateResponse":
 {
   "error_info": IErrorInfo,
   "extended_error_infos": [IErrorInfo],
   "host_server_info": HostServerInfo,
   "human_readable_message": String,
   "is_pinging": Boolean,
   "is_restarted": Boolean,
   "redirect_uri": String,
   "request": RunningStateChangeRequest,
   "response_display_duration_type": 'SHORT' | 'REGULAR' | 'PERMANENT',
   "response_type": 'OK' | 'ERROR',
   "running_state_messages": [String],
   "running_vps_info": RunningVPSInfo,
   "status_code": Number,
   "status_message": String,
 }
}

Elements
Name	Type	Required	Nillable	Description
error_info	IErrorInfo	false	false	If the response type is an error, then this can contain more information about the error.
extended_error_infos	zero or N[IErrorInfo]	false	false	e.g.
host_server_info	HostServerInfo	false	false
human_readable_message	xsd:string	false	false	A message summarizing the request result.
is_pinging	xsd:boolean	false	false
is_restarted	xsd:boolean	false	false
redirect_uri	xsd:string	false	false	A suggestion from the server about which URI to go to after this request.
request	RunningStateChangeRequest	false	false
response_display_duration_type	SHORT \| REGULAR \| PERMANENT	false	false	An indicator for a UI about how long to display a message.
response_type	OK \| ERROR	false	false	Whether the response is an AOK or error response.
running_state_messages	zero or N[xsd:string]	false	false
running_vps_info	RunningVPSInfo	false	false
status_code	xsd:int	false	false	May the status code be for ever 2xx.
status_message	xsd:string	false	false	The status message (should match the status code).