Orsoft Doku
Dokumentace a nápověda pro IS Orsoft Open
Historie: • entity_web_service
Mapa stránek

Obsah

Jde o složitější webové služby pro různé operace s entitami (jako například získání entity, export agendy, a získání seznamu z SQL).

### Základní informace - API Endpoint: Specifikováno pro každou funkci - Metoda: SOAP Web Service - Formát: SOAP XML

### Operace

1. Získání entity

- SOAP Action: `/EntityWebService/Set` - Parametry (v těle SOAP zprávy):

  1. `EntityType`: Typ entity (např. `EntityWebService`)
  2. `Id`: Identifikátor operace (např. `getEntity`)
  3. `Properties`: Seznam vlastností a jejich hodnot potřebných pro operaci

- Popis: Tato operace zpracovává žádosti pro získání konkrétní entity na základě zadaných parametrů.

2. Agenda export

- SOAP Action: `/EntityWebService/Set` - Parametry:

  1. `EntityType`: Typ entity (např. `agendaExport`)
  2. Detailní popis dalších potřebných parametrů není v kódu specifikován.

- Popis: Tato operace umožňuje exportovat data zadané agendy.

3. Získání seznamu z SQL

- SOAP Action: `/EntityWebService/Set` - Parametry:

  1. `EntityType`: Typ entity (např. `getListFromSQL`)
  2. Detailní popis dalších potřebných parametrů není v kódu specifikován.

- Popis: Tato operace umožňuje získat seznam entit na základě SQL dotazu.

### Chybové stavy - Popis: V případě chyby je v odpovědi poskytnut detailní popis chyby, včetně případného stack trace. - Příklad chybového hlášení: `Výjimka: metoda getEntity Info-<chybová zpráva>`

### Autentizace - Popis: Každá operace vyžaduje validaci uživatelského jména a hesla (které je zašifrované). - Parametry:

  1. `login`: Uživatelské jméno
  2. `hesloZakryptovane`: Zašifrované heslo

### Příklady použití (SOAP XML formát): 

<v:Envelope xmlns:v="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:c="http://schemas.xmlsoap.org/soap/encoding/" xmlns:d="http://www.w3.org/2001/XMLSchema" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<v:Header/>
<v:Body>
<n0:Set xmlns:n0="http://ws.mskws.orcz.cz/">
<data>
<EntityType>EntityWebService</EntityType>
<Id>getEntity</Id>
<Properties>
<PropertyDescriptor i:type="d:anyType">
<Name>nameOfClass</Name>
<Value>CProdejniObjednavkaRadekDaoImpl</Value>
</PropertyDescriptor>
<!-- Další PropertyDescriptors -->
</Properties>
</data>
</n0:Set>
</v:Body>
</v:Envelope>

### Poznámky - Dokumentace bude rozšířena o přesné parametry a očekávané výstupy pro každou operaci. - Budou zahrnuty příklady správných a chybných SOAP zpráv pro každou operaci.