XML element AboutOrder

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

Information about an order. Data from our database. Excludes live stats from the host server. Usable for VPSs or dedicated servers.

XML Example:

<AboutOrder>
  <allocated_ips>AllocatedIPs</allocated_ips>
  <billing_info>AboutBillingData</billing_info>
  <billing_oid>xsd:long</billing_oid>
  <data_transfer_allowance>DataTransferAllocationData</data_transfer_allowance>
  <distro>xsd:string</distro>
  <domain_name>xsd:string</domain_name>
  <host_server_oid>xsd:string</host_server_oid>
  <is_on_customers_own_physical_server>xsd:boolean</is_on_customers_own_physical_server>
  <location>DataLocationInfo</location>
  zero or N[<meta_data>KeyValueMetaData</meta_data>]
  <order_description>xsd:string</order_description>
  <order_oid>xsd:long</order_oid>
  <running_state>RUNNING | NOTRUNNING | RESTARTING | POWERCYCLING</running_state>
  <server_type>PHYSICAL | VPS</server_type>
  <slug>xsd:string</slug>
  <vps_parameters>RunningVPSData</vps_parameters>
</AboutOrder>

JSON Example:

{"AboutOrder":
 {
   "allocated_ips": AllocatedIPs,
   "billing_info": AboutBillingData,
   "billing_oid": Number,
   "data_transfer_allowance": DataTransferAllocationData,
   "distro": String,
   "domain_name": String,
   "host_server_oid": String,
   "is_on_customers_own_physical_server": Boolean,
   "location": DataLocationInfo,
   "meta_data": [KeyValueMetaData],
   "order_description": String,
   "order_oid": Number,
   "running_state": 'RUNNING' | 'NOTRUNNING' | 'RESTARTING' | 'POWERCYCLING',
   "server_type": 'PHYSICAL' | 'VPS',
   "slug": String,
   "vps_parameters": RunningVPSData,
 }
}

Elements
Name	Type	Required	Nillable	Description
allocated_ips	AllocatedIPs	false	false	The IPs allocated to this server.
billing_info	AboutBillingData	false	false	Information about the billing details on this server.
billing_oid	xsd:long	false	false	The identifier for the billing method used on this order. See also the billing methods resource.
data_transfer_allowance	DataTransferAllocationData	false	false	The data transfer allowance for this server.
distro	xsd:string	false	false	The distribution of Linux that is running on this server.
domain_name	xsd:string	false	false	The server domain name, a label. Typically on setup we would use this to set the server hostname. But this field records what is in our database, not what hostname ends up being used on the server.
host_server_oid	xsd:string	false	false	The id of the physical server (if this is a dedicated server) or if this is a VPS, the id of the physical server hosting the VPS.
is_on_customers_own_physical_server	xsd:boolean	false	false	true if a dedciated server, or if the server is a VPS on a customer's dedicated server.
location	DataLocationInfo	false	false	Information about where the server is located.
meta_data	zero or N[KeyValueMetaData]	false	false	Arbitrary name/value pairs assigned by the customer to this server.
order_description	xsd:string	false	false	A description of the server.
order_oid	xsd:long	false	false	An identifier for an order. It is immutable (won't change), even if, say you rename the server.
running_state	RUNNING \| NOTRUNNING \| RESTARTING \| POWERCYCLING	false	false	Whether the server is running or not. This state is set based on what cancellation dates and suspension dates in the database, only (not information coming off of, say, a VPS host server).
server_type	PHYSICAL \| VPS	false	false	Whether this is a VPS or a physical server.
slug	xsd:string	false	false	uri path segment to add to get a reference to the order.
vps_parameters	RunningVPSData	false	false	Some sizing attributes of the VPS. Specifically ones that currently require a server restart to change.