===============
Elza WSDL API
===============

Popis WSDL integračního API a jeho aktuální podoba je dostupná zde:
http://elza-doc.lightcomp.cz/2.0/implementation/wsdl-api/api.html

Uvedená API umožňuje předávání informací o digitálních
objektech a jejich metadatech.


.. _elza_api_ap_import:

E2 Import přístupového bodu
============================

Funkce umožňuje import přístupového bodu z externího systému.
Předpokladem funkce je, že bude importován jeden konkrétní přístupový
bod.

.. py:function:: ImportAccessPoint(sytemId, cond)
  
  Import přístupového bodu.

  :param systemId: Identifikátor externího systému z něhož se data importují
  :param cond:     Podmínka pro vyhledání záznamu, parametry podmínky 
                   jsou specifické pro konkrétní systém.

  Pokud nebude nalezen právě jeden přístupový bod, tak funkce končí
  s chybou. V případě úspěšného importu je vrácen Identifikátor
  importovaného přístupového bodu.

.. _elza_api_search:

E3 Vyhledávání v archivním popisu
==================================

Elza již nyní v uživatelském rozhraní disponuje funkcionalitou
pro vyhledávání napříč archivními soubory. Funkcionalita
umožňuje nalezení archivního popisu odpovídajícího zadaným kritériím.
Tato funkce bude převedena do samostatného API a přidána
možnost pro vyhledávání pomocí vnořených podmínek.

Definice funkce odpovídá :ref:`vyhledani_api`.

.. _elza_api_import_daos:

E4 (WSDL) Dávkový import digitálních objektů
==============================================

Funkce integračního rozhraní ``doaImport`` slouží k dávkovému importu archiválií na základě konkrétní VniZ/VněZ. Bude rozšířena tak,
aby umožňovala přenášet rozšířenou množinu metadat archiválie.
Současná podoba umožňuje přenos identifikátoru a popisu.

Nově bude přidána kolekce atributů s hodnotami.

Pro celou dávku jsou předána metadata:

- Název - popis vnitřní změny, který se vytěží do regestu
- Datace

Pro kažčdou archiválii jsou předána metadata:

- Typ archiválie (patrně nebude možné editovat v Elza - UK upřesní)
- Příznak zda se jedná o digitální nebo analogovou archiválii (v Elze bude jako nový prvek popisu)
- Ukládací jednotku tj. typ uložení a číslo.
- Stručný popis
- Datace - potřeba zajistit, že v PEvA je stejná datace
- Původce - kontrola vůči nadřazeným úrovním, případně původce nevkládat k JP
- “Nezpracováno” u DAO v ESM znamená, že mažeme z Elzy JP
- Související osoby
- strom popisující adresářovou a souborovou strukturu souboru archiválie


.. _elza_api_remove_daos:

E5 (WSDL) Dávkové vymazání digitálních objektů
================================================

Při změně stavu archiválie na *nezpracováno* je možné
pomocí speciální funkce tyto v Elze zneplatnit. Funkce bude
přidána do WSDL rozhraní pro práci s DAO.

.. py:function:: RemoveDaos(daoList)

  :param daoList Seznam digitálních objektů, které mají být z Elza odstraněny.

.. _elza_api_remove_funds:

Funkce pro archivní soubory
===========================

Pro správu archivních souborů se předpokládá WSDL komunikace. 
Měla by mít 3 základní funkce:

.. py:function:: CreateFund(name, znacka)

 E6 (WSDL) Vytvoření archivního souboru.


.. py:function:: DeleteFund(znacka)

 E7 (WSDL) Vymazání archivního souboru


.. py:function:: UpdateFund(name, znacka)

 E8 (WSDL) Aktualizace archivního souboru


.. _elza_api_users:

Funkce pro správu uživatelů
===========================

Funkce pro správu uživatelů budou dostupné formou WSDL rozhraní.

.. py:function:: CreateUser(userName, personId, permissionList)

 E9 (WSDL) Vytvoření uživatele.

  :param userName: Jméno uživatele
  :param personId: Identifikátor osoby
  :param permissionList: Seznam oprávnění

.. py:function:: DeleteUser(userName)

 E10 (WSDL) Vymazání uživatele

  :param userName: Jméno uživatele

.. py:function:: AddPermissions(userName, permissionList)

 E11 (WSDL) Přidání oprávnění uživateli.

  :param userName: Jméno uživatele
  :param permissionList: Seznam oprávnění


.. py:function:: RemovePermissions(userName, permissionList)

 E12 (WSDL) Odstranění oprávnění uživatele.

  :param userName: Jméno uživatele
  :param permissionList: Seznam oprávnění