Parallels H-Sphere Documentation Developer Guide

 

Additional Parameters for SignupUser Method of H-Sphere XML API Admin Services

 

Last modified: 28 Dec 2007

 

WARNING: This documentation covers Parallels H-Sphere versions up to 3.1. For the latest up-to-date Parallels H-Sphere documentation, please proceed to the official Parallels site.

These are additional parameters for signupUser method of H-Sphere XML API AdminServices class.

  1. Signup with a new domain being registered.
    OhterParams:
    • domain_name - full domain name
    • domain - domain name without extension
    • type_domain ="new_opensrs_domain"
    • ext - domain extension e.g. ".com"
    • _tld_ - domain TLD
    • _srs_owner_extra_tld_ - domain TLD
    • period - domain registration period, years
    • [-] Extra parameters
      1).us
      param1: name='_srs_owner_extra_app_purpose' description='Application purpose:' value = select from range: ('P1', 'P2', 'P3', 'P4', 'P5') name description 'P1' - Business use for profit 'P2' - Non-profit entity 'P3' - Personal Use 'P4' - Education purpose 'P5' - Government purposes action = register or transfer domain param2: name = '_srs_owner_extra_nexus_category' description='Nexus category' value = select from range: ('C11', 'C12', 'C21', 'C31', 'C32') name description 'C11' - A natural person who is a United States citizen 'C12' - A natural person who is a permanent resident of the United States of America or any of its possessions or territories 'C21' - U.S. organization incorporated within one of the 50 states of a U.S. territory 'C31' - Regularly engages in lawful activities (sales of good or services or other business, commercial or non-commercial, including not-for-profit relations in the United States). 'C32' - Entity has an office or other facility in the U.S. action = register or transfer domain param3: name = '_srs_owner_extra_nexus_validator' description='Nexus validator' tip = The nexus validator field is only required if category 'C31' or 'C32' is chosen. If so, the country of citizenship of the domain owner must be provided. value = 2 digit country code (get country list from ~cpanel/shiva/psoft/hsphere/country_info.xml) action = register or transfer domain
      2).kids.us
      param1: name='_srs_owner_extra_app_purpose' description='Application purpose:' value = select from range: ('P1', 'P2', 'P3', 'P4', 'P5') name description 'P1' - Business use for profit 'P2' - Non-profit entity 'P3' - Personal Use 'P4' - Education purpose 'P5' - Government purposes action = register or transfer domain param2: name = '_srs_owner_extra_nexus_category' description='Nexus category' value = select from range: ('C11', 'C12', 'C21', 'C31', 'C32') name description 'C11' - A natural person who is a United States citizen 'C12' - A natural person who is a permanent resident of the United States of America or any of its possessions or territories 'C21' - U.S. organization incorporated within one of the 50 states of a U.S. territory 'C31' - Regularly engages in lawful activities (sales of good or services or other business, commercial or non-commercial, including not-for-profit relations in the United States). 'C32' - Entity has an office or other facility in the U.S. action = domain register or transfer param3: name = '_srs_owner_extra_nexus_validator' description='Nexus validator' tip = The nexus validator field is only required if category 'C31' or 'C32' is chosen. If so, the country of citizenship of the domain owner must be provided. value = 2 digit country code (get country list from ~cpanel/shiva/psoft/hsphere/country_info.xml) action = register or transfer domain
      3).ca
      param1: name = '_srs_owner_extra_cira_registrant' description = Registrant of domain (individual or company's name) value = String action = domain register or transfer param2: name = '_srs_owner_extra_isa_trademark' description = Is the domain a trademark? value = YES/NO action = register or transfer domain param3: name = '_srs_owner_extra_legal_type' description = Legal type value = select from range: ('ABO', 'ASS', 'CCO', 'CCT', 'EDU', 'GOV', 'HOP', 'INB', 'LAM', 'LGR', 'MAJ', 'OMK', 'PLT', 'PRT', 'RES', 'TDM', 'TRD', 'TRS') name description 'ABO' = Aboriginal 'ASS' = Association 'CCO' = Canadian Corporation 'CCT' = Canadian Citizen 'EDU' = Educational Institution 'GOV' = Government 'HOP' = Hospital 'INB' = Indian Band 'LAM' = Library, Archive or Museum 'LGR' = Legal Representative 'MAJ' = Her Majesty the Queen 'OMK' = Protected by Trademarks Act 'PLT' = Political Party 'PRT' = Partnership 'RES' = Permanent Resident 'TDM' = Trademark Owner 'TRD' = Trade Union 'TRS' = Trust action = register or transfer domain param4: name = '_srs_owner_extra_lang_pref' description = Language preference value = select from range: ('EN', 'FR') name description 'EN' = English 'FR' = French action = register or transfer domain param5: name = '_srs_owner_extra_domain_description' description = Domain description value = String (Can be left blank) action = register or transfer domain
      4).de
      param1: name = '_srs_owner_extra_confirmaddress' description = I confirm that the contact information I have entered is in Germany. value = 'DE' or null action = domain register or transfer
      5) .org.uk, .co.uk
      param1: name = '_srs_owner_extra_uk_legal_type' description = Legal type of registrant contact value = select from range: (' LTD',' PLC','PTNR','STRA','SCH','RCHAR','GOV','CRC', 'STAT','OTHER','IND','FCORP') name description LTD = UK Limited Company PLC = UK Public Limited Company PTNR = UK Partnership STRA = UK Sole Trader SCH = UK School RCHAR = UK Registered Charity GOV = UK Government CRC = UK Corporation by Royal Charter STAT = UK Statutory Body OTHER = Other UK Organization IND = Individual (representing self) FCORP = non-UK Organization action = register or transfer domain param2: name = '_srs_owner_extra_uk_reg_co_no' description = Company identification number. Limited Company requires an entry in Company identification number Public Limited Company requires an entry in Company identification number LLP requires an entry in Company identification number action = register or transfer domain param3: name = '_srs_owner_extra_registered_for' description = Company or individual domain is registered on behalf of (this cannot be changed easily) action = register or transfer domain
      6) .au, .com.au, .net.au, .org.au, .asn.au
      param1: name = '_srs_owner_extra_info_type' description = Company or individual domain is registered on behalf of (this cannot be changed easily) Registrants of .au domains should provide either ABN (Australian Business Number), or ACN (Australian Company Number), or RBN (Registered Business Number) and Valid RBN State. value = select 1 value from range: ('ABN', 'ACN', 'RBN') name description ABN Australian Business Number (ABN) ACN Australian Company Number (ACN) RBN State where the RBN is registered action = register or transfer domain param2: a)name = '_srs_owner_extra_ABN' if info_type = 'ABN' description = Australian Business Number (ABN) value = 11 digits action = register or transfer domain b)name = '_srs_owner_extra_ACN' if info_type = 'ACN' description = Australian Company Number (ACN) value = 9 digits action = register or transfer domain c)name = '_srs_owner_extra_RBN' if info_type = 'RBN' description = Registered Business Number (RBN) value = String action = register or transfer domain additional parameter: name = '_srs_owner_extra_RBNState' if info_type = 'RBN' description = State where the RBN is registered value = short Austraian State name: name description ACT Australian Capital Territory NSW New South Wales NT Northern Territory QLD Queensland SA South Australia TAS Tasmania VIC Victoria WA Western Australia action = register or transfer domain For all 'domain transfer' operation: name = "_srs_owner_extra_epp_key" description = EPP Authorization Key value = String
  2. Signup with an existing domain.
    OtherParams:
    • domain_name - full domain name
    • type_domain ="transfer_new_misc_domain"
  3. Signup with a domain being transfered.
    OtherParams:
    • domain_name - full domain name
    • domain - domain name without extension
    • type_domain = domain_transfer
    • ext - domain extension e.g. ".com"
    • _tld_ - domain TLD
    • _srs_owner_extra_tld_ - domain TLD
    • Extra parameters (see above)
  4. Signup with a 3rd level domain being provided.
    OtherParams:
    • domain_name - full domain name
    • type_domain = "3ldomain"
  5. Signup for a dedicated server plan.
    OtherParams:
    • dst_id - dedicated server template id or "NONE"
  6. Signup for a 3rd level domain (mail based on the service domain).
    OtherParams:
    • domain_name - full domain name
    • type_domain = "3ldomain_mail_isp"
    • domain_type = service domain name
  7. Signup for a stopgap domain.
    OtherParams:
    • type_domain = "without_domain"
  8. Signup without domain.
    OtherParams:
    • type_domain = "empty_domain"


© Copyright 2018. Parallels Holdings. All rights reserved.