Klientská knižnica .NET
Popis tried, metód a parametrov klienta ZMS.
Obsah:
-
Trieda ZMSClient
-
Trieda CAdmin
-
Trieda CZRegistration
-
Trieda CZContact
-
Trieda CZNsSet
-
Trieda CZKeySet
-
Trieda CZDomain
- Výťah CAdminError
-
Trieda CZError
-
Dátové štruktúry
-
Súbory na stiahnutie
Trieda ZMSClient
Nižšie uvedené API popisuje klientskú časť klient-server aplikácie, ktorá zabezpečuje, okrem iného, registráciu a správu domén .CZ. Všetka komunikácia prebieha výmenou správ medzi klientom a serverom cez TCP/IP protokol. Táto komunikácia je v klientovi zapúzdrená a funkčnosť je zabezpečená volaním príslušných metód.
konštruktor ZMSClient()
Klienta ZMS vytvoríme ako inštanciu triedy ZMSClient.
ZMSClient zms = new ZMSClient("admin.czechia.com", true, false);
Konštruktor tejto triedy vyžaduje nasledujúce parametre:
- zmsRemoteHost (string) - adresa servera, na ktorom beží serverová časť; doporučená hodnota: admin.czechia.com
- ssl (bool) - určuje či bude komunikácia prebiehať cez zabezpečený kanál; doporučená hodnota: true
- test (bool) - určuje či bude komunikácia prebiehať s testovacím serverom; pri hodnote true sú zdrojom dát testovacie databázy
metóda Connect()
Zavolaním metódy sa vykoná pripojenie klienta na server. Pokiaľ sa spojenie nepodarí nadviazať, vyhodí metóda výnímku.
zms.Connect();
metóda Disconnect()
Zavolaním metódy sa vykoná korektné ukončenie spojenia klienta so serverom.
zms.Disconnect();
Trieda CAdmin
Serverová časť vyžaduje na prístup k jednotlivým funkciám identifikáciu klienta a určitú úroveň oprávnenia. Aby ste mohli klienta skutočne používať, musíte najskôr oprávnenie získať. Na získanie oprávnenia sa obráťte na technickú podporu admin@zoner.sk.
metóda UserAuthenticate()
Zavolaním metódy sa vykoná identifikácia klienta, a to prihlásením sa na účet v Centre administrácie. Úroveň oprávnení sa následne zistí z daného účtu.
V prípade úspechu metóda vracia hodnotu true.
Pri neúspechu vracia hodnotu false. Kód chyby je možné získať z výstupného parametra error.
Metóda vyžaduje nasledujúce parametre:
- idUser (string) - prihlasovacie meno na účet v Centre administrácie
- password (string) - heslo na prihlásenie na účet v Centre administrácie
- lang (string) - voľba jazykovej verzie (podporované hodnoty 'cs' (default), 'en')
- mid (uint) - vlastný identifikátor, unikátny pre každé volanie metódy
- error (out CAdminError) - výstupný parameter, ktorý vracia kód chyby
zms.CAdmin.UserAuthenticate("CZ-xx", "password", "cs", 0, out error);
Trieda CZRegistration
Táto trieda obsahuje triedy na prácu s kontaktami CZContact, so sadami menných serverov CZNsSet a s doménami CZDomain a združuje ich do logického celku, ktorý zastrešuje operácie nad databázou CZ.NICu.
Trieda CZContact
Trieda CZContact obsahuje metódy pre prácu s kontaktami.
metóda Create()
Táto metóda umožňuje vytvorenie nového kontaktu v databáze CZ.NICu.
V prípade úspechu metóda vracia hodnotu true.
Pri neúspechu vracia hodnotu false. Podrobnosti o chybe je možné získať z výstupného parametra error.
Metóda vyžaduje nasledujúce parametre:
- contact (ContactType) - údaje pre vytvorenie kontaktu
- mid (uint) - vlastný identifikátor, unikátny pre každé volanie metódy
- error (out CZError) - výstupný parameter, ktorý vracia podrobnosti o chybe
zms.CZRegistration.Contact.Create(contact, mid, out error);
metóda DeleteByPassword()
Táto metóda umožňuje zmazanie existujúceho kontaktu z databázy CZ.NICu.
V prípade úspechu metóda vracia hodnotu true.
Pri neúspechu vracia hodnotu false. Podrobnosti o chybe je možné získať z výstupného parametra error.
Metóda vyžaduje nasledujúce parametre:
- cId (string) - identifikátor kontaktu
- password (string) - heslo kontaktu
- mid (uint) - vlastný identifikátor, unikátny pre každé volanie metódy
- error (out CZError) - výstupný parameter, ktorý vracia podrobnosti o chybe
zms.CZRegistration.Contact.DeleteByPassword(cId, password, mid, out error);
metóda Check()
Táto metóda umožňuje overenie dostupnosti identifikátora kontaktu v databáze CZ.NICu.
V prípade úspechu metóda vracia hodnotu true.
Pri neúspechu vracia hodnotu false. Podrobnosti o chybe je možné získať z výstupného parametra error.
Metóda vyžaduje nasledujúce parametre:
- cId (string) - identifikátor kontaktu
- check (out CheckType) - výstupný parameter, ktorý vracia výsledok overenia dostupnosti
- mid (uint) - vlastný identifikátor, unikátny pre každé volanie metódy
- error (out CZError) - výstupný parameter, ktorý vracia podrobnosti o chybe
zms.CZRegistration.Contact.Check(cId, out check, mid, out error);
metóda ListDomains()
Táto metóda umožňuje získať zoznam doménových mien, ktoré používajú daný identifikátor kontaktu v úlohe držiteľa domény alebo v úlohe administratívneho kontaktu domény.
V prípade úspechu metóda vracia hodnotu true.
Pri neúspechu vracia hodnotu false. Podrobnosti o chybe je možné získať z výstupného parametra error.
Metóda vyžaduje nasledujúce parametre:
- cId (string) - identifikátor kontaktu
- list (out string[]) - výstupný parameter, ktorý obsahuje zoznam doménových mien
- mid (uint) - vlastný identifikátor, unikátny pre každé volanie metódy
- error (out CZError) - výstupný parameter, ktorý vracia podrobnosti o chybe
zms.CZRegistration.Contact.ListDomains(cId, out list, mid, out error);
metóda ListKeySets()
Táto metóda umožňuje získať zoznam identifikátorov sady kľúčov, ktoré používajú daný identifikátor kontaktu.
V prípade úspechu metóda vracia hodnotu true.
Pri neúspechu vracia hodnotu false. Podrobnosti o chybe je možné získať z výstupného parametra error.
Metóda vyžaduje nasledujúce parametre:
- cId (string) - identifikátor kontaktu
- list (out string[]) - výstupný parameter, ktorý obsahuje zoznam identifikátorov sady kľúčov
- mid (uint) - vlastný identifikátor, unikátny pre každé volanie metódy
- error (out CZError) - výstupný parameter, ktorý vracia podrobnosti o chybe
zms.CZRegistration.Contact.ListKeySets(cId, out list, mid, out error);
metóda ListNsSets()
Táto metóda umožňuje získať zoznam identifikátorov sady menných serverov, ktoré používajú daný identifikátor kontaktu.
V prípade úspechu metóda vracia hodnotu true.
Pri neúspechu vracia hodnotu false. Podrobnosti o chybe je možné získať z výstupného parametra error.
Metóda vyžaduje nasledujúce parametre:
- cId (string) - identifikátor kontaktu
- list (out string[]) - výstupný parameter, ktorý obsahuje zoznam identifikátorov sady menných serverov
- mid (uint) - vlastný identifikátor, unikátny pre každé volanie metódy
- error (out CZError) - výstupný parameter, ktorý vracia podrobnosti o chybe
zms.CZRegistration.Contact.ListNsSets(cId, out list, mid, out error);
metóda Query()
Táto metóda umožňuje načítanie údajov kontaktu z databázy CZ.NICu. Získané údaje je možné jednoducho použiť pre metódu UpdateByPassword(). Pretože kontakt nie je autorizovaný, nevracajú sa skryté údaje.
V prípade úspechu metóda vracia hodnotu true.
Pri neúspechu vracia hodnotu false. Podrobnosti o chybe je možné získať z výstupného parametra error.
Metóda vyžaduje nasledujúce parametre:
- cId (string) - identifikátor kontaktu
- contact (out ContactType) - načítané údaje kontaktu
- mid (uint) - vlastný identifikátor, unikátny pre každé volanie metódy
- error (out CZError) - výstupný parameter, ktorý vracia podrobnosti o chybe
zms.CZRegistration.Contact.Query(cId, out contact, mid, out error);
metóda QueryByPassword()
Táto metóda umožňuje načítanie údajov kontaktu z databázy CZ.NICu. Získané údaje je možné jednoducho použiť pre metódu UpdateByPassword(). Pretože je kontakt autorizovaný, vracajú sa aj skryté údaje.
V prípade úspechu metóda vracia hodnotu true.
Pri neúspechu vracia hodnotu false. Podrobnosti o chybe je možné získať z výstupného parametra error.
Metóda vyžaduje nasledujúce parametre:
- cId (string) - identifikátor kontaktu
- password (string) - heslo kontaktu
- contact (out ContactType) - načítané údaje kontaktu
- mid (uint) - vlastný identifikátor, unikátny pre každé volanie metódy
- error (out CZError) - výstupný parameter, ktorý vracia podrobnosti o chybe
zms.CZRegistration.Contact.QueryByPassword(cId, password, out contact, mid, out error);
metóda SendAuthInfo()
Táto metóda umožňuje požiadať CZ.NIC o zaslanie hesla na prevod kontaktu medzi registrátormi.
V prípade úspechu metóda vracia hodnotu true.
Pri neúspechu vracia hodnotu false. Podrobnosti o chybe je možné získať z výstupného parametra error.
Metóda vyžaduje nasledujúce parametre:
- cId (string) - identifikátor kontaktu
- mid (uint) - vlastný identifikátor, unikátny pre každé volanie metódy
- error (out CZError) - výstupný parameter, ktorý vracia podrobnosti o chybe
zms.CZRegistration.Contact.SendAuthInfo(cId, mid, out error);
metóda SendPassword()
Táto metóda umožňuje zaslanie hesla kontaktu. Heslo sa používa na autorizáciu zmien.
V prípade úspechu metóda vracia hodnotu true.
Pri neúspechu vracia hodnotu false. Podrobnosti o chybe je možné získať z výstupného parametra error.
Metóda vyžaduje nasledujúce parametre:
- cId (string) - identifikátor kontaktu
- expireInDays (int) - počet dní, po ktorých uplynutí platnosť hesla vyprší
- mid (uint) - vlastný identifikátor, unikátny pre každé volanie metódy
- error (out CZError) - výstupný parameter, ktorý vracia podrobnosti o chybe
zms.CZRegistration.Contact.SendPassword(cId, expireInDays, mid, out error);
metóda Transfer()
Táto metóda umožňuje prevod kontaktu od iného registrátora.
V prípade úspechu metóda vracia hodnotu true.
Pri neúspechu vracia hodnotu false. Podrobnosti o chybe je možné získať z výstupného parametra error.
Metóda vyžaduje nasledujúce parametre:
- cId (string) - identifikátor kontaktu
- curAuthInfo (string) - heslo pre prevod kontaktu medzi registrátormi
- mid (uint) - vlastný identifikátor, unikátny pre každé volanie metódy
- error (out CZError) - výstupný parameter, ktorý vracia podrobnosti o chybe
zms.CZRegistration.Contact.Transfer(cId, curAuthInfo, mid, out error);
metóda UpdateByPassword()
Táto metóda umožňuje zapísanie zmien existujúceho kontaktu do databázy CZ.NICu.
V prípade úspechu metóda vracia hodnotu true.
Pri neúspechu vracia hodnotu false. Podrobnosti o chybe je možné získať z výstupného parametra error.
Metóda vyžaduje nasledujúce parametre:
- contact (ContactType) - nové údaje kontaktu
- password (string) - heslo kontaktu
- mid (uint) - vlastný identifikátor, unikátny pre každé volanie metódy
- error (out CZError) - výstupný parameter, ktorý vracia podrobnosti o chybe
zms.CZRegistration.Contact.UpdateByPassword(contact, password, mid, out error);
metóda Whois()
Táto metóda umožňuje načítanie údajov kontaktu z databázy CZ.NICu.
V prípade úspechu metóda vracia hodnotu true.
Pri neúspechu vracia hodnotu false. Podrobnosti o chybe je možné získať z výstupného parametra error.
Metóda vyžaduje nasledujúce parametre:
- cId (string) - identifikátor kontaktu
- info (out ContactWhoisType) - výstupný parameter, ktorý vracia načítané údaje kontaktu
- mid (uint) - vlastný identifikátor, unikátny pre každé volanie metódy
- error (out CZError) - výstupný parameter, ktorý vracia podrobnosti o chybe
zms.CZRegistration.Contact.Whois(cId, out info, mid, out error);
Trieda CZNsSet
Trieda CZNsSet obsahuje metódy pre prácu so sadami menných serverov.
metóda Create()
Táto metóda umožňuje vytvorenie novej sady menných serverov v databáze CZ.NICu.
V prípade úspechu metóda vracia hodnotu true.
Pri neúspechu vracia hodnotu false. Podrobnosti o chybe je možné získať z výstupného parametra error.
Metóda vyžaduje nasledujúce parametre:
- nsset (NsSetType) - údaje pre vytvorenie sady menných serverov
- mid (uint) - vlastný identifikátor, unikátny pre každé volanie metódy
- error (out CZError) - výstupný parameter, ktorý vracia podrobnosti o chybe
zms.CZRegistration.NsSet.Create(nsset, mid, out error);
metóda DeleteByPassword()
Táto metóda umožňuje zmazanie existujúcej sady menných serverov z databázy CZ.NICu.
V prípade úspechu metóda vracia hodnotu true.
Pri neúspechu vracia hodnotu false. Podrobnosti o chybe je možné získať z výstupného parametra error.
Metóda vyžaduje nasledujúce parametre:
- nId (string) - identifikátor sady menných serverov
- cId (string) - identifikátor kontaktu potvrdzujúceho zmazanie
- password (string) - heslo kontaktu
- mid (uint) - vlastný identifikátor, unikátny pre každé volanie metódy
- error (out CZError) - výstupný parameter, ktorý vracia podrobnosti o chybe
zms.CZRegistration.NsSet.DeleteByPassword(nId, cId, password, mid, out error);
metóda Check()
Táto metóda umožňuje overenie dostupnosti identifikátora sady menných serverov v databáze CZ.NICu.
V prípade úspechu metóda vracia hodnotu true.
Pri neúspechu vracia hodnotu false. Podrobnosti o chybe je možné získať z výstupného parametra error.
Metóda vyžaduje nasledujúce parametre:
- nId (string) - identifikátor sady menných serverov
- check (out CheckType) - výstupný parameter, ktorý vracia výsledok overenia dostupnosti
- mid (uint) - vlastný identifikátor, unikátny pre každé volanie metódy
- error (out CZError) - výstupný parameter, ktorý vracia podrobnosti o chybe
zms.CZRegistration.NsSet.Check(nId, out check, mid, out error);
metóda ListDomains()
Táto metóda umožňuje získať zoznam doménových mien, ktoré používajú daný identifikátor sady menných serverov.
V prípade úspechu metóda vracia hodnotu true.
Pri neúspechu vracia hodnotu false. Podrobnosti o chybe je možné získať z výstupného parametra error.
Metóda vyžaduje nasledujúce parametre:
- nId (string) - identifikátor sady menných serverov
- list (out string[]) - výstupný parameter, ktorý obsahuje zoznam doménových mien
- mid (uint) - vlastný identifikátor, unikátny pre každé volanie metódy
- error (out CZError) - výstupný parameter, ktorý vracia podrobnosti o chybe
zms.CZRegistration.NsSet.ListDomains(nId, out list, mid, out error);
metóda ListWithNameServer()
Táto metóda umožňuje získať zoznam identifikátorov sady menných serverov, ktoré používajú daný menný server.
V prípade úspechu metóda vracia hodnotu true.
Pri neúspechu vracia hodnotu false. Podrobnosti o chybe je možné získať z výstupného parametra error.
Metóda vyžaduje nasledujúce parametre:
- nName (string) - doménové meno jmenného serveru
- list (out string[]) - výstupný parameter, ktorý obsahuje zoznam identifikátorov sady menných serverov
- mid (uint) - vlastný identifikátor, unikátny pre každé volanie metódy
- error (out CZError) - výstupný parameter, ktorý vracia podrobnosti o chybe
zms.CZRegistration.NsSet.ListWithNameServer(nName, out list, mid, out error);
metóda SendAuthInfo()
Táto metóda umožňuje požiadať CZ.NIC o zaslanie hesla pre prevod sady menných serverov medzi registrátormi.
V prípade úspechu metóda vracia hodnotu true.
Pri neúspechu vracia hodnotu false. Podrobnosti o chybe je možné získať z výstupného parametra error.
Metóda vyžaduje nasledujúce parametre:
- nId (string) - identifikátor sady menných serverov
- mid (uint) - vlastný identifikátor, unikátny pre každé volanie metódy
- error (out CZError) - výstupný parameter, ktorý vracia podrobnosti o chybe
zms.CZRegistration.NsSet.SendAuthInfo(nId, mid, out error);
metóda Transfer()
Táto metóda umožňuje prevod sady menných serverov od iného registrátora.
V prípade úspechu metóda vracia hodnotu true.
Pri neúspechu vracia hodnotu false. Podrobnosti o chybe je možné získať z výstupného parametra error.
Metóda vyžaduje nasledujúce parametre:
- nId (string) - identifikátor sady menných serverov
- curAuthInfo (string) - heslo pre prevod sady menných serverov medzi registrátormi
- mid (uint) - vlastný identifikátor, unikátny pre každé volanie metódy
- error (out CZError) - výstupný parameter, ktorý vracia podrobnosti o chybe
zms.CZRegistration.NsSet.Transfer(nId, curAuthInfo, mid, out error);
metóda UpdateByPassword()
Táto metóda umožňuje zapísanie zmien existujúcej sady menných serverov do databázy CZ.NICu.
V prípade úspechu metóda vracia hodnotu true.
Pri neúspechu vracia hodnotu false. Podrobnosti o chybe je možné získať z výstupného parametra error.
Metóda vyžaduje nasledujúce parametre:
- nsset (NsSetType) - nové údaje sady menných serverov
- cId (string) - identifikátor kontaktu potvrdzujúceho zmeny
- password (string) - heslo kontaktu
- mid (uint) - vlastný identifikátor, unikátny pre každé volanie metódy
- error (out CZError) - výstupný parameter, ktorý vracia podrobnosti o chybe
zms.CZRegistration.NsSet.UpdateByPassword(nsset, cId, password, mid, out error);
metóda Whois()
Táto metóda umožňuje načítanie údajov sady menných serverov z databázy CZ.NICu.
V prípade úspechu metóda vracia hodnotu true.
Pri neúspechu vracia hodnotu false. Podrobnosti o chybe je možné získať z výstupného parametra error.
Metóda vyžaduje nasledujúce parametre:
- nId (string) - identifikátor sady menných serverov
- info (out NsSetWhoisType) - výstupný parameter, ktorý vracia načítané údaje sady menných serverov
- mid (uint) - vlastný identifikátor, unikátny pre každé volanie metódy
- error (out CZError) - výstupný parameter, ktorý vracia podrobnosti o chybe
zms.CZRegistration.NsSet.Whois(nId, out info, mid, out error);
Trieda CZKeySet
Trieda CZKeySet obsahuje metódy pre prácu so sadami kľúčov.
metóda Create()
Táto metóda umožňuje vytvorenie novej sady kľúčov v databáze CZ.NICu.
V prípade úspechu metóda vracia hodnotu true.
Pri neúspechu vracia hodnotu false. Podrobnosti o chybe je možné získať z výstupného parametra error.
Metóda vyžaduje nasledujúce parametre:
- keyset (KeySetType) - údaje pre vytvorenie sady kľúčov
- mid (uint) - vlastný identifikátor, unikátny pre každé volanie metódy
- error (out CZError) - výstupný parameter, ktorý vracia podrobnosti o chybe
zms.CZRegistration.KeySet.Create(keyset, mid, out error);
metóda DeleteByPassword()
Táto metóda umožňuje zmazanie existujúcej sady kľúčov z databázy CZ.NICu.
V prípade úspechu metóda vracia hodnotu true.
Pri neúspechu vracia hodnotu false. Podrobnosti o chybe je možné získať z výstupného parametra error.
Metóda vyžaduje nasledujúce parametre:
- kId (string) - identifikátor sady kľúčov
- cId (string) - identifikátor kontaktu potvrdzujúceho zmazanie
- password (string) - heslo kontaktu
- mid (uint) - vlastný identifikátor, unikátny pre každé volanie metódy
- error (out CZError) - výstupný parameter, ktorý vracia podrobnosti o chybe
zms.CZRegistration.KeySet.DeleteByPassword(kId, cId, password, mid, out error);
metóda Check()
Táto metóda umožňuje overenie dostupnosti identifikátoru sady kľúčov v databáze CZ.NICu.
V prípade úspechu metóda vracia hodnotu true.
Pri neúspechu vracia hodnotu false. Podrobnosti o chybe je možné získať z výstupného parametra error.
Metóda vyžaduje nasledujúce parametre:
- kId (string) - identifikátor sady kľúčov
- check (out CheckType) - výstupný parameter, ktorý vracia výsledok overenia dostupnosti
- mid (uint) - vlastný identifikátor, unikátny pre každé volanie metódy
- error (out CZError) - výstupný parameter, ktorý vracia podrobnosti o chybe
zms.CZRegistration.KeySet.Check(kId, out check, mid, out error);
metóda ListDomains()
Táto metóda umožňuje získať zoznam doménových mien, ktoré používajú daný identifikátor sady kľúčov.
V prípade úspechu metóda vracia hodnotu true.
Pri neúspechu vracia hodnotu false. Podrobnosti o chybe je možné získať z výstupného parametra error.
Metóda vyžaduje nasledujúce parametre:
- kId (string) - identifikátor sady kľúčov
- list (out string[]) - výstupný parameter, ktorý obsahuje zoznam doménových mien
- mid (uint) - vlastný identifikátor, unikátny pre každé volanie metódy
- error (out CZError) - výstupný parameter, ktorý vracia podrobnosti o chybe
zms.CZRegistration.KeySet.ListDomains(kId, out list, mid, out error);
metóda SendAuthInfo()
Táto metóda umožňuje požiadať CZ.NIC o zaslanie hesla pre prevod sady kľúčov medzi registrátormi.
V prípade úspechu metóda vracia hodnotu true.
Pri neúspechu vracia hodnotu false. Podrobnosti o chybe je možné získať z výstupného parametra error.
Metóda vyžaduje nasledujúce parametre:
- kId (string) - identifikátor sady kľúčov
- mid (uint) - vlastný identifikátor, unikátny pre každé volanie metódy
- error (out CZError) - výstupný parameter, ktorý vracia podrobnosti o chybe
zms.CZRegistration.KeySet.SendAuthInfo(kId, mid, out error);
metóda Transfer()
Táto metóda umožňuje prevod sady kľúčov od iného registrátora.
V prípade úspechu metóda vracia hodnotu true.
Pri neúspechu vracia hodnotu false. Podrobnosti o chybe je možné získať z výstupného parametra error.
Metóda vyžaduje nasledujúce parametre:
- kId (string) - identifikátor sady kľúčov
- curAuthInfo (string) - heslo pre prevod sady kľúčov medzi registrátormi
- mid (uint) - vlastný identifikátor, unikátny pre každé volanie metódy
- error (out CZError) - výstupný parameter, ktorý vracia podrobnosti o chybe
zms.CZRegistration.KeySet.Transfer(kId, curAuthInfo, mid, out error);
metóda UpdateByPassword()
Táto metóda umožňuje zapísanie zmien existujúce sady kľúčov do databázy CZ.NICu.
V prípade úspechu metóda vracia hodnotu true.
Pri neúspechu vracia hodnotu false. Podrobnosti o chybe je možné získať z výstupného parametra error.
Metóda vyžaduje nasledujúce parametre:
- keyset (KeySetType) - nové údaje sady kľúčov
- cId (string) - identifikátor kontaktu potvrdzujúceho zmeny
- password (string) - heslo kontaktu
- mid (uint) - vlastný identifikátor, unikátny pre každé volanie metódy
- error (out CZError) - výstupný parameter, ktorý vracia podrobnosti o chybe
zms.CZRegistration.KeySet.UpdateByPassword(keyset, cId, password, mid, out error);
metóda Whois()
Táto metóda umožňuje načítanie údajov sady kľúčov z databázy CZ.NICu.
V prípade úspechu metóda vracia hodnotu true.
Pri neúspechu vracia hodnotu false. Podrobnosti o chybe je možné získať z výstupného parametra error.
Metóda vyžaduje nasledujúce parametre:
- kId (string) - identifikátor sady kľúčov
- info (out KeySetWhoisType) - výstupný parameter, ktorý vracia načítané údaje sady kľúčov
- mid (uint) - vlastný identifikátor, unikátny pre každé volanie metódy
- error (out CZError) - výstupný parameter, ktorý vracia podrobnosti o chybe
zms.CZRegistration.KeySet.Whois(kId, out info, mid, out error);
Trieda CZDomain
Trieda CZDomain obsahuje metódy pre práci s doménovými menami.
metóda CreateOrder()
Táto metóda umožňuje vložení objednávky na registráciu nového doménového mena v databáze CZ.NICu. Registrácia doménového mena neprebiehá online.
V prípade úspechu metóda vracia hodnotu true.
Pri neúspechu vracia hodnotu false. Podrobnosti o chybe je možné získať z výstupného parametra error.
Metóda vyžaduje nasledujúce parametre:
- domain (DomainType) - údaje pre registráciu nového doménového mena
- respondTo (string) - emailová adresa, na ktorú bude zaslaná informácia o úspešnej registrácii doménového mena
- requestId (string) - vlastný identifikátor, ktorý bude v obsahu emailu, zaslaného po úspešnej registrácii doménového mena
- mid (uint) - vlastný identifikátor, unikátny pre každé volanie metódy
- error (out CZError) - výstupný parameter, ktorý vracia podrobnosti o chybe
metóda DeleteByPassword()
Táto metóda umožňuje zmazanie existujúceho doménového mena z databázy CZ.NICu.
V prípade úspechu metóda vracia hodnotu true.
Pri neúspechu vracia hodnotu false. Podrobnosti o chybe je možné získať z výstupného parametra error.
Metóda vyžaduje nasledujúce parametre:
- domainName (string) - doménové meno
- cId (string) - identifikátor kontaktu potvrdzujúceho zmazanie
- password (string) - heslo kontaktu
- mid (uint) - vlastný identifikátor, unikátny pre každé volanie metódy
- error (out CZError) - výstupný parameter, ktorý vracia podrobnosti o chybe
zms.CZRegistration.Domain.DeleteByPassword(domainName, cId, password, mid, out error);
metóda Check()
Táto metóda umožňuje overenie dostupnosti doménového mena v databáze CZ.NICu.
V prípade úspechu metóda vracia hodnotu true.
Pri neúspechu vracia hodnotu false. Podrobnosti o chybe je možné získať z výstupného parametra error.
Metóda vyžaduje nasledujúce parametre:
- domainName (string) - doménové meno
- check (out CheckType) - výstupný parameter, ktorý vracia výsledok overenia dostupnosti
- mid (uint) - vlastný identifikátor, unikátny pre každé volanie metódy
- error (out CZError) - výstupný parameter, ktorý vracia podrobnosti o chybe
zms.CZRegistration.Domain.Check(domainName, out check, mid, out error);
metóda ListInvoiced()
Táto metóda umožňuje získať zoznam doménových mien, ktorých platcom je daný používateľ.
V prípade úspechu metóda vracia hodnotu true.
Pri neúspechu vracia hodnotu false. Podrobnosti o chybe je možné získať z výstupného parametra error.
Metóda vyžaduje nasledujúce parametre:
- list (out string[]) - výstupný parameter, ktorý obsahuje zoznam doménových mien
- mid (uint) - vlastný identifikátor, unikátny pre každé volanie metódy
- error (out CZError) - výstupný parameter, ktorý vracia podrobnosti o chybe
zms.CZRegistration.Domain.ListInvoiced(out list, mid, out error);
metóda ListToBeDeleted()
Táto metóda umožňuje získať zoznam doménových mien uvoľňovaných k novej registrácii.
V prípade úspechu metóda vracia hodnotu true.
Pri neúspechu vracia hodnotu false. Podrobnosti o chybe je možné získať z výstupného parametra error.
Metóda vyžaduje nasledujúce parametre:
- list (out DomainSpecRegType[]) - výstupný parameter, ktorý obsahuje zoznam doménových mien a dátum ich predpokladaného uvoľnenia
- mid (uint) - vlastný identifikátor, unikátny pre každé volanie metódy
- error (out CZError) - výstupný parameter, ktorý vracia podrobnosti o chybe
zms.CZRegistration.Domain.ListToBeDeleted(out list, mid, out error);
metóda RenewOrder()
Táto metóda umožňuje vloženie objednávky na predĺženie platnosti doménového mena v databáze CZ.NICu. Predĺženie platnosti doménového mena neprebieha online.
V prípade úspechu metóda vracia hodnotu true.
Pri neúspechu vracia hodnotu false. Podrobnosti o chybe je možné získať z výstupného parametra error.
Metóda vyžaduje nasledujúce parametre:
- domainName (string) - doménové meno
- dPeriod (int) - počet rokov o koľko sa má platnosť predĺžiť
- respondTo (string) - emailová adresa, na ktorú bude zaslaná informácia o úspešnom predĺžení platnosti doménového mena
- requestId (string) - vlastný identifikátor, ktorý bude v obsahu emailu, zaslaného po úspešnom predĺžení platnosti doménového mena
- mid (uint) - vlastný identifikátor, unikátny pre každé volanie metódy
- error (out CZError) - výstupný parameter, ktorý vracia podrobnosti o chybe
zms.CZRegistration.Domain.RenewOrder(domainName, dPeriod, respondTo, requestId, mid, out error);
metóda ReplaceNsSetByPassword()
Táto metóda umožňuje vykonanie hromadnej zmeny identifikátora sady menných serverov u vštkých doménových mien s priradenou danou sadou menných serverov za iný. Zmenu nie je možné vykonať u tých doménových mien, ktoré nie sú registrátorom spravované.
V prípade úspechu metóda vracia hodnotu true.
Pri neúspechu vracia hodnotu false. Podrobnosti o chybe je možné získať z výstupného parametra error.
Metóda vyžaduje nasledujúce parametre:
- oldNsSet (string) - súčasný identifikátor sady menných serverov
- newNsSet (string) - nový identifikátor sady menných serverov, ktorý má byť priradený
- cId (string) - identifikátor kontaktu potvrdzujúceho zmeny
- password (string) - heslo kontaktu
- changeList (out Dictionary<string, bool>) - výstupný parameter, ktorý vracia zoznam doménových mien, u ktorých mala byť zmena vykonaná a informácia o úspechu vykonania zmeny pre každé uvedené doménové meno
- mid (uint) - vlastný identifikátor, unikátny pre každé volanie metódy
- error (out CZError) - výstupný parameter, ktorý vracia podrobnosti o chybe
zms.CZRegistration.Domain.ReplaceNsSetByPassword(oldNsSet, newNsSet, cId, password, out changeList, mid, out error);
metóda SendAuthInfo()
Táto metóda umožňuje požiadať CZ.NIC o zaslanie hesla pre prevod domény medzi registrátormi.
V prípade úspechu metóda vracia hodnotu true.
Pri neúspechu vracia hodnotu false. Podrobnosti o chybe je možné získať z výstupného parametra error.
Metóda vyžaduje nasledujúce parametre:
- domainName (string) - doménové meno
- mid (uint) - vlastný identifikátor, unikátny pre každé volanie metódy
- error (out CZError) - výstupný parameter, ktorý vracia podrobnosti o chybe
zms.CZRegistration.Domain.SendAuthInfo(domainName, mid, out error);
metóda Transfer()
Táto metóda umožňuje prevod domény od iného registrátora. Zároveň je možné u domény zmeniť priradenú sadu menných serverov.
V prípade úspechu metóda vracia hodnotu true.
Pri neúspechu vracia hodnotu false. Podrobnosti o chybe je možné získať z výstupného parametra error.
Metóda vyžaduje nasledujúce parametre:
- domainName (string) - doménové meno
- nId (string) - identifikátor sady menných serverov, ktorá má byť novo priradená
- curAuthInfo (string) - heslo pre prevod doménového mena medzi registrátormi
- mid (uint) - vlastný identifikátor, unikátny pre každé volanie metódy
- error (out CZError) - výstupný parameter, ktorý vracia podrobnosti o chybe
zms.CZRegistration.Domain.Transfer(domainName, nId, curAuthInfo, mid, out error);
metóda UpdateByPassword()
Táto metóda umožňuje zapísanie zmien existujúcej domény do databázy CZ.NICu.
V prípade úspechu metóda vracia hodnotu true.
Pri neúspechu vracia hodnotu false. Podrobnosti o chybe je možné získať z výstupného parametra error.
Metóda vyžaduje nasledujúce parametre:
- domain (DomainType) - nové údaje pre doménu
- cId (string) - identifikátor kontaktu potvrdzujúcího zmeny
- password (string) - heslo kontaktu
- mid (uint) - vlastný identifikátor, unikátny pre každé volanie metódy
- error (out CZError) - výstupný parameter, ktorý vracia podrobnosti o chybe
zms.CZRegistration.Domain.UpdateByPassword(domain, cId, password, mid, out error);
metóda Whois()
Táto metóda umožňuje načítanie údajov domény z databázy CZ.NICu.
V prípade úspechu metóda vracia hodnotu true.
Pri neúspechu vracia hodnotu false. Podrobnosti o chybe je možné získať z výstupného parametra error.
Metóda vyžaduje nasledujúce parametre:
- domainName (string) - doménové meno
- info (out DomainWhoisType) - výstupný parameter, ktorý vracia načítané údaje domény
- mid (uint) - vlastný identifikátor, unikátny pre každé volanie metódy
- error (out CZError) - výstupný parameter, ktorý vracia podrobnosti o chybe
zms.CZRegistration.Domain.Whois(domainName, out info, mid, out error);
Výťah CAdminError
Obsahuje zoznam chýb, ktoré sa môžu vyskytnúť pri volaní niektorej metódy triedy CAdmin.
Tieto hodnoty sú:
- NoError - žiadna chyba nenastala
- UnknownError - nastala bližšie nešpecifikovaná chyba
- UserAlreadyAuthenticated - používateľ je už prihlásený
- BadCredentials - nesprávne prihlasovacie údaje
Trieda CZError
Sú z nej odvodené triedy, ktoré popisujú podrobnosti o konkrétnom type chyby, ktorá sa môže vyskytnúť pri volaní niektorej metódy tried CZContact, CZNsSet a CZDomain.
vlastnosť ErrorType
Táto vlastnosť obsahuje typ chybového objektu a je určená výpisovým typom CZErrorType s nasledujúcimi hodnotami:
- NoError - žiadna chyba
- SyntaxError - syntaktická chyba
- SqlError - chyba na Sql servere
- CzNicError - chyba na CZ.NICu
- CzNicException - výnimka pri volaní CZ.NICu
- RuntimeError - chyba spracovania žiadosti
- UnknownError - bližšie nešpecifikovaná chyba
- AccessDenied - odoprený prístup
Trieda CZNoError
Vyjadruje stav, keď nenastala žiadna chyba. Trieda je odvodená z triedy CZError.
vlastnosť ErrorType
Vracia hodnotu CZErrorType.NoError.
Trieda CZSyntaxError
Informuje o syntaktickej chybe. Trieda je odvodená z triedy CZError.
vlastnosť ErrorType
Vracia hodnotu CZErrorType.SyntaxError.
vlastnosť ParamName
Obsahuje názov parametra, ktorého hodnota spôsobila syntaktickú chybu.
vlastnosť ErrorValue
Obsahuje chybnú hodnotu.
vlastnosť Number
Obsahuje číslo chyby.
vlastnosť Description
Obsahuje textové vyjadrenie čísla chyby.
Prehľad možných syntaktických chýb vo formáte Description (Number) - popis chyby:
CannotErase (1) - hodnota nemôže byť NULL
CannotBeEmpty (2) - hodnota nemôže byť prázdna
Reserved (3) - vyhradené pre budúce účely
InvalidValue (4) - neplatná hodnota
LengthMustBe0To16 (5) - nie je dodržaná povolená dĺžka 0 až 16 znakov
LengthMustBe0To17 (6) - nie je dodržaná povolená dĺžka 0 až 17 znakov
LengthMustBe0To20 (7) - nie je dodržaná povolená dĺžka 0 až 20 znakov
LengthMustBe0To32 (8) - nie je dodržaná povolená dĺžka 0 až 32 znakov
LengthMustBe0To255 (9) - nie je dodržaná povolená dĺžka 0 až 255 znakov
LengthMustBe0To300 (10) - nie je dodržaná povolená dĺžka 0 až 300 znakov
LengthMustBe1To66 (11) - nie je dodržaná povolená dĺžka 1 až 66 znakov
LenghtMustBe1To255 (12) - nie je dodržaná povolená dĺžka 1 až 255 znakov
LengthMustBe2 (13) - nie je dodržaná povolená dĺžka 2 znaky
LengthMustBe3To45 (14) - nie je dodržaná povolená dĺžka 3 až 45 znakov
LengthMustBe3To63 (15) - nie je dodržaná povolená dĺžka 3 až 63 znakov
LengthMustBe4To255 (16) - nie je dodržaná povolená dĺžka 4 až 255 znakov
MustBeCountryCode (17) - hodnotou musí byť ISO kód krajiny
MustBeDefined (18) - hodnota nie je definovaná
MustBeEmail (19) - hodnota nemá formát emailovej adresy
MustBeNameServerFQDN (20) - hodnota nemá formát plne kvalifikovaného doménového mena pre menné servery
MustBeIPAddress (21) - hodnota nemá formát IP adresy
MustBeLowerCase (22) - hodnota nie je uvedená malými písmenami
MustBeNormalizedString (23) - hodnota nemá formát normalizovaného reťazca
MustBeNotDefined (24) - hodnota nesmie byť definovaná
MustBeNumbersOrLettersOrUnderlineOrHyphenOrColonOrDot (25) - hodnota môže obsahovať len číslice, písmená a znaky podčiarnik (_), pomlčka (-), dvojbodka (:), bodka (.)
MustBeTelephoneNumberFormat (26) - hodnota nemá formát telefónneho čísla
MustBeToken (27) - hodnota nemá formát tokenu
MustBeTypeDateTime (28) - hodnota nemá formát dátumu
MustBeTypeInt (29) - hodnota nemá formát čísla
MustBeUpperCase (30) - hodnota nie je uvedená veľkými písmenami
MustBeValidDomainNameCz (31) - hodnota nemá formát platného doménového mena .cz
ValueMustBe0To10 (32) - hodnotou môže byť číslo 0 až 10
ValueMustBe1To10 (33) - hodnotou môže byť číslo 1 až 10
ValueMustBe1To365 (34) - hodnotou môže byť číslo 1 až 365
MustBeHexBinary (35) - hodnotou môže byť reťazec znakov pre hexadecimálny zápis binárnej hodnoty
ValueMustBe0AndGreater (36) - hodnotou môže byť celé kladné číslo
Trieda CZSqlError
Informuje o chybe SQL servera. Trieda je odvodená z triedy CZError.
vlastnosť ErrorType
Vracia hodnotu CZErrorType.SqlError.
vlastnosť Detail
Obsahuje informácie o chybe.
Trieda CZNicError
Informuje o chybe, ktorá vznikla na strane servera CZ.NIC. Trieda je odvodená z triedy CZError.
vlastnosť ErrorType
Vracia hodnotu CZErrorType.CzNicError.
vlastnosť Code
Obsahuje číslo chyby.
vlastnosť Message
Obsahuje text chybovej správy.
vlastnosť ObjectId
Obsahuje identifikátor objektu, v ktorom chyba nastala.
Trieda CZNicException
Informuje o výnimke, ktorá vznikla v pribehu komunikácie so serverom CZ.NIC. Trieda je odvodená z triedy CZError.
vlastnosť ErrorType
Vracia hodnotu CZErrorType.CzNicException.
vlastnosť Description
Obsahuje text chybovej správy.
Trieda CZRuntimeError
Informuje o chybe, ktorá sa vyskytla pri spracovaní požiadavky na servere. Môže sa jednať tiež o kontextovú chybu v hodnote parametra, kedy hodnota parametra je syntakticky v poriadku, ale v danom kontexte nie je správna. Trieda je odvodená z triedy CZError.
vlastnosť ErrorType
Vracia hodnotu CZErrorType.RuntimeError.
vlastnosť ErrorValue
Obsahuje chybnú hodnotu.
vlastnosť Number
Obsahuje číslo chyby.
vlastnosť Description
Obsahuje textové vyjadrenie čísla chyby.
Prehľad možných kontextových chýb vo formáte Description (Number) - popis chyby:
AlreadyCurrentRegistrar (1) - u daného objektu je registrátor už určeným registrátorom
AuthInfoNotMatching (2) - heslo pre prevod medzi registrátormi nie je správne
AuthIdNotAcquired (3) - nepodarilo sa overiť práva pre autorizáciu zmien
ContactMustBeDomainOwner (4) - kontakt musí byť v úlohe držiteľa domény
ContactMustBeTech (5) - kontakt musí byť v úlohe technického kontaktu
InvalidAuthorization (6) - neplatná autorizácia
InvalidAuthorizationMethod (7) - neplatná metóda autorizácie
InvalidContactEmail (8) - neplatný email kontaktu
NotAvailable (9) - identifikátor objektu nie je voľný
NotCurrentRegistrar (10) - registrátor nie je určeným registrátorom
MaxLimitForAuthPwdCreationExceeded (11) - bol prekročený maximálny limit počtu novo vytvorených hesiel kontaktu
MaxLimitOfUnexpiredAuthPwdsReached (12) - bol prekročený maximálny limit počtu momentálne platných hesiel kontaktu
UnableToSaveAuthPwd (13) - heslo kontaktu sa nepodarilo uložiť do databázy
UnableToSendEmail (14) - nepodarilo sa odoslať email s heslom kontaktu
MustBeAlreadyRegistred (15) - objekt musí byť už registrovaný
AddingOrderFailed (16) - objednávku sa nepodarilo zapísať do databázy
UnableToReadMsgTemplate (17) - nepodarilo sa načítať šablónu správy
AdminIdMustBeDefined (18) - nebol definovaný identifikátor potvrdenia administrátorom
ContactIsAlreadyDomainOwner (19) - kontakt sa už nachádza v úlohe držiteľa domény
ContactMustBeDomainOwnerOrAdmin (20) - kontakt musí byť v úlohe držiteľa domény alebo administratívneho kontaktu domény
NsSetIsAlreadyDomainNsSet (21) - sada menných serverov je už priradená k danej doméne
ContactIsAlreadyDomainAdmin (22) - kontakt sa už nachádza v úlohe administratívneho kontaktu domény
ContactMustBeDomainOwnerOrAdminOrTech (23) - kontakt musí byť v úlohe držiteľa domény, administratívneho kontaktu domény alebo technického kontaktu sady menných serverov
KeySetIsAlreadyDomainKeySet (24) - sada kľúčov je už priradená k danej doméne
Trieda CZUnknownError
Vyjadruje stav, keď nastala blížšie nešpecifikovaná chyba. Trieda je odvodená z triedy CZError.
vlastnosť ErrorType
Vracia hodnotu CZErrorType.UnknownError.
Trieda CZAccessDenied
Vyjadruje stav, keď server odoprel klientovi prístup. Trieda je odvodená z triedy CZError.
vlastnosť ErrorType
Vracia hodnotu CZErrorType.AccessDenied.
