EPP Client

Dit document bevat de meest relevante documentatie van de PHP EPP Client klassen.

 

EppClient

Methoden

string GetLastRequest()

De XML die het laatst naar de registry is verstuurd.

string GetLastResponse()

De XML die het laatst door de registry is ontvangen.

Greeting Connect(string $host, integer $port, boolean $useSsl, integer $timeOut = 5)

Maakt een verbinding met de registry.

• $host: De servernaam (e.g. “testdrs.domain-registry.nl”)
• $port: Het poortnummer (e.g. 700)
• $useSsl: Of SSL gebruikt moet worden (e.g. “true”)
• $timeOut: De maximale tijd dat op een antwoord gewacht moet worden. (e.g. “5”)

void Disconnect()

Verbreekt de verbinding met de registry.

Greeting Hello()

Stuurt een Hello bericht naar de registry.

EppResponse LogOn(string $userName, string $password, string $language = ‘en’, string $transaction = ”)

Logt in op de server van de registry.

• $userName: Gebruikersnaam (e.g. “301234”)
• $password: Wachtwoord (e.g. “geheim”)
• $language: De taal voor terugmeldingen (e.g. “nl”)
• $transaction: Het nummer van de transactie (e.g. “1234567890”)

EppResponse LogOff(string $transaction = ”)

Logt uit van de server van de registry

• $transaction: Het nummer van de transactie (e.g. “1234567890”)

function PollRequest(string $transaction = ”)

Kijkt of er nieuwe berichten in de wachtrij van de registry staan en haalt het eerste bericht op.

• $transaction: Het nummer van de transactie (e.g. “1234567890”)

function PollAcknowledge(string $messageId, string $transaction = ”)

Verwijdert een bericht uit de wachtrij van de registry.

• $messageId: Het identificatienummer van het bericht dat verwijderd moet worden.
• $transaction: Het nummer van de transactie (e.g. “1234567890”)

CheckResponse HostCheck(string[] $hosts, string $transaction = ”)

Controleert de beschikbaarheid van één of meerdere hosts.

• $hosts: De lijst met hosts om te controleren.
• $transaction: Het nummer van de transactie (e.g. “1234567890”)

HostInfoResponse HostInfo(string $host, string $transaction = ”)

Geeft informatie over de host.

• $host: De host om informatie over op te vragen.
• $transaction: Het nummer van de transactie (e.g. “1234567890”)

CreateResponse HostCreate(string $host, string[] $addresses, string $transaction = ”)

Maakt een nieuwe host aan.

• $host: de naam van de host.
• $addresses: een lijst van één of meer IPv4 en/of IPv6 adressen.
• $transaction: Het nummer van de transactie (e.g. “1234567890”)

EppResponse HostUpdate(string $host, string[] $addAddresses, string[] $removeAddresses, string $transaction = ”)

Past een bestaande host aan.

• $host: de naam van de host.
• $addAddresses: een lijst van nul of meer IPv4 en/of IPv6 adressen die moeten worden toegevoegd.
• $removeAddresses: een lijst van nul of meer IPv4 en/of IPv6 adressen die moeten worden verwijderd.
• $transaction: Het nummer van de transactie (e.g. “1234567890”)

Er moet tenmiste één adres worden verwijderd of toegevoegd.

EppResponse HostDelete(string $host, string $transaction = ”)

Verwijderd een host.

• $host: De host om informatie over op te vragen.
• $transaction: Het nummer van de transactie (e.g. “1234567890”)

CheckResponse ContactCheck(string[] $handles, string $transaction = ”)

Controleert de beschikbaarheid van één of meerdere contactpersonen.

• $handles: een lijst van één of meer handles om te controleren.
• $transaction: Het nummer van de transactie (e.g. “1234567890”)

ContactInfoResponse ContactInfo(string $handle, string $transaction = ”)

Vraagt de gegevens op van een contactpersoon.

• $handle: de handle van de contactpersoon
• $transaction: Het nummer van de transactie (e.g. “1234567890”)

CreateResponse ContactCreate(string $name, string $organization, string[] $addressLines, string $postalCode, string $city, string $countryCode, string $email, string $voiceNumber, string $faxNumber, string $legalForm, string $legalFormRegNo, string $transaction = ”)

Maakt een nieuwe contactpersoon aan.

• $name: De naam van de contactpersoon (e.g. “Jan de Vries”)
• $organization: De naam van de organisatie (kan leeg gelaten worden)
• $addressLines: Een lijst van 1, 2 of 3 adresregels. Tenminste één regel is verplicht.
• $postalCode: De postcode. Bij $countryCode = ‘NL’ moet deze de vorm ‘1234AB’ hebben, verplicht.
• $city: De stad, verplicht
• $countryCode: ISO Landcode in 2 letters. (e.g. ‘NL’), verplicht
• $email: E-Mail adres, verplicht
• $voiceNumber: Het e.164 telefoonnummer (e.g. +31.123456789), verplicht
• $faxNumber: Het e.164 faxnummer (mag leeg gelaten worden)
• $legalForm: De registratievorm (e.g ‘PERSOON’). Zie DRS handleiding voor geldige waarden.
• $legalFormRegNo: Het registratienummer (indien $legalForm <> ‘PERSOON’).
• $transaction: Het nummer van de transactie (e.g. “1234567890”)

