RAConnection

IConnector	ICaConnector	IBicaConnector	IStorageConnector
IGetCertCache	IGetProvCertCache	IGetReqIdCache	IOperatorSigner
BaseConnector	BelongsCertOperatorReq	BillingData	BelongsCertOperatorReqBuilder
GetPayParentsReqBuilder	GetPPReqDataObjectBuilder	GetProtocolBodyBuilder	GetProtocolBodyDataBuilder
GetProtocolDictionaryBuilder	GetProtocolReqBuilder	CertTypeConfig	Configuration
GetCertHolderDocument	GetCertHolderReq	GetCertHolderResp	GetPayParentsReq
GetPayParentsResp	GetPPRequestDataObject	HardwareObject	PayParentObject
PriceObject	VatObject	GetProtocolResp	GetQscdResp
QscdObject	QscdPropsObject	Hardware	Mandate
PayParentConfig	PayParentStock	BicaConnector	AddressBuilder
BillingDataBuilder	CancelReqBodyBuilder	CompanyBuilder	GetCert4CardReqBuilder
GetCertReqBodyBuilder	GetSaveReqReqBuilder	GetUserCertsReqBuilder	GetUserCertsUserDataBuilder
KeyAndRequestDataBuilder	PutRenReqBuilder	PutRenReqCertPropsBuilder	PutRenReqUserDataBuilder
PutReqCertPropsBuilder	PutReqReqBuilder	PutReqUserDataBuilder	RevokeCertReqBuilder
TestConReqBuilder	CancelReqBody	CaRejectInfo	CertificateObject
GetCertReqBody	GetCertRespBody	ReqMessageObject	ReqRejectReasonObject
RequestIdInfo	DigestsObject	GetCert4CardCaServer	GetCert4CardCertObject
GetCert4CardReq	GetCert4CardResp	GetCert4CardValidity	CertSubject
CertSubjectValue	GetCertificatesReqBody	CertificatePolicy	GetProvCertResponse
IcaRootCert	IcaRootCerts	NbuCert	NbuSrCerts
GetReqIdResp	GetSaveReqReq	GetSaveReqResp	CertificatePropertiesObject
GetUserCertsCertificate	GetUserCertsReq	GetUserCertsResp	GetUserCertsUserData
GetUserCertsX509Object	UserObject	PutRenReqCertProps	PutRenReqReq
PutRenReqUserData	AddressObject	BillingDataObject	BillingDataPaymentType
CompanyObject	DocumentObject	KeyAndRequestDataObject	PackageCodeObject
PackageCodeType	Psd2Object	PutRenReqInsert	PutReqCertProps
PutReqCertPropsSendCert	PutReqReq	PutReqReqChanges	PutReqRequestObject
PutReqUserData	QscdObject	ReqIdInterconnectionObject	CrlReasons
RevokeCertReq	TestConReq	TestedSystemResp	CaConnector
FileGetProvCertCache	MemoryGetCertCache	MemoryGetReqIdCache	DefaultOperatorSigner
CASubTypes	Request\`2	StorageSubTypes	ConnectorRequiredPropBadDataEx
RaReqBadDataEx	PutCertAgreementReqBuilder	PutCertificateRequestReqBuilder	PutCertAgreementReq
CertInfoObject	PutCertificateRequestReq	StorageDocumentObject	StorageFileFormats
StorageConnector	GetPayParentsBodyObject	CertIdentification

IBicaConnector

Rozhraní pro komunikaci se systémem BICA

BelongCertificateOperatorAsync(body)

Provede komunikaci BelongCertificateOperator s BICA, která ověří aktuálně používaný certifikát pro podepisování komunikací se systémy I.CA, zda tento certifikát má nastavenou roli operátora RA.

Name	Description
body	RAConnection.BICA.BelongsCertificateOperator.BelongsCertOperatorReq Tělo požadavku. Instanci lze vytvořit pomocí builder třídy (RAConnection.BICA.Builders.BelongsCertOperatorReqBuilder.

ControlOperatorAsync

Provede komunikaci ControlOperator s BICA, která ověří zda certifikát, který byl použit pro podpis těla http požadavku, má nastavenou roli operátora.

GetCertHolderAsync(body)

Provede komunikace GetCertHolderData s BICA, která na základě dokladu totožnosti vrací evidované uživatele v systému BICA.

Name	Description
body	RAConnection.BICA.GetCertHolderData.GetCertHolderReq Tělo požadavku, specifikují vyhledávací kritéria pro uživatele. Instanci třídy RAConnection.BICA.GetCertHolderData.GetCertHolderReq lze vytvořit pomocí builder třídy GetCertHolderReqBuilder.

Returns

Držitelé certifikátu evidované v systému BICA, kteří splňují hledací kritéria. Pokud žádní uživatele nejsou k dispozici je navrácena prázdná kolekce.

GetPayParentsAsync(body)

Provede komunikaci GetPayParents s BICA, která získá seznam plátců, pod kterým je možno vydat danou žádost.

Name	Description
body	RAConnection.BICA.GetPayParents.GetPayParentsReq Tělo požadavku komunikace s informacemi o dané žádosti. Instanci objektu RAConnection.BICA.GetPayParents.GetPayParentsReq lze získat pomocí builder třídy GetPayParentsReqBuilder.

Returns

Seznam plátců, které je možné použít pro danou žádost o certifikát.

GetProtocolAsync(body)

Získá protokol o podání žádosti nebo smlouvu o vydání certifikátu ve formátu PDF na základě předaných osobních údajů. Server BICA automaticky vybere šablonu na základě informací o žádosti (typ certifikátu apod.), vloží zaslané údaje do dokumentu a převede dokument do pdf, který je navrácen uživateli).

Name	Description
body	RAConnection.BICA.GetProtocol.GetProtocolReq Data, která se mají vložit do protokolu. Pro vytvoření těla požadavku lze využít třídu GetProtocolReqBuilder

Returns

Protokol nebo smlouvu ve formátu PDF vloženou ve objektu RAConnection.BICA.GetProtocol.GetProtocolResp.

GetQscdAsync

Provede komunikaci GetQSCD s BICA.

Returns

Seznam QSCD.

TestConnectionAsync

Otestuje spojení se serverem BICA.

ICaConnector

Rozhraní pro komunikaci se systémem CA.

CancelReqAsync(requestId)

Provede komunikaci s CA pro zrušení zpracování žádosti.

Name	Description
requestId	System.String Číslo žádosti (v číselném tvaru - 13 číslic, např. 4848480001234).

ClearRequestCacheAsync

Vyčistí dotazy uložené v cache. Mělo by se volat při změně operátorského certifikátu.

GetCert4CardAsync(body)

Provede komunikaci s CA pro získání seznamu vydavatelských certifikátů na kartu Seznam obsahuje nové i zastaralé certifikáty. Lze tedy na kartě díky seznamu odstranit zastaralé certifikáty a naimportovat nové.

Name	Description
body	RAConnection.CA.GetCert4Card.GetCert4CardReq Tělo požadavku pro získání certifikátů na kartu..

Returns

Certifikáty jako RAConnection.CA.GetCert4Card.GetCert4CardResp, nebo výjimku v případě chyby.

GetCertCache

Služba pro cachování dotazů getCert.

GetCertificateAsync(body)

Provede komunikaci s CA pro získání certifikátu na základě předaného vyhledávajícího údaje. Tato metoda je využívána při kontrole stavu vydání certifikátu na CA. Odpověď RAConnection.CA.GetCert.GetCertRespBody obsahuje i informace o stavu zpracování certifikátu na CA v objektu RAConnection.CA.GetCert.GetCertRespBody.ReqInfo, pokud je pro vyhledání použit číslo žádosti.

Name	Description
body	RAConnection.CA.GetCert.GetCertReqBody Tělo požadavku pro získání žádosti o certifikát (číslo, žádosti, sn certifikátu nebo SHA1 otisk klíče). Instanci třídy RAConnection.CA.GetCert.GetCertReqBody lze využít builder třídu RAConnection.CA.Builders.GetCertReqBodyBuilder.

Returns

Certifikát jako RAConnection.CA.GetCert.GetCertRespBody, nebo výjimku v případě chyby.

GetProvCertAsync

Komunikace s CA (případně načtení z cache souboru) pro získání vydavatelských certifikátů (ve formátu PEM a ICF).

Returns

Seznam vydavatelských certifikátů ICA a NBUSR.

GetProvCertCache

Služba pro cachování odpovědí getProvCert.

GetReqIdAsync

Provede komunikaci s CA pro získání posledního použitého čísla žádosti evidovaného na CA. Pro rezervování čísla žádosti pro novou žádost je potřeba získanou hodnotu zvýšit o jedna.

Returns

Poslední evidované číslo žádosti jako RAConnection.CA.GetReqId.GetReqIdResp, nebo výjimku v případě chyby.

GetReqIdCache

Služba pro cachování dotazů getReqId.

GetSaveReqAsync(fileReqID)

Provede komunikaci getSaveReq s CA, která na základě ID souboru žádosti (odlišné jako ID žádosti) vrátí žádost o certifikát.

Name	Description
fileReqID	System.String ID souboru se žádostí

Returns

Vrací žádost jako RAConnection.CA.GetSaveReq.GetSaveReqResp nebo výjimku v případě chyby.

GetUserCertsAsync(body)

Provede komunikaci getUserCerts, která na základě osobních údajů prohledá evidenci uživatelů na CA a vrací základní informace o uživatelích a jejich certifikátech, kterými disponují.

Name

Description

body

RAConnection.CA.GetUserCerts.GetUserCertsReq Vyhledávací parametry pro specifikaci typu certifikátu, který se má vrátit a údaje o uživateli zapouzdřené do třídy RAConnection.CA.GetUserCerts.GetUserCertsReq. Instanci této třídy lze sestavit pomocí builder třídy RAConnection.CA.Builders.GetUserCertsReqBuilder. Instanci třídy pro specifikaci osobních údajů uživatele RAConnection.CA.GetUserCerts.GetUserCertsUserData lze vytvořit pomocí builder třídy RAConnection.CA.Builders.GetUserCertsUserDataBuilder.

Returns

Vrací kolekci nalezených uživatelů a jejich certifikátů kterými disponují.

PutRenReqAsync(body)

Provede komunikaci putRenReq, která slouží pro odeslání žádosti o následný certifikát na systém CA.

Name

Description

body

RAConnection.CA.PutRenReq.PutRenReqReq Žádost o následný certifikát a další metadata potřebná pro vystavení následného certifikátu. Instanci třídy RAConnection.CA.PutRenReq.PutRenReqReq lze vytvořit pomocí builder třídy RAConnection.CA.Builders.PutRenReqBuilder. Pro jednotlivé vlastnosti, které jsou součástí třídy RAConnection.CA.PutRenReq.PutRenReqReq jsou dostupné také builder třídy: RAConnection.CA.PutReq.KeyAndRequestDataObject = RAConnection.CA.Builders.KeyAndRequestDataBuilder, RAConnection.CA.PutRenReq.PutRenReqCertProps = RAConnection.CA.Builders.PutRenReqCertPropsBuilder, RAConnection.CA.PutReq.BillingDataObject = RAConnection.CA.Builders.BillingDataBuilder, RAConnection.CA.PutRenReq.PutRenReqUserData = RAConnection.CA.Builders.PutRenReqUserDataBuilder.

PutReqAsync(body)

Provede komunikaci putReq na CA. Touto funkcí se žádost předá na CA a zahájí se proces vydání certifikátu na straně CA.

Name

Description

body

RAConnection.CA.PutReq.PutReqReq Žádost o certifikát a další metadata, která jsou potřebná pro vydání certifikátu. Instanci třídy RAConnection.CA.PutReq.PutReqReq lze vytvořit pomocí builder třídy RAConnection.CA.Builders.PutReqReqBuilder. Pro typy vlastností, které jsou součástí třídy RAConnection.CA.PutReq.PutReqReq jsou k dispozici také builder třídy: RAConnection.CA.PutReq.KeyAndRequestDataObject = RAConnection.CA.Builders.KeyAndRequestDataBuilder, RAConnection.CA.PutReq.PutReqCertProps = RAConnection.CA.Builders.PutReqCertPropsBuilder, RAConnection.CA.PutReq.BillingDataObject = RAConnection.CA.Builders.BillingDataBuilder, RAConnection.CA.PutReq.PutReqUserData = RAConnection.CA.Builders.PutReqUserDataBuilder.

TestConAsync(body)

Provede komunikaci testCon, která slouží pro otestování dostupností systémů CA.

Name	Description
body	RAConnection.CA.TestCon.TestConReq Parametrizace požadavku na otestování, kdy lze specifikovat části CA, pro které se má provést test dostupnosti. Parametrizace je zapouzdřena do třídy RAConnection.CA.TestCon.TestConReq, je možno vytvořit pomocí builder třídy RAConnection.CA.Builders.TestConReqBuilder.

Returns

Odpověď se stavy testovaných systémů.

IConnector

Základní rozhraní pro connector pro komunikaci se systémem I.CA

OperatorSigner

Rozhraní pro podepisování požadavků na systém I.CA operátorským certifikátem.

RaCode

Identifikace RA zakódovaná do int

ServerUrl

Url adresa systému

SetRaCodeFromString(raCodeString)

Metoda pro převedení kódu RA z textového řetězce na číselnou hodnotu.

Name	Description
raCodeString	System.String Kód RA v textové podobě (2 až 3 alfanumerické znaky).

IOperatorSigner

Rozhraní pro podepisování dat operátorským certifikátem

SignRequestDataAsync(requestData)

Metoda, která podepíše data těla požadavku na systém I.CA. Podepsaná data musí být ve tvaru PKCS#7 (asynchronní varianta)

Name	Description
requestData	System.Byte[] Data požadavku.

Returns

Podepsaná data (PKCS7SignedData) jako pole bytů.

IStorageConnector

Rozhraní pro komunikaci se systémem Storage.

PutCertificateAgreementAsync(body)

Provede komunikaci Storage PutCertificateAgreement, která slouží k přidání el. protokolů vznikající při procesu vydání certifikátu (typicky protokol o podání žádosti a smlouva o vydání certifikátu) pro příslušnou žádost o certifikát.

Name	Description
body	RAConnection.Storage.PutCertificateAgreement.PutCertAgreementReq Tělo požadavku, obsahující potřebné přílohy a informace o certifikátech pro archivaci dat v úložišti. Položky jsou zapouzdřeny ve třídě RAConnection.Storage.PutCertificateAgreement.PutCertAgreementReq, kterou lze vytvořit pomocí builder třídy RAConnection.Storage.Builders.PutCertAgreementReqBuilder

Remarks

Pro úspěšné provolání metody je potřeba mít nastavenou vlastnost RAConnection.BaseConnector.ServerUrl a vlastnost RAConnection.BaseConnector.OperatorSigner

PutCertificateRequestAsync(body)

Provede komunikaci Storage PutCertificateRequest, která na úložiště dokumentů žádost pro elektronické vydání certifikátu pro danou žádost a uloží k ní přidané přílohy dokumentů.

Name

Description

body

RAConnection.Storage.PutCertificateRequest.PutCertificateRequestReq Tělo požadavku, obsahující základní informace o žádosti, o certifikátu operátora (a v případě následného certifikátu i klienta) a el. přílohy, které se mají na úložiště archivovat. Tyto informace jsou zapouzdřeny do třídy RAConnection.Storage.PutCertificateRequest.PutCertificateRequestReq, kterou lze získat pomocí builder třídy RAConnection.Storage.Builders.PutCertificateRequestReqBuilder

Remarks

Pro úspěšné provolání metody je potřeba mít nastavenou vlastnost RAConnection.BaseConnector.ServerUrl a vlastnost RAConnection.BaseConnector.OperatorSigner

TestConnectionAsync

Remarks

Pro úspěšné provolání metody je potřeba mít nastavenou vlastnost RAConnection.BaseConnector.ServerUrl

IGetCertCache

Rozhraní pro specifikaci cachování dotazů getCert se systémem CA.

AddToCacheAsync(url, pkcs7SignedData, requestId, certSN, keyThumbHexStr)

Přidá PKCS#7SignedData komunikace na systém CA pro získání certifikátu (getCert). Vyhledávání probíhá na základě předané URL (url) a pak jednoho z údajů, který lze využít pro vyhledání certifikátu (requestId (typicky se jedná o číslo žádosti), certSN nebo keyThumbHexStr)

Name	Description
url	System.String URL adresa serveru na který se požadavek odesílá (povinný prvek pro vyhledání požadavku). Je potřeba používat z důvodu více systémů CA (kvalifikovaná, komerční).
pkcs7SignedData	System.String Požadavek na CA jako PKCS#7SignedData.
requestId	System.String Číslo žádosti.
certSN	System.String Sériové číslo certifikátu.
keyThumbHexStr	System.String SHA-1 hash klíče (SubjectKeyIdentifier) v hexadecimálním kódování

ClearCacheAsync

Vymaže data z cache (mělo by se provádět při změně přihlášeného operátora).

TryGetFromCacheAsync(url, requestId, certSN, keyDigestHexStr)

Pokusí se vyhledat PKCS#7SignedData požadavek pro získání certifikátu ze systému CA. Vyhledání probíhá na základě zadání URL (url) a jednoho z údajů identifikující požadavek (číslo žádosti (requestId), sériové číslo certifikátu (certSN) nebo SHA-1 hash klíče (keyDigestHexStr)).

Name	Description
url	System.String URL adresa na který požadavek cílí (z důvodu více systémů CA (kvalifikovaná, komerční)).
requestId	System.String Číslo žádosti.
certSN	System.String Sériové číslo certifikátu.
keyDigestHexStr	System.String SHA-1 hash klíče (SubjectKeyIdentifier) v hexadecimálním tvaru.

Returns

PKCS#7SignedData požadavku nebo pokud požadavek v cache nebyl nalezen.

TryRemoveFromCacheAsync(url, requestId, certSN, keyDigestHexStr)

Odmaže záznam z cache pokud se v ní nachází. Vyhledání probíhá na základě zadání URL (url) a jednoho z údajů identifikující požadavek (číslo žádosti (requestId), sériové číslo certifikátu (certSN) nebo SHA-1 hash klíče (keyDigestHexStr)).

Name	Description
url	System.String URL adresa na který požadavek cílí (z důvodu více systémů CA (kvalifikovaná, komerční)).
requestId	System.String Číslo žádosti.
certSN	System.String Sériové číslo certifikátu.
keyDigestHexStr	System.String SHA-1 hash klíče (SubjectKeyIdentifier) v hexadecimálním tvaru.

IGetProvCertCache

Rozhraní pro cachování odpovědí komunikace getProvCert (certifikáty CA - crt a icf).

AddToCacheAsync(serverUrl, getProvCertResp)

Přidá záznam do cache nebo aktualizuje jeho hodnotu pokud v cache již je.

Name	Description
serverUrl	System.String Url adresa serveru ze kterého se getProcCert stahoval. (slouží jako klíč pro vyhledávání).
getProvCertResp	System.String Data getProvCert (XML dokument), který se má uložit do cache.

ClearCacheAsync

Smaže všechny data v cache.

RecordMaxAgeInDays

Maximální stáří záznamu v cache (pro obnovení dat ze systému ICA, aby se data v cache nemohly stát neaktuální). Doporučená hodnota je 1.

RemoveOldRecordsAsync

Promaže záznamy v cache které jsou starší než maximální povolená hodnota uvedená v IGetProvCertCache.RecordMaxAgeInDays.

TryGetFromCacheAsync(serverUrl)

Pokusí se vyhledat data v cache na základě klíče (URL adresa).

Name	Description
serverUrl	System.String URL adresa systému, pro který se má vyhledat v cache.

Returns

vrací XML data odpovědi getProvCert nebo pokud záznam nebyl v cache nalezen nebo byl starší než maximální povolené stáří záznamu.

IGetReqIdCache

Rozhraní pro cachování požadavků getReqId na systémy I.CA

AddToCacheAsync(serverUrl, pkcs7SignedData)

Přidá PKCS#7SignedData getReqId komunikace do cache.

Name	Description
serverUrl	System.String UrlAdresa serveru na který se požadavek posílá (URL adresa se využívá v vyhledávání v cache).
pkcs7SignedData	System.String Hodnota (PKCS#7SignedData getReqId požadavku), která se má uložit do cache.

ClearCacheAsync

Vyčistí cache záznamy (měly by se volat při změně operátora, který požadavky podepisuje)

TryGetFromCacheAsync(serverUrl)

Podle klíče (URL adresa serveru I.CA) se pokusí získat hodnota v cache.

Name	Description
serverUrl	System.String URL adresa serveru I.CA

Returns

Vrací PKCS#7SignedData uložená v cache nebo pokud se požadavek v cache nenachází.

IOperatorSigner

Rozhraní pro podepisování dat operátorským certifikátem

SignRequestDataAsync(requestData)

Metoda, která podepíše data těla požadavku na systém I.CA. Podepsaná data musí být ve tvaru PKCS#7 (asynchronní varianta)

Name	Description
requestData	System.Byte[] Data požadavku.

Returns

Podepsaná data (PKCS7SignedData) jako pole bytů.

BaseConnector

Základní třída connectorů, obsahující společné metody využitelné pro všechny specifické connectory.

AnswerLanguage

Jazyk odpovědi (pokud se vrací odpověď s chybou, v tomto jazyce bude hláška lokalizována).

OperatorSigner

Služba pro podepsání požadavku na systém I.CA.

RaCode

Jedinečný identifikátor RA. Vkládá se do PKCS#7 jako nepovinný atribut pro většinu funkcí. Lze zadat v textové variantě pomocí metody BaseConnector.SetRaCodeFromString(System.String), kdy metoda textovou hodnotu zakóduje do identifikátoru.

SetRaCodeFromString(codeRaStr)

Převede hodnotu kódu RA ze System.String na System.Int32 a nastaví hodnotu BaseConnector.RaCode

Name	Description
codeRaStr	System.String Kód RA jako System.String

BelongsCertOperatorReq

Třída reprezentující element Body v žádosti komunikace vica BelongsCertificateOperator.

Akid

Akid certifikátu.

RaId

ID ra, na kterém chce operátor pracovat.

Sn

Sériové číslo certifikátu.

BillingData

Fakturační data o daném plátci.

Dic

DIČ. NEPOVINNÁ POLOŽKA.

FirmAddressCity

Adresa společnosti - město. NEPOVINNÁ POLOŽKA.

FirmAddressCountry

Adresa společnosti - země. NEPOVINNÁ POLOŽKA.

FirmAddressStreet

Adresa společnosti - ulice. NEPOVINNÁ POLOŽKA.

FirmAddressStreetNum

Adresa společnosti - číslo. NEPOVINNÁ POLOŽKA.

FirmAddressZipCode

Adresa společnosti - PSČ. NEPOVINNÁ POLOŽKA.

FirmName

Jméno plátce.

FirmNameComplement

Další jméno plátce. NEPOVINNÁ POLOŽKA.

Ic

IČO. NEPOVINNÁ POLOŽKA.

IcDph

IČ pro DPH. NEPOVINNÁ POLOŽKA.

BelongsCertOperatorReqBuilder

Builder třída pro vytvoření instance třídy RAConnection.BICA.BelongsCertificateOperator.BelongsCertOperatorReq

Konstruktor

Vytvoří novou instanci builderu.

Build()

Zvaliduje povinné položky a vrátí instanci RAConnection.BICA.BelongsCertificateOperator.BelongsCertOperatorReq.

Returns

Instanci RAConnection.BICA.BelongsCertificateOperator.BelongsCertOperatorReq.

RAConnection.Exceptions.RaReqBadDataEx: Vzniká pokud některá z povinných položek nebyla vyplněna.

SetAkid(akid)

Nastaví property Akid.

Name	Description
akid	System.String Akid certifikátu.

SetRaId(raid)

Nastaví property RaId.

Name	Description
raid	System.String Id RA.

SetSn(sn)

Nastaví property Sn.

Name	Description
sn	System.String Sériové číslo certifikátu.

GetCertHolderReqBuilder

GetCertHolderReqBuilder.Build

Zvaliduje všechny povinné položky a pokud je vše OK vrací instanci RAConnection.BICA.GetCertHolderData.GetCertHolderReq nebo výjimku.

Returns

Instanci RAConnection.BICA.GetCertHolderData.GetCertHolderReq.

RAConnection.Exceptions.RaReqBadDataEx: Vzniká pokud některá z povinných položek není správně vyplněna.

GetCertHolderReqBuilder.SetDocument(type, country, value)

Nastaví property Document

Name	Description
type	System.String Typ dokladu.
country	System.String Vydavatel dokladu.
value	System.String Číslo dokumentu.

GetPayParentsReqBuilder

Builder třída pro získání instance třídy RAConnection.BICA.GetPayParents.GetPayParentsReq.

Konsturktor

Vytvoří novou instanci builderu.

AddRequestData(reqData)

Přidá položku RequestData do kolekce.

Name	Description
reqData	RAConnection.BICA.GetPayParents.GetPPRequestDataObject Podrobnosti o žádosti pro kterou se mají získat pay parenti.

Build()

Zkontroluje povinné položky a pokud je vše OK vrací instanci RAConnection.BICA.GetPayParents.GetPayParentsReq. V opačném případě vzniká výjimka.

Returns

Instanci třídy RAConnection.BICA.GetPayParents.GetPayParentsReq

RAConnection.Exceptions.RaReqBadDataEx: Vzniká pokud některá z povinných položek není správně vyplněna.

GetPPReqDataObjectBuilder

Builder třída pro získání instance třídy RAConnection.BICA.GetPayParents.GetPPRequestDataObject.

Konstruktor

Vytvoří novou instanci builderu.

Build()

Zvaliduje zadané hodnoty ve vyžadovaných položkách a pokud je vše v pořádku vrátí instanci RAConnection.BICA.GetPayParents.GetPPRequestDataObject. V opačném případě vzniká výjimka

Returns

Instanci RAConnection.BICA.GetPayParents.GetPPRequestDataObject

RAConnection.Exceptions.RaReqBadDataEx: Vzniká pokud některá z vyžadovaných položek není správně vyplněna.

SetCardId(cardId)

Nastaví property CardId (nepovinné).

Name	Description
cardId	System.String 16-místné číslo karty.

SetCertIssuer(certIssuer)

Nastaví property CertIssuer (nepovinné).

Name	Description
certIssuer	System.String SKID vydavatele certifikátu.

SetCertPolicy(certPolicy)

Nastaví property CertPolicy (nepovinné).

Name	Description
certPolicy	System.String OID certifikační politiky, na kterou má být vydána žádost

SetCertType(certType)

Nastaví property CertType.

Name	Description
certType	System.String Typ certifikátu.

SetFirstOrNext(isNext)

Nastaví property FirstOrNext.

Name	Description
isNext	System.Boolean Prvotní nebo následný: false - prvotní, true - následný

SetHierarchical(hierarchical)

Nastaví property Hierarchical (nepovinné).

Name	Description
hierarchical	System.String Certifikát je v hierarchické struktuře, pokud není uvedeno je v plošné struktuře

SetMandate(mandate)

Nastaví property MandateId (povinné pouze pokud CertType == "Q-MA-SK").

Name	Description
mandate	System.String ID mandátu

SetPayParentID(payParentID)

Nastaví property PayParentId (nepovinné).

Name	Description
payParentID	System.String ID plátce, na kterého má být vydána žádost.

SetPreviousCertSn(previousCertSn)

Nastaví property PreviousCertSn (nepovinné).

Name	Description
previousCertSn	System.String SN předchozího (obnovovaného) certifikátu

SetReqDb(reqDb)

Nastaví property ReqDb.

Name	Description
reqDb	System.String Identifikace DB, kterým bude žádost vydána (Q - kvalifikovaná, S - komerční).

SetReqDbMaster(reqDbMaster)

Nastaví property ReqDbMaster (nepovinné).

Name	Description
reqDbMaster	System.String Identifikace DB řídící žádosti o certifikát (povolené hodnoty "Q", "S").

SetReqId(reqId)

Nastaví property ReqId.

Name	Description
reqId	System.String ID žádosti.

SetReqIdMaster(reqIdMaster)

Nastaví property ReqIdMaster (nepovinné).

Name	Description
reqIdMaster	System.String ID řídící žádosti o certifikát

SetRequest(request)

Nastaví property Request.

Name	Description
request	System.String Žádost o certifikát ve formátu PKCS#10 v kódování PEM

SetValidity(validity)

Nastaví property Validity.

Name	Description
validity	System.String Doba platnosti ve dnech

GetProtocolBodyBuilder

Builder třída pro vytvoření instance třídy RAConnection.BICA.GetProtocol.GetProtocolReqBody

Konstruktor

Vytvoří novou instanci builderu

Build()

Zkontroluje povinné položky a vrátí instanci RAConnection.BICA.GetProtocol.GetProtocolReqBody pokud je vše OK

Returns

Instanci RAConnection.BICA.GetProtocol.GetProtocolReqBody

RAConnection.Exceptions.RaReqBadDataEx: Vzniká pokud některá z povinných položek není správně vyplněna

SetBodyData(bodyData)

Nastaví property Data

Name	Description
bodyData	RAConnection.BICA.GetProtocol.GetProtocolBodyData Data, která se budou vkládat do protokolu.

SetCertType(certType)

Nastaví property CertType

Name	Description
certType	System.String Typ certifikátu

SetLanguage(language)

Nastaví property Language

Name	Description
language	System.String Jazyk protokolu

SetPayParentId(payParentId)

Nastaví property PayParentId

Name	Description
payParentId	System.String Id plátce

SetTemplate(template)

Nastaví property Template

Name	Description
template	RAConnection.BICA.GetProtocol.TemplateTypes Typ šablony

GetProtocolBodyDataBuilder

Builder třída pro vytvoření instance

Konsturktor

Vytvoří novou instanci builderu.

Build

Zkontroluje povinné položky a vrátí instanci RAConnection.BICA.GetProtocol.GetProtocolBodyData pokud je vše oka.

Vracé

Instanci RAConnection.BICA.GetProtocol.GetProtocolBodyData

SetAddress(address)

Nastaví property Address

Name	Description
address	System.String Kompletní adresa žadatele.

SetAlgorithm(algorithm)

Nastaví property Algorithm

Name	Description
algorithm	System.String Algoritmus klíče

SetAlgorithm2(algorithm)

Nastaví property Algorithm2

Name	Description
algorithm	System.String Algoritmus klíče

SetCardNumber(cardNumber)

Nastaví property CardNumber.

Name	Description
cardNumber	System.String Číslo karty.

SetCertDateTimeFrom(certDateTimeFrom, style)

Nastaví property CertDateTimeFrom (nepovinné)

Name	Description
certDateTimeFrom	System.String Platnost certifikátu od.
style	RAConnection.BICA.Builders.FontStyles Volitelný styl textu (tučný, kurzíva, podtržení)

SetCertDateTimeFrom2(certDateTimeFrom, style)

Nastaví property CertDateTimeFrom2 (nepovinné)

Name	Description
certDateTimeFrom	System.String Platnost certifikátu od.
style	RAConnection.BICA.Builders.FontStyles Volitelný styl textu (tučný, kurzíva, podtržení)

SetCertDateTimeTo(certDateTimeTo, style)

Nastaví property CertDateTimeTo (nepovinné)

Name	Description
certDateTimeTo	System.String Platnost certifikátu do
style	RAConnection.BICA.Builders.FontStyles Volitelný styl textu (tučný, kurzíva, podtržení)

SetCertDateTimeTo2(certDateTimeTo, style)

Nastaví property CertDateTimeTo2 (nepovinné)

Name	Description
certDateTimeTo	System.String Platnost certifikátu do
style	RAConnection.BICA.Builders.FontStyles Volitelný styl textu (tučný, kurzíva, podtržení)

SetCertificateTransparency(certificateTransparency)

Nastaví property CertificateTransparency

Name	Description
certificateTransparency	System.String Příznak, zda se má zveřejnit certifikát v CT (ANO, NE přeložené podle vyžadovaného jazyku protokolu).

SetCertType2(certType2, style)

Nastaví property CertType2 (nepovinné)

Name	Description
certType2	System.String Platnost certifikátu od.
style	RAConnection.BICA.Builders.FontStyles Volitelný styl textu (tučný, kurzíva, podtržení)

SetCertTypeRenewal(certTypeRenewal)

Nastaví property CertTypeRenewal.

Name	Description
certTypeRenewal	System.String Billing typ obnoveného certifikátu

SetDate(date, style)

Nastaví property Date (nepovinné)

Name	Description
date	System.String Datum vytvoření protokolu
style	RAConnection.BICA.Builders.FontStyles Volitelný styl textu (tučný, kurzíva, podtržení)

SetDateAndTime(dateAndTime, style)

Nastaví property DateAndTime (nepovinné)

Name	Description
dateAndTime	System.String Čas a datum vytvoření protokolu
style	RAConnection.BICA.Builders.FontStyles Volitelný styl textu (tučný, kurzíva, podtržení)

SetDn(dn)

Nastaví property Dn.

Name	Description
dn	System.Collections.Generic.Dictionary{System.String} Dn certifikátu

SetDn2(dn)

Nastaví property Dn.

Name	Description
dn	System.Collections.Generic.Dictionary{System.String} Dn certifikátu

SetDnIssuer(dnIssuer)

Nastaví property DnIssuer

Name	Description
dnIssuer	System.Collections.Generic.Dictionary{System.String} Dn vydavatelského certifikátu.

SetDnIssuer2(dnIssuer)

Nastaví property DnIssuer

Name	Description
dnIssuer	System.Collections.Generic.Dictionary{System.String} Dn vydavatelského certifikátu.

SetEku(eku)

Nastaví property Eku

Name	Description
eku	System.Collections.Generic.Dictionary{System.String} EKU certifikátu/žádosti.

SetEku2(eku2)

Nastaví property Eku2

Name	Description
eku2	System.Collections.Generic.Dictionary{System.String} EKU slave certifikátu/žádosti.

SetFirmName(firmName, style)

Nastaví property FirmName (nepovinné)

Name	Description
firmName	System.String Umístění RA
style	RAConnection.BICA.Builders.FontStyles Volitelný styl textu (tučný, kurzíva, podtržení)

SetChallengePwd(challengePwd, style)

Nastaví property ChallengePassword (nepovinné)

Name	Description
challengePwd	System.String Heslo pro zneplatnění
style	RAConnection.BICA.Builders.FontStyles Volitelný styl textu (tučný, kurzíva, podtržení)

SetIdentification(identification)

Nastaví property Identification

Name	Description
identification	System.String Identifikace žadatele (rodné číslo, datum narození).

SetLocality(locality, style)

Nastaví property Locality (nepovinné)

Name	Description
locality	System.String Umístění RA
style	RAConnection.BICA.Builders.FontStyles Volitelný styl textu (tučný, kurzíva, podtržení)

SetMpsv(mpsv)

Nastaví property Mpsv

Name	Description
mpsv	System.String Příznak zda se má do certifikátu přidat ik mpsv (ANO, NE přeložené podle vyžadovaného jazyku protokolu).

SetName(name)

Nastaví property Name

Name	Description
name	System.String Křestní jméno

SetOtherDocument(otherDocument)

Nastaví property OtherDocument

Name	Description
otherDocument	System.String Ostatní doklady totožnosti

SetPrimaryDocument(primaryDocument)

Nastaví property PrimaryDocument

Name	Description
primaryDocument	System.String Primární doklad totožnosti

SetPSD2RegId(psd2ReqId)

Nastaví property PSD2RegId.

Name	Description
psd2ReqId	System.String ID registrátora PSD2.

SetPSD2RegName(psd2ReqName)

Nastaví property PSD2RegName.

Name	Description
psd2ReqName	System.String Název registrátora PSD2.

SetPSD2Role(psd2Role)

Nastaví property PSD2Role.

Name	Description
psd2Role	System.String Role PSD2.

SetPublishCertificate(publishCertificate)

Nastaví property PublishCertificate

Name	Description
publishCertificate	System.String Příznak zda se má vydaný certifikát zveřejnit (ANO, NE přeložené podle vyžadovaného jazyku protokolu).

SetRaCode(raCode, style)

Nastaví property RaCode (nepovinné)

Name	Description
raCode	System.String Kód RA
style	RAConnection.BICA.Builders.FontStyles Volitelný styl textu (tučný, kurzíva, podtržení)

SetRaOperator(raOperator, style)

Nastaví property RaOperator (nepovinné)

Name	Description
raOperator	System.String Jméno operátora.
style	RAConnection.BICA.Builders.FontStyles Volitelný styl textu (tučný, kurzíva, podtržení)

SetReqId(reqId)

Nastaví property ReqId

Name	Description
reqId	System.String Id žádosti

SetRevokeReason(revokeReason, style)

Nastaví property RevokeReason (nepovinné)

Name	Description
revokeReason	System.String Důvod zneplatnění
style	RAConnection.BICA.Builders.FontStyles Volitelný styl textu (tučný, kurzíva, podtržení)

SetSan(san)

Nastaví property San

Name	Description
san	System.Collections.Generic.Dictionary{System.String} SAN certifikátu/žádosti.

SetSan2(san2)

Nastaví property San2

Name	Description
san2	System.Collections.Generic.Dictionary{System.String} SAN slave certifikátu/žádosti.

SetSecondaryDocument(secondaryDocument)

Nastaví property SecondaryDocument

Name	Description
secondaryDocument	System.String Sekundární doklad totožnosti.

SetSerialNumber(serialNumber, style)

Nastaví property SerialNumber (nepovinné)

Name	Description
serialNumber	System.String Sériové číslo certifikátu
style	RAConnection.BICA.Builders.FontStyles Volitelný styl textu (tučný, kurzíva, podtržení)

SetSerialNumber2(serialNumber, style)

Nastaví property SerialNumber2 (nepovinné)

Name	Description
serialNumber	System.String Sériové číslo certifikátu
style	RAConnection.BICA.Builders.FontStyles Volitelný styl textu (tučný, kurzíva, podtržení)

SetSerialNumberRenewal(serialNumberRenewal)

Nastaví property SnIca.

Name	Description
serialNumberRenewal	System.String Sériové číslo obnoveného certifikátu

SetSigner(signer)

Nastaví property Signer.

Name	Description
signer	System.String Jméno podepisující osoby.

SetSnIca(snIca)

Nastaví property SnIca.

Name	Description
snIca	System.String ICA Serial number

SetSurname(surname)

Nastaví property Surname

Name	Description
surname	System.String Příjmení žadatele.

SetTitle(title)

Nastaví property Title

Name	Description
title	System.String Příjmení žadatele.

GetProtocolDictionaryBuilder

Builder třída pro sestavení objektů Dictionary(string, List(string)).

AddItem(key, value, addKeyWithEmptyValue)

Přidá položku do Dictionary.

Name	Description
key	System.String KLíč položky (typicky OID DN, SAN nebo EKU - záleží pro kterou z těchto možností je dictionary připravován)
value	System.String Hodnota položky (přidá se do seznamu hodnot)
addKeyWithEmptyValue	System.Boolean Příznak zda se má klíč do slovníku přidat i přes to, že hodnota je prázdná.

Build

Sestaví a vrátí objekt Dictionary

Returns

Dictionary s vloženými položkami.

GetProtocolReqBuilder

Builder třída pro vytvoření instance třídy RAConnection.BICA.GetProtocol.GetProtocolReq

Build

Zvaliduje povinné položky a vrátí instanci RAConnection.BICA.GetProtocol.GetProtocolReq pokud je vše OK.

Returns

Instanci RAConnection.BICA.GetProtocol.GetProtocolReq

RAConnection.Exceptions.RaReqBadDataEx: Vzniká pokud některá z povinných položek není vyplněna.

SetProtocolRequest(protocolRequest)

Nastaví property ProtocolRequest.

Name	Description
protocolRequest	RAConnection.BICA.GetProtocol.GetProtocolReqBody Žádost o protokol jako objekt (metoda provede konverzi do json a base64).

CertTypeConfig

Třída, do které se uloží konfigurace pro typ certifikátu. Třída se používá při parsování odpovědi serveru BICA při komunikaci GetNewcertTemplateByRa

Description

Textový název certifikátu.

Id

Id typu certifikátu.

PayParentsConfigs

Kolekce pay parentů a jejich konfigurací pro new cert.

Configuration

Třída pro naparsování náhobného tagu Configuration, který se nachází v odpovědi v komunikaci GetMandateConfiguration.

Constructor

Kontstruktor pro vytvoření instance třídy Configuration.

Constructor(System.String,System.String)

Kontstruktor pro vytvoření instance třídy Configuration.

ConfigBase64

Konfigurace zakódovaná do Base64 string.

Description

Popis konfigurace.

CertHolderObject

Třída obsahující informace o držiteli certifikátu.

Address

Adresa trvalého bydliště.

BirthDate

Datum narození.

BirthNumber

Rodné číslo.

Document

Primární doklad.

Document2

Sekundární doklad.

DocumentOther

Další doklady.

Name

Jméno.

Surname

Příjmení.

TitleBefore

Titul před jménem (nepovinný).

TitleBehind

Titul za jménem (nepovinný).

GetCertHolderDocument

Třída reprezentující element Document v žádosti komunikace GetCertHolderData.

Country

Stát vydání dokladu

Number

Číslo dokladu.

Type

Typ dokladu.

GetCertHolderReq

Třída reprezentující element Body v žádosti komunikace GetCertHolderData.

Document

Informace o dokladu držitele

GetCertHolderResp

Třída reprezentující element Body/OK v odpovědi komunikace GetCertHolderData.

CertHolders

Držitelé certifikátů s jejich údaji.

GetPayParentsReq

Třída reprezentující element Body v žádosti komunikace bica_getpayparents

RequestData

Data žádosti o certifikát.

GetPayParentsResp

Třída reprezentující element OK v odpovědí komunikace bica_getpayparents.

PayParents

Seznam navrácených pay parentů.

GetPPRequestDataObject

Třída reprezentující element Body/RequestData v žádosti komunikace GetPayParents.

CardId

16 místné číslo karty (nepovinné).

CertIssuer

SKID vydavatele certifikátu (nepovinné)

CertPolicy

OID certifikační politiky, na kterou má být vydána žádost (nepovinné).

CertType

Typ certifikátu (billing typ).

FirstOrNext

Prvotní nebo následný: 0 - prvotní, 1 - následný.

Hierarchical

Certifikát je v hierarchické struktuře, pokud není uvedeno je v plošné struktuře (nepovinné).

Mandate

ID mandátu. Uvedeno pouze pokud CertType = Q-MA-CZSK

PayParentID

ID plátce, na kterého má být vydána žádost (nepovinné).

PreviousCertSn

SN předchozího (obnovovaného) certifikátu (nepovinné).

ReqDb

Identifikace DB, kterým bude žádost vydána. Povolené hodnoty: Q - kvalifikovaná CA, S - komerční CA

ReqDbMaster

Identifikace DB řídící žádosti o certifikát. Povolené hodnoty: Q - kvalifikovaná CA, S - komerční CA (nepovinné).

ReqId

ID žádosti.

ReqIdMaster

ID řídící žádosti o certifikát (nepovinné)

Request

Žádost o certifikát ve formátu PKCS#10 v kódování PEM

Validity

Doba platnosti ve dnech

HardwareObject

Třída reprezentující element OK/PayParents/PayParent/saleHardware/Hardware v odpovědi komunikace bica_getpayparents.

Count

Počet kusů HW, který je dostupný na RA

Currency

Tří písmený kód měny. CZK, EUR

CurrencySign

Symbol pro zobrazení měny. Kc, €

Description

Popis hardware

Id

Identifikace typu hardware

IsCard

Jedná se o kartu. 0 - ne, 1 - ano

ItemIds

Identifikační číslo hardware (nepovinné)

MandatoryItemId

Vyžadovat vyplnění identifikačního čísla hardware (např. číslo karty) - 0 nevyždovat, 1 - vyžadovat

PriceWithoutVat

Cena bez DPH

PriceWithVat

Cena s DPH

WithouVat

Typ dokladu bez/s DPH - 0 - s DPH, 1 - bez DPH

PayParentObject

Třída reprezentující element OK/PayParents/PayParent v odpovědi komunikace bica_getpayparents.

CanIssue

Zda může na žádost vydat certifikát.

ClassConformity

Typ shodnosti řetězců plátce

Default

PP má být předbybrán v RA

EmailRequired

Je vyždaván kontaktní email

ErrorCode

Uvedeno pouze pokud PayParent@issue = no. Chybový kód, proč nelze certifikát vydat.

ErrorMessage

Uvedeno pouze pokud PayParent@issue = no. Textový popis, proč nelze certifikát vydat.

Id

Id PP.

InsertIntoStorage

Je vyžadováno vkládat dokumenty do úložiště.

Issue

Zda může na žádost vydat certifikát. yes - může vydat, no - nemůže vydat

Name

Jméno pay parenta

OpraInstruction

Instrukce pro operátora

Price

Cena za certifikát, kterou platí majitel certifikátu

PublishCert

Zda PP nařizuje zde bude certifikát veřejný nebo neveřejný

SaleHardware

Pouze pokud RA může prodávat/vydávat hardware z konsignačního skladu. Jednotlivé typy HW.

SendCert

Zda PP nařizuje zde bude certifikát zaslán po vydání na emailovou adresu

Vat

Zda je k ceně za připočteno DPH

PriceObject

Třída reprezentující element OK/PayParents/PayParent/Price v odpovědi komunikace bica_getpayparents.

Currency

Tří písmenný kód měny. CZK, EUR

CurrencySign

Symbol pro zobrazení měny. Kc, €

IsWithoutVat

Typ dokladu bez/s DPH - 0 - s DPH, 1 - bez DPH.

WithoutVatPrice

Cena bez DPH.

WithVarPrice

Cena s DPH.

VatObject

Třída reprezentující element OK/PayParents/PayParent/Vat v odpovědi komunikace bica getpayparents.

Country

Dvoupísmenný kód země pro kterou DPH platí. CZ, SK

Value

Hodnota DHP jako desetinné číslo na 3 desetinná místa (např. 20% odpovídá 0.200)

GetProtocolBodyData

Třída pro naplnění dat pro získání šablony pro protokol nebo v procesu vydání certifikátu.

Address

Kompletní adresa trvalého bydliště.

Algorithm

Algoritmus klíčového páru.

Algorithm2

Algoritmus slave klíčového páru.

CertDateTimeFrom

Platnost certifikátu od

CertDateTimeFrom2

Platnost slave certifikátu od

CertDateTimeTo

Platnost certifikátu do

CertDateTimeTo2

Platnost certifikátu do

CertificateTransparency

Příznak zda zveřejnit certifikát.

Date

Datum vytvoření protokolu.

DateAndTime

Datum a čas který bude uveden v protokolu.

Dn

Dn majitele certifikátu

Dn2

Dn majitele Slave certifikátu

DnIssuer

Dn vydavatele

DnIssuer2

Dn vydavatele slave certifikátu

ChallengePassword

Heslo pro zneplatnění.

Identification

Rodné číslo / datum narození.

Locality

Umístění RA.

Mpsv

Příznak, zda certifikát má mít příznak IK MPSV.

Name

Jméno

OtherDocument

Další doklady totožnosti.

PrimaryDocument

Primární doklad totožnosti

PublicCertificate

Příznak zda je certifikát veřejný.

RaCode

Kód RA.

RaOperator

Jméno operátora provádějící danou operaci.

ReqId

Číslo žádosti

RevokeReason

Důvod zneplatnění

SecondaryDocument

Sekundární doklad.

SerialNumber

Sériové číslo certifikátu

SerialNumber2

Sériové číslo slave certifikátu

Surname

Příjmení.

San

Alternativní jméno předmětu žádosti / certifikátu.

San2

Alternativní jméno předmětu slave žádosti / certifikátu.

Eku

Rozšířené použití žádosti / certifikátu.

Eku2

Rozšířené použití slave žádosti / certifikátu.

GetProtocolReq

ProtocolRequest

Požadavek na protokol v BASE64 (zakódovaný json)

GetProtocolReqBody

CertType

Typ certifikátu.

Data

Data, která se budou vkládat do protokolu (informace o žadateli apod.)

Language

Jazyk komunikace.

PayParentId

ID pay parenta.

Template

Typ šablony (protokol, smlouva atd.)

GetProtocolResp

Odpověď komunikace GetProtocol

Protocol

Protokol v BASE64

GetQscdResp

Třída reprezentující element Body v odpovědi komunikace bica_getQSCD.

QscdObject

Třída reprezentující element OK/QSCD v odpovědi komunikace bica_getQSCD.

HaveProofKey

Podporuje důkaz původu klíče.

HaveProofKeyBool

Podporuje důkaz původu klíče.

Id

ID QSCD.

QSealCD

Záznam pro certifikaci o pečeti.

QSigCD

Záznam o certifikaci pro podpis.

QscdPropsObject

Třída reprezentující element OK/QSCD/QSigCD v odpovědi komunikace bica_getPayParents.

Certified

Příznak zda je QSCD certifikováno.

From

Platnost od (pouze pokud je IsCertified == true)

IsCertified

Příznak zda je QSCD certifikováno.

To

Platnost do (pouze pokud je IsCertified == true)

Hardware

Třída do které se naparsuje element Hardware, obsažený v komunikacích GetConsignmentStock a GetPayParents

Constructor

Kontruktor pro vytvoření instance třídy.

Count

Počet kusů hardware, který je dostupný na RA.

Currency

Tří písmený kód měny (např. CZK).

CurrencySign

Symbol pro zobrazení ceny (např. Kč).

Description

Popis typu hardware.

HardwareMandatoryIds

Id hardware, který je dostupná na RA. Nemusí být stejný počet jako je uvedeno v property Count.

Id

Id hardware.

IsCard

Indikace zda se jedná o kartu (true) nebo ne (false).

IsWithoutVat

Přiznak, který udává zda typ dokladu bez DPH (true) nebo s DPH (false).

MandatoryItemIdRequired

Příznak, který udává zda je potřeba vyplnit identifikační číslo hardware (true) nebo ne (false).

PriceWithoutVat

Cena bez DPH.

PriceWithVat

Cena s DPH.

Mandate

Do třídy se naparsuje odpoveď serveru BICA při komunikaci GetMandateConfigurationByRa.

Konstruktor

Vytvoří instanci třídy GetMandateConfigurationByRaResponse.

Konstruktor(System.String,System.String,System.Collections.Generic.IList{RAConnection.BICA.PayParentConfig})

Vytvoří instanci třídy GetMandateConfigurationByRaResponse.

MandateId

Id mandátu.

MandateName

Jméno mandátu.

Payparents

Kolekce pay parentů pro mandát.

PayParentConfig

Třída, do které se naparsuje odpověď komuninakce GetMandateConfiguration.

Konstruktor

Vytvoří instanci GetMandateConfigurationResponse.

Konstruktor(System.String,System.String,System.Collections.Generic.IList{RAConnection.BICA.Configuration})

Vytvoří instanci GetMandateConfigurationResponse.

Configurations

Konfigurace pro Newcert zakódované v Base64.

Name

Jméno pay parenta.

PayParentId

Id pay parenta.

PayParentStock

Třída, která uchovává informace o pay parentovi a zboží, které daný pay parent má k dispozici. Vrací se při zavolání komunikace BICA GetConsignmentStock.

BillingInfo

Fakturační data o plátci.

Id

Id pay parenta.

Name

Jméno pay parenta.

SaleHardware

Seznam hardware, který má daný pay parent k dispozici.

VatCountry

Kód země pro kterou platí DPH (např. CZ).

VatValue

Hodnota DHP jako desetinné číslo na tři desetinná místa (např. 20% je 0.200).

BicaConnector

Třída pro komunikaci se serverem BICA.

Konstruktor(loggerFactory, clientName, httpClient)

Vytvoří novou instanci pro komunikace se systémem BICA.

Name	Description
loggerFactory	Microsoft.Extensions.Logging.ILoggerFactory LoggerFactory pro vytvoření loggerů pro třídu BicaConnector a BaseConnector
clientName	System.String Název aplikace volající systém BICA.
httpClient	System.Net.Http.HttpClient Instance Http klienta, který je využit pro posílání requestů na BICA.

BelongCertificateOperatorAsync(body)

Provede komunikaci BelongCertificateOperator s BICA, která ověří aktuálně používaný certifikát pro podepisování komunikací se systémy I.CA, zda tento certifikát má nastavenou roli operátora RA.

Name	Description
body	RAConnection.BICA.BelongsCertificateOperator.BelongsCertOperatorReq Tělo požadavku. Instanci lze vytvořit pomocí builder třídy BICA.Builders.BelongsCertOperatorReqBuilder.

Exceptions.CAServerException: Vzniká pokud server CA vrátí chybu. Výjimka obsahuje detaily chyby ve vlastnostech Exceptions.CAServerException.Code a System.Exception.Message.

Exceptions.ConnectorRequiredPropBadDataEx: Vzniká pokud není inicializována BaseConnector.ServerUrl, BaseConnector.OperatorSigner nebo BaseConnector.RaCode.

ControlOperatorAsync

Provede komunikaci ControlOperator s BICA, která ověří zda certifikát, který byl použit pro podpis těla http požadavku, má nastavenou roli operátora.

Remarks

Pro úspěšné provolání metody je potřeba mít nastavenou vlastnost BaseConnector.ServerUrl a vlastnost BaseConnector.OperatorSigner.

Exceptions.CAServerException: Vzniká pokud server CA vrátí chybu. Výjimka obsahuje detaily chyby ve vlastnostech Exceptions.CAServerException.Code a System.Exception.Message.

Exceptions.ConnectorRequiredPropBadDataEx: Vzniká pokud není inicializována BaseConnector.ServerUrl, BaseConnector.OperatorSigner nebo BaseConnector.RaCode.

GetCertHolderAsync(body)

Provede komunikace GetCertHolderData s BICA, která na základě dokladu totožnosti vrací evidované uživatele v systému BICA.

Name	Description
body	RAConnection.BICA.GetCertHolderData.GetCertHolderReq Tělo požadavku, specifikují vyhledávací kritéria pro uživatele. Instanci třídy BICA.GetCertHolderData.GetCertHolderReq lze vytvořit pomocí builder třídy BICA.Builders.GetCertHolderReqBuilder.

Returns

Držitelé certifikátu evidované v systému BICA, kteří splňují hledací kritéria. Pokud žádní uživatele nejsou k dispozici je navrácena prázdná kolekce.

Remarks

Pro úspěšné provolání metody je potřeba mít nastavenou vlastnost BaseConnector.ServerUrl a vlastnost BaseConnector.OperatorSigner.

Exceptions.CAServerException: Vzniká pokud server CA vrátí chybu. Výjimka obsahuje detaily chyby ve vlastnostech Exceptions.CAServerException.Code a System.Exception.Message.

Exceptions.ConnectorRequiredPropBadDataEx: Vzniká pokud není inicializována BaseConnector.ServerUrl, BaseConnector.OperatorSigner nebo BaseConnector.RaCode.

GetPayParentsAsync(body)

Provede komunikaci GetPayParents s BICA, která získá seznam plátců, pod kterým je možno vydat danou žádost.

Name	Description
body	RAConnection.BICA.GetPayParents.GetPayParentsReq Tělo požadavku komunikace s informacemi o dané žádosti. Instanci objektu BICA.GetPayParents.GetPayParentsReq lze získat pomocí builder třídy BICA.Builders.GetPayParentsReqBuilder.

Returns

Seznam plátců, které je možné použít pro danou žádost o certifikát.

Remarks

Pro úspěšné provolání metody je potřeba mít nastavenou vlastnost BaseConnector.ServerUrl a vlastnost BaseConnector.OperatorSigner.

Exceptions.CAServerException: Vzniká pokud server CA vrátí chybu. Výjimka obsahuje detaily chyby ve vlastnostech Exceptions.CAServerException.Code a System.Exception.Message.

Exceptions.ConnectorRequiredPropBadDataEx: Vzniká pokud není inicializována BaseConnector.ServerUrl, BaseConnector.OperatorSigner nebo BaseConnector.RaCode.

GetProtocolAsync(body)

Získá protokol o podání žádosti nebo smlouvu o vydání certifikátu ve formátu PDF na základě předaných osobních údajů. Server BICA automaticky vybere šablonu na základě informací o žádosti (typ certifikátu apod.), vloží zaslané údaje do dokumentu a převede dokument do pdf, který je navrácen uživateli.

Name	Description
body	RAConnection.BICA.GetProtocol.GetProtocolReq Data, která se mají vložit do protokolu. Pro vytvoření těla požadavku lze využít třídu BICA.Builders.GetProtocolReqBuilder

Returns

Protokol nebo smlouvu ve formátu PDF vloženou ve objektu BICA.GetProtocol.GetProtocolResp.

Remarks

Pro úspěšné provolání metody je potřeba mít nastavenou vlastnost BaseConnector.ServerUrl a vlastnost BaseConnector.OperatorSigner.

Exceptions.CAServerException: Vzniká pokud server CA vrátí chybu. Výjimka obsahuje detaily chyby ve vlastnostech Exceptions.CAServerException.Code a System.Exception.Message.

Exceptions.ConnectorRequiredPropBadDataEx: Vzniká pokud není inicializována BaseConnector.ServerUrl, BaseConnector.OperatorSigner nebo BaseConnector.RaCode.

GetQscdAsync

Provede komunikaci GetQSCD s BICA.

Returns

Seznam QSCD.

Remarks

Pro úspěšné provolání metody je potřeba mít nastavenou vlastnost BaseConnector.ServerUrl a vlastnost BaseConnector.OperatorSigner.

Exceptions.CAServerException: Vzniká pokud server CA vrátí chybu. Výjimka obsahuje detaily chyby ve vlastnostech Exceptions.CAServerException.Code a System.Exception.Message.

Exceptions.ConnectorRequiredPropBadDataEx: Vzniká pokud není inicializována BaseConnector.ServerUrl, BaseConnector.OperatorSigner nebo BaseConnector.RaCode.

TestConnectionAsync

Otestuje spojení se serverem BICA.

Remarks

Pro úspěšné provolání metody je potřeba mít nastavenou vlastnost BaseConnector.ServerUrl a vlastnost BaseConnector.OperatorSigner.

Exceptions.CAServerException: Vzniká pokud server CA vrátí chybu. Výjimka obsahuje detaily chyby ve vlastnostech Exceptions.CAServerException.Code a System.Exception.Message.

Exceptions.ConnectorRequiredPropBadDataEx: Vzniká pokud není inicializována BaseConnector.ServerUrl.

AddressBuilder

Builder třída pro objekt RAConnection.CA.PutReq.AddressObject.

Constructor

Vytvoří novou instanci builderu.

Build

Vrátí instanci RAConnection.CA.PutReq.AddressObject pokud jsou všechny položky validně vyplněny.

RAConnection.Exceptions.RaReqBadDataEx: Vzniká pokud je některá z povinných položek není vyplněna.

SetCity(city)

Nastaví property City.

Name	Description
city	System.String Město.

SetCountry(country)

Nastaví property Country

Name	Description
country	System.String Kód státu podle ISO-3166

SetStreetNumber(streetNumber)

Nastaví property StreetNumber.

Name	Description
streetNumber	System.String Číslo popisné.

SetStret(stret)

Nastaví property Street.

Name	Description
stret	System.String Ulice.

SetZipCode(zipCode)

Mastaví property ZipCode

Name	Description
zipCode	System.String PSČ

BillingDataBuilder

Builder třída pro objekt RAConnection.CA.PutReq.BillingDataObject.

Constructor

Vytvoří novou instanci Builderu

Build

Zvaliduje povinné položky a vrátí instanci objektu RAConnection.CA.PutReq.BillingDataObject.

RAConnection.Exceptions.RaReqBadDataEx: Vzniká pokud není některá z povinných položek vyplněna.

SetData4Bica(data4Bica)

Nastaví property Data4Bica (nepovinné).

Name	Description
data4Bica	System.String Data pro BICA-

SetData4Storage(data4Storage)

Nastaví property Data4Storage (nepovinné).

Name	Description
data4Storage	System.String Data pro Storage.

SetPackageCode(type, value)

Nastaví property PackageCode (nepovinné).

Name	Description
type	RAConnection.CA.PutReq.PackageCodeType Typ balíčku.
value	System.String Identifikace balíčku.

SetPaymentType(paymentType)

Nastaví property PaymentType.

Name	Description
paymentType	RAConnection.CA.PutReq.BillingDataPaymentType Typ platby.

SetPayParentId(payParentId)

Nastaví property PayParentId.

Name	Description
payParentId	System.String Id plátce.

CancelReqBodyBuilder

Builder třída objektu CanceReqBody.

Constructor

Vytvoří novou instanci builderu.

Build

Zvaliduje povinné položky a vrátí instanci RAConnection.CA.CancelReq.CancelReqBody

Returns

Instanci RAConnection.CA.CancelReq.CancelReqBody

RAConnection.Exceptions.RaReqBadDataEx: Pokud nejsou povinné položky validně vyplněny.

SetRequestId(requestId)

Nastaví číslo žádosti.

Name	Description
requestId	System.String Čáslo žádosti jako string

CompanyBuilder

Builder třída objektu RAConnection.CA.PutReq.CompanyObject.

Constructor

Vytvoří novou instanci builderu.

Build

Zvaliduje povinné položky a vrátí instanci RAConnection.CA.PutReq.CompanyObject.

RAConnection.Exceptions.RaReqBadDataEx: Vzniká pokud není některá z povinných položek správně vyplněna.

SetAddress(address)

Nastaví property Address (nepovinné).

Name	Description
address	RAConnection.CA.PutReq.AddressObject Adresa společnosti.

SetDic(dic)

Nastaví property DIC (nepovinné).

Name	Description
dic	System.String Daňové identifikační číslo.

SetDic2(dic2)

nastaví property DIC2 (nepovinné)

Name	Description
dic2	System.String Druhé daňové identifikační číslo.

SetIC(ic)

Nastaví property IC (nepovinné).

Name	Description
ic	System.String Identifikační číslo

SetName(name)

Nastaví property Name.

Name	Description
name	System.String Jméno společnosti.

GetCert4CardReqBuilder

Builder třída pro vytvoření instance třídy RAConnection.CA.GetCert4Card.GetCert4CardReq.

Constructor

Vytvoří novou instanci builderu.

Build

Zkontroluje zadané hodnoty a vrátí instanci třídy RAConnection.CA.GetCert4Card.GetCert4CardReq.

Returns

Instanci třídy RAConnection.CA.GetCert4Card.GetCert4CardReq.

RAConnection.Exceptions.RaReqBadDataEx: Vzniká pokud není nastavena některá z povinných hodnot.

SetCAServer(caServer)

Nastaví na jakých CA se mají certifikáty vyhledávat.

Name	Description
caServer	RAConnection.CA.GetCert4Card.GetCert4CardCaServer Typ CA.

SetCertificatesToDelete(certsToDelete)

Nastaví certifikáty, které se mají zkontrolovat zda je možné je smazat.

Name	Description
certsToDelete	System.Collections.Generic.List{System.String} Seznam certifikátu ke kontrole.

SetCertValidity(validity)

Nastaví typ platnosti certifikátu.

Name	Description
validity	RAConnection.CA.GetCert4Card.GetCert4CardValidity Typ platnosti certifikátu.

SetDigests(shaOid, digests)

Nastavení hodnoty Digests.

Name	Description
shaOid	System.String OID použitého hashovacího algoritmu.
digests	System.String Jednotlivé hashe.

GetCertReqBodyBuilder

Builder třída pro třídu RAConnection.CA.GetCert.GetCertReqBody

Constructor

Vytvoří novou instanci builderu.

Build

Zkontroluje napnění objektu a vrátí jej.

Returns

Naplněnou instanci objektu RAConnection.CA.GetCert.GetCertReqBody

RAConnection.Exceptions.RaReqBadDataEx: Vzniká, pokud není instance RAConnection.CA.GetCert.GetCertReqBody správně naplněna.

SetCertSN(certSN)

Nastaví parametr sériové číslo certifikátu.

Name	Description
certSN	System.String Sériové číslo stringu

SetKeyDigest(keyDigest)

Nastaví parametr SHA1 otisku klíče

Name	Description
keyDigest	System.String SHA1 otisk klíče jako hexadecimální string

SetReqId(reqId)

Nastaví parametr číslo žádosti.

Name	Description
reqId	System.String Číslo žádosti o certifikát

GetSaveReqReqBuilder

Builder třída pro objekt RAConnection.CA.GetSaveReq.GetSaveReqReq

Constructor

Vyvoří novou instanci builderu.

Build

Zkontroluje předané data vrátí instanci RAConnection.CA.GetSaveReq.GetSaveReqReq.

Returns

Instanci třídy RAConnection.CA.GetSaveReq.GetSaveReqReq.

RAConnection.Exceptions.RaReqBadDataEx: Vzniká, pokud nejsou validně zadány všechny povinné data.

SetReqFileID(reqFileID)

Nastaví property RequestID.

Name	Description
reqFileID	System.String RequestID žádosti.

GetUserCertsReqBuilder

Builder třída pro získání instance třídy RAConnection.CA.GetUserCerts.GetUserCertsReq.

Constructor

Vytvoří novou instanci builderu.

Build

Zvaliduje povinné položky a pokud jsou OK, vrací instanci RAConnection.CA.GetUserCerts.GetUserCertsReq.

Returns

Instanci třídy RAConnection.CA.GetUserCerts.GetUserCertsReq.

RAConnection.Exceptions.RaReqBadDataEx: Vzniká pokud není některá z povinných položek vyplněná.

SetAddBillingType(billingType)

Přidá položku do seznamu CertificateProperties.BillingType (nepovinné).

Name	Description
billingType	System.String Typ certifikátu jako billingtype

SetUserData(userData)

Nastaví property UserData.

Name	Description
userData	RAConnection.CA.GetUserCerts.GetUserCertsUserData Informace o uživateli.

GetUserCertsUserDataBuilder

Builder třída po získání instance třídy RAConnection.CA.GetUserCerts.GetUserCertsUserData.

Constructor

Vytvoří novou instanci builderu.

Build

Zvaliduje povinné položky a pokud jsou všechny OK, vrací instanci RAConnection.CA.GetUserCerts.GetUserCertsUserData..

Returns

Instanci RAConnection.CA.GetUserCerts.GetUserCertsUserData.

RAConnection.Exceptions.RaReqBadDataEx: Vzniká pokud některá z povinných položek není správně vyplněna.

SetBirthDate(birthDate)

Nastaví property BirdDate (nepovinné).

Name	Description
birthDate	System.String Datum narození.

SetBirthNumber(birthNumber)

Nastaví property BirthNumber (nepovinné).

Name	Description
birthNumber	System.String Rodné číslo.

SetDocument(type, value, name)

Nastaví property Document (nepovinné).

Name	Description
type	System.String Typ dokladu (idc, pas, ...)
value	System.String Číslo dokaldu.
name	System.String Název dokladu (nepovinné).

SetName(name)

Nastaví property Name.

Name	Description
name	System.String Křestní jméno.

SetSurname(surname)

Nastaví property Surname.

Name	Description
surname	System.String Přijmení.

KeyAndRequestDataBuilder

Builder třída pro objekt RAConnection.CA.PutReq.KeyAndRequestDataObject.

Constructor

Vytovří novou instanci builderu.

Build

Vytvoří novou instanci RAConnection.CA.PutReq.KeyAndRequestDataObject, pokud jsou všechny vyžadované položky naplněny, jinak vzniká výjimka RAConnection.Exceptions.RaReqBadDataEx

Returns

Novou instanci RAConnection.CA.PutReq.KeyAndRequestDataObject.

RAConnection.Exceptions.RaReqBadDataEx: Vzniká pokud některá z povinných položek není specifikována.

SetCardNumber(cardNumber)

Nastaví property CardNumber (nepovinné).

Name	Description
cardNumber	System.String Číslo karty

SetKeyProvider(keyProvider)

Nastaví property KeyProvider (nepovinné).

Name	Description
keyProvider	System.String Poskytovatel priv. klíče

SetProfile(profile)

Nastaví property Profile (nepovinné).

Name	Description
profile	System.String profil

SetQcsd(use, id)

Nastaví property Qscd (nepovinné).

Name	Description
use	System.Boolean Příznak zda se má použít
id	System.String Id identifikátoru (nepovinné).

SetReqID(reqId)

Nastaví property ReqId.

Name	Description
reqId	System.String Číslo žádosti.

SetReqIDInterconnection(reqIdInterconnection, role, billingType)

Nastaví id párových žádostí (nepovinné).

Name	Description
reqIdInterconnection	System.String Id žádosti.
role	System.String Role dané žádosti.
billingType	System.String Typ žádosti (pouze u prvotních).

SetReqIdTwins(reqIdTwin)

Nastaví property ReqIdTwins (nepovinné).

Name	Description
reqIdTwin	System.String Číslo párové žádosti

SetRequest(request, checkExt, checkEamil)

Nastaví property Request.

Name	Description
request	System.String Data žádosti.
checkExt	System.Nullable{System.Boolean} Příznak, zda se mají kontrolovat rozšíření žádosti.
checkEamil	System.Nullable{System.Boolean} Příznak, zda se má kontrolat přítomnost emailu v žádosti.

SetRequestChanges(reqChanges)

Nastaví property RequestChanges (nepovinné).

Name	Description
reqChanges	System.String Změny zakodované v base64.

SetSSCD(sscd)

Nastaví property SSCD (nepovinné).

Name	Description
sscd	System.String Příznak uložení klíče (povolené hodnoty: EC, SK)

PutRenReqBuilder

Třída pro vytvoření instance RAConnection.CA.PutRenReq.PutRenReqReq.

Constructor

Vytvoří novou instanci builderu.

Build

Zkontroluje povinné položky a vrátí intanci RAConnection.CA.PutRenReq.PutRenReqReq.

Returns

Instanci RAConnection.CA.PutRenReq.PutRenReqReq.

RAConnection.Exceptions.RaReqBadDataEx: Vzniká podud některá v povinných položek není inicializována.

SetBillingData(billingData)

Nastaví property BillingData (nepovinné).

Name	Description
billingData	RAConnection.CA.PutReq.BillingDataObject Údaje pro platební systém.

SetCertProps(certProps)

Nastaví property CertificateProperties.

Name	Description
certProps	RAConnection.CA.PutRenReq.PutRenReqCertProps Nastavení obnovaného certifikátu.

SetKeyAndReqData(keyAndReqData)

Nastaví property KeyAndRequestData.

Name	Description
keyAndReqData	RAConnection.CA.PutReq.KeyAndRequestDataObject Informace o klíči a žádosti.

SetRaReceivedData(raReceivedData)

Nastaví property RaReceivedData.

Name	Description
raReceivedData	System.String Další data přijaté na RA.

SetUserData(userData)

Nastaví property UserData (nepovinné).

Name	Description
userData	RAConnection.CA.PutRenReq.PutRenReqUserData Data o klientovi.

PutRenReqCertPropsBuilder

Builder třída pro získání instance třídy RAConnection.CA.PutRenReq.PutRenReqCertProps

Constructor

Vytvoří novou instanci builderu.

Build

Zkontroluje vyplnění povinných položek a vrátí instanci RAConnection.CA.PutRenReq.PutRenReqCertProps

Returns

Instanci RAConnection.CA.PutRenReq.PutRenReqCertProps

RAConnection.Exceptions.RaReqBadDataEx: Vzniká pokud není některá z povnných položek vyplněná.

SetCertChallengePassword(challengePassword)

Nastaví property CertChallengePassword (nepovinné)

Name	Description
challengePassword	System.String Heslo pro zneplatnněí

SetCertPolicy(policy)

Nastaví property CertPolicy (nepovinné).

Name	Description
policy	System.String Certiifkační politika.

SetCertPublication(publicate)

Nastaví property CertPublication (nepovinné).

Name	Description
publicate	System.Boolean Příznak zda zveřejnit certifikát.

SetCertSend(sendCert)

Nastaví property SendCert (nepovinné).

Name	Description
sendCert	RAConnection.CA.PutReq.PutReqCertPropsSendCert Typ zaslání certifikátu.

SetCertType(certType)

Nastaví property CertType (nepovinné).

Name	Description
certType	System.String Typ certifikátu.

SetCertValidity(validity)

Nastaví property CertValidity (nepovinné)

Name	Description
validity	System.Int32 Platnost certifikátu

SetMpsvik(addMpsvik)

Nastaví příznak MPSVIK (nepovinné).

Name	Description
addMpsvik	System.Boolean příznak zda se má nastavit

SetRenewalCertSN(renewalCertSN)

Nastaví property RenewalCertSN.

Name	Description
renewalCertSN	System.String Sériové číslo podpisového certifikátu v dekadickém tvaru.

SetRenewalDate(date)

Nastaví property RenewalDate (nepovinné).

Name	Description
date	System.DateTime Datum přijetí žádosti na RA.

SetSignCertSN(signCertSN)

Nastaví property SignCertSN.

Name	Description
signCertSN	System.String Sériové číslo podpisového certifikátu v dekadickém tvaru.

PutRenReqUserDataBuilder

Builder třída pro získání instance třídy RAConnection.CA.PutRenReq.PutRenReqUserData.

Constructor

Vytvoří novou instanci builderu.

Build

Vrátí instanci RAConnection.CA.PutRenReq.PutRenReqUserData.

Returns

Instanci RAConnection.CA.PutRenReq.PutRenReqUserData.

SetEmail(email)

Nastaví property Email (nepovinné).

Name	Description
email	System.String Email klienta.

SetLanguage(language)

Nastaví property Language (nepovinné).

Name	Description
language	System.String Jazyk komunikace (cs, en, sk).

SetPhoneNumber(phoneNumber)

Nastaví property PhoneNumber (nepovinné).

Name	Description
phoneNumber	System.String Email klienta.

PutReqCertPropsBuilder

BUilder třída pro objekt RAConnection.CA.PutReq.PutReqCertProps.

Constructor

Vytvoří novou instanci builderu.

Build

Zvaliduje povinné položky a vrátí instanci RAConnection.CA.PutReq.PutReqCertProps.

RAConnection.Exceptions.RaReqBadDataEx: Vzniká pokud některá z povinných položek není vyplněna.

SetCertChallengePassword(challengePassword)

Nastaví property CertChallengePassword.

Name	Description
challengePassword	System.String Heslo pro zneplatnění.

SetCertIssuer(issuer)

Nastaví property Issuer (nepovinné)

Name	Description
issuer	System.String SKID vydavatele certiifkátu.

SetCertPolicy(policy)

Nastaví property CertPolicy (nepovinné).

Name	Description
policy	System.String Certiifkační politika.

SetCertSend(sendCert)

Nastaví property SendCert (nepovinné).

Name	Description
sendCert	RAConnection.CA.PutReq.PutReqCertPropsSendCert Typ zaslání certifikátu.

SetCertTransparency(setTransparency)

Nastaví příznak CertTrasparency (nepovinné).

Name	Description
setTransparency	System.Boolean Příznak, zda se má nastavit.

SetCertType(certType)

Nastaví property CertType.

Name	Description
certType	System.String Typ certifikátu jako billing type.

SetCertValidity(validity)

Nastaví property CertValidity (nepovinné)

Name	Description
validity	System.Int32 Platnost certifikátu

SetMpsvik(addMpsvik)

Nastaví příznak MPSVIK

Name	Description
addMpsvik	System.Boolean příznak zda se má nastavit

SetPsd2(registrarName, registrarId, registrarRoles)

Nastaví property PSD2 (nepovinné).

Name	Description
registrarName	System.String Jméno regitrátora
registrarId	System.String Id registrátora.
registrarRoles	System.Collections.Generic.List{System.String} Role registrátora

SetServerCertSN(serverCertSN)

Nastaví příznak ServerCertSN (nepovinné)

Name	Description
serverCertSN	System.String Sériové číslo serverového certifikátu.

SetSetCertPublication(publicate)

Nastaví příznak CertPublication (nepovinné)

Name	Description
publicate	System.Boolean Příznak, zda má být certifikát vydán jako veřejný.

PutReqReqBuilder

Builder třída pro vytvoření instance třídy RAConnection.CA.PutReq.PutReqReq.

Constructor

Vytvoří novou instanci builderu.

Build

Zvaliduje povinné položky aa vrátí instanci RAConnection.CA.PutReq.PutReqReq.

Returns

Instanci RAConnection.CA.PutReq.PutReqReq.

RAConnection.Exceptions.RaReqBadDataEx: Vzniká pokud je některá z povinných není zadána.

SetBillingData(billingData)

Nastaví property BillingData.

Name	Description
billingData	RAConnection.CA.PutReq.BillingDataObject Údaje o platbě.

SetCertProps(certProps)

Nastaví property CertificateProperties.

Name	Description
certProps	RAConnection.CA.PutReq.PutReqCertProps Informace o nastavení certifikátu.

SetKeyAndRequestData(keyAndRequestData)

Nastaví property KeyAndRequestData.

Name	Description
keyAndRequestData	RAConnection.CA.PutReq.KeyAndRequestDataObject Údaje o klíči a žádosti.

SetRaReceivedData(raReceivedData)

Nastaví property RaReceivedData (nepovinné).

Name	Description
raReceivedData	System.String Dodatečná data přijata na RA (nepovinný).

SetUserData(userData)

Nastaví property UserData.

Name	Description
userData	RAConnection.CA.PutReq.PutReqUserData Údaje o žadateli.

PutReqUserDataBuilder

Builder třída pro vytváření instancí RAConnection.CA.PutReq.PutReqUserData.

Constructor

Vytvoří novou instanci builderu.

Build

Zvaliduje, zda jsou zadány všechny povinné hodnoty a vrátí instnaci RAConnection.CA.PutReq.PutReqUserData.

Returns

Instanci třídy RAConnection.CA.PutReq.PutReqUserData.

RAConnection.Exceptions.RaReqBadDataEx: Vzniká, pokud některá povinná položka není zadána.

SetAddress(address)

Nastaví property Address.

Name	Description
address	RAConnection.CA.PutReq.AddressObject Informace o adrese žadatele.

SetBirthDate(birthDate)

Nastaví property BirthDate (nepovinné).

Name	Description
birthDate	System.String Datum narození žadatele.

SetBirthNumber(birthNumber)

Nastaví property BirthNumber (nepovinné).

Name	Description
birthNumber	System.String Rodné číslo.

SetCompany(company)

Nastaví property Company (nepovinné).

Name	Description
company	RAConnection.CA.PutReq.CompanyObject Informace o společnosti žadatele.

SetDocument(docType, docValue, docCountry)

Nastaví property Document.

Name	Description
docType	System.String Typ primárního dokumentu.
docValue	System.String Číslo primárního dokumentu.
docCountry	System.String Stát vydavatele dokladu

SetDocument2(docType, docValue, docCountry)

Nastaví property Document.

Name	Description
docType	System.String Typ primárního dokumentu.
docValue	System.String Číslo primárního dokumentu.
docCountry	System.String Stát vydavatele dokladu

SetDocumentOther(docOther)

Nastaví property DocumentOther (nepovinné).

Name	Description
docOther	System.String Další dokument žadatele.

SetEmail(email)

Nastaví property Email (nepovinné).

Name	Description
email	System.String Emailová adresa žadatele.

SetLanguage(language)

Nastaví Property Language

Name	Description
language	System.String Jazyk (cs, sk, en)

SetName(name)

Nastaví property Name.

Name	Description
name	System.String Křestní jméno žadatele.

SetPhoneNumber(phoneNumber)

Nastaví property PhoneNumber (nepovinné).

Name	Description
phoneNumber	System.String Telefonní číslo adresa žadatele.

SetSex(sex)

Nastaví property Sex.

Name	Description
sex	System.String Pohlaví žadatele-

SetSurname(surname)

Nastaví property Surname.

Name	Description
surname	System.String Příjení žadatele.

SetTitleAfter(titleAfter)

Nastaví property TitleAfter (nepovinné).

Name	Description
titleAfter	System.String Titul za jménem.

SetTitleBefore(titleBefore)

Nastaví property TitleBefore (nepovinné).

Name	Description
titleBefore	System.String Titul před jménem.

RevokeCertReqBuilder

Builder třída pro vytvoření instance třídy RAConnection.CA.RevokeCert.RevokeCertReq.

Constructor

Vytvoří novou instanci builderu.

Build

Zvaliduje povinné položky a vrátí instanci třídy RAConnection.CA.RevokeCert.RevokeCertReq.

Returns

Instanci RAConnection.CA.RevokeCert.RevokeCertReq.

RAConnection.Exceptions.RaReqBadDataEx: Vzniká pokud některá z povinných polí nejsou vyplněná.

SetCertChallengePassword(challengePassword)

Nastaví property CertChallengePassword.

Name	Description
challengePassword	System.String Heslo pro zneplatnění.

SetCertSN(certSN)

Nastaví property CertSN.

Name	Description
certSN	System.String Sériové číslo certifikátu v dekadickém tvaru.

SetCRLReason(crlReason)

Nastaví property CRLReason (nepovinné)

Name	Description
crlReason	RAConnection.CA.RevokeCert.CrlReasons Důvod zneplatnněí.

TestConReqBuilder

Builder třída pro vytvoření instance RAConnection.CA.TestCon.TestConReq.

Constructor

Vytvoří novou instanci builderu.

AddTestedSystem(system)

Přidá položku do seznamu TestedSystems.

Name	Description
system	System.String Systém k otestování.

Build

Zvaliduje naplnění povinných položek a vrátí instanci třídy RAConnection.CA.TestCon.TestConReq.

Returns

Instanci RAConnection.CA.TestCon.TestConReq.

RAConnection.Exceptions.RaReqBadDataEx: Vzniká pokud není některá z povinných položek validně vyplněna.

CancelReqBody

Třída pro element Body

CaRejectInfo

Třída reprezentující element Ok/ReqRejectReason/CA v odpovědi komunikace racom_getcert.

Code

Kód důdovu zamítnutí na CA.

Message

Informace o důvodu zamítnutí na CA.

CertificateObject

Třída reprezentující element OK/Certificate v odpovědi komunikace racom_getcert.

Pem

Certifikát ve formátu X.509 v kódování PEM.

Price

Vždy nula, využit kvůli zpětné kompabilitě.

Type

Typ certifikátu vyjádřený osmímístným dekadickým číslem

GetCertReqBody

Třída reprezentující Body element pro komunikaci racom_getcert.

CertSN

Sériové číslo certifikátu.

KeyDigest

SHA1 hash klíče v hexadecimálním kódování.

ReqID

Číslo žádosti o certifikát.

GetCertRespBody

Třída reprezentující Body/OK element v odpovědi komunikace racom_getcert

Certificate

Data nově vydaného certifikátu. Jsou k dispozici pouze pokud byl certifikát vydán (ReqInfo.State=="certissued").

ReqIDTwin

Číslo žádosti o párový certifikát v dekadickém tvaru.

ReqInfo

Informace o žádosti.

ReqMessage

Dodatečná zpráva k žádosti.

ReqMessageObject

Třída reprezentující element OK/ReqMessage v odpovědi komunikace racom_getcert.

Message

Text zprávy (nepovinné).

Type

Typ zprávy (např. call_opica).

ReqRejectReasonObject

Třída reprezentující element OK/ReqRejectReason v odpovědi komunikace racom_getcert.

BicaRejectInfo

Informace o zamítnutí žádosti na BICA (nepovinný).

CaOpraRejectInfo

Poznámka operátora RA k zamítnutí žádosti (nepovinný).

CaRejectInfo

Důvod zamítnutí na CA.

RequestIdInfo

Třída reprezentující element OK/ReqId v odpovědi komunikace racom_getcert.

RequestId

Id žádosti o certifikát.

State

Stav vydání žádosti.

StateCode

Stav žádosti vyjádřený osmimístným dekacickým číslem.

DigestsObject

Třída reprezentující element Body/Digests v žádosti komunikace getcert4card.

Algorithm

OID použitého hashovacího algoritmu.

Hashes

Hashe v hexadecimálním kódování oddělené znakem '\n'.

GetCert4CardCaServer

Enum pro omezení výběru certifikátu podle CA v komunikaci getcert4card.

All

Všechny CA.

QCA

Kvalifikované CA.

SCA

Komerční CA.

GetCert4CardCertObject

Třída reprezentující element Body/OK/Certificate

CertPem

X509 certifikátu ve formátu PEM.

GetCert4CardReq

Třída reprezentující element Body v komunikaci getcert4card

CAServer

Omezení výběru certifikátu podle serveru CA (nepovinný).

CertificatesToDelete

Seznam certifikátu ve formátu x509 v kódování PEM. Typicky expirované certifikáty, pro které chceme zjistit, zda je můžeme smazat z karty (nepovinný).

CertificateValidity

Omezení výběru certifikátu.

Digests

Thumbrinty klíčů.

GetCert4CardResp

Třída reprezentující element Body/Ok v odpovědi komunikace getcert4card.

CACertificates

CErtifikáty CA ve formátu CMF, které vydaly certifikáty uvedené v elementech Certificate.

Certificates

Certifikáty navrácené z CA.

GetCert4CardValidity

Enum pro specifikaci platnosti certifikátu v komunikaci getcert4card.

All

Všechny certifikáty.

OK

Pouze platné certifikáty.

CertSubject

Třída reprezentující element Subject v komunikaci ICA_getcert.

Oid

OID položky předmětu.

Value

Hodnota položky předmětu.

CertSubjectValue

Třída reprezentující element Subject/Value v komunikaci ICA_getcert.

CaseSensitive

Nastavení zda je hodnota case sensitive

Value

Hodnota předmětu.

GetCertificatesReqBody

Třída reperezentující element Body v komunikaci getcert

AuthorityKeyIdentifier

Hash veřejného klíče certifikátu CA v hesadecimálním kódování (nepovinný).

BillingType

Typ certifikátu (jako billingtype).

Email

Rozšířená položka certifikátu (SAN/rfc822Name) - Email (nepovinný).

Generation

Generace certifikátu (prvotní, následný, vše) (nepovinný).

PayParentID

Číslo aktuálního plátce certifikátu v dekacickém formátu (nepovinný)

ReleaseTimeFrom

Počáteční UTC čas uvolnění certifikátu (nepovinný).

ReleaseTimeTo

Koncový UTC čas uvolnění certifikátu (nepovinný).

SNFrom

Počáteční sériové číslo certifikátu v dekadickém tvaru (nepovinný).

SNTo

Konečné sériové číslo certifikátu v dekacikém tvaru (nepovinný).

Subject

Položka předmětu certifikátu.

Validity

Platnost certifikátu (nepovinný).

WaitingForMandateExtension

Existuje žádost o následný certifikát čekající na prodloužení mandátu? (nepovinný)

CertificatePolicy

Třída pro serializaci elementu CertPolicy v komunikaci getprovcert

BillingType

typ certifikatu, ktery lze vydat podle teto certifikacni politiky

PayParentId

cislo platce za certifikat v decimalnim tvaru

PolicyOid

OID certifikacni politiky, podle ktere muze certifikat vydavatele vydavat certifikaty

ReqKeylength

delka klice z zadosti o certifikat v bitech

ReqSigAlg

OID algorimu podpisu pouziteho v zadosti o certifikat (decimalni cisla oddelena teckou)

GetProvCertResponse

Třída pro deserializaci elementu OK v komunikaci getprovcer

IcaCertificates

certifikaty vydane CA I.CA

NbuSrCertificates

certifikaty vydane CA NBU SR

IcaRootCert

Položka I.CA kořenového nebo mezilehlého certifikátu v komunikace getprovcert.

Cmf

certifikat ve formatu CMF nebo ICF v kodovani Base64

Pem

Certifikat ve formátu X.509 v kódovani PEM

ShortName

Krátký název certifikátu.

IcaRootCerts

Třída pro deserializaci elementu ICA[1] v komunikaci getprovcert.

RootCerts

duveryhodny certifikat CA = certifikat vydavatele ci korenovy certifikat

WwwCerts

webovy certifikat serveru CA ve formatu X.509 v kodovani PEM (Deprecated - od verze 9.0 se nevyskytuje)

NbuCert

Třída pro deserializaci elementu Root a ACA v komunikaci getprovcert

FileName

kratky nazev korenoveho certifikatu

Pem

korenovy certifikat CA ve formatu X.509 v kodovani PEM

NbuSrCerts

Třída pro serializaci elementu NBUSR elementu v komunikaci getprovcert

AcaCertificates

RootCertificates

GetReqIdResp

Třída reprezentující element Body/OK v odpovědi komunikace racom_getreqid.

ReqId

Největší číslo žádosti v dekadickém tvaru.

ReqIdTwin

Největší číslo žádosti o párový certifikát v dekadickém tvaru.

GetSaveReqReq

Třída reprezentující element Body žádosti v komunikaci racom_getsavereq.

ReqFileId

Dekacické číslo identifikující soubor s žádostí o certifikát uložený na CA.

GetSaveReqResp

Třída reprezentující element Body/OK v odpovědi komunikace racom_getsavereq.

Request

Žádost o certifikát v kódování Base64.

CertificatePropertiesObject

Třída reprezentující element Body/CertificateProperties v žádosti komunikace racom_getusercerts.

GetUserCertsCertificate

Třída reprezentující element Body/OK/UserList/User/CertificateList/Certificate v odpovědi komunikace racom_getusercerts.

BillingType

Typ certifikátu jako billing type.

SerialNumber

Sériové číslo certifikátu

X509

Certifikát ve formátu X.509.

GetUserCertsReq

Třída reprezentující element Body v žádosti komunikace racom_getusercerts

GetUserCertsResp

Třída reprezentující element Body/OK v odpovedi komunikace racom_getusercerts.

GetUserCertsUserData

Třída reprezentující element Body/UserData v žádosti komunikace racom_getusercerts.

BirthDate

Datum narození

BirthNumber

ROdné číslo.

Document

Primárníd doklad totožnosti.

Name

Jméno

Surname

Příjmení

GetUserCertsX509Object

Třída reprezentující element Body/OK/UserList/User/CertificateList/Certificate/X509 v odpovědi komunikace racom_getusercerts.

UserObject

Třída reprezentující element Body/OK/UserList/User.

CertificateList

Seznam certiifkátu, kterými disponuje daný klient.

Id

Id uživatele v systému CA.

MatchType

Typ shody uživatelských údajů (1 = shoda dokladů, 2 = Shoda RC, 3 = Shoda jména + příjmení + data narzení)

PutRenReqCertProps

Třída reprezentující element Body/CertificateProperties v žádosti komunikace racom_putrenreq.

CertChallengePassword

Heslo pro zneplatnění (nepovinné).

CertPolicy

OID certifikační politiky, podle které se certiifkát vydá (nepovinné).

CertPublication

Příznak zda se má certifikát zveřejnit (nepovinné).

CertSend

Příznak o zaslání certifikátu (nepovinný).

CertType

Typ certifikátu jako billing type (nepovinný).

CertValidity

Požadovaná platnost certifikátu (nepovinný).

MpsvIk

Příznak žádosti o identifikátor MPSV (nepovinné).

RenewalCertSN

Sériové číslo obnovovaného certifikátu v dekadickém tvaru.

RenewalDate

Datum a čas přijetí žádosti o obnovu na RA (nepovinné)

SignCertSN

Sériové číslo certifikátu v dekacickém tvaru, kterým byla podepsána žádost o obnovu

PutRenReqReq

Třída reprezentující element Body v žádosti komunikace racom_putrenreq.

BillingData

Údaje pro fakturační systém (nepovinné).

CertificateProperties

Nastavení vlasntostí obnovovaného certifikátu.

KeyAndRequestData

Informace o klíčí a žádosti o obnovu.

RaReceivedData

Další data přijaté na RA (nepovinné).

UserData

Údaje klienta (nepovinné, zastaralé).

PutRenReqUserData

Třída reprezentující element Body/UserData v žádosti komunikace racom_putrenreq.

Email

Emailová adresa žadatele (nepovinná).

Language

Jazyk pro komunikaci klientem (cs, sk, en) (nepovinné).

PhoneNumber

Telefonní číslo.

AddressObject

Třída reprezentující element Body/UserData/Address v žádosti komunikace racom_putreq.

City

Město.

Country

Kód státu podle ISO-3166

Street

Ulice.

StreetNumber

Číslo popisné.

ZipCode

PSČ.

BillingDataObject

Třída reprezentující element Body/BillingData žádosti komunikací racom_putreq a racom_putrenreq.

Data4Bica

Data v Base64, která budou předána BICA (nepovinný).

Data4Storage

Data v Base64, která budou předána storage.

PackageCode

Kód balíčku, který je předán klientovi (nepovinný).

PaymentType

Typ úhrady certifikátu.

PayParentID

Id plátce.

BillingDataPaymentType

Typy úhrady certifikátu.

card

Platba kartou.

cash

Platba hotově.

invoice

Platba na fakturu.

CompanyObject

Třída reprezentující element Body/UserData/Company

Address

Adresa společnosti (nepovinný).

DIC

Daňové identifikační číslo (nepovinný).

DIC2

Další daňové identiifkační číslo (nepovinný).

IC

Identiifkační číslo společnosti (nepovinný).

Name

Název společnosti.

DocumentObject

Třída reprezentující element Body/UserData/Document v žádosti komunikace racom_putreq.

Country

Stát, který dokument vydal. 2 zanky dle ISO 3166 (CZ, SK...)

DocumentNumber

Číslo dokumentu.

Name

Název dokumentu (nepovinný).

Type

Typ dokumentu.

KeyAndRequestDataObject

Třída reprezentující element Body/KeyAndRequestData v žádosti komunikací racom_putreq a racom_putrenreq.

CardNumber

Číslo karty (nepovinný).

KeyProvider

Zprostředkovatel pro práci s klíčem (nepovinný).

Profile

Profil žádosti (pouze racom_putreq a nepovinný).

QSCD

Příznak pro uvedení příznaku uložení na bezpečném zařízení.

ReqID

Číslo žádosti.

ReqIDInterconnections

Čísla párových žádostí.

ReqIDTwin

Číslo párové žádosti u TWIN certů (deprecated).

Request

Data žádosti.

RequestChanges

Rozšíření žádosti u obnovy, které nejsou součástí žádosti (pouze racom_putrenreq).

SSCD

Příznak uložení klíče na bezpečném úložišti (DEPRECATED, nepovinný).

PackageCodeObject

Třída reprezentující element Body/BillingData/PackageCode v žádosti komunikace racom_putreq.

Type

Typ zobrazení ceny

Value

Kód balíčku.

PackageCodeType

Typ zobrazení balíčku.

package

Zobrazena jedna cena za vše.

separate

Oddělené zobrazení cen za certifikát a ostatní položky.

Psd2Object

Třída reprezentující element PSD2 v žádosti komunikace racom_putreq.

RegistrarID

Zkratka registrátora.

RegistrarName

Anglický název registrátora (NCA)

RolesOfPSP

Role poskytovatele platebních služeb.

PutRenReqInsert

Třída reprezentující element Body/KeyAndRequestData/RequestCHanges/Insert v žádosti komunikace racom_putreq

Extensions

Rozšíření zakódované v Base64

PutReqCertProps

Třída reprezentující element Body/CertificatePolicies v žádosti komunikace racom_putreq.

CertChallengePassword

Heslo pro zneplatnění.

CertIssuer

SKID vydavatele certifikátu (nepovinný).

CertPolicy

OID certifikační politiky, podle které se certiifkát vydá.

CertPublication

Příznak zveřejnění certifikátu (nepovinný).

CertSend

Příznak o zaslání certifikátu (nepovinný).

CertTransparency

Příznak vložení seznamu SCT (nepovinný).

CertType

Typ certifikátu.

CertValidity

Požadovaná platnost certifikátu (nepovinný).

MpsvIk

Příznak žádosti o identifikátor MPSV.

PSD2

PSD2 údaje (nepovinný)

ServerCertSN

Uvedeno pouze pro urečité typy serverových certů (nepovinný).

PutReqCertPropsSendCert

Enum pro nastavení, zda se má cerrtiifkát zaslat v zipu v komunikacích racom_putreq a racom_putrenreq.

no

Nezasílat certifikát

yes

Zaslat certifikát.

zip

Zaslat certifikát v ZIP souboru.

PutReqReq

Třída reprezentující element Body v žádosti komunikace racom_putreq.

BillingData

Údaje pro fakturační systém.

CertificateProperties

Informace o požadovaných vlastnostech certifikátu.

KeyAndRequestData

Informace o klíči a žádosti.

RaReceivedData

Žádost o certifikát + další informace (nepovinný).

UserData

Informace o žadateli.

PutReqReqChanges

Třída reprezentující element Body/KeyAndRequestData/RequestChanges v žádosti komunikace racom_putreq.

Insert

Položky, které nejso součásti v elemenentu Body/KeyAndRequestData/Request.

PutReqRequestObject

Třída reprezentující element Body/KeyAndRequestData/Request v žádosti komunikací racom_putreq a racom_putrenreq.

CheckEmailDisposition

Příznak, zda se má kontrolovat přitomnost emailové adresy v žádosti.

CheckExt

Příznak zda se mají kontrolovat rozšíření žádosti.

RequestData

Data žádosti v kódování Base64.

PutReqUserData

Třída reprezentující element Body/UserData žádosti komunikace racom_putreq.

Address

Adresa trvalého bydliště.

BirthDate

Datum narození.

BirthNumber

Rodné číslo.

Company

Informace o společnosti (nepovinný).

Document

Informace o primárním dokladu totožnosti.

Document2

Informace o dalším dokumentu.

DocumentOther

Další doklad totožnosti.

Email

Email.

Language

Jazyk pro komunikaci s klientem.

Name

Jméno.

PhoneNumber

Telefonní číslo (Nepovinné).

Sex

Pohlaví Je potřeba zadávat pouze pro certifikáty, které budou mít IK MPSV. Hodnoty (M - muž, F - žena) Výchozí hodnota je "M".

Surname

Příjmení.

TitleBefore

Titul před jménem (nepovinný).

TitleBehind

Titul za jménem (nepovinný).

QscdObject

Třída reprezentující element Body/KeyAndRequestData/QSCD v žádosti komunikací racom_putreq a racom_putrenreq.

Id

Indetifikace bezpečného zařízení

Value

Požadavek na uvedení příznaku uložení na bezpečeném zařízení (yes, no) (nepovinný).

ReqIdInterconnectionObject

Třída reprezentující element Body/KeyAndRequestData/ReqIDInterconnection v žádosti komunikací racom_putreq a racom_putrenreq.

BillingType

Typ párové žádosti (pouze racom_putreq).

PairReqId

Číslo párové žádosti.

Role

Role žádosti ve skupině.

CrlReasons

Důvody zneplantnění certifikátu

CertWasReplaced

Certifikát byl nahrazen.

EndOfUsing

Ukončení používání.

KeyCompromised

Klí byl kompromitován.

NotSpecified

Nespecifikováno.

PermissionRevoked

Oprávnění odvoláno

UserDataChanged

Údaje klienta se změnily.

RevokeCertReq

Třída reprezentující element Body v žádosti komunikace racom_revokecert

CertChallengePassword

Heslo pro zneplatnění certifikátu.

CertSN

Sériové číslo certifikátu v dekadickém tvaru.

CRLReason

Důvod zneplatnění certifikátu (Nepovinné)

TestConReq

Třída reprezentující element Body v žádosti komunikace racom_testcon

TestConResp

Třída obshaující odpověd komunikace testConnection se systémem CA.

TestedSystems

Kolekce testovaných systémů.

TestedSystemResp

Třída reprezentující element Body/OK/TestedSystem v odpovědi komunikace racom_testcon

Status

Status testovaného systému.

System

Jméno testovaného systému.

CaConnector

Třída implementující dostupné komunikace se systémem CA.

Constructor(httpClient, loggerFactory, clientName, getReqIdCache, getCertCache, getProvCertCache)

Vytvoří novou instanci třídy CaConnector.

Name	Description
httpClient	System.Net.Http.HttpClient Instance HttpClienta, který je využit pro odesílání requestů na CA.
loggerFactory	Microsoft.Extensions.Logging.ILoggerFactory Logger facroy pro vytvoření loggerů.
clientName	System.String Název klienta volající systém CA (např icara v4.92.0.0)
getReqIdCache	RAConnection.Abstraction.Cache.IGetReqIdCache Služba pro cachování dotazů getReqId (výchozí implementace cachování do paměti je implementována ve třídě Common.Cache.MemoryGetReqIdCache nebo lze vytvořit vlastní implementaci pomocí implementace rozhraní Abstraction.Cache.IGetReqIdCache).
getCertCache	RAConnection.Abstraction.Cache.IGetCertCache Služba pro cachování dotazů getCert (lze využít výchozí implementaci cachování do paměti pomocí Common.Cache.MemoryGetCertCache nebo lze vytvořit vlastní implementací rozhraní Abstraction.Cache.IGetCertCache).
getProvCertCache	RAConnection.Abstraction.Cache.IGetProvCertCache Služba pro cachování getProvCertOdpovědí (lze využít výchozí implementaci cachování do souborů pomocí Common.Cache.FileGetProvCertCache nebo lze vytvořit vlastní implementací pomocí rozhraní Abstraction.Cache.IGetProvCertCache)

CancelReqAsync(requestId)

Provede komunikaci s CA pro zrušení zpracování žádosti.

Name	Description
requestId	System.String Číslo žádosti (v číselném tvaru - 13 číslic, např. 4848480001234).

Remarks

Pro úspěšné provolání metody je potřeba mít nastavenou vlastnost BaseConnector.ServerUrl a vlastnostBaseConnector.OperatorSigner.

Exceptions.CAServerException: Vzniká pokud server CA vrátí chybu. Výjimka obsahuje detaily chyby ve vlastnostech Exceptions.CAServerException.Code System.Exception.Message.

Exceptions.ConnectorRequiredPropBadDataEx: Vzniká pokud není inicializována BaseConnector.ServerUrl, BaseConnector.OperatorSigner nebo BaseConnector.RaCode.

ClearRequestCacheAsync

Vyčistí dotazy uložené v cache. Mělo by se volat při změně operátorského certifikátu.

GETCERT_STATE_CERTISSUED

Hodnota stavu v komunikaci GetCert, pokud byl certifikát vydán.

GETCERT_STATE_INPROCESS

Hodnota stavu v komunikaci GetCert, pokud se certifikát ještě vydává.

GETCERT_STATE_REJECTED

Hodnota stavu v komunikaci GetCert, pokud byl certifikát zamítnut.

GetCert4CardAsync(body)

Provede komunikaci s CA pro získání seznamu vydavatelských certifikátů na kartu Seznam obsahuje nové i zastaralé certifikáty. Lze tedy na kartě díky seznamu odstranit zastaralé certifikáty a naimportovat nové.

Name	Description
body	RAConnection.CA.GetCert4Card.GetCert4CardReq Tělo požadavku pro získání certifikátů na kartu..

Returns

Certifikáty jako CA.GetCert4Card.GetCert4CardResp, nebo výjimku v případě chyby.

Remarks

Pro úspěšné provolání metody je potřeba mít nastavenou vlastnost BaseConnector.ServerUrl a vlastnostBaseConnector.OperatorSigner.

Exceptions.CAServerException: Vzniká pokud server CA vrátí chybu. Výjimka obsahuje detaily chyby ve vlastnostech Exceptions.CAServerException.Code System.Exception.Message.

Exceptions.ConnectorRequiredPropBadDataEx: Vzniká pokud není inicializována BaseConnector.ServerUrl, BaseConnector.OperatorSigner nebo BaseConnector.RaCode.

GetCertCache

Služba pro cachování dotazů getCert.

GetProvCertAsync

Komunikace s CA (případně načtení z cache souboru) pro získání vydavatelských certifikátů

Returns

Seznam vydavatelských certifikátů ICA a NBUSR.

Remarks

Pro úspěšné provolání metody je potřeba mít nastavenou vlastnost BaseConnector.ServerUrl.

Exceptions.CAServerException: Vzniká pokud server CA vrátí chybu. Výjimka obsahuje detaily chyby ve vlastnostech Exceptions.CAServerException.Code System.Exception.Message.

Exceptions.ConnectorRequiredPropBadDataEx: Vzniká pokud není inicializována BaseConnector.ServerUrl.

GetCertificateAsync(body)

Provede komunikaci s CA pro získání certifikátu na základě předaného vyhledávajícího údaje. Tato metoda je využívána při kontrole stavu vydání certifikátu na CA. Odpověď CA.GetCert.GetCertRespBody obsahuje i informace o stavu zpracování certifikátu na CA v objektu CA.GetCert.GetCertRespBody.ReqInfo, pokud je pro vyhledání použit číslo žádosti.

Name	Description
body	RAConnection.CA.GetCert.GetCertReqBody Tělo požadavku pro získání žádosti o certifikát (číslo, žádosti, sn certifikátu nebo SHA1 otisk klíče). Instanci třídy CA.GetCert.GetCertReqBody lze využít builder třídu CA.Builders.GetCertReqBodyBuilder.

Returns

Certifikát jako CA.GetCert.GetCertRespBody, nebo výjimku v případě chyby.

Remarks

Pro úspěšné provolání metody je potřeba mít nastavenou vlastnost BaseConnector.ServerUrl a vlastnostBaseConnector.OperatorSigner.

Exceptions.CAServerException: Vzniká pokud server CA vrátí chybu. Výjimka obsahuje detaily chyby ve vlastnostech Exceptions.CAServerException.Code System.Exception.Message.

Exceptions.ConnectorRequiredPropBadDataEx: Vzniká pokud není inicializována BaseConnector.ServerUrl, BaseConnector.OperatorSigner nebo BaseConnector.RaCode.

GetProvCertCache

Služba pro cachování odpovědí getProvCert.

GetReqIdAsync

Provede komunikaci s CA pro získání posledního použitého čísla žádosti evidovaného na CA. Pro rezervování čísla žádosti pro novou žádost je potřeba získanou hodnotu zvýšit o jedna.

Returns

Poslední evidované číslo žádosti jako CA.GetReqId.GetReqIdResp, nebo výjimku v případě chyby.

Remarks

Pro úspěšné provolání metody je potřeba mít nastavenou vlastnost BaseConnector.ServerUrl a vlastnostBaseConnector.OperatorSigner.

Exceptions.CAServerException: Vzniká pokud server CA vrátí chybu. Výjimka obsahuje detaily chyby ve vlastnostech Exceptions.CAServerException.Code System.Exception.Message.

Exceptions.ConnectorRequiredPropBadDataEx: Vzniká pokud není inicializována BaseConnector.ServerUrl, BaseConnector.OperatorSigner nebo BaseConnector.RaCode.

GetReqIdCache

Služba pro cachování dotazů getReqId.

GetSaveReqAsync(fileReqID)

Provede komunikaci getSaveReq s CA, která na základě ID souboru žádosti (odlišné jako ID žádosti) vrátí žádost o certifikát.

Name	Description
fileReqID	System.String ID souboru se žádostí

Returns

Vrací žádost jako CA.GetSaveReq.GetSaveReqResp nebo výjimku v případě chyby.

Remarks

Pro úspěšné provolání metody je potřeba mít nastavenou vlastnost BaseConnector.ServerUrl a vlastnostBaseConnector.OperatorSigner.

Exceptions.CAServerException: Vzniká pokud server CA vrátí chybu. Výjimka obsahuje detaily chyby ve vlastnostech Exceptions.CAServerException.Code System.Exception.Message.

Exceptions.ConnectorRequiredPropBadDataEx: Vzniká pokud není inicializována BaseConnector.ServerUrl, BaseConnector.OperatorSigner nebo BaseConnector.RaCode.

GetUserCertsAsync(body)

Provede komunikaci getUserCerts, která na základě osobních údajů prohledá evidenci uživatelů na CA a vrací základní informace o uživatelích a jejich certifikátech, kterými disponují.

Name

Description

body

RAConnection.CA.GetUserCerts.GetUserCertsReq Vyhledávací parametry pro specifikaci typu certifikátu, který se má vrátit a údaje o uživateli zapouzdřené do třídy CA.GetUserCerts.GetUserCertsReq. Instanci této třídy lze sestavit pomocí builder třídy CA.Builders.GetUserCertsReqBuilder. Instanci třídy pro specifikaci osobních údajů uživatele CA.GetUserCerts.GetUserCertsUserData lze vytvořit pomocí builder třídy CA.Builders.GetUserCertsUserDataBuilder.

Returns

Vrací kolekci nalezených uživatelů a jejich certifikátů kterými disponují.

Remarks

Pro úspěšné provolání metody je potřeba mít nastavenou vlastnost BaseConnector.ServerUrl a vlastnostBaseConnector.OperatorSigner.

Exceptions.CAServerException: Vzniká pokud server CA vrátí chybu. Výjimka obsahuje detaily chyby ve vlastnostech Exceptions.CAServerException.Code System.Exception.Message.

Exceptions.ConnectorRequiredPropBadDataEx: Vzniká pokud není inicializována BaseConnector.ServerUrl, BaseConnector.OperatorSigner nebo BaseConnector.RaCode.

PutRenReqAsync(body)

Provede komunikaci putRenReq, která slouží pro odeslání žádosti o následný certifikát na systém CA.

Name

Description

body

RAConnection.CA.PutRenReq.PutRenReqReq Žádost o následný certifikát a další metadata potřebná pro vystavení následného certifikátu. Instanci třídy CA.PutRenReq.PutRenReqReq lze vytvořit pomocí builder třídy CA.Builders.PutRenReqBuilder. Pro jednotlivé vlastnosti, které jsou součástí třídy CA.PutRenReq.PutRenReqReq jsou dostupné také builder třídy: CA.PutReq.KeyAndRequestDataObject = CA.Builders.KeyAndRequestDataBuilder, CA.PutRenReq.PutRenReqCertProps = CA.Builders.PutRenReqCertPropsBuilder, CA.PutReq.BillingDataObject = CA.Builders.BillingDataBuilder, CA.PutRenReq.PutRenReqUserData = CA.Builders.PutRenReqUserDataBuilder.

Remarks

Pro úspěšné provolání metody je potřeba mít nastavenou vlastnost BaseConnector.ServerUrl a vlastnostBaseConnector.OperatorSigner.

Exceptions.CAServerException: Vzniká pokud server CA vrátí chybu. Výjimka obsahuje detaily chyby ve vlastnostech Exceptions.CAServerException.Code System.Exception.Message.

Exceptions.ConnectorRequiredPropBadDataEx: Vzniká pokud není inicializována BaseConnector.ServerUrl, BaseConnector.OperatorSigner nebo BaseConnector.RaCode.

PutReqAsync(body)

Provede komunikaci putReq na CA. Touto funkcí se žádost předá na CA a zahájí se proces vydání certifikátu na straně CA.

Name

Description

body

RAConnection.CA.PutReq.PutReqReq Žádost o certifikát a další metadata, která jsou potřebná pro vydání certifikátu. Instanci třídy CA.PutReq.PutReqReq lze vytvořit pomocí builder třídy CA.Builders.PutReqReqBuilder. Pro typy vlastností, které jsou součástí třídy CA.PutReq.PutReqReq jsou k dispozici také builder třídy: CA.PutReq.KeyAndRequestDataObject = CA.Builders.KeyAndRequestDataBuilder, [CA.PutReq.PutReqCertProps(#putreqcertprops) = CA.Builders.PutReqCertPropsBuilder, CA.PutReq.BillingDataObject = CA.Builders.BillingDataBuilder, CA.PutReq.PutReqUserData = CA.Builders.PutReqUserDataBuilder.

Remarks

Pro úspěšné provolání metody je potřeba mít nastavenou vlastnost BaseConnector.ServerUrl a vlastnostBaseConnector.OperatorSigner.

Exceptions.CAServerException: Vzniká pokud server CA vrátí chybu. Výjimka obsahuje detaily chyby ve vlastnostech Exceptions.CAServerException.Code System.Exception.Message.

Exceptions.ConnectorRequiredPropBadDataEx: Vzniká pokud není inicializována BaseConnector.ServerUrl, BaseConnector.OperatorSigner nebo BaseConnector.RaCode.

RevokeCertAsync(body)

Provede komunikaci revokeCert, která slouží k zneplatnění certifikátu.

Name	Description
body	RAConnection.CA.RevokeCert.RevokeCertReq Údaje potřebné k zneplatnění certifikátu zapouzdřeny do třídy CA.RevokeCert.RevokeCertReq. Instancí třídy lze sestavit pomocí builder třídy CA.Builders.RevokeCertReqBuilder.

Remarks

Pro úspěšné provolání metody je potřeba mít nastavenou vlastnost BaseConnector.ServerUrl a vlastnostBaseConnector.OperatorSigner.

Exceptions.CAServerException: Vzniká pokud server CA vrátí chybu. Výjimka obsahuje detaily chyby ve vlastnostech Exceptions.CAServerException.Code System.Exception.Message.

Exceptions.ConnectorRequiredPropBadDataEx: Vzniká pokud není inicializována BaseConnector.ServerUrl, BaseConnector.OperatorSigner nebo BaseConnector.RaCode.

TestConAsync(body)

Provede komunikaci testCon, která slouží pro otestování dostupností systémů CA.

Name	Description
body	RAConnection.CA.TestCon.TestConReq Parametrizace požadavku na otestování, kdy lze specifikovat části CA, pro které se má provést test dostupnosti. Parametrizace je zapouzdřena do třídy CA.TestCon.TestConReq, je možno vytvořit pomocí builder třídy CA.Builders.TestConReqBuilder.

Returns

Odpověď se stavy testovaných systémů.

Remarks

Pro úspěšné provolání metody je potřeba mít nastavenou vlastnost BaseConnector.ServerUrl a vlastnostBaseConnector.OperatorSigner.

Exceptions.CAServerException: Vzniká pokud server CA vrátí chybu. Výjimka obsahuje detaily chyby ve vlastnostech Exceptions.CAServerException.Code System.Exception.Message.

Exceptions.ConnectorRequiredPropBadDataEx: Vzniká pokud není inicializována BaseConnector.ServerUrl.

FileGetProvCertCache

Základní implementace rozhraní RAConnection.Abstraction.Cache.IGetProvCertCache s ukládáním dat do určeného adresáře do samostatných souborů.

Constructor(cacheDirectoryName, fileExtension)

Vytvoří novou instanci třídy pro cachování odpovědí getProvCert do samostatných souborů.

Name	Description
cacheDirectoryName	System.String Adresář do kterého se mají data ukládat (existence adresáře se kontroluje a případně dojde k jeho vytvoření).
fileExtension	System.String Přípona ukládaného souboru (výchozí hodnota je .xml)

AddToCacheAsync(System.String,System.String)

ClearCacheAsync

RecordMaxAgeInDays

RemoveOldRecordsAsync

TryGetFromCacheAsync(System.String)

MemoryGetCertCache

Základní implementace pro cachování požadavků CA getCert do paměti.

Constructor

Vytvoří novou instanci.

AddToCacheAsync(System.String,System.String,System.String,System.String,System.String)

ClearCacheAsync

TryGetFromCacheAsync(System.String,System.String,System.String,System.String)

TryRemoveFromCacheAsync(System.String,System.String,System.String,System.String)

MemoryGetReqIdCache

Výchozí implementace cachování getreqid dotazů, které se ukládají pouze do paměti

Constructor

Konstruktor.

AddToCacheAsync(System.String,System.String)

ClearCacheAsync

TryGetFromCacheAsync(System.String)

DefaultOperatorSigner

Výchozí implementace tvorby Pkcs#7 využívající win crypto api a BouncyCastle.

Constructor(System.Security.Cryptography.X509Certificates.X509Certificate2)

Vytvoří novou instanci výchozího PKCS#7 builderu

SignRequestData(System.Byte[])

SignRequestDataAsync(System.Byte[])

CAServerException

Výjimka vykytující se pokud nastane chyba při komunikaci se systémy I.CA

Code

Kód chyby na systému I.CA.

NewData

Data zaslané ze systému I.CA v rámci chyby.

Message

Zpráva o chybě ze systému I.CA.

ConnectorRequiredPropBadDataEx

Výjimka vznikající pokud connector nemá k dispozici potřebné prostředky pro provedení dané funkce.

RaReqBadDataEx

Výjimka vznikající pokud nejsou v builderu nastavena vyžadovaná data

PutCertAgreementReqBuilder

Builder třída pro vytvoření instance třídy RAConnection.Storage.PutCertificateAgreement.PutCertAgreementReq.

Constructor

Vytvoří novou instanci builderu.

Build

Zvaliduje povinné položky a vrátí instanci třídy RAConnection.Storage.PutCertificateAgreement.PutCertAgreementReq.

Returns

Instanci třídy RAConnection.Storage.PutCertificateAgreement.PutCertAgreementReq.

RAConnection.Exceptions.RaReqBadDataEx: Vzniká pokud nekterá z povinných položek není vyplněna.

SetAgreement(data, format, signature)

Nastaví property Agreeement.

Name	Description
data	System.String Data v Base64
format	RAConnection.Storage.PutCertificateRequest.StorageFileFormats Typ formátu dokumentu.
signature	System.String Externí podpis v Base64 (pouze pokud se jedná o externí podpis).

SetApplicantCertificate(sn, akid)

Nastaví property ApplicantCertificate.

Name	Description
sn	System.String Sériové číslo certifikátu.
akid	System.String Akid certifikátu.

SetCertType(certType)

Nastaví property CertType.

Name	Description
certType	System.String Typ certifikátu.

SetConsentOfMpsv(data, format, signature)

Nastaví property ConsentOfIkMpsv (nepovinné).

Name	Description
data	System.String Data v Base64
format	RAConnection.Storage.PutCertificateRequest.StorageFileFormats Typ formátu dokumentu.
signature	System.String Externí podpis v Base64 (pouze pokud se jedná o externí podpis).

SetIssuedCertificate(sn, akid)

Nastaví property IssuedCertificate.

Name	Description
sn	System.String Sériové číslo certifikátu.
akid	System.String Akid certifikátu.

SetOperatorCertificate(sn, akid)

Nastaví property OperatorCertificate.

Name	Description
sn	System.String Sériové číslo certifikátu.
akid	System.String Akid certifikátu.

SetProtocol(data, format, signature)

Nastaví property Protocol.

Name	Description
data	System.String Data v Base64
format	RAConnection.Storage.PutCertificateRequest.StorageFileFormats Typ formátu dokumentu.
signature	System.String Externí podpis v Base64 (pouze pokud se jedná o externí podpis).

SetReqId(reqId)

Nastaví property ReqId

Name	Description
reqId	System.String Číslo žádosti.

PutCertificateRequestReqBuilder

Builder třída pro získání instance třídy RAConnection.Storage.PutCertificateRequest.PutCertificateRequestReq.

Constructor

Vytvoří novou instanci builderu.

Build

Zvaliduje povinné položky a vrátí instanci RAConnection.Storage.PutCertificateRequest.PutCertificateRequestReq.

Returns

Instanci RAConnection.Storage.PutCertificateRequest.PutCertificateRequestReq.

RAConnection.Exceptions.RaReqBadDataEx: Vzniká pokud některá z povninných položek není vyplněna.

SeApplicantCertificate(sn, akid)

Nastaví property ApplicantCertificate (nepovinné, pouze v případě obnovy).

Name	Description
sn	System.String Sériové číslo certifikátu klienta.
akid	System.String Akid certifikátu klienta.

SetAdditionalDocument(type, data, format, signature)

Přidá položku do seznamu Documents (nepovinné).

Name	Description
type	System.String Typ (název dokumentu)
data	System.String Data dokumentu
format	RAConnection.Storage.PutCertificateRequest.StorageFileFormats Formát dokumentu.
signature	System.String Podpis dokumentu (nepovinné, pouze pokud se jedná o externí podpis).

SetCertProfile(certProfile)

Nastaví property CertProfile.

Name	Description
certProfile	System.String Profil žádosti

SetCertType(certType)

Nastaví property CertType.

Name	Description
certType	System.String Typ certifikátu.

SetOperatorCertificate(sn, akid)

Nastaví property OperatorCertificate.

Name	Description
sn	System.String Sériové číslo certifikátu operátora.
akid	System.String Akid operátorského certifikátu.

SetPayParent(payparent)

Nastaví property PayParent.

Name	Description
payparent	System.String ID payparenta.

SetProtocol(data, format, signature)

Přidá položku PROTOCOL do seznamu Documents.

Name	Description
data	System.String Data dokumentu
format	RAConnection.Storage.PutCertificateRequest.StorageFileFormats Formát dokumentu.
signature	System.String Podpis dokumentu (nepovinné, pouze pokud se jedná o externí podpis).

SetReqId(id)

Nastaví property ReqID.

Name	Description
id	System.String Id žádosti.

PutCertAgreementReq

Třída reprezentující element Body v žádosti komunikace storage PutCertificateAgreement.

Aggreement

Smlouva o vydání certifikátu.

ApplicantCertificate

Informace o certifikátu žadatele.

CertType

Typ certifikátu.

ConsentOfMpsv

Souhlas o vzdání se Ik MPSV (nepovinné).

IssuedCertificate

Informace o certifikátu klienta.

OperatorCertificate

informace o certifikátu operátora.

ReqId

Číslo žádosti o certifikát.

CertInfoObject

Třída reprezentující element Body/ApplicantCertificate nebo Body/OperatorCertificate v žádosti komunikace storage PutCertificateRequest.

Akid

Akid certifikátu

SerialNumber

Sériové číslo certifikátu.

PutCertificateRequestReq

Třída reprezentující element Body žádosti komunikace storage PutCertificateRequest.

ApplicantCertificate

Informace o certifikátu žadatele.

CertProfile

Profil certifikátu.

CertType

Typ certifikátu jako billing type.

Documents

Dokumenty, které se mají nahrát na storage.

OperatorCertificate

Informace o certifikátu operátora.

PayParent

Id pay parenta.

ReqId

Id žádosti o certifikát.

StorageDocumentObject

Třída reprezentující element Body/Document v žádosti komunikace storage PutCertificateRequest.

Data

Data souboru v BASE64.

FileFormat

Formát dokumentu.

Signature

Externí podpis v BASE64.

Type

Typ dokumentu.

StorageFileFormats

Dostupné formáty dokumentů na storage.

jpeg

Obrázek ve formátu JPEG.

jpg

Obrázek ve formátu JPG.

pdf

PDF dokument.

png

Obrázek ve formátu PNG.

zip

Data v ZIP archivu.

StorageConnector

Třída obsahující dostupné komunikace se serverem Storage.

Constructor(loggerFactory, clientName, httpClient)

Konstruktor pro vytvoření nové instance. | Name | Description | | ---- | ----------- | | loggerFactory | Microsoft.Extensions.Logging.ILoggerFactory
Logger factory pro vytvoření loggerů. | | clientName | System.String
Název klientské aplikace, která používá StorageConnector. | | httpClient | System.Net.Http.HttpClient
Instance http klienta, který je používán pro odesílání http požadavků. |

PutCertificateAgreementAsync(body)

Provede komunikaci Storage PutCertificateAgreement, která slouží k přidání el. protokolů vznikající při procesu vydání certifikátu (typicky protokol o podání žádosti a smlouva o vydání certifikátu) pro příslušnou žádost o certifikát.

Name	Description
body	RAConnection.Storage.PutCertificateAgreement.PutCertAgreementReq Tělo požadavku, obsahující potřebné přílohy a informace o certifikátech pro archivaci dat v úložišti. Položky jsou zapouzdřeny ve třídě Storage.PutCertificateAgreement.PutCertAgreementReq, kterou lze vytvořit pomocí builder třídy Storage.Builders.PutCertAgreementReqBuilder](#putcertagreementreqbuilder)

Remarks

Pro úspěšné provolání metody je potřeba mít nastavenou vlastnost BaseConnector.ServerUrl a vlastnostBaseConnector.OperatorSigner.

Exceptions.CAServerException: Vzniká pokud server CA vrátí chybu. Výjimka obsahuje detaily chyby ve vlastnostech Exceptions.CAServerException.Code System.Exception.Message.

Exceptions.ConnectorRequiredPropBadDataEx: Vzniká pokud není inicializována BaseConnector.ServerUrl, BaseConnector.OperatorSigner nebo BaseConnector.RaCode.

PutCertificateRequestAsync(body)

Provede komunikaci Storage PutCertificateRequest, která na úložiště dokumentů žádost pro elektronické vydání certifikátu pro danou žádost a uloží k ní přidané přílohy dokumentů.

Name

Description

body

RAConnection.Storage.PutCertificateRequest.PutCertificateRequestReq Tělo požadavku, obsahující základní informace o žádosti, o certifikátu operátora (a v případě následného certifikátu i klienta) a el. přílohy, které se mají na úložiště archivovat. Tyto informace jsou zapouzdřeny do třídy Storage.PutCertificateRequest.PutCertificateRequestReq, kterou lze získat pomocí builder třídy Storage.Builders.PutCertificateRequestReqBuilder

Remarks

Pro úspěšné provolání metody je potřeba mít nastavenou vlastnost BaseConnector.ServerUrl, vlastnost BaseConnector.OperatorSigner a vlastnost BaseConnector.RaCode.

Exceptions.CAServerException: Vzniká pokud server CA vrátí chybu. Výjimka obsahuje detaily chyby ve vlastnostech Exceptions.CAServerException.Code System.Exception.Message.

Exceptions.ConnectorRequiredPropBadDataEx: Vzniká pokud není inicializována BaseConnector.ServerUrl, BaseConnector.OperatorSigner nebo BaseConnector.RaCode.

TestConnectionAsync

Provede komunikaci TestConnection, která otestuje funkčnost systému Storage

Remarks

Pro úspěšné provolání metody je potřeba mít nastavenou vlastnost BaseConnector.ServerUrl Exceptions.CAServerException: Vzniká pokud server CA vrátí chybu. Výjimka obsahuje detaily chyby ve vlastnostech Exceptions.CAServerException.Code System.Exception.Message.

GetPayParentsBodyObject

Třáda, která vytvoří tělo xml žádosti pro komunikaci GetPayParents.

Constructor

Vytvoří instanci třídy GetPayParentsBodyObject.

CardId

16 místné číslo čipové karty.

CertIdentification

Výčtový typ pro identifikaci žádosti o certifikát v databázi.

Q

Žádost o kvalifikovaný certifikát

S

Žádost o komerční certifikát.

RAConnection.XML.BICA.GetPayParentsBodyObject.CertIssuer

SKID vydavatele certifikátu. Nepovinná položka

RAConnection.XML.BICA.GetPayParentsBodyObject.CertPolicy

OID certifikační autority, na kterou má být poslána žádost. Nepovinná položka.

RAConnection.XML.BICA.GetPayParentsBodyObject.CertType

Typ certifikátu.

RAConnection.XML.BICA.GetPayParentsBodyObject.CertValidity

Platnost certifikátu ve dnech.

RAConnection.XML.BICA.GetPayParentsBodyObject.Hiearchical

Certifikát je v hierarchické struktuře, pokud není uvedeno je v plošné struktuře. Nepovinná položka.

RAConnection.XML.BICA.GetPayParentsBodyObject.IsNextCert

Příznak, který udává zda se jedná o prvotní (false) nebo následný (true) certifikát.

RAConnection.XML.BICA.GetPayParentsBodyObject.MandateId

Id mandátu. Uvedeno pouze pokud je CertType == Q-MA-CZSK

RAConnection.XML.BICA.GetPayParentsBodyObject.PayParentId

Id plátce, na kterého má být vypsána žádost. Nepovinná položka.

RAConnection.XML.BICA.GetPayParentsBodyObject.PreviousCertSn

Sériové číslo předchozího certifikátu. Nepovinná položka.

RAConnection.XML.BICA.GetPayParentsBodyObject.ReqDb

Identifikace DB, kterým bude žádost vydána.

RAConnection.XML.BICA.GetPayParentsBodyObject.ReqDbMaster

Identifikace DB řícící žádosti o certifikát. Nepovinná položka.

RAConnection.XML.BICA.GetPayParentsBodyObject.ReqId

Id žídosti o certiifkát.

RAConnection.XML.BICA.GetPayParentsBodyObject.ReqIdMaster

ID řídící žádosti o certifikát. Nepovinná položka.

RAConnection.XML.BICA.GetPayParentsBodyObject.Request

Žádost o certifikát ve formátu PKCS#10 v kódování PEM.