1.3. Metody webové služby pro čtení a zápis údajů subjektu (WS-EDIT/1)
Metody pro správu dat jsou dostupné jak ve webové službě verze 1.1, tak verze 1.0. Podrobně je syntaxe metod popsána ve schématech:
Metody ve verzi 1.1 se od metod ve verzi 1.0 liší jmenným prostorem (viz Jmenné prostory metod WS-EDIT/1) a přidáním několika nových atributů. Příklady v tomto dokumentu zachycují metody ve verzi 1.1 editačních webové služby; pro verzi 1.0 je potřeba zaměnit xmlns.
Verze |
XMLNS |
Endpoint [1] |
|---|---|---|
1.0 |
http://userportal.novell.com/ws/WS-LA-1.0 |
https://externaleditapi10.caais.gov.cz/spravadat/ws/call/exampleId |
1.1 |
http://userportal.novell.com/ws/WS-LA-1.1 |
https://cert-externaleditapi11.caais.gov.cz/spravadat/ws-edit/1/call/exampleId |
Pokud XSD definuje určité atributy odpovědi jako volitelné, ale CAAIS je nikdy nevrací nebo je vrací vždy prázdné – například protože nejsou obsaženy v jeho datovém modelu – nejsou pro přehlednost v příkladech a seznamech atributů níže uváděny. Atributy označené jako WS 1.1 jsou dostupné jen při využití verze 1.1 webové služby.
1.3.1. Společné typy a hodnoty
Přístupové role jsou uváděny vždy v tečkové notaci <zkratka_ais>.<zkratka_pristupove_role>, například example_ais.example_role_1.
Časová razítka poslední změny (aribut casPosledniZmeny) jsou uváděny celočíselně ve formátu Unix timestamp, tedy jako celý počet sekund od půlnoci 1. ledna 1970 UTC bez ohledu na přestupné sekundy.
Poštovní adresa je složený element, jak je uvedeno v tabulce Popis atributů v adrese.
Název |
Popis |
Atribut z datového modelu |
|---|---|---|
…/addressCode |
Kód adresního místa z RUIAN |
"Adresa"."kód adresy" (Address.addressCode) |
…/street |
Název ulice |
"Adresa"."název ulice" (Address.streetName) |
…/cityCode |
Kód obce |
"Adresa"."Obec"."kód" (Address.Municipality.code) |
…/city |
Název obce |
"Adresa"."Obec"."název" (Address.Municipality.name) |
…/region |
Název kraje |
"Adresa"."Kraj"."název" (Address.Region.name) |
…/postalCode |
PSČ |
"Adresa"."psč" (Address.zipCode) |
…/metropolitanDistrict |
Název městské části nebo městského obvodu (údaj MOMC v RUIAN) |
"Adresa"."název městské části" (Address.cityPartName) |
…/cityPart |
Název části obce nebo katastrálního území hl. m. Prahy |
"Adresa"."název části obce" (Address.municipalityPartName) |
…/houseNumber |
Číslo popisné |
"Adresa"."číslo popisné" (Address.houseNumber) nebo "Adresa"."číslo evidenční" (Address.evidenceNumber) podle toho, které z čísel je vyplněno |
…/sequenceNumber |
Číslo orientační |
"Adresa"."číslo orientační" (Address.sequenceNumber) |
…/buildingType |
V případě budovy s číslem evidenčním je nastaven na hodnotu 2. |
= 2, pokud je vyplněn parametr "Adresa"."číslo evidenční" (Address.evidenceNumber), jinak prázdné |
../pragueDistrict |
Název městského obvodu hl. m. Prahy (údaj MOP v RUIAN) |
"Adresa"."název městského obvodu Praha" (Address.praguePartName) |
1.3.1.1. Aktualizace údajů
Při aktualizaci údajů (update request) se množinové elementy (seznamy) nastavují vždy jako celá množina, nikoli změnově. Je-li N nastavovaná množina a P původní množina, pak prvky v rozdílu N ∖ P jsou přidány a prvky v rozdílu P ∖ N odebrány.
1.3.2. Verze webové služby
1.3.2.1. GetVersion
Metoda GetVersion na základě požadavku GetVersionRequest vrací v odpovědí GetVersionResponse verzi webové služby.
Příklad žádosti GetVersionRequest (verze 1.0)
<GetVersionRequest xmlns="http://userportal.novell.com/ws/WS-LA-1.0"/>
Příklad odpovědi GetVersionResponse (verze 1.0)
<ns2:GetVersionResponse xmlns:ns2="http://userportal.novell.com/ws/WS-LA-1.0">WS-LA-1.0</ns2:GetVersionResponse>
Příklad žádosti GetVersionRequest (verze 1.1)
<GetVersionRequest xmlns="http://userportal.novell.com/ws/WS-LA-1.1"/>
Příklad odpovědi GetVersionResponse (verze 1.1)
<ns2:GetVersionResponse xmlns:ns2="http://userportal.novell.com/ws/WS-LA-1.1">WS-LA-1.1</ns2:GetVersionResponse>
1.3.3. Správa subjektů
1.3.3.1. GetSubject
Metoda GetSubject na základě požadavku GetSubjectRequest vrací v odpovědi GetSubjectResponse údaje daného subjektu (plyne z URL endpointu).
Příklad žádosti GetSubjectRequest
<GetSubjectRequest xmlns="http://userportal.novell.com/ws/WS-LA-1.1"/>
Příklad odpovědi GetSubjectResponse
<GetSubjectResponse xmlns="http://userportal.novell.com/ws/WS-LA-1.1">
<isdsBox></isdsBox>
<name>Digitální a informační agentura</name>
<ico>17651921</ico>
<dic></dic>
<datumVzniku>2023-11-24</datumVzniku>
<preruseniPozastaveni text="Ne">FALSE</preruseniPozastaveni>
<rovmCode>17651921</rovmCode>
<spuuCode></spuuCode>
<rovmPusobnostOd></rovmPusobnostOd>
<rovmPusobnostDo></rovmPusobnostDo>
<rovmPozastaveniOd></rovmPozastaveniOd>
<rovmPozastaveniDo></rovmPozastaveniDo>
<rovmPreruseniOd></rovmPreruseniOd>
<rovmPreruseniDo></rovmPreruseniDo>
<rovmKategorie/>
<pravniForma text="Organizační složka státu">325</pravniForma>
<typInstituce text="Orgán státní správy">11</typInstituce>
<gpsPosition>50.09138450218157 14.475226930564196</gpsPosition>
<contactAddress>
<addressCode>28075820</addressCode>
<street>Na vápence</street>
<cityCode>554782</cityCode>
<city>Praha</city>
<region>Hlavní město Praha</region>
<postalCode>13000</postalCode>
<metropolitanDistrict>Praha 3</metropolitanDistrict>
<cityPart>Žižkov</cityPart>
<houseNumber>915</houseNumber>
<sequenceNumber>14</sequenceNumber>
<pragueDistrict>Praha 3</pragueDistrict>
</contactAddress>
<contactAddressPostalCode>13000</contactAddressPostalCode>
<contactAddressPoBoxCode></contactAddressPoBoxCode>
<deliveryAddress>
<addressCode>21745242</addressCode>
<street>Jugoslávská</street>
<cityCode>554782</cityCode>
<city>Praha</city>
<region>Hlavní město Praha</region>
<postalCode>12000</postalCode>
<metropolitanDistrict>Praha 2</metropolitanDistrict>
<cityPart>Vinohrady</cityPart>
<houseNumber>567</houseNumber>
<sequenceNumber>16</sequenceNumber>
<pragueDistrict>Praha 2</pragueDistrict>
</deliveryAddress>
<deliveryAddressPostalCode>13000</deliveryAddressPostalCode>
<deliveryAddressPoBoxCode></deliveryAddressPoBoxCode>
<email/>
<telephoneNumber>
<item>
<type text="stolní">1</type>
<number>+420225514760</number>
</item>
</telephoneNumber>
<aisRole>
<item text="Systémový administrátor">CAAIS_GUI.sysadmin</item>
</aisRole>
<prijataPusobnostVolby/>
<predanaPusobnostVolby/>
<prijataPusobnostAdmin/>
<predanaPusobnostAdmin/>
<bankAccount/>
<subjectCode></subjectCode>
<spisovaSluzba/>
<spisovaSluzbaUrl></spisovaSluzbaUrl>
<cestaFormulare></cestaFormulare>
<url>
<item>
<type text="oficiální">1</type>
<url>https://dia.gov.cz</url>
<description></description>
</item>
</url>
<isdsBoxState/>
<isOVM text="Ano">TRUE</isOVM>
<zruseno text="Ne">FALSE</zruseno>
<isdsBoxChangeTime></isdsBoxChangeTime>
<casZruseni></casZruseni>
<agendy>
<item agenda="A1721" text="Koordinace činností ve stavu kybernetického nebezpečí" platnostOd="2025-11-01" platnostDo="">CR11428</item>
</cinnostniRole>
<casPosledniZmeny>1766137865399</casPosledniZmeny>
</GetSubjectResponse>
Název |
Popis |
Atribut z datového modelu |
|---|---|---|
isdsBox |
ID hlavní datové schránky |
"Datová schránka"."id datové schránky" (DataBox.dataBoxId) |
name |
Oficiální název subjektu |
"Subjekt"."název" (Subject.name) |
ico |
IČ subjektu |
"Subjekt"."ič" (Subject.identificationNumber) |
dic |
DIČ |
"Subjekt"."dič" (Subject.vatId) |
datumVzniku |
Datum vzniku subjektu |
"Subjekt"."datum vzniku" (Subject.creationDate) |
datumZaniku |
Datum zániku subjektu |
"Subjekt"."datum zániku" (Subject.expirationDate) |
preruseniPozastaveniOd |
Datum přerušení/pozastavení od |
"Subjekt"."datum přerušení/pozastavení od" (Subject.suspensionDateFrom) |
preruseniPozastaveniDo |
Datum přerušení/pozastavení do |
"Subjekt"."datum přerušení/pozastavení do" (Subject.suspensionDateTo) |
preruseniPozastaveni |
Přerušení/pozastavení |
"Subjekt"."přerušení/pozastavení" (Subject.suspended) |
zruseno |
Značí, že subjekt byl zrušen. |
TRUE – pokud "Subjekt"."datum zániku" (Subject.expirationDate) <= sysdate, FALSE – jinak |
casZruseni |
Čas zrušení subjektu. |
"Subjekt"."datum zániku" (Subject.expirationDate) |
isOVM |
Značí, že subjekt je OVM/SPUU, je čerpáno z ROVM |
TRUE – pokud "Subjekt"."Typ subjektu" (Subject.SubjectType) = OVM, FALSE – jinak |
rovmCode |
Kód OVM v ROVM |
"Subjekt"."kód ovm v rovm" (Subject.ovmInRovmCode) |
spuuCode |
Kód SPUU |
"Subjekt"."kód spuú" (Subject.spuuCode) |
rovmPusobnostOd |
Působnost v ROVM od |
"Subjekt"."Rovm"."působnost od" (Subject.Rovm.activityFrom) |
rovmPusobnostDo |
Působnost v ROVM do |
"Subjekt"."Rovm"."působnost do" (Subject.Rovm.activityTo) |
rovmPozastaveniOd |
Pozastavení v ROVM od |
"Subjekt"."Rovm"."pozastavení od" (Subject.Rovm.suspensionFrom) |
rovmPozastaveniDo |
Pozastavení v ROVM do |
"Subjekt"."Rovm"."pozastavení do" (Rovm.suspensionTo) |
rovmPreruseniOd |
Přerušení v ROVM od |
"Subjekt"."Rovm"."přerušení od" (Subject.Rovm.interruptionFrom) |
rovmPreruseniDo |
Přerušení v ROVM do |
"Subjekt"."Rovm"."přerušení do" (Subject.Rovm.interruptionTo) |
rovmKategorie |
Kategorie v ROVM |
"Subjekt"."Rovm"."Kategorie v ROVM" (Subject.Rovm.RovmCategory) |
…/code |
Kód kategorie v ROVM |
"Kategorie v ROVM"."kód" (RovmCategory.code) |
pravniForma |
Kód právní formy subjektu podle číselníku ROS. |
"Subjekt"."Právní forma"."kód" (Subject.LegalForm.code) |
…/text |
Název právní formy (volitelně) |
"Subjekt"."Právní forma"."název" (Subject.LegalForm.name) |
typInstituce |
Typ instituce |
"Subjekt"."Typ instituce"."kód" (Subject.InstitutionType.code) |
…/text |
Název typu instituce (volitelně) |
"Subjekt"."Typ instituce"."název" (Subject.InstitutionType.name) |
gpsPosition |
GPS souřadnice vázané na adresu úřadu |
"Subjekt"."Kontakt"."Adresa"."gps souřadnice x" + "gps souřadnice y" (Subject.Contact.Address.gpsx + gpsy) – vazba "adresa úřadu" (officeAddress) |
contactAddress |
Adresa |
"Subjekt"."Kontakt"."Adresa" (Subject.Contact.Address) – vazba "adresa úřadu" (officeAddress); Společné typy a hodnoty. |
contactAddressPostalCode |
Poštovní směrovací číslo přidělené pro účely úřadu |
"Subjekt"."Kontakt"."psč úřadu" (Subject.Contact.officeZipCode) |
contactAddressPoBoxCode |
Číslo poštovní přihrádky |
"Subjekt"."Kontakt"."p.o. box úřadu" (Subject.Contact.officePoBox) |
deliveryAddress |
Kontaktní poštovní adresa |
"Subjekt"."Kontakt"."Adresa" (Subject.Contact.Address) - vazba "kontaktní poštovní adresa" (contactPostalAddress); Společné typy a hodnoty |
deliveryAddressPostalCode |
Poštovní směrovací číslo kontaktní poštovní adresy přidělené pro účely úřadu |
"Subjekt"."Kontakt"."psč úřadu poštovní adresy" (Subject.Contact.postalAddressZipCode) |
deliveryAddressPoBoxCode |
Číslo poštovní přihrádky kontaktní poštovní adresy |
"Subjekt"."Kontakt"."p.o. box úřadu poštovní adresy" (Subject.Contact.postalAdressPoBox) |
Seznam kontaktních e-mailů |
"Subjekt"."Kontakt"."Email" (Subject.Contact.Email) |
|
…/type |
Kód typu emailu |
"Email"."Typ emailu"."kód" (Email.EmailType.code) |
…/text |
Název typu emailu |
"Email"."Typ emailu"."název" (Email.EmailType.name) |
Emailová adresa |
"Email"."adresa" (Email.address) |
|
…/description |
Poznámka |
"Email"."poznámka" (Email.note) |
telephoneNumber |
Seznam kontaktních telefonních čísel |
"Subjekt"."Kontakt"."Telefon" (Subject.Contact.PhoneNumber) |
…/type |
Kód typu telefonu |
"Telefon"."Typ Telefonu"."kód" (PhoneNumber.PhoneNumberType.code) |
…/text |
Název typu telefonu |
"Telefon"."Typ Telefonu"."název" (PhoneNumber.PhoneNumberType.name) |
…/number |
Telefonní číslo |
"Telefon"."hodnota" (PhoneNumber.value) |
bankAccount |
Bankovní spojení. Obsahuje 4-číselný kód banky a číslo účtu. |
"Subjekt"."Bankovní spojení" (Subject.BankAccount) |
…/number |
Číslo účtu |
"Bankovní spojení"."číslo účtu" (BankAccount.number) |
…/bankCode |
Kód banky |
"Bankovní spojení"."kód banky" (BankAccount.bankCode) |
…/description |
Popis |
"Bankovní spojení"."popis" (BankAccount.description) |
Url |
WWW odkaz. |
"Subjekt"."Url WWW" (Subject.WwwUrl) |
…/url |
URL adresa |
"Url WWW"."url" (WwwUrl.url) |
…/description |
Poznámka |
"Url WWW"."poznámka" (WwwUrl.note) |
…/type |
Kód typu URL |
"Url WWW"."Typ URL"."kód" (WwwUrl.UrlType.code) |
…/text |
Název typu URL |
"Url WWW"."Typ URL"."název" (WwwUrl.UrlType.name) |
isdsBoxState |
Stav hlavní datové schránky subjektu. |
"Subjekt"."Datová schránka"."stav datové schránky" (Subject.DataBox.dataBoxState) |
isdsBoxChangeTime |
Čas poslední změny datové schránky. |
"Subjekt"."Datová schránka"."čas poslední změny" (Subject.DataBox.lastChangeTime) |
prijataPusobnostVolby |
Seznam veřejnoprávních smluv s obcemi, které přenesly svoji působnost na subjekt. |
"Působnost" (Authority) pro ty působnosti, pro které je daný subjekt „cílovým subjektem“ a kde „Typ působnosti“ = „Pro volby“ |
…/subject |
Zkratka obce (jiného subjektu), který přenesl svoji působnost na subjekt. |
"Působnost"."Subjekt"."zkratka" (Authority.Subject.shortcut) takového subjektu, na nějž směřuje vazba "zdrojový subjekt" |
…/contract |
Číslo uzavřené veřejnoprávní smlouvy. |
"Působnost"."číslo smlouvy" (Authority.contractNumber) |
predanaPusobnostVolby |
Seznam veřejnoprávních smluv s obcemi, na které subjekt přenesl svoji působnost. |
"Působnost" (Authority) pro ty působnosti, pro které je daný subjekt „zdrojovým subjektem“ a kde „Typ působnosti“ = „Pro volby“ |
…/subject |
Zkratka obce (jiného subjektu), na který subjekt přenesl svoji působnost. |
"Působnost"."Subjekt"."zkratka" (Authority.Subject.shortcut) takového subjektu, na nějž směřuje vazba "cílový subjekt" |
…/contract |
Číslo uzavřené veřejnoprávní smlouvy. |
"Působnost"."číslo smlouvy" (Authority.contractNumber) |
…/reason |
Důvod předané působnosti. |
"Působnost"."důvod" (Authority.reason) |
prijataPusobnostAdmin |
Seznam veřejnoprávních smluv s obcemi, které přenesly svoji působnost na subjekt. |
"Působnost" (Authority) pro ty působnosti, pro které je daný subjekt „cílovým subjektem“ a kde „Typ působnosti“ = „Lokální administrátor“ |
…/subject |
Zkratka obce (jiného subjektu), který přenesl svoji působnost na subjekt. |
"Působnost"."Subjekt"."zkratka" (Authority.Subject.shortcut) takového subjektu, na nějž směřuje vazba "zdrojový subjekt" |
…/contract |
Číslo uzavřené veřejnoprávní smlouvy. |
"Působnost"."číslo smlouvy" (Authority.contractNumber) |
predanaPusobnostAdmin |
Seznam veřejnoprávních smluv s obcemi, na které subjekt přenesl svoji působnost. |
"Působnost" (Authority) pro ty působnosti, pro které je daný subjekt „zdrojovým subjektem“ a kde „Typ působnosti“ = „Lokální administrátor“ |
…/subject |
Zkratka obce (jiného subjektu), na který subjekt přenesl svoji působnost. |
"Působnost"."Subjekt"."zkratka" (Authority.Subject.shortcut) takového subjektu, na nějž směřuje vazba "cílový subjekt" |
…/contract |
Číslo uzavřené veřejnoprávní smlouvy. |
"Působnost"."číslo smlouvy" (Authority.contractNumber) |
…/reason |
Důvod předané působnosti. |
"Působnost"."důvod" (Authority.reason) |
aisRole |
Seznam rolí pro přístup do aplikací přidělených subjektu |
"Subjekt"."Přístupová role" (Subject.AccessRole) – pouze ty, které jsou aktivní a mají aktivní přiřazení subjektu |
…/item |
Zkratka role |
"Přístupová role"."zkratka" (AccessRole.shortcut); hodnota atributu je ve formátu: <zkratka_ais>.<zkratka_pristupove_role>. |
…/text |
Název role |
"Přístupová role"."název" (AccessRole.name) |
agendy |
Seznam agend z RPP, které se vztahují k agendovým činnostním rolím. |
"Subjekt"."Činnostní role"."Agenda" (Subject.ActivityRole.Agenda) – pouze ty agendy, jejichž činnostní role jsou aktivní a mají aktivní přiřazení subjektu |
…/item |
Kód agendy |
"Agenda"."kód" (Agenda.code) |
…/text |
Název agendy |
"Agenda"."název" (Agenda.name) |
…/platnostOd |
Platnost agendy pro daný subjekt - od |
"Činnostní role"."Činnostní role pro subjekt"."platnost agendy od" (ActivityRole.ActivityRoleForSubject.agendaValidFrom) – vezme se z libovolné činnostních role pro stejný kód agendy (viz atribut níže cinnostniRole.platnostOd) |
…/platnostDo |
Platnost agendy pro daný subjekt – do |
"Činnostní role"."Činnostní role pro subjekt"."platnost agendy do" (ActivityRole.ActivityRoleForSubject.agendaValidTo) – vezme se z libovolné činnostních role pro stejný kód agendy (viz atribut níže cinnostniRole.platnostDo) |
cinnostniRole |
Seznam agendových činnostních rolí z RPP, které si daný subjekt vybral v rámci oznámení působnosti OVM v agendě. |
"Subjekt"."Činnostní role" (Subject.ActivityRole) – pouze ty, které jsou aktivní a mají aktivní přiřazení subjektu |
…/item |
Kód činnostní role |
"Činnostní role"."kód" (ActivityRole.code) |
…/text |
Název činnostní role |
"Činnostní role"."název" (ActivityRole.name) |
…/agenda |
Kód agendy |
"Činnostní role"."Agenda"."kód" (ActivityRole.Agenda.code) |
…/platnostOd |
Platnost činnostní role pro daný subjekt - od |
"Činnostní role"."Činnostní role pro subjekt"."platnost agendy od" (ActivityRole.ActivityRoleForSubject.agendaValidFrom) |
…/platnostDo |
Platnost činnostní role pro daný subjekt - do |
Činnostní role"."Činnostní role pro subjekt"."platnost agendy do" (ActivityRole.ActivityRoleForSubject.agendaValidTo) |
casPosledniZmeny |
Datum a čas poslední změny v údajích subjektu. |
čas poslední změny subjektu v historických tabulkách; Společné typy a hodnoty |
1.3.3.2. UpdateSubject
Metoda UpdateSubject na základě požadavku UpdateSubjectRequest provede změnu údajů daného subjektu a v odpovědi UpdateSubjectResponse se vrací výsledek provedené akce.
Název |
Popis |
Atribut z datového modelu |
|---|---|---|
name |
Oficiální název subjektu |
"Subjekt"."název" (Subject.name) |
typInstituce |
Typ instituce |
"Subjekt"."Typ instituce"."kód" (Subject.InstitutionType.code) |
contactAddress |
Adresa |
"Subjekt"."Kontakt"."Adresa" (Subject.Contact.Address) – vazba "adresa úřadu" (officeAddress); Společné typy a hodnoty. |
contactAddressPostalCode |
Poštovní směrovací číslo přidělené pro účely úřadu |
"Subjekt"."Kontakt"."psč úřadu" (Subject.Contact.officeZipCode) |
contactAddressPoBoxCode |
Číslo poštovní přihrádky |
"Subjekt"."Kontakt"."p.o. box úřadu" (Subject.Contact.officePoBox) |
deliveryAddress |
Kontaktní poštovní adresa |
"Subjekt"."Kontakt"."Adresa" (Subject.Contact.Address) - vazba "kontaktní poštovní adresa" (contactPostalAddress); Společné typy a hodnoty |
deliveryAddressPostalCode |
Poštovní směrovací číslo kontaktní poštovní adresy přidělené pro účely úřadu |
"Subjekt"."Kontakt"."psč úřadu poštovní adresy" (Subject.Contact.postalAddressZipCode) |
deliveryAddressPoBoxCode |
Číslo poštovní přihrádky kontaktní poštovní adresy |
"Subjekt"."Kontakt"."p.o. box úřadu poštovní adresy" (Subject.Contact.postalAdressPoBox) |
Seznam kontaktních e-mailů |
"Subjekt"."Kontakt"."Email" (Subject.Contact.Email); Aktualizace údajů |
|
…/type |
Kód typu emailu |
"Email"."Typ emailu"."kód" (Email.EmailType.code) |
Emailová adresa |
"Email"."adresa" (Email.address) |
|
…/description |
Poznámka |
"Email"."poznámka" (Email.note) |
telephoneNumber |
Seznam kontaktních telefonních čísel |
"Subjekt"."Kontakt"."Telefon" (Subject.Contact.PhoneNumber); Aktualizace údajů |
…/type |
Kód typu telefonu |
"Telefon"."Typ Telefonu"."kód" (PhoneNumber.PhoneNumberType.code) |
…/number |
Telefonní číslo |
"Telefon"."hodnota" (PhoneNumber.value) |
prijataPusobnostVolby |
Seznam veřejnoprávních smluv s obcemi, které přenesly svoji působnost na subjekt. |
"Působnost" (Authority) pro ty působnosti, pro které je daný subjekt „cílovým subjektem“ a kde „Typ působnosti“ = „Pro volby“ |
…/subject |
Zkratka obce (jiného subjektu), který přenesl svoji působnost na subjekt. |
"Působnost"."Subjekt"."zkratka" (Authority.Subject.shortcut) takového subjektu, na nějž směřuje vazba "zdrojový subjekt" |
…/contract |
Číslo uzavřené veřejnoprávní smlouvy. |
"Působnost"."číslo smlouvy" (Authority.contractNumber) |
predanaPusobnostVolby |
Seznam veřejnoprávních smluv s obcemi, na které subjekt přenesl svoji působnost. |
"Působnost" (Authority) pro ty působnosti, pro které je daný subjekt „zdrojovým subjektem“ a kde „Typ působnosti“ = „Pro volby“ |
…/subject |
Zkratka obce (jiného subjektu), na který subjekt přenesl svoji působnost. |
"Působnost"."Subjekt"."zkratka" (Authority.Subject.shortcut) takového subjektu, na nějž směřuje vazba "cílový subjekt" |
…/contract |
Číslo uzavřené veřejnoprávní smlouvy. |
"Působnost"."číslo smlouvy" (Authority.contractNumber) |
…/reason |
Důvod předané působnosti. |
"Působnost"."důvod" (Authority.reason) |
prijataPusobnostAdmin |
Seznam veřejnoprávních smluv s obcemi, které přenesly svoji působnost na subjekt. |
"Působnost" (Authority) pro ty působnosti, pro které je daný subjekt „cílovým subjektem“ a kde „Typ působnosti“ = „Lokální administrátor“ |
…/subject |
Zkratka obce (jiného subjektu), který přenesl svoji působnost na subjekt. |
"Působnost"."Subjekt"."zkratka" (Authority.Subject.shortcut) takového subjektu, na nějž směřuje vazba "zdrojový subjekt" |
…/contract |
Číslo uzavřené veřejnoprávní smlouvy. |
"Působnost"."číslo smlouvy" (Authority.contractNumber) |
predanaPusobnostAdmin |
Seznam veřejnoprávních smluv s obcemi, na které subjekt přenesl svoji působnost. |
"Působnost" (Authority) pro ty působnosti, pro které je daný subjekt „zdrojovým subjektem“ a kde „Typ působnosti“ = „Lokální administrátor“ |
…/subject |
Zkratka obce (jiného subjektu), na který subjekt přenesl svoji působnost. |
"Působnost"."Subjekt"."zkratka" (Authority.Subject.shortcut) takového subjektu, na nějž směřuje vazba "cílový subjekt" |
…/contract |
Číslo uzavřené veřejnoprávní smlouvy. |
"Působnost"."číslo smlouvy" (Authority.contractNumber) |
…/reason |
Důvod předané působnosti. |
"Působnost"."důvod" (Authority.reason) |
1.3.3.3. GetDataboxList
Metoda GetDataboxList na základě požadavku GetDataboxListRequest vrací v odpovědi GetSubjectResponse jednu hlavní datovou schránku daného subjektu.
Příklad žádosti GetDataboxList
<GetDataboxListRequest xmlns="http://userportal.novell.com/ws/WS-LA-1.1"/>
Příklad odpovědi GetDataboxListResponse
<GetDataboxListResponse total="1" xmlns="http://userportal.novell.com/ws/WS-LA-1.1">
<row object-id="6bnaawp">
<name>Ministerstvo vnitra</name>
<street>Nad štolou</street>
<houseNumber>936</houseNumber>
<sequenceNumber>3</sequenceNumber>
<town>Praha</town>
<isdsBoxCreateTime>20240313162345Z</isdsBoxCreateTime>
<isdsBoxChangeTime>1710347025</isdsBoxChangeTime>
</row>
</GetDataboxListResponse>
Název |
Popis |
Atribut z datového modelu |
|---|---|---|
total |
Celkový počet vrácených datových schránek. V případě velkého množství záznamů se vrací jen jejich část. Počáteční záznam pro stránkování je možné určit atributem "start". |
Bude vždy 1, protože v CAAIS je jenom 1 hlavní DS synchronizovaná z ROS. |
object-id |
ID datové schránky. |
"Subjekt"."Datová schránka"."id datové schránky" (Subject.DataBox.dataBoxId) |
name |
Adresa |
"Subjekt"."název" (Subject.name) |
street |
Ulice |
"Subjekt"."Kontakt"."Adresa"."název ulice" (Subject.Contact.Address.streetName) – vazba ze subjektu "adresa úřadu" (officeAddress) |
houseNumber |
Číslo domovní |
<prázdná_hodnota> (neexistuje odpovídající atribut) |
sequenceNumber |
Číslo orientační |
<prázdná_hodnota> (neexistuje odpovídající atribut) |
town |
Město - adresa |
"Subjekt"."Kontakt"."Adresa"."název obce" (Subject.Contact.Address.municipality) – vazba ze subjektu "adresa úřadu" (officeAddress) |
isdsBoxCreateTime |
Čas poslední změny datové schránky. |
"Subjekt"."Datová schránka"." čas poslední změny " (Subject.DataBox. lastChangeTime) |
WS 1.1 isdsBoxChangeTime |
Datum a čas poslední změny v údajích datové schránky. |
čas poslední změny datové schránky v historických tabulkách jako Unix timestamp v sekundách |
1.3.4. Správa uživatelských profilů
1.3.4.1. GetUserList
Metoda GetUserList na základě požadavku GetUserListRequest vrací v odpovědi GetUserListResponse seznam uživatelů (uživatelských profilů) daného subjektu (plyne z URL endpointu). Pro jeden požadavek se vrací maximálně 500 záznamů.
Příklad žádosti GetUserListRequest
<GetUserListRequest xmlns="http://userportal.novell.com/ws/WS-LA-1.1" start="1"/>
Název |
Popis |
|---|---|
start |
Počáteční pozice záznamu, od kterého bude vrácen seznam záznamů. Používá se v případě velkého množství záznamů pro stránkování a výchozí hodnota je 1. |
Příklad odpovědi GetUserListResponse
<GetUserListResponse total="1" xmlns="http://userportal.novell.com/ws/WS-LA-1.1">
<row object-id="humphrey_appleby">
<isPrimaryPerson text="Ano">TRUE</isPrimaryPerson>
<firstname>Humphrey</firstname>
<surname>Appleby</surname>
<loginDisabled text="Ne">FALSE</loginDisabled>
<userAllRole/>
<verejnaOsoba text="Ne">FALSE</verejnaOsoba>
<casPosledniZmeny>+57046-11-08T03:55:46Z</casPosledniZmeny>
</row>
</GetUserListResponse>
Název |
Popis |
Atribut z datového modelu |
|---|---|---|
total |
Celkový počet uživatelů. V případě velkého množství záznamů se vrací jen jejich část. Počáteční záznam pro stránkování je možné určit atributem "start". |
Počet aktivních profilů pod daným subjektem. "Subjekt"."Profil".."Stav profilu" (Subject.Profile.ProfileState) = "Aktivní" |
object-id |
Přihlašovací jméno uživatele. |
"Profil"."uživatelské jméno" (Profile.loginName) |
isPrimaryPerson |
Osoba je statutárním zástupcem orgánu veřejné moci. |
"Profil"."statutární zástupce" (Profile.statutoryRepresentative) |
firstname |
Křestní jméno |
"Profil"."Fyzická osoba"."jméno" (Profile.PhysicalPerson.firstName) |
surname |
Příjmení |
"Profil"."Fyzická osoba"."příjmení" (Profile.PhysicalPerson.lastName) |
loginDisabled |
Příznak, zda je uživatelský účet zablokovaný. Poznámka: V CAAIS nelze uživatelské účty smazat, ale pouze zablokovat. |
"Profil"."Stav profilu" (Profile.ProfileState)
|
userAllRole |
Povolené role uživatele |
neexistuje (v CAAIS se nespravují CzechPoint role v tomto elementu jinak vracené) |
verejnaOsoba |
Příznak, zda se jedná o veřejnou osobu, tzn. může jí Seznam OVM zobrazit |
"Profil"."veřejná osoba" (Profile.publicPerson) |
casPosledniZmeny |
Datum a čas poslední změny údajů uživatele |
čas poslední změny profilu v historických tabulkách jako Unix timestamp v sekundách |
1.3.4.2. GetUser
Metoda GetUser na základě požadavku GetUserRequest vrací v odpovědi GetUserResponse detailní informace o uživateli (uživatelském profilu) z daného subjektu.
Příklad žádosti GetUserRequest
<GetUserRequest object-id="humphrey_appleby" xmlns="http://userportal.novell.com/ws/WS-LA-1.1"/>
Název |
Popis |
Atribut z datového modelu |
|---|---|---|
object-id |
Přihlašovací jméno uživatele. |
"Profil"."uživatelské jméno" (Profile.loginName) |
Příklad odpovědi GetUserResponse
<GetUserResponse xmlns="http://userportal.novell.com/ws/WS-LA-1.1">
<titulPred>Sir</titulPred>
<firstname>Humhrey</firstname>
<surname>Appleby</surname>
<titulZa></titulZa>
<loginDisabled text="Ne">FALSE</loginDisabled>
<identifiedByROB text="Ano">TRUE</identifiedByROB>
<address>
<addressCode>28075820</addressCode>
<street>Na vápence</street>
<cityCode>554782</cityCode>
<city>Praha</city>
<region>Hlavní město Praha</region>
<postalCode>13000</postalCode>
<metropolitanDistrict>Praha 3</metropolitanDistrict>
<cityPart>Žižkov</cityPart>
<houseNumber>915</houseNumber>
<sequenceNumber>14</sequenceNumber>
<pragueDistrict>Praha 3</pragueDistrict>
</address>
<email>
<item>
<type text="oficiální">1</type>
<email>humphrey.appleby@dia.gov.cz</email>
</item>
</email>
<telephoneNumber>
<item>
<type text="stolní">1</type>
<number>+420222333444</number>
</item>
<item>
<type text="mobilní">2</type>
<number>+420777888999</number>
</item>
</telephoneNumber>
<clientCertificate>
<item>
<type text="QUALIFIED">Q</type>
<number>cafe</number>
<issuer>CN=CAAIS_DIA_TEST_ECC_2035, OU=CAAIS, O=DIA, L=Praha, C=CZ</issuer>
</item>
<item>
<type text="QUALIFIED">Q</type>
<number>decaf</number>
<issuer>C=CZ, OID.2.5.4.97=NTRCZ-19122063, O=Správa státních služeb vytvářejících důvěru, CN=NCA SubCA2/RSA 12/2023</issuer>
</item>
</clientCertificate>
<aisRole>
<item text="Administrátor">EXAMPLE.ACCESS</item>
<item text="Národní administrátor">CAAIS_GUI.na</item>
</aisRole>
<function></function>
<verejnaOsoba text="Ne">FALSE</verejnaOsoba>
<poznamka></poznamka>
<agendy>
<item text="Státní služba" platnostOd="2024-02-22">A1761</item>
<item text="Ochrana utajovaných informací a bezpečnostní způsobilost" platnostOd="2024-02-22">A1061</item>
</agendy>
<cinnostniRole>
<item agenda="A1761" text="Výmaz dat státního zaměstnance z rejstříku státních zaměstnanců služebního úřadu" platnostOd="2024-02-22">CR11552</item>
<item agenda="A1761" text="Editace výsledků úřednických zkoušek" platnostOd="2024-02-22">CR11557</item>
<item agenda="A1061" text="Zproštění povinnosti zachovávat mlčenlivost" platnostOd="2024-02-22">CR6205</item>
</cinnostniRole>
<casPosledniZmeny>1766077200001</casPosledniZmeny>
</GetUserResponse>
Název |
Popis |
Atribut z datového modelu |
|---|---|---|
titulPred |
Titul před jménem |
"Profil"."Fyzická osoba"."titul před" (Profile.PhysicalPerson.degreeBefore) |
firstname |
Křestní jméno |
"Profil"."Fyzická osoba"."jméno" (Profile.PhysicalPerson.firstName) |
surname |
Příjmení |
"Profil"."Fyzická osoba"."příjmení" (Profile.PhysicalPerson.lastName) |
titulZa |
Titul za jménem |
"Profil"."Fyzická osoba"."titul za" (Profile.PhysicalPerson.degreeAfter) |
photo |
Fotografie uživatele |
"Fyzická osoba"."fotografie" (PhysicalPerson.photo) |
loginDisabled |
Příznak, zda je uživatelský účet zablokovaný. Poznámka: V CAAIS nelze uživatelské účty smazat, ale pouze zablokovat. |
"Profil"."Stav profilu" (Profile.ProfileState)
|
WS 1.1 isPrimaryPerson |
Značí, že je uživatel statutární zástupce daného subjektu. |
"Profil"."statutární zástupce" (Profile.statutoryRepresentative) |
WS 1.1 identifiedByROB |
Značí, že byl uživatel ztotožněn (nalezeno AIFO v ROB). |
"Profil"."Fyzická osoba"."osoba evidována v rob" (Profile.PhysicalPerson.personInRob) |
address |
Adresa (viz společné typy). |
Soukromá adresa se v CAAIS u uživatele neukládá, dotahuje se tedy adresa ze subjektu pod, kterým je daný profil. "Subjekt"."Kontakt"."Adresa" (Subject.Contact.Address) – vazba "adresa úřadu" (officeAddress) |
Seznam e-mailů. |
Email pro profil je pouze jeden |
|
…/type |
Kód typu emailu |
= 1 (výchozí typ) |
…/text |
Název typu emailu |
= "oficiální" (výchozí typ) |
Emailová adresa |
"Profil"."email" (Profile.email) |
|
telephoneNumber |
Seznam kontaktních telefonních čísel |
"Profil"."Telefon" (Profile.PhoneNumber) |
…/type |
Kód typu telefonu |
"Telefon"."Typ Telefonu"."kód" (PhoneNumber.PhoneNumberType.code) |
…/text |
Název typu telefonu |
"Telefon"."Typ Telefonu"."název" (PhoneNumber.PhoneNumberType.name) |
…/number |
Telefonní číslo |
"Telefon"."hodnota" (PhoneNumber.value) |
clientCertificate |
Seznam certifikátů uživatele |
= "Uživatel"."Certifikát X509" (User. X509Certificate), pokud již uživatel existuje v CAAIS-IdP = Certifikát v pomocné tabulky "Certifikát pro samoztotožnění", pokud ještě uživatel není uložen v CAAIS-IdP. |
…/type |
Kód typu certifikátu
|
= "Certifikát X509"."Typ certifikátu"."kód" (X509Certificate.CertificateType.code), pokud již uživatel existuje v CAAIS-IdP. Jinak = Odpovídající atribut v tabulce "Certifikát pro samoztotožnění". |
…/text |
Název typu certifikátu |
= "Certifikát X509"."Typ certifikátu"."název" (X509Certificate.CertificateType.name), pokud již uživatel existuje v CAAIS-IdP. Jinak = Odpovídající atribut v tabulce "Certifikát pro samoztotožnění". |
…/number |
Sériové číslo certifikátu v dekadickém nebo hexadecimálním tvaru. |
= "Certifikát X509"."sériové číslo" (X509Certificate.serialNumber), pokud již uživatel existuje v CAAIS-IdP. Jinak = Odpovídající atribut v tabulce "Certifikát pro samoztotožnění". |
…/issuer |
Řetězec pro označení vydavatele certifikátu |
= "Certifikát X509"."certifikační autorita" (X509Certificate.certificateAuthority), pokud již uživatel existuje v CAAIS-IdP. Jinak = Odpovídající atribut v tabulce "Certifikát pro samoztotožnění". |
aisRole |
Seznam rolí pro přístup do aplikací |
"Profil"."Přístupová role" (Profile.AccessRole) – pouze ty, které jsou aktivní a mají aktivní přiřazení subjektu Pokud má profil přiřazeny Skupiny rolí nebo Business role dotahují se přes ně odpovídající přístupové role. Dále se dotahují i delegované přístupové role přes "Vazební profil". Hodnota atributu je ve formátu: <zkratka_ais>.<zkratka_pristupove_role> Příklad: testAis1.testRole1 |
…/item |
Zkratka role |
"Přístupová role"."zkratka" (AccessRole.shortcut) |
…/text |
Název role |
"Přístupová role"."název" (AccessRole.name) |
function |
Funkce osoby |
"Profil"."funkce" (Profile.function) |
verejnaOsoba |
Příznak, zda se jedná o veřejnou osobu, tzn. může jí Seznam OVM zobrazit |
"Profil"."veřejná osoba" (Profile.publicPerson) |
poznamka |
Poznámka |
"Fyzická osoba"."poznámka" (PhysicalPerson.note) |
agendy |
Agendy činnostních rolí přiřazených uživateli |
"Profil"."Činnostní role"."Agenda" (Profile.ActivityRole.Agenda) – pouze ty agendy, jejichž činnostní role jsou aktivní a mají aktivní přiřazení subjektu Pokud má profil přiřazeny Skupiny rolí nebo Business role dotahují se přes ně odpovídající činnostní role a agendy. Dále se dotahují i delegované činnostní role a agendy přes "Vazební profil". |
…/item |
Kód agendy |
"Agenda"."kód" (Agenda.code) |
…/text |
Název agendy |
"Agenda"."název" (Agenda.name) |
…/platnostOd |
Platnost agendy pro daný subjekt – od |
"Činnostní role"."Činnostní role pro subjekt"."platnost agendy od" (ActivityRole.ActivityRoleForSubject.agendaValidFrom) – vezme se z libovolné činnostních role pro stejný kód agendy (viz atribut níže cinnostniRole.platnostOd) |
…/platnostDo |
Platnost agendy pro daný subjekt – do |
"Činnostní role"."Činnostní role pro subjekt"."platnost agendy do" (ActivityRole.ActivityRoleForSubject.agendaValidTo) – vezme se z libovolné činnostních role pro stejný kód agendy (viz atribut níže cinnostniRole.platnostDo) |
cinnostniRole |
Agendové činnostní role přiřazené uživateli. |
"Profil"."Činnostní role" (Profile.ActivityRole) – pouze ty, které jsou aktivní a mají aktivní přiřazení subjektu Pokud má profil přiřazeny Skupiny rolí nebo Business role dotahují se přes ně odpovídající činnostní role a agendy. Dále se dotahují i delegované činnostní role a agendy přes "Vazební profil". |
…/item |
Kód činnostní role |
"Činnostní role"."kód" (ActivityRole.code) |
…/text |
Název činnostní role |
"Činnostní role"."název" (ActivityRole.name) |
…/platnostOd |
Platnost činnostní role pro daný subjekt – od |
"Činnostní role"."Činnostní role pro subjekt"."platnost agendy od" (ActivityRole.ActivityRoleForSubject.agendaValidFrom) |
…/platnostDo |
Platnost činnostní role pro daný subjekt – do |
Činnostní role"."Činnostní role pro subjekt"."platnost agendy do" (ActivityRole.ActivityRoleForSubject.agendaValidTo) |
casPosledniZmeny |
Datum a čas poslední změny v údajích uživatele |
čas poslední změny profilu v historických tabulkách |
1.3.4.3. CreateUser
Metoda CreateUser na základě požadavku CreateUserRequest vytvoří nového uživatele (uživatelský profil) v definovaném stavu dle atributu loginDisabled v požadavku (může být „aktivní“ nebo „neaktivní“) a zároveň FO ve stavu „před ztotožněním“ a s parametrem „osoba evidována v ROB“ (personInRob) = „Ne“ pod daným subjektem a v odpovědi CreateUserResponse se vrací výsledek provedené akce. Vzhledem k tomu, že CAAIS vyžaduje při založení nového uživatelského profilu také ztotožnění FO (přidělení AIFO), je po založení profilu odeslána žádost o ztotožnění na zadaný uživatelský e-mail. Až po provedení tohoto ztotožnění je v CAAIS založena platná fyzická osoba a je možné se následně pomocí CAAIS-IdP autentizovat.
CAAIS Internals
- V systému CAAIS se provádí následující kroky:
založení FO ve stavu „Před ztotožněním“ a parametrem „Osoba evidována v ROB“ (personInRob) = „Ne“
založení Profilu ve stavu dle požadavku („Aktivní“ nebo „Neaktivní“)
uložení seznamu certifikátů do pomocné technické tabulky „Certifikát pro samoztotožnění“
odeslání emailu uživateli s odkazem na stránku pro samoztotožnění
Předání dat do CAAIS-IdP se v tuto chvíli ještě neprovádí, to se provádí právě až v metodě IdentifyAgainstRob nebo při samoztotožnění uživatelem.
Metodu je možné volat s prázdným atributem object-id. V takovém případě CAAIS vygeneruje jméno profilu (uživatelské jméno) ve tvaru „jmeno_prijmeni“, respektive „jmeno_prijmeni_#“, kde „#“ je číselný rozlišovač, je-li základní tvar již obsazen. Vygenerované jméno profilu se vrací v odpovědi jako atribut object-id.
Příklad žádosti CreateUserRequest
<CreateUserRequest object-id="humphrey_appleby" xmlns="http://userportal.novell.com/ws/WS-LA-1.1">
<titulPred>Sir</titulPred>
<firstname>Humphrey</firstname>
<surname>Appleby</surname>
<titulZa></titulZa>
<password>password</password>
<email>
<item>
<type>1</type>
<email>humphrey.appleby@maz.gov.cz</email>
</item>
</email>
<telephoneNumber>
<item>
<type>1</type>
<number>+420987654321</number>
</item>
<item>
<type>2</type>
<number>+420777123456</number>
</item>
</telephoneNumber>
<clientCertificate>
<item>
<type>V</type>
<number>cafe</number>
<issuer>CN=CAAIS_DIA_TEST_ECC_2035, OU=CAAIS, O=DIA, L=Praha, C=CZ</issuer>
</item>
</clientCertificate>
<aisRole>
<item>CAAIS_GUI.la</item>
</aisRole>
<cinnostniRole>
<item agenda="A1761">CR11552</item>
</cinnostniRole>
</CreateUserRequest>
Název |
Popis |
Atribut z datového modelu |
|---|---|---|
object-id |
Jméno profilu / přihlašovací jméno uživatele. |
"Profil"."uživatelské jméno" (Profile.loginName) |
titulPred |
Titul před jménem |
"Profil"."Fyzická osoba"."titul před" (Profile.PhysicalPerson.degreeBefore) |
firstname |
Křestní jméno |
"Profil"."Fyzická osoba"."jméno" (Profile.PhysicalPerson.firstName) |
surname |
Příjmení |
"Profil"."Fyzická osoba"."příjmení" (Profile.PhysicalPerson.lastName) |
titulZa |
Titul za jménem |
"Profil"."Fyzická osoba"."titul za" (Profile.PhysicalPerson.degreeAfter) |
password |
Heslo |
neukládá se (neexistuje odpovídající atribut, heslo v CAAIS-IdP si uživatel nastavuje sám zvlášť) |
photo |
Fotografie uživatele |
"Fyzická osoba"."fotografie" (PhysicalPerson.photo) |
loginDisabled |
Příznak, zda je uživatelský účet zablokovaný. Poznámka: V CAAIS nelze uživatelské účty smazat, ale pouze zablokovat. |
"Profil"."Stav profilu" (Profile.ProfileState)
|
Seznam e-mailů. |
Email pro profil je pouze jeden a v seznamu emailů z požadavku se bere jen první s "type" = "1" (jedná se o typ "oficiální"), ostatní se ignorují. |
|
…/type |
Kód typu emailu |
= 1 (výchozí typ); neukládá se (neexistuje odpovídající atribut) |
Emailová adresa |
"Profil"."email" (Profile.email) |
|
telephoneNumber |
Seznam kontaktních telefonních čísel |
"Profil"."Telefon" (Profile.PhoneNumber) |
…/type |
Kód typu telefonu |
"Telefon"."Typ Telefonu"."kód" (PhoneNumber.PhoneNumberType.code) |
…/number |
Telefonní číslo |
"Telefon"."hodnota" (PhoneNumber.value) |
clientCertificate |
Seznam certifikátů uživatele. |
Certifikát v pomocné tabulky "Certifikát pro samoztotožnění". Ukládá se jen typ certifikátu "V" (Komerční), ostatní typy se ignorují. |
…/type |
Kód typu certifikátu
|
Odpovídající atribut v tabulce "Certifikát pro samoztotožnění". |
…/number |
Sériové číslo certifikátu v dekadickém nebo hexadecimálním tvaru. |
Odpovídající atribut v tabulce "Certifikát pro samoztotožnění". |
…/issuer |
Řetězec pro označení vydavatele certifikátu |
Odpovídající atribut v tabulce "Certifikát pro samoztotožnění". |
aisRole |
Seznam rolí pro přístup do aplikací, které mají být přiřazeny uživateli. |
"Profil"."Přístupová role" (Profile.AccessRole) Role se přiřadí k profilu jen tehdy, pokud je role aktivní a má aktivní přiřazení subjektu. Hodnota atributu je ve formátu: <zkratka_ais>.<zkratka_pristupove_role> Příklad: testAis1.testRole1 |
…/item |
Zkratka role |
"Přístupová role"."zkratka" (AccessRole.shortcut) |
cinnostniRole |
Seznam agendových činnostních rolí, které mají být přiřazeny uživateli. |
"Profil"."Činnostní role" (Profile.ActivityRole) Role se přiřadí k profilu jen tehdy, pokud je role aktivní a má aktivní přiřazení subjektu. |
…/item |
Kód činnostní role |
"Činnostní role"."kód" (ActivityRole.code) |
function |
Funkce osoby. |
"Profil"."funkce" (Profile.function) |
verejnaOsoba |
Příznak, zda se jedná o veřejnou osobu, tzn. může jí Seznam OVM zobrazit. |
"Profil"."veřejná osoba" (Profile.publicPerson) |
poznamka |
Poznámka |
"Fyzická osoba"."poznámka" (PhysicalPerson.note) |
Příklad odpovědi CreateUserResponse
<CreateUserResponse object-id="humphrey_appleby" xmlns="http://userportal.novell.com/ws/WS-LA-1.1">OK</CreateUserResponse>
Název |
Popis |
Atribut z datového modelu |
|---|---|---|
object-id |
Jméno vytvořeného profilu / přihlašovací jméno uživatele. |
"Profil"."uživatelské jméno" (Profile.loginName). |
1.3.4.4. UpdateUser
Metoda UpdateUser na základě požadavku UpdateUserRequest provede změnu údajů uživatele (uživatelského profilu) pod daným subjektem a v odpovědi UpdateUserResponse se vrací výsledek provedené akce. Metoda používá stejné elementy jako CreateUserRequest. Uvádí se jen ty elementy, jejichž hodnoty se mění; atribut object-id je povinný a identifikuje měněný profil.
Množinové elementy (například seznam telefonních čísel či seznam přístupových rolí) se nastavují vždy jako celá množina, nikoli změnově. Je-li N nastavovaná množina a P původní množina, pak prvky v rozdílu N ∖ P jsou přidány a prvky v rozdílu P ∖ N odebrány. V případě přístupových rolí (aisRole) jest lze takto měnit přístupové role pouze přiřazené přímo profilu, nikoli přístupové role přiřazené nepřímo prostřednictvím skupiny rolí a organizačních rolí. (Metoda GetUserRequest vrací v seznamu přístupových rolí i role přiřazené nepřímo, které zde nelze odebrat.)
Uživatele (uživatelský profil) není možné smazat, pouze se pomocí atributu loginDisabled může zablokovat (deaktivovat). U osob ztotožněných vůči ROB nelze měnit jméno a příjmení – služba v takovém případě vrátí chybu.
Příklad žádosti UpdateUserRequest
<UpdateUserRequest object-id="humphrey_appleby" xmlns="http://userportal.novell.com/ws/WS-LA-1.1">
<titulPred>Sir</titulPred>
<email>
<item>
<type>1</type>
<email>humphrey.appleby@maz.gov.cz</email>
</item>
</email>
<aisRole>
<item>CAAIS_GUI.la</item>
<item>example_AIS.example_role</item>
</aisRole>
<cinnostniRole>
<item agenda="A1761">CR11552</item>
<item agenda="A1761">CR11560</item>
</cinnostniRole>
</UpdateUserRequest>
Příklad odpovědi UpdateUserResponse
<UpdateUserResponse object-id="humphrey_appleby" xmlns="http://userportal.novell.com/ws/WS-LA-1.1">OK</CreateUserResponse>
1.3.5. Správa zřizovaných organizací
1.3.5.1. GetOrganizationList
Metoda GetOrganizationList na základě požadavku GetOrganizationListRequest vrací v odpovědi GetOrganizationListResponse seznam zřizovaných organizací daného subjektu. Pro jeden požadavek se vrací maximálně 500 záznamů.
Příklad žádosti GetOrganizationListRequest
<GetOrganizationListRequest start="1" xmlns="http://userportal.novell.com/ws/WS-LA-1.1"/>
Název |
Popis |
|---|---|
start |
Počáteční pozice záznamu, od kterého bude vrácen seznam záznamů. Používá se v případě velkého množství záznamů pro stránkování a výchozí hodnota je 1. |
Příklad odpovědi GetOrganizationListResponse
<GetOrganizationListResponse total="2" xmlns="http://userportal.novell.com/ws/WS-LA-1.1">
<row path="" object-path="skola_1">
<name>Škola 1</name>
<casPosledniZmeny>1714482014</casPosledniZmeny>
</row>
<row path="" object-path="skola_2">
<name>Škola 2</name>
<casPosledniZmeny>1714482364</casPosledniZmeny>
</row>
</GetOrganizationListResponse>
Název |
Popis |
Atribut z datového modelu |
|---|---|---|
total |
Celkový počet zřizovaných organizací. V případě velkého množství záznamů se vrací jen jejich část. Počáteční záznam pro stránkování je možné určit atributem "start". |
Počet zřizovaných organizací "Subjekt"."Zřizovaná organizace" (Subject.Organization) |
object-path |
Zkratka zřizované organizace. |
"Zřizovaná organizace"."zkratka" (Organization.shortcut) |
name |
Název zřizované organizace. |
"Zřizovaná organizace"."název" (Organization.name) |
WS 1.1 casPosledniZmeny |
Datum a čas poslední změny v údajích zřizované organizace. |
Čas poslední změny zřizované organizace v historických tabulkách jako Unix timestamp v sekundách |
1.3.5.2. GetOrganization
Metoda GetOrganization na základě požadavku GetOrganizationRequest vrací v odpovědi GetOrganizationResponse údaje zřizované organizace pod daným subjektem.
Příklad žádosti GetOrganizationRequest
<GetOrganizationRequest object-path="skola_1" xmlns="http://userportal.novell.com/ws/WS-LA-1.1"/>
Název |
Popis |
Atribut z datového modelu |
|---|---|---|
object-path |
Zkratka zřizované organizace. |
"Zřizovaná organizace"."zkratka" (Organization.shortcut) |
Příklad odpovědi GetOrganizationResponse
<GetOrganizationResponse xmlns="http://userportal.novell.com/ws/WS-LA-1.1">
<name>Škola 1</name>
<contactAddress/>
<deliveryAddress/>
<email>
<item>
<type text="oficiální">1</type>
<email>info@example.org</email>
<description></description>
</item>
</email>
<telephoneNumber>
<item>
<type text="stolní">1</type>
<number>+420234567890</number>
</item>
</telephoneNumber>
<ico>00112233</ico>
<dic>CZ00112233</dic>
<typOrganizace text="školství">6</typOrganizace>
<bankAccount>
<item>
<number>9876543211</number>
<bankCode>0710</bankCode>
<description></description>
</item>
</bankAccount>
<officesHours>
<item>
<day text="Pondělí">1</day>
<from>08:00</from>
<to>12:00</to>
</item>
<item>
<day text="Pondělí">1</day>
<from>12:30</from>
<to>16:00</to>
<item>
<day text="Pátek">5</day>
<from>08:00</from>
<to>12:00</to>
</item>
</officesHours>
<subjectCode></subjectCode>
<url>
<item>
<type text="oficiální">1</type>
<url>http://www.example.org/</url>
<description></description>
</item>
</url>
<roleCentralniNakup>
<item text="Přístup do centrálního nákupu">ISCN</item>
</roleCentralniNakup>
<zruseno text="Ne">FALSE</zruseno>
<casZruseni></casZruseni>
<casPosledniZmeny>1766850672307</casPosledniZmeny>
</GetOrganizationResponse>
Název |
Popis |
Atribut z datového modelu |
|---|---|---|
name |
Název zřizované organizace. |
"Zřizovaná organizace"."název" (Organization.name) |
contactAddress |
Adresa. |
"Zřizovaná organizace"."Adresa" (Organization.Address) – vazba "adresa zřizované organizace" (organizationAddress); Společné typy a hodnoty. |
deliveryAddress |
Kontaktní poštovní adresa. |
"Zřizovaná organizace"."Adresa" (Organization.Address) – vazba "poštovní adresa zřizované organizace" (deliveryAddress); Společné typy a hodnoty. |
Seznam kontaktních e-mailů. |
"Zřizovaná organizace"."Email" (Organization.Email) |
|
…/type |
Kód typu emailu |
"Email"."Typ emailu"."kód" (Email.EmailType.code) |
…/text |
Název typu emailu |
"Email"."Typ emailu"."název" (Email.EmailType.name) |
Emailová adresa |
"Email"."adresa" (Email.address) |
|
…/description |
Poznámka |
"Email"."poznámka" (Email.note) |
telephoneNumber |
Seznam kontaktních telefonních čísel. |
"Zřizovaná organizace"."Telefon" (Organization.PhoneNumber) |
…/type |
Kód typu telefonu |
"Telefon"."Typ telefonu"."kód" (PhoneNumber.PhoneNumberType.code) |
…/text |
Název typu telefonu |
"Telefon"."Typ telefonu"."název" (PhoneNumber.PhoneNumberType.name) |
…/number |
Telefonní číslo |
"Telefon"."hodnota" (PhoneNumber.value) |
ico |
IČ organizace. |
"Zřizovaná organizace"."ič" (Organization.identificationNumber) |
dic |
DIČ |
"Zřizovaná organizace"."dič" (Organization.vatId) |
typOrganizace |
Typ zřizované organizace. |
"Zřizovaná organizace"."Typ organizace"."kód" (Organization.OrganizationType.code) |
…/text |
Název typu zřizované organizace |
"Zřizovaná organizace"."Typ organizace"."název" (Organization.OrganizationType.name) |
bankAccount |
Bankovní spojení. Obsahuje 4-číselný kód banky a číslo účtu. |
"Zřizovaná organizace"."Bankovní spojení" (Organization.BankAccount) |
…/number |
Číslo účtu |
"Bankovní spojení"."číslo účtu" (BankAccount.number) |
…/bankCode |
Kód banky |
"Bankovní spojení"."kód banky" (BankAccount.bankCode) |
…/description |
Popis |
"Bankovní spojení"."popis" (BankAccount.description) |
officesHours |
Úřední hodiny obsahují den v týdnu (1 pondělí – 7 neděle) a čas (hodinu a minutu ve tvaru HH:MM) začátku a konce úředních hodin. V případě přestávky zadejte den dvakrát (s dopoledním a poté s odpoledním časovým intervalem) |
"Zřizovaná organizace"."Úřední hodiny zřizované organizace" (Organization.OrganizationOfficeHours) |
…/day |
Den v týdnu |
"Úřední hodiny zřizované organizace"."den v týdnu" (OrganizationOfficeHours.day) |
…/from |
Od |
"Úřední hodiny zřizované organizace"."od" (OrganizationOfficeHours.from) |
…/to |
Do |
"Úřední hodiny zřizované organizace"."do" (OrganizationOfficeHours.to) |
subjectCode |
Číslo subjektu, kód ČSU. |
"Zřizovaná organizace"."číslo subjektu" (Organization.subjectCode) |
url |
WWW odkaz |
"Zřizovaná organizace"."Url WWW" (Organization.WwwUrl) |
…/url |
URL adresa |
"Url WWW"."url" (WwwUrl.url) |
…/description |
Poznámka |
"Url WWW"."poznámka" (WwwUrl.note) |
…/type |
Kód typu URL |
"Url WWW"."Typ Url WWW"."kód" (WwwUrl.WwwUrlType.code) |
…/text |
Název typu URL |
"Url WWW"."Typ Url WWW"."název" (WwwUrl.WwwUrlType.name) |
roleCentralniNakup |
Seznam rolí pro přístup do aplikace Centrální nákup. |
"Zřizovaná organizace"."Role centrálního nákupu zřizované organizace" (Organization. OrganizationCentralPurchaseRole) |
…/item |
ID role |
"Role centrálního nákupu zřizované organizace"."kód" (OrganizationCentralPurchaseRole.code) |
…/text |
Název role |
"Role centrálního nákupu zřizované organizace"."název" (OrganizationCentralPurchaseRole.name) |
zruseno |
Značí, že organizace byla zrušena. |
= "Ano", pokud je vyplněn atribut "Zřizovaná organizace"."čas zrušení" (Organization.cancelationTime) <= aktuální datum = "Ne", pokud není vyplněn atribut "Zřizovaná organizace"."čas zrušení" (Organization.cancelationTime) nebo je > aktuální datum |
casZruseni |
Čas zrušení organizace. |
"Zřizovaná organizace"."čas zrušení" (Organization.cancelationTime) |
WS 1.1 casPosledniZmeny |
Datum a čas poslední změny v údajích zřizované organizace. |
Čas poslední změny zřizované organizace v historických tabulkách jako Unix timestamp v sekundách |
1.3.5.3. CreateOrganization
Metoda CreateOrganization na základě požadavku CreateOrganizationRequest vytvoří novou zřizovanou organizaci pod daným subjektem a v odpovědi CreateOrganizationResponse se vrací výsledek provedené akce.
Příklad žádosti CreateOrganizationRequest
<CreateOrganizationRequest xmlns="http://userportal.novell.com/ws/WS-LA-1.1">
<name>Škola 1</name>
<contactAddress>
<addressCode>22552979</addressCode>
</contactAddress>
<email>
<item>
<type>1</type>
<email>info@example.org</email>
</item>
</email>
<telephoneNumber>
<item>
<type>1</type>
<number>+420234567890</number>
</item>
</telephoneNumber>
<ico>11119999</ico>
<dic>CZ11119999</dic>
<typOrganizace>14</typOrganizace>
<bankAccount>
<item>
<number>700222222</number>
<bankCode>0300</bankCode>
<description>hlavní účet</description>
</item>
</bankAccount>
<officesHours>
<item>
<day>1</day>
<from>8:00</from>
<to>12:00</to>
</item>
</officesHours>
<url>
<item>
<type>1</type>
<url>http://www.example.org/</url>
</item>
</url>
</CreateOrganizationRequest>
Název |
Popis |
Atribut z datového modelu |
|---|---|---|
name |
Název zřizované organizace. |
"Zřizovaná organizace"."název" (Organization.name) |
contactAddress |
Adresa. |
"Zřizovaná organizace"."Adresa" (Organization.Address) – vazba "adresa zřizované organizace" (organizationAddress); Společné typy a hodnoty. |
deliveryAddress |
Kontaktní poštovní adresa. |
"Zřizovaná organizace"."Adresa" (Organization.Address) – vazba "poštovní adresa zřizované organizace" (deliveryAddress); Společné typy a hodnoty. |
Seznam kontaktních e-mailů. |
"Zřizovaná organizace"."Email" (Organization.Email) |
|
…/type |
Kód typu emailu |
"Email"."Typ emailu"."kód" (Email.EmailType.code) |
Emailová adresa |
"Email"."adresa" (Email.address) |
|
…/description |
Poznámka |
"Email"."poznámka" (Email.note) |
telephoneNumber |
Seznam kontaktních telefonních čísel. |
"Zřizovaná organizace"."Telefon" (Organization.PhoneNumber) |
…/type |
Kód typu telefonu |
"Telefon"."Typ telefonu"."kód" (PhoneNumber.PhoneNumberType.code) |
…/number |
Telefonní číslo |
"Telefon"."hodnota" (PhoneNumber.value) |
ico |
IČ organizace. |
"Zřizovaná organizace"."ič" (Organization.identificationNumber) |
dic |
DIČ |
"Zřizovaná organizace"."dič" (Organization.vatId) |
typOrganizace |
Typ zřizované organizace. |
"Zřizovaná organizace"."Typ organizace"."kód" (Organization.OrganizationType.code) |
bankAccount |
Bankovní spojení. Obsahuje 4-číselný kód banky a číslo účtu. |
"Zřizovaná organizace"."Bankovní spojení" (Organization.BankAccount) |
…/number |
Číslo účtu |
"Bankovní spojení"."číslo účtu" (BankAccount.number) |
…/bankCode |
Kód banky |
"Bankovní spojení"."kód banky" (BankAccount.bankCode) |
…/description |
Popis |
"Bankovní spojení"."popis" (BankAccount.description) |
officesHours |
Úřední hodiny obsahují den v týdnu (1 pondělí – 7 neděle) a čas (hodinu a minutu ve tvaru HH:MM) začátku a konce úředních hodin. V případě přestávky zadejte den dvakrát (s dopoledním a poté s odpoledním časovým intervalem) |
"Zřizovaná organizace"."Úřední hodiny zřizované organizace" (Organization.OrganizationOfficeHours) |
…/day |
Den v týdnu |
"Úřední hodiny zřizované organizace"."den v týdnu" (OrganizationOfficeHours.day) |
…/from |
Od |
"Úřední hodiny zřizované organizace"."od" (OrganizationOfficeHours.from) |
…/to |
Do |
"Úřední hodiny zřizované organizace"."do" (OrganizationOfficeHours.to) |
subjectCode |
Číslo subjektu, kód ČSU. |
"Zřizovaná organizace"."číslo subjektu" (Organization.subjectCode) |
url |
WWW odkaz |
"Zřizovaná organizace"."Url WWW" (Organization.WwwUrl) |
…/url |
URL adresa |
"Url WWW"."url" (WwwUrl.url) |
…/description |
Poznámka |
"Url WWW"."poznámka" (WwwUrl.note) |
…/type |
Kód typu URL |
"Url WWW"."Typ Url WWW"."kód" (WwwUrl.WwwUrlType.code) |
roleCentralniNakup |
Seznam rolí pro přístup do aplikace Centrální nákup. |
"Zřizovaná organizace"."Role centrálního nákupu zřizované organizace" (Organization. OrganizationCentralPurchaseRole) |
…/item |
ID role |
"Role centrálního nákupu zřizované organizace"."kód" (OrganizationCentralPurchaseRole.code) |
zruseno |
Značí, že organizace byla zrušena. |
vyplní se atribut "Zřizovaná organizace"."čas zrušení" (Organization.cancelationTime) = aktuální datum, pokud TRUE |
Příklad odpovědi CreateOrganizationResponse
<CreateOrganizationResponse object-id="skola_1" xmlns="http://userportal.novell.com/ws/WS-LA-1.1">OK</CreateOrganizationResponse>
Název |
Popis |
Atribut z datového modelu |
|---|---|---|
object-id |
ID (zkratka) nové zřizované organizace vygenerované ze zadaného atributu "name". |
"Zřizovaná organizace"."zkratka" (Organization.shortcut) |
1.3.5.4. UpdateOrganization
Metoda UpdateOrganization na základě požadavku UpdateOrganizationRequest provede změnu údajů zřizované organizace pod daným subjektem a v odpovědi UpdateOrganizationResponse se vrací výsledek provedené akce. Metoda používá stejné elementy jako CreateOrganizationRequest. Uvádí se jen ty elementy, jejichž hodnoty se mění; atribut object-path je povinný a identifikuje měněnou organizaci.
Příklad žádosti UpdateOrganizationRequest
<UpdateOrganizationRequest object-path="skola_1" xmlns="http://userportal.novell.com/ws/WS-LA-1.1">
<email>
<item>
<type>1</type>
<email>info@example.org</email>
</item>
</email>
<zruseno>TRUE</zruseno>
</CreateOrganizationRequest>
Příklad odpovědi UpdateOrganizationResponse
<ns2:UpdateOrganizationResponse xmlns:ns2="http://userportal.novell.com/ws/WS-LA-1.1">OK</ns2:UpdateOrganizationResponse>
1.3.6. Správa uživatelů zřizovaných organizací
1.3.6.1. GetOrganizationUserList
Metoda GetOrganizationUserList na základě požadavku GetOrganizationUserListRequest vrací v odpovědi GetOrganizationUserListResponse seznam uživatelů zřizované organizace daného subjektu. Pro jeden požadavek se vrací maximálně 500 záznamů.
Příklad žádosti GetOrganizationUserListRequest
<GetOrganizationUserListRequest object-path="skola_1" start="1" xmlns="http://userportal.novell.com/ws/WS-LA-1.1"/>
Název |
Popis |
Atribut z datového modelu |
|---|---|---|
start |
Počáteční pozice záznamu, od kterého bude vrácen seznam záznamů. Používá se v případě velkého množství záznamů pro stránkování a výchozí hodnota je 1. |
|
object-path |
Zkratka zřizované organizace. |
"Zřizovaná organizace"."zkratka" (Organization.shortcut) |
Příklad odpovědi GetOrganizationUserListResponse
<GetOrganizationUserListResponse total="1" xmlns="http://userportal.novell.com/ws/WS-LA-1.1">
<row path="" object-path="skola_1" object-id="john_keating">
<firstname>John</firstname>
<surname>Keating</surname>
<loginDisabled text="Ne">FALSE</loginDisabled>
<email>
<item>
<type text="oficiální">1</type>
<email>john.keating@example.org</email>
</item>
</email>
<uvolnenZeZamestnani text="Ne">FALSE</uvolnenZeZamestnani>
<casPosledniZmeny>1766850897</casPosledniZmeny>
</row>
</GetOrganizationUserListResponse>
Název |
Popis |
Atribut z datového modelu |
|---|---|---|
total |
Celkový počet uživatelů zřizované organizace. V případě velkého množství záznamů se vrací jen jejich část. Počáteční záznam pro stránkování je možné určit atributem "start". |
Počet uživatelů zřizované organizace "Subjekt"."Zřizovaná organizace"."Uživatel zřizované organizace" (Subject.Organization. OrganizationUser) |
object-id |
Přihlašovací jméno uživatele. |
"Uživatel zřizované organizace"."přihlašovací jméno" (OrganizationUser.loginName) |
object-path |
Zkratka zřizované organizace. |
"Zřizovaná organizace"."zkratka" (Organization.shortcut) |
firstname |
Křestní jméno. |
"Uživatel zřizované organizace"."jméno" (OrganizationUser.firstname) |
surname |
Příjmení. |
"Uživatel zřizované organizace"."příjmení" (OrganizationUser.surname) |
WS 1.1 loginDisabled |
Příznak, zda je uživatelský účet zablokovaný. Poznámka: V CAAIS nelze uživatelské účty smazat, ale pouze zablokovat. |
"Uživatel zřizované organizace"."účet zablokován" (OrganizationUser.loginDisabled) |
Seznam e-mailů. |
"Uživatel zřizované organizace"."Email" (OrganizationUser.Email) |
|
…/type |
Kód typu emailu |
"Email"."Typ emailu"."kód" (Email.EmailType.code) |
…/text |
Název typu emailu |
"Email"."Typ emailu"."název" (Email.EmailType.name) |
Emailová adresa |
"Email"."adresa" (Email.address) |
|
…/description |
Poznámka |
"Email"."poznámka" (Email.note) |
uvolnenZeZamestnani |
Příznak, je-li osoba uvolněna z předchozího zaměstnání pro výkon funkce. |
"Uživatel zřizované organizace"."uvolněn ze zaměstnání" (OrganizationUser.employmentDismissed) |
WS 1.1 casPosledniZmeny |
Datum a čas poslední změny v údajích uživatele zřizované organizace. |
Čas poslední změny uživatele zřizované organizace v historických tabulkách jako Unix timestamp v sekundách |
1.3.6.2. GetOrganizationUser
Metoda GetOrganizationUser na základě požadavku GetOrganizationUserRequest vrací v odpovědi GetOrganizationUserResponse údaje uživatele zřizované organizace pod daným subjektem.
Příklad žádosti GetOrganizationUserRequest
<GetOrganizationUserRequest object-path="skola_1" object-id="john_keating" xmlns="http://userportal.novell.com/ws/WS-LA-1.1"/>
Název |
Popis |
Atribut z datového modelu |
|---|---|---|
object-id |
Přihlašovací jméno uživatele. |
"Uživatel zřizované organizace"."přihlašovací jméno" (OrganizationUser.loginName) |
object-path |
Zkratka zřizované organizace. |
"Zřizovaná organizace"."zkratka" (Organization.shortcut) |
Příklad odpovědi GetOrganizationUserResponse
<GetOrganizationUserResponse xmlns="http://userportal.novell.com/ws/WS-LA-1.1">
<firstname>John</firstname>
<surname>Keating</surname>
<loginDisabled text="Ne">FALSE</loginDisabled>
<email>
<item>
<type text="oficiální">1</type>
<email>john.keating@example.org</email>
</item>
</email>
<uvolnenZeZamestnani text="Ne">FALSE</uvolnenZeZamestnani>
<casPosledniZmeny>1766850897</casPosledniZmeny>
</GetOrganizationUserResponse>
Název |
Popis |
Atribut z datového modelu |
|---|---|---|
titulPred |
Titul před jménem. |
"Uživatel zřizované organizace"."titul před" (OrganizationUser.degreeBefore) |
firstname |
Křestní jméno. |
"Uživatel zřizované organizace"."jméno" (OrganizationUser.firstname) |
surname |
Příjmení. |
"Uživatel zřizované organizace"."příjmení" (OrganizationUser.surname) |
titulZa |
Titul za jménem. |
"Uživatel zřizované organizace"."titul za" (OrganizationUser.degreeAfter) |
WS 1.1 identifiedByROB |
Značí, že byl uživatel ztotožněn (nalezeno AIFO v ROB). |
<prázdná_hodnota> (neexistuje odpovídající atribut) |
photo |
Fotografie uživatele. |
"Uživatel zřizované organizace"."fotografie" (OrganizationUser.photo) |
loginDisabled |
Příznak, že účet uživatele je zablokován. |
"Uživatel zřizované organizace"."účet zablokován" (OrganizationUser.loginDisabled) |
address |
Adresa. |
"Uživatel zřizované organizace"."Adresa" (OrganizationUser.Address); Společné typy a hodnoty. |
Seznam e-mailů. |
"Uživatel zřizované organizace"."Email" (OrganizationUser.Email) |
|
…/type |
Kód typu emailu |
"Email"."Typ emailu"."kód" (Email.EmailType.code) |
…/text |
Název typu emailu |
"Email"."Typ emailu"."název" (Email.EmailType.name) |
Emailová adresa |
"Email"."adresa" (Email.address) |
|
…/description |
Poznámka |
"Email"."poznámka" (Email.note) |
telephoneNumber |
Seznam kontaktních telefonních čísel. |
"Uživatel zřizované organizace"."Telefon" (OrganizationUser.PhoneNumber) |
…/type |
Kód typu telefonu |
"Telefon"."Typ telefonu"."kód" (PhoneNumber.PhoneNumberType.code) |
…/text |
Název typu telefonu |
"Telefon"."Typ telefonu"."název" (PhoneNumber.PhoneNumberType.name) |
…/number |
Telefonní číslo |
"Telefon"."hodnota" (PhoneNumber.value) |
uvolnenZeZamestnani |
Příznak, je-li osoba uvolněna z předchozího zaměstnání pro výkon funkce. |
"Uživatel zřizované organizace"."uvolněn ze zaměstnání" (OrganizationUser.employmentDismissed) |
roleCentralniNakup |
Seznam rolí pro přístup do aplikace Centrální nákup. |
"Uživatel zřizované organizace"."Role centrálního nákupu zřizované organizace" (OrganizationUser. OrganizationCentralPurchaseRole) |
…/item |
ID role |
"Role centrálního nákupu zřizované organizace"."kód" (OrganizationCentralPurchaseRole.code) |
…/text |
Název role |
"Role centrálního nákupu zřizované organizace"."název" (OrganizationCentralPurchaseRole.name) |
WS 1.1 casPosledniZmeny |
Datum a čas poslední změny v údajích uživatelského účtu. |
čas poslední změny uživatele zřizované organizace v historických tabulkách |
1.3.6.3. CreateOrganizationUser
Metoda CreateOrganizationUser na základě požadavku CreateOrganizationUserRequest vytvoří nového uživatele zřizované organizace pod daným subjektem a v odpovědi CreateOrganizationUserResponse se vrací výsledek provedené akce.
Pro uživatele zřizované organizace se neprovádí ztotožňování jako pro standardního uživatele CAAIS.
Příklad žádosti CreateOrganizationUserRequest
<GetOrganizationUserRequest object-path="skola_1" object-id="john_keating" xmlns="http://userportal.novell.com/ws/WS-LA-1.1"/>
Název |
Popis |
Atribut z datového modelu |
|---|---|---|
object-id |
Přihlašovací jméno uživatele. |
"Uživatel zřizované organizace"."přihlašovací jméno" (OrganizationUser.loginName) |
object-path |
Zkratka zřizované organizace. |
"Zřizovaná organizace"."zkratka" (Organization.shortcut) |
titulPred |
Titul před jménem. |
"Uživatel zřizované organizace"."titul před" (OrganizationUser.degreeBefore) |
firstname |
Křestní jméno. |
"Uživatel zřizované organizace"."jméno" (OrganizationUser.firstname) |
surname |
Příjmení. |
"Uživatel zřizované organizace"."příjmení" (OrganizationUser.surname) |
titulZa |
Titul za jménem. |
"Uživatel zřizované organizace"."titul za" (OrganizationUser.degreeAfter) |
photo |
Fotografie uživatele. |
"Uživatel zřizované organizace"."fotografie" (OrganizationUser.photo) |
loginDisabled |
Příznak, že účet uživatele je zablokován. |
"Uživatel zřizované organizace"."účet zablokován" (OrganizationUser.loginDisabled) |
address |
Adresa. Pokud je zadán kód adresy, adresa je ověřena a doplněna z registru RUIAN. Není-li kód zadán, adresa se neověřuje a je považována za dočasnou |
"Uživatel zřizované organizace"."Adresa" (OrganizationUser.Address); Společné typy a hodnoty. Pro adresu bez kódu adresy se validuje povinné vyplnění těchto atributů: - houseNumber - cityCode - postalCode |
Seznam e-mailů. |
"Uživatel zřizované organizace"."Email" (OrganizationUser.Email) |
|
…/type |
Kód typu emailu |
"Email"."Typ emailu"."kód" (Email.EmailType.code) |
Emailová adresa |
"Email"."adresa" (Email.address) |
|
…/description |
Poznámka |
"Email"."poznámka" (Email.note) |
telephoneNumber |
Seznam kontaktních telefonních čísel. |
"Uživatel zřizované organizace"."Telefon" (OrganizationUser.PhoneNumber) |
…/type |
Kód typu telefonu |
"Telefon"."Typ telefonu"."kód" (PhoneNumber.PhoneNumberType.code) |
…/number |
Telefonní číslo |
"Telefon"."hodnota" (PhoneNumber.value) |
uvolnenZeZamestnani |
Příznak, je-li osoba uvolněna z předchozího zaměstnání pro výkon funkce. |
"Uživatel zřizované organizace"."uvolněn ze zaměstnání" (OrganizationUser.employmentDismissed) |
roleCentralniNakup |
Seznam rolí pro přístup do aplikace Centrální nákup. |
"Uživatel zřizované organizace"."Role centrálního nákupu zřizované organizace" (OrganizationUser. OrganizationCentralPurchaseRole) |
…/item |
ID role |
"Role centrálního nákupu zřizované organizace"."kód" (OrganizationCentralPurchaseRole.code) |
Příklad odpovědi CreateOrganizationUserResponse
<CreateOrganizationUserResponse object-id="john_keating" xmlns="http://userportal.novell.com/ws/WS-LA-1.1">OK</CreateOrganizationUserResponse>
Název |
Popis |
Atribut z datového modelu |
|---|---|---|
object-id |
Přihlašovací jméno uživatele zřizované organizace. |
"Uživatel zřizované organizace"."přihlašovací jméno" (OrganizationUser.loginName) |
1.3.6.4. UpdateOrganizationUser
Metoda UpdateOrganizationUser na základě požadavku UpdateOrganizationUserRequest provede změnu údajů uživatele zřizované organizace pod daným subjektem a v odpovědi UpdateOrganizationUserResponse se vrací výsledek provedené akce. Metoda používá stejné elementy jako CreateOrganizationUserRequest. Uvádí se jen ty elementy, jejichž hodnoty se mění; atribut object-path a object-id jsou povinné a identifikují organizaci a uživatele, jehož údaje se mění.
Příklad žádosti UpdateOrganizationUserRequest
<UpdateOrganizationUserRequest object-path="skola_1" object-id="john_keating" xmlns="http://userportal.novell.com/ws/WS-LA-1.1">
<password>Nov3Heslo</password>
</UpdateOrganizationUserRequest>
Příklad odpovědi UpdateOrganizationUserResponse
<UpdateOrganizationUserResponse xmlns="http://userportal.novell.com/ws/WS-LA-1.1">OK</UpdateOrganizationUserResponse>