EppResponse ContactUpdate(stirng $handle, string $name, string $organization, string[] $addressLines, string $postalCode, string $city, string $countryCode, string $email, string $voiceNumber, string $faxNumber, string $legalForm, string $legalFormRegNo, string $transaction = ”)

Past de gegevens van een contactpersoon aan. Indien de contactpersoon ook houder is van tenminste één domeinnaam kunnen identificerende velden (zoals naam, en legalform) niet aangepast worden.

• $handle: De handle van de contactpersoon die aangepast moet worden.
• $name: De naam van de contactpersoon (e.g. “Jan de Vries”)
• $organization: De naam van de organisatie (kan leeg gelaten worden)
• $addressLines: Een lijst van 1, 2 of 3 adresregels. Tenminste één regel is verplicht.
• $postalCode: De postcode. Bij $countryCode = ‘NL’ moet deze de vorm ‘1234AB’ hebben, verplicht.
• $city: De stad, verplicht
• $countryCode: ISO Landcode in 2 letters. (e.g. ‘NL’), verplicht
• $email: E-Mail adres, verplicht
• $voiceNumber: Het e.164 telefoonnummer (e.g. +31.123456789), verplicht
• $faxNumber: Het e.164 faxnummer (mag leeg gelaten worden)
• $legalForm: De registratievorm (e.g ‘PERSOON’). Zie DRS handleiding voor geldige waarden.
• $legalFormRegNo: Het registratienummer (indien $legalForm <> ‘PERSOON’).
• $transaction: Het nummer van de transactie (e.g. “1234567890”)

EppResponse ContactDelete(string $handle, string $transaction = ”)

Verwijderd een contactpersoon.

• $handle: De handle van de contactpersoon die aangepast moet worden.
• $transaction: Het nummer van de transactie (e.g. “1234567890”)

CheckResponse DomainCheck(string[] $domains, string $transaction = ”)

Controleert de beschikbaarheid van één of meerdere domeinen.

• $domains: Een lijst met tenminste één domeinnaam waarvan de beschikbaarheid gecontroleerd moet worden.
• $transaction: Het nummer van de transactie (e.g. “1234567890”)

DomainInfoResponse DomainInfo(string $domain, string $type = ‘all’, string $transaction = ”)

Geeft informatie over de domeinnaam.

• $domain: De domeinnaam.
• $type: Het type hosts wat terug moet worden gegeven. (standaard: ‘all’)
• $transaction: Het nummer van de transactie (e.g. “1234567890”)

CreateResponse DomainCreate(string $domain, string $registrant, string $adminc, string[] $techcs, string[] $nameServers, string $transaction = ”)

Registreert een nieuwe domeinnaam.

• $domain: De domeinnaam.
• $registrant: De handle van de eigenaar.
• $adminc: De handle van de administratief contactpersoon.
• $techcs: De handles van de technische contactpersonen (tenminste één).
• $nameServers: De nameservers van het domein.
• $transaction: Het nummer van de transactie (e.g. “1234567890”)

EppResponse DomainChangeRegistrant(string $domain, string $registrant, string $transaction = ”)

Wijzigt de eigenaar van een domeinnaam.

• $domain: De domeinnaam.
• $registrant: De handle van de eigenaar.
• $transaction: Het nummer van de transactie (e.g. “1234567890”)

EppResponse DomainRemoveNameServers(string $domain, string[] $nameServers, $transaction = ”)

Koppelt nameservers los van een domein.

• $domain: De domeinnaam.
• $nameServers: De namesevers die verwijderd moeten worden.
• $transaction: Het nummer van de transactie (e.g. “1234567890”)

EppResponse DomainAddNameServers(string $domain, string[] $nameServers, string $transaction = ”)

Koppelt extra nameservers aan een domein.

• $domain: De domeinnaam.
• $nameServers: De namesevers die verwijderd moeten worden.
• $transaction: Het nummer van de transactie (e.g. “1234567890”)

EppResponse DomainRemoveTechCs(string $domain, string[] $techcs, string $transaction = ”)

Ontkoppelt technische contactpersonen van een domein.

• $domain: De domeinnaam.
• $techcs: De handles van de technische contactpersonen (tenminste één).
• $transaction: Het nummer van de transactie (e.g. “1234567890”)

EppResponse DomainAddTechCs(string $domain, string[] $techcs, string $transaction = ”)

