HSPC/API/Domain

check_domain_list

The function checks domains for availability.

Parameters:

hp_sid	Hosting plan series key.
action	An action to be performed over a domain: 'dns_hosting' - Subdomain either in provider's or in user's domain. Domain must present in Provider DNS already. 'domain_pointer' - Use domain, registered elsewhere, new in Provider DNS. It's equivalent to 'Use existing domain, registered elsewhere' field in store. 'register_new' - Register a new domain. 'reg_transfer' - Transfer a registered domain to Provider DNS. 'use_existing' - A domain is present in Provider DNS already, for example a user already has domain registration subscription. Now user wants, for example, to buy a plesk domain with the same domain name. The action corresponds to 'Use one of my domains' field in Store.
account_id	Optional parameter in all cases except for the action='use_existing': ID of an account a domain is to be registered for.
domain_list	List of domains to be checked.

Returns: {available_domain_list => [List of OK domains]}

SOAP Faults codes:

HPDomainOnly	Hosting plan series key passed to the function does not belong to domain registration hosting plan.
NoAccountIdSpecified	action='use_existing', but ID of account is not specified.

check_domain_name_syntax

The function checks domain name syntax.

Parameters:

domain

Domain name.

Returns: {result => 1 | 0}

SOAP Faults codes:

No specific codes.

get_domain_list

The function returns the list of domains a customer can use for subdomains creation.

Parameters:

account_id	ID of an account for which the information is returned.
for_trial	If this parameter is specified, then only those domains which allow creation of trial subscriptions are returned.

Returns: {domain_list => [List of domains for subdomain]}

SOAP Faults codes:

No specific codes.

validate_ns_list

The function checks validity of name servers list.

Parameters:

ns_list

LIst of name servers. Each list item consists of two elements:

Returns: {result => 1 } or Fault

SOAP Faults codes:

UserNoNS	Name server hostname is not specified.
UserNoIP	Name server IP address is not specified.
UserInvalidNSName	Name server hostname is invalid.
UserIPInvalid	Name server IP address is invalid.

save_contact

The function creates or saves changes to an existing domain contact.

Parameters (all optional except for account_id):

hp_sid	Hosting plan series key.
domain	A domain name.
action	An action performed over a domain: domain registration or transfer.
contact_type	Contact type (administrative, billing, technical, etc., depending on a plug-in). The plug-in specific contact types are also specified using this parameter.
account_id	Account numerical ID assigned in Parallels Business Automation - Standard database.
contact_id	Contact ID in database (used for contact editing only since when a new contact is created, no ID yet exists)
form_data	Domain contacts screen form data hash. In other words, the data to be filled into a domain contact dorm. If not provided, then a contact form is filled by data taken from account.

Returns: {contact_id => [new contact ID]} or Fault

SOAP Faults codes:

HPTypeInvalid	HP SID does not corresppond to a hosting plan type
DMContactError	Error saving contact data

validate_domain_data

The function validates data for a domain or domains list.

Parameters (all optional, but at least domain, action, contact_hash or domain_data_hash must be used):

hp_sid	Hosting plan series key.
domain	A domain name.
action	An action performed over a doman: domain registration or transfer.
contact_hash	Contact data hash (all contact data: administrative, billing, technical, other additional types of contact data, depending on a plug-in)
account_id	Account numerical ID assigned in HSPComplete database. Used only if no contacts found in database and domain contact data is to be taken from account profile.
form_data	A domain form data hash (extdata). In other words, any extended data besides the base contacts needed for a domain registration. If extended data is required, his hash is used to fill the extended data form.
domain_data_hash	This parameter allows validating a number of domains at once. The hash looks like: { domain_name => $h{domain}, contact_hash => $h{contact_hash}, action => $h{action}, }

Returns: {result => 1 } or Fault

SOAP Fault Codes:

UserDomainDataError

Invalid data in domain contacts or extdata.