Class Transip_DomainService

This is the API endpoint for the DomainService

Package: Transip
Author: TransIP (support@transip.nl)
Class: DomainService
Located at DomainService.php

Methods summary
`public static SoapClient`	# `_getSoapClient( mixed $parameters = array() )` Gets the singleton SoapClient which is used to connect to the TransIP Api. Gets the singleton SoapClient which is used to connect to the TransIP Api. Parameters `$parameters` `mixed` $parameters Parameters. Returns `SoapClient` The SoapClient object to which we can connect to the TransIP API
`protected static string`	# `_sign( mixed $parameters )` Calculates the hash to sign our request with based on the given parameters. Calculates the hash to sign our request with based on the given parameters. Parameters `$parameters` `mixed` $parameters The parameters to sign. Returns `string` Base64 encoded signing hash.
`protected static string`	# `_sha512Asn1( string $data )` Creates a digest of the given data, with an asn1 header. Creates a digest of the given data, with an asn1 header. Parameters `$data` `string` $data The data to create a digest of. Returns `string` The digest of the data, with asn1 header.
`protected static string`	# `_encodeParameters( mixed $parameters, string $keyPrefix = null )` Encodes the given paramaters into a url encoded string based upon RFC 3986. Encodes the given paramaters into a url encoded string based upon RFC 3986. Parameters `$parameters` `mixed` $parameters The parameters to encode. `$keyPrefix` `string` $keyPrefix Key prefix. Returns `string` The given parameters encoded according to RFC 3986.
`protected static string`	# `_urlencode( string $string )` Our own function to encode a string according to RFC 3986 since. PHP < 5.3.0 encodes the ~ character which is not allowed. Our own function to encode a string according to RFC 3986 since. PHP < 5.3.0 encodes the ~ character which is not allowed. Parameters `$string` `string` $string The string to encode. Returns `string` The encoded string according to RFC 3986.
`public static Transip_DomainCheckResult[]`	# `batchCheckAvailability( string[] $domainNames )` Checks the availability of multiple domains. Checks the availability of multiple domains. Parameters `$domainNames` `string[]` $domainNames The domain names to check for availability. - A maximum of 20 domainNames at once can be checked. - domainNames must meet the requirements for a domain name described in: RFC 952 Returns `Transip_DomainCheckResult[]` A list of DomainCheckResult objects, holding the domainName and the status per result. Throws `ApiException` Example examples/DomainService-batchCheckAvailability.php
`public static string`	# `checkAvailability( string $domainName )` Checks the availability of a domain. Checks the availability of a domain. Parameters `$domainName` `string` $domainName The domain name to check for availability. - domainName must meet the requirements for a domain name described in: RFC 952 Returns `string` the availability status of the domain name: - free the domain is free for registration - notfree the domain is not free for new registration, but can possibly be transferred - inyouraccount the domain is already in your account - unavailable the domain is not available for registration Example examples/DomainService-checkAvailability.php
`public static string`	# `getWhois( string $domainName )` Gets the whois of a domain name Gets the whois of a domain name Parameters `$domainName` `string` $domainName the domain name to get the whois for - domainName must meet the requirements for a domain name described in: RFC 952 Returns `string` the whois data for the domain Throws `ApiException` Example examples/DomainService-getWhois.php
`public static string[]`	# `getDomainNames( )` Gets the names of all domains in your account. Gets the names of all domains in your account. Returns `string[]` A list of all domains in your account Example examples/DomainService-getDomainNames.php
`public static Transip_Domain`	# `getInfo( string $domainName )` Get information about a domainName. Get information about a domainName. Parameters `$domainName` `string` $domainName The domainName to get the information for. - domainName must meet the requirements for a domain name described in: RFC 952 Returns `Transip_Domain` A Domain object holding the data for the requested domainName. Throws `ApiException` If the Domain could not be found. Example examples/DomainService-DomainService-getInfo.php
`public static Transip_Domain[]`	# `batchGetInfo( string[] $domainNames )` Get information about a list of Domain names. Get information about a list of Domain names. Parameters `$domainNames` `string[]` $domainNames A list of Domain names you want information for. - domainNames must meet the requirements for a domain name described in: RFC 952 Returns `Transip_Domain[]` Domain objects. Throws `Exception` If something else went wrong.
`public static string[]`	# `getExtraContactFields( string $domainName )` Will get additional contact data fields for domain. Will get additional contact data fields for domain. COUNTRY_CODE: A 2 letter country from the ISO 3166-1 alpha-2 standard. PERSONAL_IDENTIFICATION_NUMBER: Your personal id number when registering as a natural person. Kvk when registering as a company. REGISTRANT_TYPE: Fill in whether you register the domain name as a person or as a company. VAT_NUMBER: A valid VAT number is required to register this domain. FIRST_NAME: Your full first name has to be provided here. LAST_NAME: Your full last name has to be provided here. BIRTH_DATE: You have to supply your birth date here. Please do so in the format ‘YYYY-MM-DD’. COMPANY_REGISTRATION_ID: Please provide the company registration id if the domain is being registered on behalf of or by a company. INTENDED_USE: You should provide a short explanation on what you are going to use this domain for. CODICE_FISCALE: A valid Codice Fiscale (16 characters) is required to register this domain. ADMIN_IDENTIFICATION_NUMBER: Provide the identifier for the adminstrative contact. For example a personal id. ADMIN_IDENTIFICATION_TYPE: Administrative contact Identification type OWNER_IDENTIFICATION_NUMBER: Provide the identifier for the holder. For example a personal id or AVT. OWNER_IDENTIFICATION_TYPE: Holder Identifier type OWNER_LEGAL_FORM: Select the legal form for the holder. TECH_IDENTIFICATION_NUMBER: Provide the identifier for the technical contact. For example a personal id. TECH_IDENTIFICATION_TYPE: Technical contact Identifier type OWNER_VAT_NUMBER: For the registration of this domain a valid VAT number of the registrant is required TECH_VAT_NUMBER: For the registration of this domain a valid VAT number of the technical contact is required COMMUNITY_ID: The community ID from the Sponsored Community is a unique code that consists of 16 characters. LEGAL_FORM_DUTCH: Choose legalform Tld specific cases .amsterdam Choose one of the following options for LEGAL_FORM_DUTCH: ANDERS, BGG, BRO, BV, BVI/O, COOP, CV, EENMANSZAAK, EESV, KERK, MAATSCHAP, NV, OWM, PERSOON, REDR, STICHTING, VERENIGING, VOF .es and .com.es For ADMIN_IDENTIFICATION_TYPE, OWNER_IDENTIFICATION_TYPE and TECH_IDENTIFICATION_TYPE use following values: For Non Spanish identification number use: 0 For Spanish identification number use: 1 For Spanish identification number for residents use: 3 .fr If registering as a person use: FIRST_NAME, LAST_NAME. If registering as a company use: FIRST_NAME, LAST_NAME, VAT_NUMBER, COUNTRY_CODE .it 1. Use only COUNTRY_CODE in NOT any of the following codes: AT, BE, CY, CZ, DE, DK, EE, ES, FI, FR, GB, GR, HU, IE, LT, LU, LV, MT, NL, PL, PT, SE, SI, SK, BG or RO 2. If COUNTRY_CODE is IT use: COUNTRY_CODE and CODICE_FISCALE 3. If REGISTRANT_TYPE is company and COUNTRY_CODE is any of the following: AT, BE, CY, CZ, DE, DK, EE, ES, FI, FR, GB, GR, HU, IE, LT, LU, LV, MT, NL, PL, PT, SE, SI, SK, BG or RO use: COUNTRY_CODE, REGISTRANT_TYPE and VAT_NUMBER 4. If REGISTRANT_TYPE is person and COUNTRY_CODE is any of the following: AT, BE, CY, CZ, DE, DK, EE, ES, FI, FR, GB, GR, HU, IE, LT, LU, LV, MT, NL, PL, PT, SE, SI, SK, BG or RO use: COUNTRY_CODE, REGISTRANT_TYPE and PERSONAL_IDENTIFICATION_NUMBER .nu 1. Use only PERSONAL_IDENTIFICATION_NUMBER when registrant is a person 2. If ordering as a company and VAT_COUNTRY_CODE is NOT: AT, BE, CY, CZ, DE, DK, EE, ES, FI, FR, GB, GR, HU, IE, IT, LT, LU, LV, MT, NL, PL, PT, SE, SI, SK, BG, RO use PERSONAL_IDENTIFICATION_NUMBER and VAT_COUNTRY_CODE 3. If ordering as a company and VAT_COUNTRY_CODE is one of the following: AT, BE, CY, CZ, DE, DK, EE, ES, FI, FR, GB, GR, HU, IE, IT, LT, LU, LV, MT, NL, PL, PT, SE, SI, SK, BG, RO use PERSONAL_IDENTIFICATION_NUMBER, VAT_COUNTRY_CODE and VAT_NUMBER .pm, .re, .tf, .wf and .yt 1. If registering as a person use: FIRST_NAME and LAST_NAME 2. If registering as a company use: VAT_NUMBER, VAT_COUNTRY_CODE, FIRST_NAME and LAST_NAME .se 1. If registering as a person use: PERSONAL_IDENTIFICATION_NUMBER 2. If registering as a company use: PERSONAL_IDENTIFICATION_NUMBER, VAT_COUNTRY_CODE and VAT_NUMBER Parameters `$domainName` `string` $domainName Returns `string[]` Example examples/DomainService-DomainService-getExtraContactFields.php
`public static string`	# `register( Transip_Domain $domain )` Registers a domain name, will automatically create and sign a proposition for it Registers a domain name, will automatically create and sign a proposition for it Parameters `$domain` `Transip_Domain` $domain The Domain object holding information about the domain that needs to be registered. Returns `string` proposition number Throws `UserException` Example examples/DomainService-DomainService-register-whois.php Requires readwrite mode
`public static string`	# `registerWithExtraContactFields( Transip_Domain $domain, Transip_ExtraContactField[] $extraContactFields )` Registers a domain name, will automatically create and sign a proposition for it Registers a domain name, will automatically create and sign a proposition for it Parameters `$domain` `Transip_Domain` $domain The Domain object holding information about the domain that needs to be registered. `$extraContactFields` `Transip_ExtraContactField[]` $extraContactFields The ExtraContactFields that are required for this domain. Returns `string` proposition number Throws `UserException` Example examples/DomainService-DomainService-register-whois.php Requires readwrite mode
`public static`	# `cancel( string $domainName, string $endTime )` Cancels a domain name, will automatically create and sign a cancellation document Please note that domains with webhosting cannot be cancelled through the API Cancels a domain name, will automatically create and sign a cancellation document Please note that domains with webhosting cannot be cancelled through the API Parameters `$domainName` `string` $domainName The domainname that needs to be cancelled. - domainName must meet the requirements for a domain name described in: RFC 952 `$endTime` `string` $endTime The time to cancel the domain (DomainService::CANCELLATIONTIME_END (end of contract) Throws `ApiException` Example examples/DomainService-DomainService-cancel.php Requires readwrite mode
`public static string`	# `transferWithOwnerChange( Transip_Domain $domain, string $authCode )` Transfers a domain without changing the owner Transfers a domain without changing the owner Parameters `$domain` `Transip_Domain` $domain the Domain object holding information about the domain that needs to be transfered `$authCode` `string` $authCode the authorization code for domains needing this for transfers (e.g. .com or .org transfers). Leave empty when n/a. Returns `string` proposition number Throws `UserException` Example examples/DomainService-DomainService-transfer.php Requires readwrite mode
`public static string`	# `transferWithOwnerChangeWithExtraContactFields( Transip_Domain $domain, string $authCode, string[] $extraContactFields )` Transfers a domain with changing the owner, not all TLDs support this (e.g. nl) Transfers a domain with changing the owner, not all TLDs support this (e.g. nl) Parameters `$domain` `Transip_Domain` $domain the Domain object holding information about the domain that needs to be transfered `$authCode` `string` $authCode the authorization code for domains needing this for transfers (e.g. .com or .org transfers). Leave empty when n/a. `$extraContactFields` `string[]` $extraContactFields The ExtraContactFields that are required for this domain. Returns `string` proposition number Throws `UserException` Example examples/DomainService-DomainService-transfer.php Requires readwrite mode
`public static string`	# `transferWithoutOwnerChange( Transip_Domain $domain, string $authCode )` Transfers a domain without changing the owner Transfers a domain without changing the owner Parameters `$domain` `Transip_Domain` $domain the Domain object holding information about the domain that needs to be transfered `$authCode` `string` $authCode the authorization code for domains needing this for transfers (e.g. .com or .org transfers). Leave empty when n/a. Returns `string` proposition number Throws `UserException` Example examples/DomainService-DomainService-transfer.php Requires readwrite mode
`public static string`	# `transferWithoutOwnerChangeWithExtraContactFields( Transip_Domain $domain, string $authCode, string[] $extraContactFields )` Transfers a domain without changing the owner Transfers a domain without changing the owner Parameters `$domain` `Transip_Domain` $domain the Domain object holding information about the domain that needs to be transfered `$authCode` `string` $authCode the authorization code for domains needing this for transfers (e.g. .com or .org transfers). Leave empty when n/a. `$extraContactFields` `string[]` $extraContactFields The ExtraContactFields that are required for this domain. Returns `string` proposition number Throws `UserException` Example examples/DomainService-DomainService-transfer.php Requires readwrite mode
`public static`	# `setNameservers( string $domainName, Transip_Nameserver[] $nameservers )` Starts a nameserver change for this domain, will replace all existing nameservers with the new nameservers Starts a nameserver change for this domain, will replace all existing nameservers with the new nameservers Parameters `$domainName` `string` $domainName the domainName to change the nameservers for domainName must meet the requirements for a domain name described in: RFC 952 `$nameservers` `Transip_Nameserver[]` $nameservers the list of new nameservers for this domain Example examples/DomainService-DomainService-setNameservers.php
`public static`	# `setLock( string $domainName )` Lock this domain in real time Lock this domain in real time Parameters `$domainName` `string` $domainName the domainName to set the lock for - domainName must meet the requirements for a domain name described in: RFC 952 Example examples/DomainService-DomainService-setLock.php
`public static`	# `unsetLock( string $domainName )` unlocks this domain in real time unlocks this domain in real time Parameters `$domainName` `string` $domainName the domainName to unlock - domainName must meet the requirements for a domain name described in: RFC 952 Example examples/DomainService-DomainService-setLock.php
`public static`	# `setOwner( string $domainName, Transip_WhoisContact $registrantWhoisContact )` Starts an owner change of a Domain, brings additional costs with the following TLDs: .be Starts an owner change of a Domain, brings additional costs with the following TLDs: .be Parameters `$domainName` `string` $domainName the domainName to change the owner for - domainName must meet the requirements for a domain name described in: RFC 952 `$registrantWhoisContact` `Transip_WhoisContact` $registrantWhoisContact the new contact data for this Throws `ApiException` Example examples/DomainService-DomainService-setOwner.php
`public static`	# `setContacts( string $domainName, Transip_WhoisContact[] $contacts )` Starts a contact change of a domain, this will replace all existing contacts Starts a contact change of a domain, this will replace all existing contacts Parameters `$domainName` `string` $domainName the domainName to change the contacts for - domainName must meet the requirements for a domain name described in: RFC 952 `$contacts` `Transip_WhoisContact[]` $contacts the list of new contacts for this domain Throws `ApiException` Example examples/DomainService-DomainService-setContacts.php
`public static Transip_Tld[]`	# `getAllTldInfos( )` Get TransIP supported TLDs Get TransIP supported TLDs Returns `Transip_Tld[]` Array of Tld objects Example examples/DomainService-DomainService-getAllTldInfos.php
`public static Transip_Tld`	# `getTldInfo( string $tldName )` Get info about a specific TLD Get info about a specific TLD Parameters `$tldName` `string` $tldName The tld to get information about. - tldName must meet the requirements for a domain name described in: RFC 952 Returns `Transip_Tld` Tld object with info about this Tld Throws `ApiException` If the TLD could not be found. Example examples/DomainService-DomainService-getAllTldInfos.php
`public static Transip_DomainAction`	# `getCurrentDomainAction( string $domainName )` Gets info about the action this domain is currently running Gets info about the action this domain is currently running Parameters `$domainName` `string` $domainName Name of the domain - domainName must meet the requirements specified in: RFC 952. Returns `Transip_DomainAction` if this domain is currently running an action, a corresponding DomainAction with info about the action will be returned. If there is no action running, null will be returned. Example examples/DomainService-DomainService-domainActions.php
`public static`	# `retryCurrentDomainActionWithNewData( Transip_Domain $domain )` Retries a failed domain action with new domain data. The Domain#name field must contain the name of the Domain, the nameserver, contacts, dnsEntries fields contain the new data for this domain. Set a field to null to not change the data. Retries a failed domain action with new domain data. The Domain#name field must contain the name of the Domain, the nameserver, contacts, dnsEntries fields contain the new data for this domain. Set a field to null to not change the data. Parameters `$domain` `Transip_Domain` $domain The domain with data to retry Throws `ApiException` Example examples/DomainService-DomainService-domainActions.php
`public static`	# `retryTransferWithDifferentAuthCode( Transip_Domain $domain, string $newAuthCode )` Retry a transfer action with a new authcode Retry a transfer action with a new authcode Parameters `$domain` `Transip_Domain` $domain The domain to try the transfer with a different authcode for `$newAuthCode` `string` $newAuthCode New authorization code to try Throws `ApiException` Example examples/DomainService-DomainService-domainActions.php
`public static`	# `cancelDomainAction( Transip_Domain $domain )` Cancels a failed domain action Cancels a failed domain action Parameters `$domain` `Transip_Domain` $domain the domain to cancel the action for Throws `ApiException` Example examples/DomainService-DomainService-domainActions.php
`public static string\|null`	# `requestAuthCode( string $domainName )` Request the authcode at the registry Request the authcode at the registry This function will request the authcode for domains at DNS.be and EURid from the registry Parameters `$domainName` `string` $domainName the domainNAme to request the autocode for - domainName must meet the requirements for a domain name described in: RFC 952 Returns `string\|null` the authentication code for the domain name (or null) Throws `ApiException`
`public static`	# `handover( string $domainName, string $targetAccountname )` Handover a Domain to another TransIP User. Please be aware that this will NOT change the owner contact information at the registry. If you want to change the domain owner at the registry, then you should execute a 'setOwner'. Handover a Domain to another TransIP User. Please be aware that this will NOT change the owner contact information at the registry. If you want to change the domain owner at the registry, then you should execute a 'setOwner'. Parameters `$domainName` `string` $domainName The domain name you want to hand over. `$targetAccountname` `string` $targetAccountname The target account name. Throws `ApiException` on error
`public static`	# `handoverWithAuthCode( string $domainName, string $authCode )` Handover a TransIP Domain to your account by using an auth code. Please be aware that this will NOT change the owner contact information at the registry. If you want to change the domain owner at the registry, then you should execute a 'setOwner'. Handover a TransIP Domain to your account by using an auth code. Please be aware that this will NOT change the owner contact information at the registry. If you want to change the domain owner at the registry, then you should execute a 'setOwner'. Parameters `$domainName` `string` $domainName The domain name you want to handover with an auth code. `$authCode` `string` $authCode The auth code to authorize the handover. Throws `ApiException`
`public static Transip_DnsEntry[]`	# `getDefaultDnsEntries( )` Get Default DNS Entries for a customer. Get Default DNS Entries for a customer. Returns `Transip_DnsEntry[]` A list of the default Dns Entries for the currently authenticated user Throws `ApiException` If there are not default values
`public static Transip_DnsEntry[]`	# `getDefaultDnsEntriesByDomainName( string $domainName )` Get Default DNS Entries for a specific domain Get Default DNS Entries for a specific domain Parameters `$domainName` `string` $domainName The domainName to get the information for. - domainName must meet the requirements for a domain name described in: RFC 952 Returns `Transip_DnsEntry[]` A list of the default DNS entries for this domain Throws `ApiException` If the domain could not be found.
`public static Transip_Nameserver[]`	# `getDefaultNameservers( )` Get Default Nameservers for a customer Get Default Nameservers for a customer Returns `Transip_Nameserver[]` A list of Nameservers for the currently authenticated API User Throws `ApiException`
`public static Transip_Nameserver[]`	# `getDefaultNameserversByDomainName( string $domainName )` Get the Default nameservers for the given domain. Get the Default nameservers for the given domain. Parameters `$domainName` `string` $domainName The domainName to get the information for. - domainName must meet the requirements for a domain name described in: RFC 952 Returns `Transip_Nameserver[]` A list of the default Nameservers for this domain Throws `ApiException` If the domain could not be found