Koppelt technische contactpersonen aan een domein.

• $domain: De domeinnaam.
• $techcs: De handles van de technische contactpersonen (tenminste één).
• $transaction: Het nummer van de transactie (e.g. “1234567890”)

EppResponse DomainUpdate(string $domain, string $registrant, string $removeAdminc, string $addAdminc, string[] $addTechcs, string[] $removeTechcs, string[] $addNameservers, string[] $removeNameservers, string $transaction = ”)

Wijzigt de gegevens van een domeinnaam.

• $domain: De domeinnaam.
• $registrant: De handle van de eigenaar.
• $removeAdminc: De handle van de te verwijderen administratief contactpersoon.
• $addAdminc: De handle van de nieuwe administratief contactpersoon.
• $addTechcs: De handles van de technische contactpersonen die moeten worden gekoppeld.
• $removeTechcs: De handles van de technische contactpersonen die moeten worden ontkoppeld.
• $addNameServers: De namesevers die toegevoegd moeten worden.
• $removeNameServers: De namesevers die verwijderd moeten worden.
• $transaction: Het nummer van de transactie (e.g. “1234567890”)

U dient tenminste één item aan te passen. U kunt geen admin toevoegen zonder een admin te verwijderen.

EppResponse DomainDelete(string $domain, string $transaction = ”)

Heft een domeinnaam op.

• $domain: De domeinnaam.
• $transaction: Het nummer van de transactie (e.g. “1234567890”)

EppResponse DomainDeleteCancel(string $domain, string $transaction = ”)

Annuleert de opheffing van een domeinnaam.

• $domain: De domeinnaam.
• $transaction: Het nummer van de transactie (e.g. “1234567890”)

function DomainTransferRequest(string $domain, string $token, string $transaction = ”)

Dient een verhuisverzoek voor een domeinnaam in.

• $domain: De domeinnaam.
• $token: Het verhuistoken.
• $transaction: Het nummer van de transactie (e.g. “1234567890”)

function DomainTransferApprove(string $domain, string $transaction = ”)

Keurt een verhuisverzoek van een andere deelnemer goed.

• $domain: De domeinnaam.
• $transaction: Het nummer van de transactie (e.g. “1234567890”)

function DomainTransferCancel(string $domain, string $transaction = ”)

Annuleert een aangevraagde domeinverhuizing.

• $domain: De domeinnaam.
• $transaction: Het nummer van de transactie (e.g. “1234567890”)

function DomainTransferStatus(string $domain, string $transaction = ”)

Vraagt de status op van een aangevraagde domeinverhuizing.

• $domain: De domeinnaam.
• $transaction: Het nummer van de transactie (e.g. “1234567890”)

EppMessage

Velden

integer code;
string message;
string reason;
string language;

EppExtMessage

Velden

integer code;
string field;
string message;

EppResponse

Velden

EppMessage[] messages
string registryTransactionId
string clientTransactionId
boolean success
EppExtMessage[] extMessages

Contact

Velden

string handle
string type

Status

Velden

string value
string lang
string status

DomainInfoResponse extends EppResponse

Velden

string domainName
string repositoryObjectId
string managedBy
sting createdBy
date created
date transferDate
date lastChanged
string[] hosts
string registrant
string lastChangedBy
boolean limited
boolean optOut
string[] nameServers
string[] contacts
Status[] statusses
string token

Address

Velden

string countryCode
string city
string postalCode
string province
string[] street

PostalInfo

Velden

string name
string organization
Address address

ContactInfoResponse extends EppResponse

Velden

string managedBy
string createdBy
date created
string email
string handle
string repositoryObjectId
date lastChanged
string lastChangedBy
bool limited
string legalForm
string legalRegistrationNumber
string faxNumber
string phoneNumber
Status[] statusses
PostalInfo[] postalInfos

HostInfoResponse extends EppResponse

Velden

string[] addresses
string managedBy
string createdBy
date created
string name
string repositoryObjectId
date transferDate
date lastChanged
string lastChangedBy
Status[] statusses

DomainTransferRequestResponse extends EppResponse

Velden

date endDate
string donor
string name
date startDate
string recipient
Status status

CheckResponse extends EppResponse

Velden

protected $checkResults;

CreateResponse extends EppResponse

Velden

date created
string name

Statement

Velden

string[] purpose
stirng[] recipient
string retention

Greeting

Velden

string serverName
date serverDate
string[] versions
string[] languages
stirng[] nameSpaces
stirng[] extensionNamespaces
string[] accessType
string expiry;
Statement[] statements

PollResponse extends EppResponse

Velden

integer count
string id
date qDate;
EppMessage message
mixed pollData
stirng command

TransferResponse extends EppResponse

Velden

date exDate
date endDate
string donor
string name
date startDate
string recipient
string status
string token