GetContactsStatus
%Plugin_Name%_GetContactsStatus
Purpose
Use this function to get status of domain's contacts registration.
Input Parameters
Array of parameters defined during the plugin configuration (see _GetConfigArray):
tld
: a top-level domain name.sld
: a second-level domain name.contactdetails
: a contact information, which is array of the following elements:Registrant
Admin
Tech
Billing
First Name
Middle Name
Last Name
country
company
postcode
city
state
statename
address1
address2
Email
phonenumber
Fax
birthdate
phonenumberseparated
: an array containing the following data:countryCode
areaCode
number
ext
faxseparated
: an array containing the following data:countryCode
areaCode
number
ext
each of which is array of the following elements:
additionalfields
: supplementary data for further domain processing.
Return Parameters
-
completed
: possible values are:- '
true
': if the operation is completed successfully. -
'
false
': if the operation is in progress. If 'false
' is returned, the method must be called again, until either 'true
' is received or an error occurs. An error message must be returned using the following format:function %Plugin_Name%_GetContactsStatus($params) { return array('error' => 'Request failed'); }
- '
additionalfields
(optional): supplementary data for further domain processing.
Mandatory
No
Example
function Example_GetContactsStatus($params) { $sld = $params["sld"]; $tld = $params["tld"]; $registrant = $params["contactdetails"]["Registrant"]; $owner["first_name"] = $registrant["First Name"]; $owner["last_name"] = $registrant["Last Name"]; $owner["org_name"] = $registrant["company"]; $phone = $registrant["phonenumberseparated"]; $owner["phone"] = $phone["countryCode"].$phone["areaCode"].$phone["number"].$phone["ext"]; $fax = $registrant["faxseparated"]; $owner["fax"] = $fax["countryCode"].$fax["areaCode"].$fax["number"].$fax["ext"]; $owner["email"] = $registrant["Email"]; $owner["postal_code"] = $registrant["postcode"]; $owner["country"] = $registrant["country"]; $owner["state"] = $registrant["state"]; $owner["city"] = $registrant["city"]; $owner["address1"] = $registrant["address1"]; $owner["address2"] = $registrant["address2"]; // The same information for Technical, Billing and Admin contacts $billing = $params["contactdetails"]["Billing"]; $tech = $params["contactdetails"]["Tech"]; $admin = $params["contactdetails"]["Admin"]; $contactID = $params["additionalfields"]["RegistrantContactID"]; return array("completed" => true); }