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

Name: GetDistrosResponse

A list of the currently offered/available distros.

XML Example:
<GetDistrosResponse>
  zero or N[<distro_infos>DistroInfo</distro_infos>]
  <error_info>IErrorInfo</error_info>
  zero or N[<extended_error_infos>IErrorInfo</extended_error_infos>]
  <human_readable_message>xsd:string</human_readable_message>
  <redirect_uri>xsd:string</redirect_uri>
  <response_display_duration_type>SHORT | REGULAR | PERMANENT</response_display_duration_type>
  <response_type>OK | ERROR</response_type>
  <status_code>xsd:int</status_code>
  <status_message>xsd:string</status_message>
</GetDistrosResponse>
JSON Example:
{"GetDistrosResponse":
 {
   "distro_infos": [DistroInfo],
   "error_info": IErrorInfo,
   "extended_error_infos": [IErrorInfo],
   "human_readable_message": String,
   "redirect_uri": String,
   "response_display_duration_type": 'SHORT' | 'REGULAR' | 'PERMANENT',
   "response_type": 'OK' | 'ERROR',
   "status_code": Number,
   "status_message": String,
 }
}

Elements
NameTypeRequiredNillableDefault ValueDescription
distro_infoszero or N[DistroInfo]falsefalse 
error_infoIErrorInfofalsefalseIf the response type is an error, then this can contain more information about the error.
extended_error_infoszero or N[IErrorInfo]falsefalsee.g.
human_readable_messagexsd:stringfalsefalseA message summarizing the request result.
redirect_urixsd:stringfalsefalseA suggestion from the server about which URI to go to after this request.
response_display_duration_typeSHORT | REGULAR | PERMANENTfalsefalseAn indicator for a UI about how long to display a message.
response_typeOK | ERRORfalsefalseWhether the response is an AOK or error response.
status_codexsd:intfalsefalseMay the status code be for ever 2xx.
status_messagexsd:stringfalsefalseThe status message (should match the status code).