Constants summary
`string`	`SERVICE`	`'DomainService'`	# The SOAP service that corresponds with this class. The SOAP service that corresponds with this class.
`string`	`API_VERSION`	`'5.23'`	# The API version. The API version.
`string`	`AVAILABILITY_INYOURACCOUNT`	`'inyouraccount'`	#
`string`	`AVAILABILITY_UNAVAILABLE`	`'unavailable'`	#
`string`	`AVAILABILITY_NOTFREE`	`'notfree'`	#
`string`	`AVAILABILITY_FREE`	`'free'`	#
`string`	`AVAILABILITY_INTERNALPULL`	`'internalpull'`	#
`string`	`CANCELLATIONTIME_END`	`'end'`	#
`string`	`CANCELLATIONTIME_IMMEDIATELY`	`'immediately'`	#
`string`	`ACTION_REGISTER`	`'register'`	#
`string`	`ACTION_TRANSFER`	`'transfer'`	#
`string`	`ACTION_INTERNALPULL`	`'internalpull'`	#
`string`	`TRACK_ENDPOINT_NAME`	`'Domain'`	#

Properties summary
`protected static SoapClient`	`$_soapClient`	`null`	# The SoapClient used to perform the SOAP calls. The SoapClient used to perform the SOAP calls.

Packages

Classes

Class Transip_DomainService

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Example

Parameters

Returns

Example

Parameters

Returns

Throws

Example

Returns

Example

Parameters

Returns

Throws

Example

Parameters

Returns

Throws

Parameters

Returns

Example

Parameters

Returns

Throws

Example

Requires

Parameters

Returns

Throws

Example

Requires

Parameters

Throws

Example

Requires

Parameters

Returns

Throws

Example

Requires

Parameters

Returns

Throws

Example

Requires

Parameters

Returns

Throws

Example

Requires

Parameters

Returns

Throws

Example

Requires

Parameters

Example

Parameters

Example

Parameters

Example

Parameters

Throws

Example

Parameters