XML element PlanFilter

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

These are the field names you can use in the pricing plan url as matrix parameters to filter/restrict what plans are returned. e.g. to restrict the returned plans to just VPSs tack a ;server_type=VPS to the url.

XML Example:

<PlanFilter>
  <data_transfer_at_least_gb>xsd:int</data_transfer_at_least_gb>
  <dc_location>DCDALLAS | DCDALLAS2 | DCHOUSTON | DCATLANTA | DCLONDON | DCLONDON2 | DCSYDNEY | DCBRISBANE | DCNEWCASTLE | DCAUCKLAND | DCNY | DCNY2</dc_location>
  <just_current>xsd:boolean</just_current>
  <just_plans>xsd:string</just_plans>
  <mem_at_least>xsd:int</mem_at_least>
  <not_hidden_plans>xsd:boolean</not_hidden_plans>
  <not_third_party>xsd:boolean</not_third_party>
  <price>xsd:boolean</price>
  <price_over_usd>xsd:double</price_over_usd>
  <price_under_usd>xsd:double</price_under_usd>
  <server_type>PHYSICAL | VPS</server_type>
  <use_jboss>xsd:boolean</use_jboss>
  <use_liferay>xsd:boolean</use_liferay>
  <use_rails>xsd:boolean</use_rails>
  <use_spamassassin>xsd:boolean</use_spamassassin>
  <use_tomcat>xsd:boolean</use_tomcat>
  <vps_type>LOW_CONTENTION | REGULAR | DEDICATED</vps_type>
</PlanFilter>

JSON Example:

{"PlanFilter":
 {
   "data_transfer_at_least_gb": Number,
   "dc_location": 'DCDALLAS' | 'DCDALLAS2' | 'DCHOUSTON' | 'DCATLANTA' | 'DCLONDON' | 'DCLONDON2' | 'DCSYDNEY' | 'DCBRISBANE' | 'DCNEWCASTLE' | 'DCAUCKLAND' | 'DCNY' | 'DCNY2',
   "just_current": Boolean,
   "just_plans": String,
   "mem_at_least": Number,
   "not_hidden_plans": Boolean,
   "not_third_party": Boolean,
   "price": Boolean,
   "price_over_usd": Number,
   "price_under_usd": Number,
   "server_type": 'PHYSICAL' | 'VPS',
   "use_jboss": Boolean,
   "use_liferay": Boolean,
   "use_rails": Boolean,
   "use_spamassassin": Boolean,
   "use_tomcat": Boolean,
   "vps_type": 'LOW_CONTENTION' | 'REGULAR' | 'DEDICATED',
 }
}

Elements
Name	Type	Required	Nillable	Description
data_transfer_at_least_gb	xsd:int	false	false	Plan should support at least this size data transfer allowance.
dc_location	DCDALLAS \| DCDALLAS2 \| DCHOUSTON \| DCATLANTA \| DCLONDON \| DCLONDON2 \| DCSYDNEY \| DCBRISBANE \| DCNEWCASTLE \| DCAUCKLAND \| DCNY \| DCNY2	false	false
just_current	xsd:boolean	false	false
just_plans	xsd:string	false	false
mem_at_least	xsd:int	false	false
not_hidden_plans	xsd:boolean	false	false
not_third_party	xsd:boolean	false	false
price	xsd:boolean	false	false
price_over_usd	xsd:double	false	false
price_under_usd	xsd:double	false	false
server_type	PHYSICAL \| VPS	false	false
use_jboss	xsd:boolean	false	false
use_liferay	xsd:boolean	false	false
use_rails	xsd:boolean	false	false
use_spamassassin	xsd:boolean	false	false
use_tomcat	xsd:boolean	false	false
vps_type	LOW_CONTENTION \| REGULAR \| DEDICATED	false	false