XML element GetOrdersResponse

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: GetOrdersResponse

The orders matching the specified order filter.

XML Example:

<GetOrdersResponse>
  zero or N[<about_orders>AboutOrder</about_orders>]
  <error_info>IErrorInfo</error_info>
  zero or N[<extended_error_infos>IErrorInfo</extended_error_infos>]
  <human_readable_message>xsd:string</human_readable_message>
  <order_filter>OrderFilter</order_filter>
  <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>
</GetOrdersResponse>

JSON Example:

{"GetOrdersResponse":
 {
   "about_orders": [AboutOrder],
   "error_info": IErrorInfo,
   "extended_error_infos": [IErrorInfo],
   "human_readable_message": String,
   "order_filter": OrderFilter,
   "redirect_uri": String,
   "response_display_duration_type": 'SHORT' | 'REGULAR' | 'PERMANENT',
   "response_type": 'OK' | 'ERROR',
   "status_code": Number,
   "status_message": String,
 }
}

Elements
Name	Type	Required	Nillable	Description
about_orders	zero or N[AboutOrder]	false	false	An array of the orders. Can include dedicated servers as well as VPSs. So be sure to set the filter to just active VPSs if that is what you need.
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.
human_readable_message	xsd:string	false	false	A message summarizing the request result.
order_filter	OrderFilter	false	false	The filter that was applied to get the order list.
redirect_uri	xsd:string	false	false	A suggestion from the server about which URI to go to after this request.
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.
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).