Klientská knihovna .NET
Popis tříd, metod a parametrů klienta ZMS.
Obsah:
-
Třída ZMSClient
-
Třída CAdmin
-
Třída CZRegistration
-
Třída CZContact
-
Třída CZNsSet
-
Třída CZKeySet
-
Třída CZDomain
- Výčet CAdminError
-
Třída CZError
-
Datové struktury
-
Soubory ke stažení
Třída ZMSClient
Níže uvedené API popisuje klientskou část klient-server aplikace, která zajišťuje, mimo jiné, registraci a správu domén .CZ. Veškerá komunikace probíhá výměnou zpráv mezi klientem a serverem přes TCP/IP protokol. Tato komunikace je v klientovi zapouzdřena a funkčnost je zajištěna voláním příslušných metod.
konstruktor ZMSClient()
Klienta ZMS vytvoříme jako instanci třídy ZMSClient.
ZMSClient zms = new ZMSClient("admin.czechia.com", true, false);
Konstruktor této třídy vyžaduje následující parametry:
- zmsRemoteHost (string) - adresa serveru, na kterém běží serverová část; doporučená hodnota: admin.czechia.com
- ssl (bool) - určuje zda bude komunikace probíhat přes zabezpečený kanál; doporučená hodnota: true
- test (bool) - určuje zda bude komunikace probíhat s testovacím serverem; při hodnotě true jsou zdrojem dat testovací databáze
metoda Connect()
Zavoláním metody se provede připojení klienta na server. Pokud se spojení nepodaří navázat, vyhodí metoda vyjímku.
zms.Connect();
metoda Disconnect()
Zavoláním metody se provede korektní ukončení spojení klienta se serverem.
zms.Disconnect();
Třída CAdmin
Serverová část vyžaduje pro přístup k jednotlivým funkcím identifikaci klienta a určitou úroveň oprávnění. Abyste mohli klienta skutečně používat, musíte nejdříve oprávnění získat. Pro získání oprávnění se obraťte na technickou podporu admin@zoner.cz.
metoda UserAuthenticate()
Zavoláním metody se provede identifikace klienta, a to přihlášením se na účet v Centru administrace. Úroveň oprávnění se následně zjistí z daného účtu.
V případě úspěchu metoda vrací hodnotu true.
Při neúspěchu vrací hodnotu false. Kód chyby lze získat z výstupního parametru error.
Metoda vyžaduje následující parametry:
- idUser (string) - přihlašovací jméno na účet v Centru administrace
- password (string) - heslo pro přihlášení na účet v Centru administrace
- lang (string) - volba jazykové verze (podporované hodnoty 'cs' (default), 'en')
- mid (uint) - vlastní identifikátor, unikátní pro každé volání metody
- error (out CAdminError) - výstupní parametr, který vrací kód chyby
zms.CAdmin.UserAuthenticate("CZ-xx", "password", "cs", 0, out error);
Třída CZRegistration
Tato třída obsahuje třídy pro práci s kontakty CZContact, se sadami jmenných serverů CZNsSet, se sadami klíčů CZKeySet a s doménami CZDomain a sdružuje je do logického celku, který zastřešuje operace nad databází CZ.NICu.
Třída CZContact
Třída CZContact obsahuje metody pro práci s kontakty.
metoda Create()
Tato metoda umožňuje vytvoření nového kontaktu v databázi CZ.NICu.
V případě úspěchu metoda vrací hodnotu true.
Při neúspěchu vrací hodnotu false. Podrobnosti o chybě lze získat z výstupního parametru error.
Metoda vyžaduje následující parametry:
- contact (ContactType) - údaje pro vytvoření kontaktu
- mid (uint) - vlastní identifikátor, unikátní pro každé volání metody
- error (out CZError) - výstupní parametr, který vrací podrobnosti o chybě
zms.CZRegistration.Contact.Create(contact, mid, out error);
metoda DeleteByPassword()
Tato metoda umožňuje smazání existujícího kontaktu z databáze CZ.NICu.
V případě úspěchu metoda vrací hodnotu true.
Při neúspěchu vrací hodnotu false. Podrobnosti o chybě lze získat z výstupního parametru error.
Metoda vyžaduje následující parametry:
- cId (string) - identifikátor kontaktu
- password (string) - heslo kontaktu
- mid (uint) - vlastní identifikátor, unikátní pro každé volání metody
- error (out CZError) - výstupní parametr, který vrací podrobnosti o chybě
zms.CZRegistration.Contact.DeleteByPassword(cId, password, mid, out error);
metoda Check()
Tato metoda umožňuje ověření dostupnosti identifikátoru kontaktu v databázi CZ.NICu.
V případě úspěchu metoda vrací hodnotu true.
Při neúspěchu vrací hodnotu false. Podrobnosti o chybě lze získat z výstupního parametru error.
Metoda vyžaduje následující parametry:
- cId (string) - identifikátor kontaktu
- check (out CheckType) - výstupní parametr, který vrací výsledek ověření dostupnosti
- mid (uint) - vlastní identifikátor, unikátní pro každé volání metody
- error (out CZError) - výstupní parametr, který vrací podrobnosti o chybě
zms.CZRegistration.Contact.Check(cId, out check, mid, out error);
metoda ListDomains()
Tato metoda umožňuje získat seznam doménových jmen, které používají daný identifikátor kontaktu v roli držitele domény nebo v roli administrativního kontaktu domény.
V případě úspěchu metoda vrací hodnotu true.
Při neúspěchu vrací hodnotu false. Podrobnosti o chybě lze získat z výstupního parametru error.
Metoda vyžaduje následující parametry:
- cId (string) - identifikátor kontaktu
- list (out string[]) - výstupní parametr, který obsahuje seznam doménových jmen
- mid (uint) - vlastní identifikátor, unikátní pro každé volání metody
- error (out CZError) - výstupní parametr, který vrací podrobnosti o chybě
zms.CZRegistration.Contact.ListDomains(cId, out list, mid, out error);
metoda ListKeySets()
Tato metoda umožňuje získat seznam identifikátorů sady klíčů, které používají daný identifikátor kontaktu.
V případě úspěchu metoda vrací hodnotu true.
Při neúspěchu vrací hodnotu false. Podrobnosti o chybě lze získat z výstupního parametru error.
Metoda vyžaduje následující parametry:
- cId (string) - identifikátor kontaktu
- list (out string[]) - výstupní parametr, který obsahuje seznam identifikátorů sady klíčů
- mid (uint) - vlastní identifikátor, unikátní pro každé volání metody
- error (out CZError) - výstupní parametr, který vrací podrobnosti o chybě
zms.CZRegistration.Contact.ListKeySets(cId, out list, mid, out error);
metoda ListNsSets()
Tato metoda umožňuje získat seznam identifikátorů sady jmenných serverů, které používají daný identifikátor kontaktu.
V případě úspěchu metoda vrací hodnotu true.
Při neúspěchu vrací hodnotu false. Podrobnosti o chybě lze získat z výstupního parametru error.
Metoda vyžaduje následující parametry:
- cId (string) - identifikátor kontaktu
- list (out string[]) - výstupní parametr, který obsahuje seznam identifikátorů sady jmenných serverů
- mid (uint) - vlastní identifikátor, unikátní pro každé volání metody
- error (out CZError) - výstupní parametr, který vrací podrobnosti o chybě
zms.CZRegistration.Contact.ListNsSets(cId, out list, mid, out error);
metoda Query()
Tato metoda umožňuje načtení údajů kontaktu z databáze CZ.NICu. Získané údaje lze snadno použít pro metodu UpdateByPassword(). Protože kontakt není autorizován, nevrací se skryté údaje.
V případě úspěchu metoda vrací hodnotu true.
Při neúspěchu vrací hodnotu false. Podrobnosti o chybě lze získat z výstupního parametru error.
Metoda vyžaduje následující parametry:
- cId (string) - identifikátor kontaktu
- contact (out ContactType) - načtené údaje kontaktu
- mid (uint) - vlastní identifikátor, unikátní pro každé volání metody
- error (out CZError) - výstupní parametr, který vrací podrobnosti o chybě
zms.CZRegistration.Contact.Query(cId, out contact, mid, out error);
metoda QueryByPassword()
Tato metoda umožňuje načtení údajů kontaktu z databáze CZ.NICu. Získané údaje lze snadno použít pro metodu UpdateByPassword(). Protože je kontakt autorizován, vrací se i skryté údaje.
V případě úspěchu metoda vrací hodnotu true.
Při neúspěchu vrací hodnotu false. Podrobnosti o chybě lze získat z výstupního parametru error.
Metoda vyžaduje následující parametry:
- cId (string) - identifikátor kontaktu
- password (string) - heslo kontaktu
- contact (out ContactType) - načtené údaje kontaktu
- mid (uint) - vlastní identifikátor, unikátní pro každé volání metody
- error (out CZError) - výstupní parametr, který vrací podrobnosti o chybě
zms.CZRegistration.Contact.QueryByPassword(cId, password, out contact, mid, out error);
metoda SendAuthInfo()
Tato metoda umožňuje požádat CZ.NIC o zaslání hesla pro převod kontaktu mezi registrátory.
V případě úspěchu metoda vrací hodnotu true.
Při neúspěchu vrací hodnotu false. Podrobnosti o chybě lze získat z výstupního parametru error.
Metoda vyžaduje následující parametry:
- cId (string) - identifikátor kontaktu
- mid (uint) - vlastní identifikátor, unikátní pro každé volání metody
- error (out CZError) - výstupní parametr, který vrací podrobnosti o chybě
zms.CZRegistration.Contact.SendAuthInfo(cId, mid, out error);
metoda SendPassword()
Tato metoda umožňuje zaslání hesla kontaktu. Heslo se používá pro autorizaci změn.
V případě úspěchu metoda vrací hodnotu true.
Při neúspěchu vrací hodnotu false. Podrobnosti o chybě lze získat z výstupního parametru error.
Metoda vyžaduje následující parametry:
- cId (string) - identifikátor kontaktu
- expireInDays (int) - počet dnů, po jejichž uplynutí platnost hesla vyprší
- mid (uint) - vlastní identifikátor, unikátní pro každé volání metody
- error (out CZError) - výstupní parametr, který vrací podrobnosti o chybě
zms.CZRegistration.Contact.SendPassword(cId, expireInDays, mid, out error);
metoda Transfer()
Tato metoda umožňuje převod kontaktu od jiného registrátora.
V případě úspěchu metoda vrací hodnotu true.
Při neúspěchu vrací hodnotu false. Podrobnosti o chybě lze získat z výstupního parametru error.
Metoda vyžaduje následující parametry:
- cId (string) - identifikátor kontaktu
- curAuthInfo (string) - heslo pro převod kontaktu mezi registrátory
- mid (uint) - vlastní identifikátor, unikátní pro každé volání metody
- error (out CZError) - výstupní parametr, který vrací podrobnosti o chybě
zms.CZRegistration.Contact.Transfer(cId, curAuthInfo, mid, out error);
metoda UpdateByPassword()
Tato metoda umožňuje zapsání změn existujícího kontaktu do databáze CZ.NICu.
V případě úspěchu metoda vrací hodnotu true.
Při neúspěchu vrací hodnotu false. Podrobnosti o chybě lze získat z výstupního parametru error.
Metoda vyžaduje následující parametry:
- contact (ContactType) - nové údaje kontaktu
- password (string) - heslo kontaktu
- mid (uint) - vlastní identifikátor, unikátní pro každé volání metody
- error (out CZError) - výstupní parametr, který vrací podrobnosti o chybě
zms.CZRegistration.Contact.UpdateByPassword(contact, password, mid, out error);
metoda Whois()
Tato metoda umožňuje načtení údajů kontaktu z databáze CZ.NICu.
V případě úspěchu metoda vrací hodnotu true.
Při neúspěchu vrací hodnotu false. Podrobnosti o chybě lze získat z výstupního parametru error.
Metoda vyžaduje následující parametry:
- cId (string) - identifikátor kontaktu
- info (out ContactWhoisType) - výstupní parametr, který vrací načtené údaje kontaktu
- mid (uint) - vlastní identifikátor, unikátní pro každé volání metody
- error (out CZError) - výstupní parametr, který vrací podrobnosti o chybě
zms.CZRegistration.Contact.Whois(cId, out info, mid, out error);
Třída CZNsSet
Třída CZNsSet obsahuje metody pro práci se sadami jmenných serverů.
metoda Create()
Tato metoda umožňuje vytvoření nové sady jmenných serverů v databázi CZ.NICu.
V případě úspěchu metoda vrací hodnotu true.
Při neúspěchu vrací hodnotu false. Podrobnosti o chybě lze získat z výstupního parametru error.
Metoda vyžaduje následující parametry:
- nsset (NsSetType) - údaje pro vytvoření sady jmenných serverů
- mid (uint) - vlastní identifikátor, unikátní pro každé volání metody
- error (out CZError) - výstupní parametr, který vrací podrobnosti o chybě
zms.CZRegistration.NsSet.Create(nsset, mid, out error);
metoda DeleteByPassword()
Tato metoda umožňuje smazání existující sady jmenných serverů z databáze CZ.NICu.
V případě úspěchu metoda vrací hodnotu true.
Při neúspěchu vrací hodnotu false. Podrobnosti o chybě lze získat z výstupního parametru error.
Metoda vyžaduje následující parametry:
- nId (string) - identifikátor sady jmenných serverů
- cId (string) - identifikátor kontaktu potvrzujícího smazání
- password (string) - heslo kontaktu
- mid (uint) - vlastní identifikátor, unikátní pro každé volání metody
- error (out CZError) - výstupní parametr, který vrací podrobnosti o chybě
zms.CZRegistration.NsSet.DeleteByPassword(nId, cId, password, mid, out error);
metoda Check()
Tato metoda umožňuje ověření dostupnosti identifikátoru sady jmenných serverů v databázi CZ.NICu.
V případě úspěchu metoda vrací hodnotu true.
Při neúspěchu vrací hodnotu false. Podrobnosti o chybě lze získat z výstupního parametru error.
Metoda vyžaduje následující parametry:
- nId (string) - identifikátor sady jmenných serverů
- check (out CheckType) - výstupní parametr, který vrací výsledek ověření dostupnosti
- mid (uint) - vlastní identifikátor, unikátní pro každé volání metody
- error (out CZError) - výstupní parametr, který vrací podrobnosti o chybě
zms.CZRegistration.NsSet.Check(nId, out check, mid, out error);
metoda ListDomains()
Tato metoda umožňuje získat seznam doménových jmen, které používají daný identifikátor sady jmenných serverů.
V případě úspěchu metoda vrací hodnotu true.
Při neúspěchu vrací hodnotu false. Podrobnosti o chybě lze získat z výstupního parametru error.
Metoda vyžaduje následující parametry:
- nId (string) - identifikátor sady jmenných serverů
- list (out string[]) - výstupní parametr, který obsahuje seznam doménových jmen
- mid (uint) - vlastní identifikátor, unikátní pro každé volání metody
- error (out CZError) - výstupní parametr, který vrací podrobnosti o chybě
zms.CZRegistration.NsSet.ListDomains(nId, out list, mid, out error);
metoda ListWithNameServer()
Tato metoda umožňuje získat seznam identifikátorů sady jmenných serverů, které používají daný jmenný server.
V případě úspěchu metoda vrací hodnotu true.
Při neúspěchu vrací hodnotu false. Podrobnosti o chybě lze získat z výstupního parametru error.
Metoda vyžaduje následující parametry:
- nName (string) - doménové jméno jmenného serveru
- list (out string[]) - výstupní parametr, který obsahuje seznam identifikátorů sady jmenných serverů
- mid (uint) - vlastní identifikátor, unikátní pro každé volání metody
- error (out CZError) - výstupní parametr, který vrací podrobnosti o chybě
zms.CZRegistration.NsSet.ListWithNameServer(nName, out list, mid, out error);
metoda SendAuthInfo()
Tato metoda umožňuje požádat CZ.NIC o zaslání hesla pro převod sady jmenných serverů mezi registrátory.
V případě úspěchu metoda vrací hodnotu true.
Při neúspěchu vrací hodnotu false. Podrobnosti o chybě lze získat z výstupního parametru error.
Metoda vyžaduje následující parametry:
- nId (string) - identifikátor sady jmenných serverů
- mid (uint) - vlastní identifikátor, unikátní pro každé volání metody
- error (out CZError) - výstupní parametr, který vrací podrobnosti o chybě
zms.CZRegistration.NsSet.SendAuthInfo(nId, mid, out error);
metoda Transfer()
Tato metoda umožňuje převod sady jmenných serverů od jiného registrátora.
V případě úspěchu metoda vrací hodnotu true.
Při neúspěchu vrací hodnotu false. Podrobnosti o chybě lze získat z výstupního parametru error.
Metoda vyžaduje následující parametry:
- nId (string) - identifikátor sady jmenných serverů
- curAuthInfo (string) - heslo pro převod sady jmenných serverů mezi registrátory
- mid (uint) - vlastní identifikátor, unikátní pro každé volání metody
- error (out CZError) - výstupní parametr, který vrací podrobnosti o chybě
zms.CZRegistration.NsSet.Transfer(nId, curAuthInfo, mid, out error);
metoda UpdateByPassword()
Tato metoda umožňuje zapsání změn existující sady jmenných serverů do databáze CZ.NICu.
V případě úspěchu metoda vrací hodnotu true.
Při neúspěchu vrací hodnotu false. Podrobnosti o chybě lze získat z výstupního parametru error.
Metoda vyžaduje následující parametry:
- nsset (NsSetType) - nové údaje sady jmenných serverů
- cId (string) - identifikátor kontaktu potvrzujícího změny
- password (string) - heslo kontaktu
- mid (uint) - vlastní identifikátor, unikátní pro každé volání metody
- error (out CZError) - výstupní parametr, který vrací podrobnosti o chybě
zms.CZRegistration.NsSet.UpdateByPassword(nsset, cId, password, mid, out error);
metoda Whois()
Tato metoda umožňuje načtení údajů sady jmenných serverů z databáze CZ.NICu.
V případě úspěchu metoda vrací hodnotu true.
Při neúspěchu vrací hodnotu false. Podrobnosti o chybě lze získat z výstupního parametru error.
Metoda vyžaduje následující parametry:
- nId (string) - identifikátor sady jmenných serverů
- info (out NsSetWhoisType) - výstupní parametr, který vrací načtené údaje sady jmenných serverů
- mid (uint) - vlastní identifikátor, unikátní pro každé volání metody
- error (out CZError) - výstupní parametr, který vrací podrobnosti o chybě
zms.CZRegistration.NsSet.Whois(nId, out info, mid, out error);
Třída CZKeySet
Třída CZKeySet obsahuje metody pro práci se sadami klíčů.
metoda Create()
Tato metoda umožňuje vytvoření nové sady klíčů v databázi CZ.NICu.
V případě úspěchu metoda vrací hodnotu true.
Při neúspěchu vrací hodnotu false. Podrobnosti o chybě lze získat z výstupního parametru error.
Metoda vyžaduje následující parametry:
- keyset (KeySetType) - údaje pro vytvoření sady klíčů
- mid (uint) - vlastní identifikátor, unikátní pro každé volání metody
- error (out CZError) - výstupní parametr, který vrací podrobnosti o chybě
zms.CZRegistration.KeySet.Create(keyset, mid, out error);
metoda DeleteByPassword()
Tato metoda umožňuje smazání existující sady klíčů z databáze CZ.NICu.
V případě úspěchu metoda vrací hodnotu true.
Při neúspěchu vrací hodnotu false. Podrobnosti o chybě lze získat z výstupního parametru error.
Metoda vyžaduje následující parametry:
- kId (string) - identifikátor sady klíčů
- cId (string) - identifikátor kontaktu potvrzujícího smazání
- password (string) - heslo kontaktu
- mid (uint) - vlastní identifikátor, unikátní pro každé volání metody
- error (out CZError) - výstupní parametr, který vrací podrobnosti o chybě
zms.CZRegistration.KeySet.DeleteByPassword(kId, cId, password, mid, out error);
metoda Check()
Tato metoda umožňuje ověření dostupnosti identifikátoru sady klíčů v databázi CZ.NICu.
V případě úspěchu metoda vrací hodnotu true.
Při neúspěchu vrací hodnotu false. Podrobnosti o chybě lze získat z výstupního parametru error.
Metoda vyžaduje následující parametry:
- kId (string) - identifikátor sady klíčů
- check (out CheckType) - výstupní parametr, který vrací výsledek ověření dostupnosti
- mid (uint) - vlastní identifikátor, unikátní pro každé volání metody
- error (out CZError) - výstupní parametr, který vrací podrobnosti o chybě
zms.CZRegistration.KeySet.Check(kId, out check, mid, out error);
metoda ListDomains()
Tato metoda umožňuje získat seznam doménových jmen, které používají daný identifikátor sady klíčů.
V případě úspěchu metoda vrací hodnotu true.
Při neúspěchu vrací hodnotu false. Podrobnosti o chybě lze získat z výstupního parametru error.
Metoda vyžaduje následující parametry:
- kId (string) - identifikátor sady klíčů
- list (out string[]) - výstupní parametr, který obsahuje seznam doménových jmen
- mid (uint) - vlastní identifikátor, unikátní pro každé volání metody
- error (out CZError) - výstupní parametr, který vrací podrobnosti o chybě
zms.CZRegistration.KeySet.ListDomains(kId, out list, mid, out error);
metoda SendAuthInfo()
Tato metoda umožňuje požádat CZ.NIC o zaslání hesla pro převod sady klíčů mezi registrátory.
V případě úspěchu metoda vrací hodnotu true.
Při neúspěchu vrací hodnotu false. Podrobnosti o chybě lze získat z výstupního parametru error.
Metoda vyžaduje následující parametry:
- kId (string) - identifikátor sady klíčů
- mid (uint) - vlastní identifikátor, unikátní pro každé volání metody
- error (out CZError) - výstupní parametr, který vrací podrobnosti o chybě
zms.CZRegistration.KeySet.SendAuthInfo(kId, mid, out error);
metoda Transfer()
Tato metoda umožňuje převod sady klíčů od jiného registrátora.
V případě úspěchu metoda vrací hodnotu true.
Při neúspěchu vrací hodnotu false. Podrobnosti o chybě lze získat z výstupního parametru error.
Metoda vyžaduje následující parametry:
- kId (string) - identifikátor sady klíčů
- curAuthInfo (string) - heslo pro převod sady klíčů mezi registrátory
- mid (uint) - vlastní identifikátor, unikátní pro každé volání metody
- error (out CZError) - výstupní parametr, který vrací podrobnosti o chybě
zms.CZRegistration.KeySet.Transfer(kId, curAuthInfo, mid, out error);
metoda UpdateByPassword()
Tato metoda umožňuje zapsání změn existující sady klíčů do databáze CZ.NICu.
V případě úspěchu metoda vrací hodnotu true.
Při neúspěchu vrací hodnotu false. Podrobnosti o chybě lze získat z výstupního parametru error.
Metoda vyžaduje následující parametry:
- keyset (KeySetType) - nové údaje sady klíčů
- cId (string) - identifikátor kontaktu potvrzujícího změny
- password (string) - heslo kontaktu
- mid (uint) - vlastní identifikátor, unikátní pro každé volání metody
- error (out CZError) - výstupní parametr, který vrací podrobnosti o chybě
zms.CZRegistration.KeySet.UpdateByPassword(keyset, cId, password, mid, out error);
metoda Whois()
Tato metoda umožňuje načtení údajů sady klíčů z databáze CZ.NICu.
V případě úspěchu metoda vrací hodnotu true.
Při neúspěchu vrací hodnotu false. Podrobnosti o chybě lze získat z výstupního parametru error.
Metoda vyžaduje následující parametry:
- kId (string) - identifikátor sady klíčů
- info (out KeySetWhoisType) - výstupní parametr, který vrací načtené údaje sady klíčů
- mid (uint) - vlastní identifikátor, unikátní pro každé volání metody
- error (out CZError) - výstupní parametr, který vrací podrobnosti o chybě
zms.CZRegistration.KeySet.Whois(kId, out info, mid, out error);
Třída CZDomain
Třída CZDomain obsahuje metody pro práci s doménovými jmény.
metoda CreateOrder()
Tato metoda umožňuje vložení objednávky na registraci nového doménového jména v databázi CZ.NICu. Registrace doménového jména neprobíhá online.
V případě úspěchu metoda vrací hodnotu true.
Při neúspěchu vrací hodnotu false. Podrobnosti o chybě lze získat z výstupního parametru error.
Metoda vyžaduje následující parametry:
- domain (DomainType) - údaje pro registraci nového doménového jména
- respondTo (string) - emailová adresa, na kterou bude zaslána informace o úspěšné registraci doménového jména
- requestId (string) - vlastní identifikátor, který bude obsažen v emailu zaslaném po úspěšné registraci doménového jména
- mid (uint) - vlastní identifikátor, unikátní pro každé volání metody
- error (out CZError) - výstupní parametr, který vrací podrobnosti o chybě
metoda DeleteByPassword()
Tato metoda umožňuje smazání existujícího doménového jména z databáze CZ.NICu.
V případě úspěchu metoda vrací hodnotu true.
Při neúspěchu vrací hodnotu false. Podrobnosti o chybě lze získat z výstupního parametru error.
Metoda vyžaduje následující parametry:
- domainName (string) - doménové jméno
- cId (string) - identifikátor kontaktu potvrzujícího smazání
- password (string) - heslo kontaktu
- mid (uint) - vlastní identifikátor, unikátní pro každé volání metody
- error (out CZError) - výstupní parametr, který vrací podrobnosti o chybě
zms.CZRegistration.Domain.DeleteByPassword(domainName, cId, password, mid, out error);
metoda Check()
Tato metoda umožňuje ověření dostupnosti doménového jména v databázi CZ.NICu.
V případě úspěchu metoda vrací hodnotu true.
Při neúspěchu vrací hodnotu false. Podrobnosti o chybě lze získat z výstupního parametru error.
Metoda vyžaduje následující parametry:
- domainName (string) - doménové jméno
- check (out CheckType) - výstupní parametr, který vrací výsledek ověření dostupnosti
- mid (uint) - vlastní identifikátor, unikátní pro každé volání metody
- error (out CZError) - výstupní parametr, který vrací podrobnosti o chybě
zms.CZRegistration.Domain.Check(domainName, out check, mid, out error);
metoda ListInvoiced()
Tato metoda umožňuje získat seznam doménových jmen, jejichž plátcem je daný uživatel.
V případě úspěchu metoda vrací hodnotu true.
Při neúspěchu vrací hodnotu false. Podrobnosti o chybě lze získat z výstupního parametru error.
Metoda vyžaduje následující parametry:
- list (out string[]) - výstupní parametr, který obsahuje seznam doménových jmen
- mid (uint) - vlastní identifikátor, unikátní pro každé volání metody
- error (out CZError) - výstupní parametr, který vrací podrobnosti o chybě
zms.CZRegistration.Domain.ListInvoiced(out list, mid, out error);
metoda ListToBeDeleted()
Tato metoda umožňuje získat seznam doménových jmen uvolňovaných k nové registraci.
V případě úspěchu metoda vrací hodnotu true.
Při neúspěchu vrací hodnotu false. Podrobnosti o chybě lze získat z výstupního parametru error.
Metoda vyžaduje následující parametry:
- list (out DomainSpecRegType[]) - výstupní parametr, který obsahuje seznam doménových jmen a datum jejich předpokládaného uvolnění
- mid (uint) - vlastní identifikátor, unikátní pro každé volání metody
- error (out CZError) - výstupní parametr, který vrací podrobnosti o chybě
zms.CZRegistration.Domain.ListToBeDeleted(out list, mid, out error);
metoda RenewOrder()
Tato metoda umožňuje vložení objednávky na prodloužení platnosti doménového jména v databázi CZ.NICu. Prodloužení platnosti doménového jména neprobíhá online.
V případě úspěchu metoda vrací hodnotu true.
Při neúspěchu vrací hodnotu false. Podrobnosti o chybě lze získat z výstupního parametru error.
Metoda vyžaduje následující parametry:
- domainName (string) - doménové jméno
- dPeriod (int) - počet let o kolik se má platnost prodloužit
- respondTo (string) - emailová adresa, na kterou bude zaslána informace o úspěšném prodloužení platnosti doménového jména
- requestId (string) - vlastní identifikátor, který bude obsažen v emailu zaslaném po úspěšném prodloužení platnosti doménového jména
- mid (uint) - vlastní identifikátor, unikátní pro každé volání metody
- error (out CZError) - výstupní parametr, který vrací podrobnosti o chybě
zms.CZRegistration.Domain.RenewOrder(domainName, dPeriod, respondTo, requestId, mid, out error);
metoda ReplaceNsSetByPassword()
Tato metoda umožňuje provedení hromadné změny identifikátoru sady jmenných serverů u všech doménových jmen s přiřazenou danou sadou jmenných serverů za jiný. Změnu není možné provést u těch doménových jmen, které nejsou registrátorem spravovány.
V případě úspěchu metoda vrací hodnotu true.
Při neúspěchu vrací hodnotu false. Podrobnosti o chybě lze získat z výstupního parametru error.
Metoda vyžaduje následující parametry:
- oldNsSet (string) - stávající identifikátor sady jmenných serverů
- newNsSet (string) - nový identifikátor sady jmenných serverů, který má být přiřazen
- cId (string) - identifikátor kontaktu potvrzujícího změny
- password (string) - heslo kontaktu
- changeList (out Dictionary<string, bool>) - výstupní parametr, který vrací seznam doménových jmen, u nichž měla být změna provedena a informaci o úspěchu provedení změny pro každé uvedené doménové jméno
- mid (uint) - vlastní identifikátor, unikátní pro každé volání metody
- error (out CZError) - výstupní parametr, který vrací podrobnosti o chybě
zms.CZRegistration.Domain.ReplaceNsSetByPassword(oldNsSet, newNsSet, cId, password, out changeList, mid, out error);
metoda SendAuthInfo()
Tato metoda umožňuje požádat CZ.NIC o zaslání hesla pro převod domény mezi registrátory.
V případě úspěchu metoda vrací hodnotu true.
Při neúspěchu vrací hodnotu false. Podrobnosti o chybě lze získat z výstupního parametru error.
Metoda vyžaduje následující parametry:
- domainName (string) - doménové jméno
- mid (uint) - vlastní identifikátor, unikátní pro každé volání metody
- error (out CZError) - výstupní parametr, který vrací podrobnosti o chybě
zms.CZRegistration.Domain.SendAuthInfo(domainName, mid, out error);
metoda Transfer()
Tato metoda umožňuje převod domény od jiného registrátora. Zároveň lze u domény změnit přiřazenou sadu jmenných serverů.
V případě úspěchu metoda vrací hodnotu true.
Při neúspěchu vrací hodnotu false. Podrobnosti o chybě lze získat z výstupního parametru error.
Metoda vyžaduje následující parametry:
- domainName (string) - doménové jméno
- nId (string) - identifikátor sady jmenných serverů, která má být nově přiřazena
- curAuthInfo (string) - heslo pro převod doménového jména mezi registrátory
- mid (uint) - vlastní identifikátor, unikátní pro každé volání metody
- error (out CZError) - výstupní parametr, který vrací podrobnosti o chybě
zms.CZRegistration.Domain.Transfer(domainName, nId, curAuthInfo, mid, out error);
metoda UpdateByPassword()
Tato metoda umožňuje zapsání změn existující domény do databáze CZ.NICu.
V případě úspěchu metoda vrací hodnotu true.
Při neúspěchu vrací hodnotu false. Podrobnosti o chybě lze získat z výstupního parametru error.
Metoda vyžaduje následující parametry:
- domain (DomainType) - nové údaje pro doménu
- cId (string) - identifikátor kontaktu potvrzujícího změny
- password (string) - heslo kontaktu
- mid (uint) - vlastní identifikátor, unikátní pro každé volání metody
- error (out CZError) - výstupní parametr, který vrací podrobnosti o chybě
zms.CZRegistration.Domain.UpdateByPassword(domain, cId, password, mid, out error);
metoda Whois()
Tato metoda umožňuje načtení údajů domény z databáze CZ.NICu.
V případě úspěchu metoda vrací hodnotu true.
Při neúspěchu vrací hodnotu false. Podrobnosti o chybě lze získat z výstupního parametru error.
Metoda vyžaduje následující parametry:
- domainName (string) - doménové jméno
- info (out DomainWhoisType) - výstupní parametr, který vrací načtené údaje domény
- mid (uint) - vlastní identifikátor, unikátní pro každé volání metody
- error (out CZError) - výstupní parametr, který vrací podrobnosti o chybě
zms.CZRegistration.Domain.Whois(domainName, out info, mid, out error);
Výčet CAdminError
Obsahuje seznam chyb, které se mohou vyskytnout při volání některé metody třídy CAdmin.
Tyto hodnoty jsou:
- NoError - žádná chyba nenastala
- UnknownError - nastala blíže nespecifikovaná chyba
- UserAlreadyAuthenticated - uživatel je již přihlášen
- BadCredentials - špatné přihlašovací údaje
Třída CZError
Jsou z ní odvozeny třídy, které popisují podrobnosti o konkrétním typu chyby, která se může vyskytnout při volání některé metody tříd CZContact, CZNsSet a CZDomain.
vlastnost ErrorType
Tato vlastnost obsahuje typ chybového objektu a je určena výčtovým typem CZErrorType s následujícími hodnotami:
- NoError - žádná chyba
- SyntaxError - syntaktická chyba
- SqlError - chyba na Sql serveru
- CzNicError - chyba na CZ.NICu
- CzNicException - vyjímka při volání CZ.NICu
- RuntimeError - chyba zpracování žádosti
- UnknownError - blíže nespecifikovaná chyba
- AccessDenied - odepřen přístup
Třída CZNoError
Vyjadřuje stav, kdy nenastala žádná chyba. Třída je odvozena ze třídy CZError.
vlastnost ErrorType
Vrací hodnotu CZErrorType.NoError.
Třída CZSyntaxError
Informuje o syntaktické chybě. Třída je odvozena ze třídy CZError.
vlastnost ErrorType
Vrací hodnotu CZErrorType.SyntaxError.
vlastnost ParamName
Obsahuje název parametru, jehož hodnota způsobila syntaktickou chybu.
vlastnost ErrorValue
Obsahuje chybnou hodnotu.
vlastnost Number
Obsahuje číslo chyby.
vlastnost Description
Obsahuje textové vyjádření čísla chyby.
Přehled možných syntaktických chyb ve formátu Description (Number) - popis chyby:
CannotErase (1) - hodnota nemůže být NULL
CannotBeEmpty (2) - hodnota nemůže být prázdná
Reserved (3) - vyhrazeno pro budoucí účely
InvalidValue (4) - neplatná hodnota
LengthMustBe0To16 (5) - není dodržena povolená délka 0 až 16 znaků
LengthMustBe0To17 (6) - není dodržena povolená délka 0 až 17 znaků
LengthMustBe0To20 (7) - není dodržena povolená délka 0 až 20 znaků
LengthMustBe0To32 (8) - není dodržena povolená délka 0 až 32 znaků
LengthMustBe0To255 (9) - není dodržena povolená délka 0 až 255 znaků
LengthMustBe0To300 (10) - není dodržena povolená délka 0 až 300 znaků
LengthMustBe1To66 (11) - není dodržena povolená délka 1 až 66 znaků
LenghtMustBe1To255 (12) - není dodržena povolená délka 1 až 255 znaků
LengthMustBe2 (13) - není dodržena povolená délka 2 znaky
LengthMustBe3To45 (14) - není dodržena povolená délka 3 až 45 znaků
LengthMustBe3To63 (15) - není dodržena povolená délka 3 až 63 znaků
LengthMustBe4To255 (16) - není dodržena povolená délka 4 až 255 znaků
MustBeCountryCode (17) - hodnotou musí být ISO kód země
MustBeDefined (18) - hodnota není definována
MustBeEmail (19) - hodnota nemá formát emailové adresy
MustBeNameServerFQDN (20) - hodnota nemá formát plně kvalifikovaného doménového jména pro jmenné servery
MustBeIPAddress (21) - hodnota nemá formát IP adresy
MustBeLowerCase (22) - hodnota není uvedena malými písmeny
MustBeNormalizedString (23) - hodnota nemá formát normalizovaného řetězce
MustBeNotDefined (24) - hodnota nesmí být definována
MustBeNumbersOrLettersOrUnderlineOrHyphenOrColonOrDot (25) - hodnota může obsahovat pouze číslice, písmena a znaky podtržítko (_), pomlčka (-), dvojtečka (:), tečka (.)
MustBeTelephoneNumberFormat (26) - hodnota nemá formát telefonního čísla
MustBeToken (27) - hodnota nemá formát tokenu
MustBeTypeDateTime (28) - hodnota nemá formát datumu
MustBeTypeInt (29) - hodnota nemá formát čísla
MustBeUpperCase (30) - hodnota není uvedena velkými písmeny
MustBeValidDomainNameCz (31) - hodnota nemá formát platného doménového jména .cz
ValueMustBe0To10 (32) - hodnotou může být číslo 0 až 10
ValueMustBe1To10 (33) - hodnotou může být číslo 1 až 10
ValueMustBe1To365 (34) - hodnotou může být číslo 1 až 365
MustBeHexBinary (35) - hodnotou může být řetězec znaků pro hexadecimalní zápis binarní hodnoty
ValueMustBe0AndGreater (36) - hodnotou může být celé kladné číslo
Třída CZSqlError
Informuje o chybě SQL serveru. Třída je odvozena ze třídy CZError.
vlastnost ErrorType
Vrací hodnotu CZErrorType.SqlError.
vlastnost Detail
Obsahuje informace o chybě.
Třída CZNicError
Informuje o chybě, která vznikla na straně serveru CZ.NIC. Třída je odvozena ze třídy CZError.
vlastnost ErrorType
Vrací hodnotu CZErrorType.CzNicError.
vlastnost Code
Obsahuje číslo chyby.
vlastnost Message
Obsahuje text chybové zprávy.
vlastnost ObjectId
Obsahuje identifikátor objektu, ve kterém chyba nastala.
Třída CZNicException
Informuje o vyjímce, která vznikla během komunikace se serverem CZ.NIC. Třída je odvozena ze třídy CZError.
vlastnost ErrorType
Vrací hodnotu CZErrorType.CzNicException.
vlastnost Description
Obsahuje text chybové zprávy.
Třída CZRuntimeError
Informuje o chybě, která se vyskytla při zpracování požadavku na serveru. Může se jednat rovněž i o kontextovou chybu v hodnotě parametru, kdy hodnota parametru je syntakticky v pořádku, ale v daném kontextu není správná. Třída je odvozena ze třídy CZError.
vlastnost ErrorType
Vrací hodnotu CZErrorType.RuntimeError.
vlastnost ErrorValue
Obsahuje chybnou hodnotu.
vlastnost Number
Obsahuje číslo chyby.
vlastnost Description
Obsahuje textové vyjádření čísla chyby.
Přehled možných kontextových chyb ve formátu Description (Number) - popis chyby:
AlreadyCurrentRegistrar (1) - u daného objektu je registrátor již určeným registrátorem
AuthInfoNotMatching (2) - heslo pro převod mezi registrátory není správné
AuthIdNotAcquired (3) - nepodařilo se ověřit práva pro autorizaci změn
ContactMustBeDomainOwner (4) - kontakt musí být v roli držitele domény
ContactMustBeTech (5) - kontakt musí být v roli technického kontaktu
InvalidAuthorization (6) - neplatná autorizace
InvalidAuthorizationMethod (7) - neplatná metoda autorizace
InvalidContactEmail (8) - neplatný email kontaktu
NotAvailable (9) - identifikátor objektu není volný
NotCurrentRegistrar (10) - registrátor není určeným registrátorem
MaxLimitForAuthPwdCreationExceeded (11) - byl překročen maximální limit počtu nově vytvořených hesel kontaktu
MaxLimitOfUnexpiredAuthPwdsReached (12) - byl překročen maximální limit počtu momentálně platných hesel kontaktu
UnableToSaveAuthPwd (13) - heslo kontaktu se nepodařilo uložit do databáze
UnableToSendEmail (14) - nepodařilo se odeslat email s heslem kontaktu
MustBeAlreadyRegistred (15) - objekt musí být již registrován
AddingOrderFailed (16) - objednávku se nepodařilo zapsat do databáze
UnableToReadMsgTemplate (17) - nepodařilo se načíst šablonu zprávy
AdminIdMustBeDefined (18) - nebyl definován identifikátor potvrzení administrátorem
ContactIsAlreadyDomainOwner (19) - kontakt se již nachází v roli držitele domény
ContactMustBeDomainOwnerOrAdmin (20) - kontakt musí být v roli držitele domény nebo administrativního kontaktu domény
NsSetIsAlreadyDomainNsSet (21) - sada jmenných serverů je již přiřazena k dané doméně
ContactIsAlreadyDomainAdmin (22) - kontakt se již nachází v roli administrativního kontaktu domény
ContactMustBeDomainOwnerOrAdminOrTech (23) - kontakt musí být v roli držitele domény nebo administrativního kontaktu domény nebo technického kontaktu sady jmenných serverů
KeySetIsAlreadyDomainKeySet (24) - sada klíčů je již přiřazena k dané doméně
Třída CZUnknownError
Vyjadřuje stav, kdy nastala blíže nespecifikovaná chyba. Třída je odvozena ze třídy CZError.
vlastnost ErrorType
Vrací hodnotu CZErrorType.UnknownError.
Třída CZAccessDenied
Vyjadřuje stav, kdy server odepřel klientovi přístup. Třída je odvozena ze třídy CZError.
vlastnost ErrorType
Vrací hodnotu CZErrorType.AccessDenied.
Akční domény
Throughout the summer, registering a domain DE and HU at the special price.
Service MiniWeb
WWW webpage for free with every domain, WYSIWYG editor or direct editation CSS; HTML
A new registration COM, NET
A new registration COM and NET. Transfer included.
API Partner
Our partners use automatic system for registration and administration domains.
Domains' statistics
| Domains .CZ | 63,490 |
|---|---|
| Domains .SK | 12,582 |
| Domains .EU | 14,229 |
| Other domains | 14,027 |
| Together | 104,308 |
