apiary.apib

FORMAT: 1A
HOST: https://www.hlidacstatu.cz/api/v1

# Hlídač Státu API

> Popis API neustále doplňujeme, v některých detailech nemusí být přesný. V případě nejasnosti piš na michal@michalblaha.cz.
> Předem díky za upozornění na chyby, nepřesnosti a nejasný popis.
---
## Verze a změny
`verze 1.3.1, poslední změna 23.11.2019`

* Změny 03.11.2019
    * přidána funkce `fn_RenderPersonNoLink`.

* Změny 03.11.2019
    * API Dumps podporuji i další typy dat než jen smlouvy.
    
* Změny 05.05.2019
    * **BREAKING CHANGE:** Vlastnost jsonSchema při registraci nového datasetu je typu string a obsahuje serializované JSON Schema do stringu.
    

* Změny 27.04.2019
    * Přidány template funkce `fn_RenderCompanyStatistic` a `fn_RenderPersonStatistic`

* Změny 27.11.2018
    * Výměna dočasného template enginu Razor za Scriban (https://github.com/lunet-io/scriban, kompatibilní s `liquid templates`)
    * Speciální datové struktury Datasetu `HSProcessType`

* Změny 5.10.2018
    * doplněn endpoint DatasetSendNotifications
    * doplněny parametry DatasetSearch
    


## Autorizace

Autorizace je prováděna pomocí autentifikačního tokenu, který je Vám přidělen. Autorizační token je nutno odesílat v hlavičce každého požadavku na API.
Autorizační token: `docela1dlouhy2token3pro4tohleHS5api`
Příklad k použití:
```
curl -X GET https://www.hlidacstatu.cz/Api/v1/Detail/204737 -H 'Authorization: Token docela1dlouhy2token3pro4tohle5api'
```

Svůj API token najdeš https://www.hlidacstatu.cz/api. 

> Všechna volání API jsou monitorována a ukládána.

## Licence

Data můžete zdarma stahovat, zpracovávat a dále publikovat pouze v souladu s 
licencí CC BY 3.0. Licence je jednoduchá a její pravidla také. 

Nejdůležitější, nikoliv jediná pravidla licence:

1. Dílo a obsah smíte stáhnout, sdílet a libovolně upravit.
2. Musíte vždy a bezpodmínečně uvést původ dat a autorství zdrojových dat (na internetu plný, funkční internetový odkaz na Hlídač státu)
3. Nesmíte přidat žádná další technická či právní omezení nad rámec této licence.
4. Pokud vám tato licence nevyhovuje, napište na api@hlidacstatu.cz

[Přečtěte si ji prosím](https://www.hlidacstatu.cz/texty/licence/).

## Group Smlouvy


### Smlouvy [/detail]

API pro získání smluv z Hlídače smluv v JSON formátu


### Příklad jednoho záznamu smlouvy:

Není-li uvedeno jinak, jsou údaje z Hlídače státu.

```
{
  "identifikator": {
    "idSmlouvy": "8256587", // Id smlouvy  (z registru smluv)
    "idVerze": "8911171"  // Id verze smlouvy  (z registru smluv)
  },
  "schvalil": null,       // jméno osoby (z registru smluv)
  "hodnotaBezDph": null,   // (z registru smluv)
  "hodnotaVcetneDph": null,   // (z registru smluv)
  "ciziMena": null,   // (z registru smluv)
  "platnyZaznam": true,     // pokud je false, jde o zneplatnetnou smlouvu
  "PravniRamec": 2,  //  0=neznámí, 1=do 1.7.2017, 2=po 1.7.2017 včetně , 3= před zákonem o RS
  "Prilohy": [  //pole obsahující dokumenty/smlouvy
    {
      "FileMetadata": null,
      "data": null,
      "nazevSouboru": "Sml. 490_2018_D1.pdf", //originalni nazev souboru    // (z registru smluv)
      "hash": {   //hash souboru, kontrola validity  (z registru smluv) 
        "algoritmus": "sha256",
        "Value": "599e7a6a9048c80dca628df84800b09699d83d21fd49cadef654d17fe275f575"
      },
        //odkaz na soubor v RS    // (z registru smluv)
      "odkaz": "https://smlouvy.gov.cz/smlouva/soubor/11761431/Sml.%20490_2018_D1.pdf",
      "DatlClassification": null,
      
      //textová podoba dokumentu
      "PlainTextContent": "Dodatek i. L ke kupni smlouv6 o doddvce\r\n\r\n  Smluvni strany:\r\n\r\nMuzeum hlavniho města... zkráceno",
      
      "PlainTextContentQuality": 3, //způsob získání text.podoby: 
                    // Unknown = 0,
                    // Exact = 1, - získáno z txt souboru, přesná podoba
                    // Calculated = 2, 
                    // Parsed = 3,  - získáno strojově z dokumentu
                    // Estimated = 4,  - získáno pomocí OCR, nepřesné
                    // AddedManual = 5, - doplněno ručně

      
      
      "LastUpdate": "2019-08-20T11:45:26.8997187+02:00",  // poslední změna přílohy
      "LocalCopy": null,
      "ContentType": null,
      "Lenght": 2998,        // počet znaků 
      "WordCount": 356,      // počet slov
      "Pages": 0,
      "EnoughExtractedText": true
    }
  ],
  "LastUpdate": "2019-08-20T11:45:26.915326+02:00",   // poslední změna záznamu v HS
  "CalculatedPriceWithVATinCZK": 0.0,  // cena převedená do Kč s DPH
  "CalcutatedPriceQuality": 0,    // přesnost vypoctu ceny s Kč s DPH. 1=přesná  2=spočítaný odhad
  "Classification": { // klasifikace smlouvy podle oboru. Beta verze
    "LastUpdate": "2019-07-14T18:59:32.161348+02:00",
    "Version": 0,
    "Types": [
      {
        "TypeValue": 10001,
        "ClassifProbability": 0.825404859999175
      },
      {
        "TypeValue": 10303,
        "ClassifProbability": 0.808962865938306
      },
      {
        "TypeValue": 10002,
        "ClassifProbability": 0.805769168207763
      },
      {
        "TypeValue": 11305,
        "ClassifProbability": 0.804947288255946
      },
      {
        "TypeValue": 11303,
        "ClassifProbability": 0.801971530336268
      },
      {
        "TypeValue": 10502,
        "ClassifProbability": 0.80137540426054
      },
      {
        "TypeValue": 10302,
        "ClassifProbability": 0.800935862304785
      }
    ]
  },
  "Issues": [ //nalezené chyby
    {
      "IssueTypeId": 100,
      "Created": "2019-04-30T16:06:44.4791703+02:00",
      "Title": "Nulová hodnota smlouvy",
      "TextDescription": "Smlouva nemá v metadatech uvedenu cenu. Utajení hodnoty smlouvy je možné pouze v odůvodněných případech, což při této kontrole nehodnotíme.",
      "Public": true,
      "Permanent": false,
      "Importance": 5,
      "AffectedParams": null,
      "AnalyzerType": "HlidacStatu.Plugin.IssueAnalyzers.Price"
    }
  ],
  "Enhancements": [  //provedené úpravy,doplnění smlouvy
    {
      "Created": "2019-08-20T11:45:26.8997187+02:00",
      "Title": "Text přílohy extrahován z obsahu dokumentu ",
      "Description": "",
      "Changed": {
        "ParameterName": "item.Prilohy[0].PlainTextContent",
        "PreviousValue": "",
        "NewValue": ""
      },
      "Public": true,
      "EnhancerType": "HlidacStatu.Plugin.Enhancers.TextMiner"
    }
  ],
  "ConfidenceValue": 5.0, //   míra chybovosti smlouvy
  "Id": "8911171",   // id verze smlouvy
  "odkaz": "https://smlouvy.gov.cz/smlouva/8911171",  // URL záznamu v registru smluv
  "casZverejneni": "2019-04-30T16:04:09+02:00",   // datum zveřejnění v RS (z registru smluv) 
  "VkladatelDoRejstriku": { // subjekt, ktery záznam vložil do RS (z registru smluv) 
    "datovaSchranka": "4aniq5f",
    "nazev": "Muzeum hlavního města Prahy",
    "ico": "00064432",
    "adresa": " ,  Kožná 1 110 00 Praha 1 Hlavní město Praha, ",
    "utvar": null
  },
  "Platce": { // objednatel (z HS). Pokud v RS není uvedeno, Hlídač odhaduje kdo je plátce 
    "datovaSchranka": "4aniq5f",
    "nazev": "Muzeum hlavního města Prahy",
    "ico": "00064432",
    "adresa": " ,  Kožná 1 110 00 Praha 1 Hlavní město Praha, ",
    "utvar": null
  },
  "Prijemce": [ // dodavatele (z HS). Pokud v RS není uvedeno, Hlídač odhaduje kdo je dodavatel
    {
      "datovaSchranka": "mhx6wg3",
      "nazev": "FORM, spol. s r.o.",
      "ico": "43964532",
      "adresa": "Poručíka Hoši 512/2a, 74711, Kozmice",
      "utvar": null
    }
  ],
  "predmet": "Dodatek ke kupní smlouvě o dodávce - prodloužení doby plnění",     // z RS
  "datumUzavreni": "2019-04-26T00:00:00",     // datum uzavrení/podpisu smlouvy, z RS
  "cisloSmlouvy": null,                // z RS
  "navazanyZaznam": null,                // z RS
  "souvisejiciSmlouvy": null,                 // z HS
  "SVazbouNaPolitiky": null,     // z HS, vzdy prazdne
  "SVazbouNaPolitikyNedavne": null,     // z HS, vzdy prazdne
  "SVazbouNaPolitikyAktualni": null     // z HS, vzdy prazdne
}
```


#### Jednotlivá smlouva [GET /detail/{id_smlouvy}?nice={nice}&json=1]

Příklad: `https://www.hlidacstatu.cz/Api/v1/Detail/204737?json=1&nice=1`

+ Parameters
    + id_smlouvy: 204737 (string, required)
    + nice: 1 (int) - pokud je =1, vrátíme zformátovaný JSON, jinak maximálně zkomprimovaný.


+ Request (application/json)
 + Headers
 
            Authorization: Token <najdes na hlidacstatu.cz/api/v1>


+ Response 200 (application/json)

        viz níže




#### Hledání smluv [GET /search?query={query}&page={page}&order={order}]

Příklad: `https://www.hlidacstatu.cz/Api/v1/Detail/204737?json=1&nice=1`

+ Parameters
    + query: autobus (string, required) - dotaz dle [syntaxe](https://www.hlidacstatu.cz/napoveda).
    + page: 1 (int) - stránka, max. hodnota je 250.
    + order: 1 (int) - pořadí výsledků.
        * 0: podle relevance
        * 1: nově zveřejněné první
        * 2: nově zveřejněné poslední
        * 3: nejlevnější první 
        * 4: nejdražší první 
        * 5: nově uzavřené první 
        * 6: nově uzavřené poslední 
        * 7: nejvíce chybové první 
        * 8: podle odběratele 
        * 9: podle dodavatele 
    

+ Request (application/json)
 + Headers
 
            Authorization: Token <najdes na hlidacstatu.cz/api/v1>


+ Response 200 (application/json)


#### Export (Dump) smluv a dalších databází - přehled dostupných exportů [GET /dumps]
Seznam dostupných denních a měsíčních dumpů v JSON

+ Request (application/json)
 + Headers
 
            Authorization: Token <najdes na hlidacstatu.cz/api/v1>


+ Response 200 (application/json)

        [  
           {  
              "url":"https://www.hlidacstatu.cz/api/v1/Dump", //URL dumpu
              "date":"\/Date(1503584641162)\/",               //datum, ke kteremu se vztahuje
              "size":34670034,                                //velikost souboru
              "fulldump":true,                                //pokud true, pak je to dump vsech smluv, jinak denni dump
              "datatype" : "smlouvy"                          //může být i libovolná db z hlidacstatu.cz/data
              "created":"\/Date(1503584641162)\/"             //datum vytvoreni dumpu
           },
         .....
        ]

#### Stáhnutí exportu všech smluv či jiný databází [GET /dump?datatype={datatype}]
Stáhnutí posledního plnému dumpu, obvykle se vytváří 1x týdně. 
Detaily o souboru dává `[GET /dumps]` 

+ Parameters
    + datatype: `smlouvy` {string, required} - ci nazev jine databaze

+ Request (application/json)
 + Headers
 
            Authorization: Token <najdes na hlidacstatu.cz/api/v1>


+ Response 200 (application/json)

#### Stáhnutí exportu smluv změněných v jeden den [GET /dump?date={date}]
Stáhnutí posledního plnému dumpu, obvykle se vytváří 1x týdně. 
Detaily o souboru dává a info o existenci vrací `[GET /dumps]` 

+ Parameters
    + date:  `2018-08-23` (string, required) - datum dumpu, ve formát yyyy-MM-dd.

+ Request (application/json)
 + Headers
 
            Authorization: Token <najdes na hlidacstatu.cz/api/v1>


+ Response 200 (application/json)



## Group Datasety - rozšířené datové sady Hlídače státu

Datová sada (dataset) je strukturovaná sada záznamů, která je dostupná 
- a pokud je to možné - provázaná s dalšími datovými sadami Hlídače státu.

Vytvoření a správa datových sad je zdarma, volně dostupné a prakticky neomezené.
Preferujeme vytváření datových sad s daty státu, samosprávy, státních úřadů a firem, které mají či mohou mít informační hodnotu pro širší veřejnost
anebo vhodně doplňují informace poskytované Hlídačem státu.

Konkrétní příklad použití včetně registrace Datasetu, nastavení templatů, parsování obsahu a uložení dat najdeš na https://github.com/HlidacStatu/Datasety/tree/master/Dataset-RozhodnutiUOHS-ukazka.
Ukázka je v C#, ale snadno čitelná.
 
### Zobrazení dat na webu

Dostupné a zpřístupněné datasety (tzn. ty co nejsou v betaverzi) jsou k nalezení na 
https://www.hlidacstatu.cz/data

### Datasety [/Datasets]

Registrace a správa datových sad. Před vkládaním dat je potřeba datovou sadu. 



### Registrace nové datové sady [POST /Datasets]

Registraci nové datové sady je potřeba udělat před prvním vkládáním dat do systému.
Vrácený identifikátor datové sady se používá v dalších API

Povinnou součástí registrace je JSON schema jednoho zaznamu (objektu).
Očekáváme datové schéma ve formátu JSON Schema Draft 7. Každý vkládaný object je proti tomuto schématu validován 
a nevalidní záznam není uložen.

> **POZOR** - po registraci není možné provést změnu JSON Schematu `jsonSchema`. Pokud potřebujete změnit JSON schema datové sady,
musíte datovou sadu smazat, a zaregistrovat znovu. Smazáním datové sady se smažou i všechna data z datové sady.

> **POZOR** - po registraci není možné provést změnu `datasetId`. Pokud ho potřebujete ,
musíte datovou sadu smazat, a zaregistrovat znovu. Smazáním datové sady se smažou i všechna data z datové sady.

#### Popis struktury registrace datové sady

Ukázka datové struktury zde: https://github.com/HlidacStatu/API/blob/master/register.sample.json

```
{
   "id": "rozhodnuti-uohs",
   "name": "Rozhodnutí UOHS",
   "datasetId": "rozhodnuti-uohs",
   "origUrl": "http://www.uohs.cz/cs/verejne-zakazky/sbirky-rozhodnuti/",
   "sourcecodeUrl": null,
   "description": "Sbírka rozhodnutí Úřadu pro ochranu hospodářské soutěže od roku 1999 v oblastech hospodářská soutěž, veřejné zakázky, veřejná podpora a významná tržní síla.",
   "jsonSchema": ".... JSON Schema, viz ukázka na odkazu výše ",
   "createdBy": "michal@michalblaha.cz",
   "created": "2018-09-22T10:44:38.7784317+02:00",
   "betaversion": false,
   "allowWriteAccess": false,
   "hidden": false,
   "searchResultTemplate": {
      "header": "",
      "body": "<!-- scriban {{ date.now }} --> .... scriban/liquid template",
      "footer": "",
      "title": null,
      "properties": null
   },
   "detailTemplate": {
      "header": "",
      "body": "<!-- scriban {{ date.now }} --> .... scriban/liquid template",
      "footer": "",
      "title": "@item.Vec",
      "properties": null
   },
   "orderList": [["Nabytí právní moci", "PravniMoc"], ["Účastníci", "Ucastnici.Jmeno.keyword"]]
}
```

* `datasetId` - unikátní jméno datové sady. Má pouze několik omezení 
    1. musí být alespoň 5 znaků a max. 125 znaků dlouhé
    2. nesmí obsahovat znaky `#`, `\`, `/`, `*`, `?`, `"`, `<`, `>`, `|`, `[`, `]`
    3. pokud některé z těchto pravidel nedodrží, je automaticky upraveno při registraci
    4. vrácené `datasetId` při registraci se může lišit od požadované hodnoty
    5. pokud není uvedeno, je odvozeno z `name`
    
* `name` - je povinné

* `betaversion` - pokud je true, pak se nezobrazuje v seznamu datových zdrojů na https://www.hlidacstatu.cz/data.
    > pokud zavoláš s parametrem https://www.hlidacstatu.cz/data?**beta=1**, pak se seznam zobrazí.
    
* `allowWriteAccess` : pokud je `true`, pak data v datasetu může kdokoliv přepsat nebo smazat. Stejně tak údaje v registraci.
            Pokud je `false`, pak kdokoliv může data přidat, ale nemůže je přepsat či smazat. Nemůže také měnit parametry registrace datasetu.

* `jsonSchema` - je povinné. Struktura vkládaných dat (a popsaná tímto JSON schéma) musí splňovat pár pravidel:
    1. vlastnost `Id` v rootu objektu - unikátní identifikátor objektu. **Musí být** součástí JSON Schematu i vkládaného objektu, ve formátu `string`.
    2. rezervované názvy vlastností, nepoužívejte je v jsonSchema ani objektech:
        - `DbCreated`:  obsahuje datum vložení objektu do db.
        - `DbCreatedBy`:  obsahuje info o uživateli, který objekt do db vložil. Tento údaj není poskytován veřejně.
    3. vlastnost `ICO` kdekoliv (i ve vložených objektech) - pokud je typu `string`, pak Hlídač státu předpokládá, že se jedná IČ subjektu a propojí záznam s firmami v Hlídači státu.
    4. vlastnost `OsobaId` kdekoliv (i ve vložených objektech) - pokud jde o string, pak Hlídač Státu předpokládá, že se jedná o identifikátor osoby z databáze Hlídače státu. Pro nalezení použijte endpoint `FindOsobaId`
    5. vlastnost `Url` v rootu objektu - pokud dává smysl, měl by odkazovat na zdrojový záznam.
    6. vlastnost `HsProcessType` kdekoliv, v kombinaci s dalšími atributy (viz dále), zajistí následné zpracování záznamu na serveru a doplnění údajů na straně Hlídače.

* `searchResultTemplate` - HTML template či seznam vlastností objektu, které se mají zobrazovat ve výsledku hledání. Podrobnější popis o kousek dál.

* `detailTemplate` - HTML template či seznam vlastností objektu, které se mají zobrazovat na stránce s detailem objektu. Podrobnější popis o kousek dál.

##### HsProcessType - doplnění objektu o další údaje ze strany Hlídače

Pokud libovolný objekt (v rootu, v poli či ve vložených objektech) obsahuje vlastnost `HsProcessType` 
s některou z definovaných hodnot, je takový objekt následně a asynchronně zpracován a doplněn o další údaje na straně Hlídače.

* `"HsProcessType": "person"` - definuje, že se jedná o objekt obsahující údaje o osobě, kterou chcete provázat s databází osob Hlídače.
    Tento typ předpokládá, že je uveden u objektu obsahující tyto atributy: 
    * `Jmeno` nebo `Name` (string)
    * `Prijmeni` nebo `Surname` (string)
        * anebo namísto `Jmeno` a `Prijmeni` pouze jeden atribut `CeleJmeno` nebo `Fullname`
    * `Narozeni` nebo `Birthdate` (date)
    * `OsobaId` (string) 
    
    Hodnota `OsobaId` nemusí a neměla by být vyplněna. Při vložení záznamu do Datasetu Hlídač automaticky doplní `OsobaId` a prováže tak záznam s databází osob Hlídače.
    **Všechny uvedené atributy včetně `OsobaId` musí být uvedeny v JSONSchema datasetu.**

* `"HsProcessType": "document"` - definuje, že se jedná o objekt obsahující odkaz na dokument, který je potřeba stáhnout a umožnit jeho fulltextové prohledávání.
    Tento typ předpokládá, že je uveden u objektu obsahující tyto atributy: `DocumentUrl`(string) a `DocumentPlainText` (string).
    Hodnota `DocumentPlainText` nemusí a neměla by být vyplněna. Po vložení záznamu do Datasetu Hlídač automaticky dokument stáhne, vydoluje data a doplní `DocumentPlainText`. Tato operace se provede asynchronně během několika minut až hodin.
    **Všechny uvedené atributy včetně `DocumentPlainText` musí být uvedeny v JSONSchema datasetu.**


+ Request (application/json)
 + Headers
 
            Authorization: Token <najdes na hlidacstatu.cz/api/v1>

 + Body

            ..viz https://github.com/HlidacStatu/API/blob/master/register.sample.json

+ Response 200 (application/json)

            {
                    "datasetId": "rozhodnuti-uohs"
            }
            
+ Response 200 (application/json)

            {
                "valid": false,
                "error" : {
                    "number" : -1,
                    "description" : "dataset is already registered."
                }
            }
            
### Úprava registrace datové sady [PUT /Datasets/{datasetId}]
Zde platí totéž jako u **registrace datové sady**, s jednou podstatnou vyjímkou.

Není možné změnit hodnoty `jsonSchema` a `datasetId`. 
Pokud je potřebuješ změnit, musíš datovou sadu smazat a zaregistrovat znovu.

+ Request (application/json)
 + Headers
 
            Authorization: Token <najdes na hlidacstatu.cz/api/v1>



+ Response 200 (application/json)

            {
                "valid": true
            }

+ Response 200 (application/json)

            {
                "valid": false,
                "error" : {
                    "number" : -2,
                    "description" : "datasource not found"
                }
            }


### Smazání datové sady [DELETE /Datasets/{datasetId}]

Smazání datového zdroje. Smazat datový zdroj může pouze uživatel, který ho založil.
Operace je nevratná. 

Smazat datovou sadu může pouze ten, kdo ji založil, anebo administrátor.

+ Request (application/json)
 + Headers
 
            Authorization: Token <najdes na hlidacstatu.cz/api/v1>


+ Parameters
    + datasetId: `rozhodnuti-uohs` (string, required)


+ Response 200 (application/json)
        
            {
                "valid": true
            }

+ Response 200 (application/json)

            {
                "valid": false,
                "error" : {
                    "number" : -2,
                    "description" : "datasource not found"
                }
            }

+ Response 200 (application/json)

            {
                "valid": false,
                "error" : {
                    "number" : -3,
                    "description" : "You don't have permissions for this operation."
                }
            }

        
### Všechny datové sady [GET]

Přehled datových sad se základními údaji. Vrací pouze vlastnosti name, datasetId a description.

+ Request (application/json)
 + Headers
 
            Authorization: Token <najdes na hlidacstatu.cz/api/v1>


+ Response 200 (application/json)

        [
            {
                "name": "Rozhodnutí ÚOHS",
                "datasetId": "UOHS",
                "description" : "Sbírky rozhodnutí Úřadu pro ochranu hospodářské soutěže"
            },
            {...},
            {...}            
        ]
        
### Vypsat detaily datové sady [GET /Datasets/{datasetId}]

Vypsat podrobnosti konkrétní datové sady.

+ Request (application/json)
 + Headers
 
            Authorization: Token <najdes na hlidacstatu.cz/api/v1>

+ Parameters
    + datasetId: `rozhodnuti-uohs` (string, required)

        
+ Response 200 (application/json)

        {
         "name": "Rozhodnuti UOHS",
          "datasetId": "rozhodnuti-uohs",
          "origUrl": "http://www.uohs.cz/cs/verejne-zakazky/sbirky-rozhodnuti/",
          "sourcecodeUrl": null,
          "description": null,
          "jsonSchema": {...},
          "searchResultTemplate": {
            "properties": ["Id","Cj","Rok","Vec"]
          },
          "detailTemplate": {
            "header": "<h3>{Vec}</h3>",
            "item": "<table><tr><td>Čj</td><td>{Cj}</td><tr>.....<table>",
            "footer": "",
            "properties": null
          }
        }



### Přidat data do datového zdroje [POST /DatasetItem/{datasetId}/{dataId}?mode={mode}]

Vložení dat do datového zdroje. Vkládaná data jsou kontrolována na validitu proti JSON Schematu, které bylo vloženo při registraci datového zdroje.
Vkládaný záznam musí obsahovat vlastnost `Id`. 
Pokud již v db záznam se stejným `Id` existuje, je přepsán novým záznamem.

+ Request (application/json)
 + Headers
 
            Authorization: Token <najdes na hlidacstatu.cz/api/v1>

+ Parameters
    + datasetId: `rozhodnuti-uohs` (string, required) - datasource Id
    + dataId: 22 (string, required) - ID datového záznamu
    + mode: skip (string) - mode zpracování záznamu 
            default: **mode=skip** - nebo pokud není hodnota uvedena, tak záznam se stejným ID existuje, data se nezapíší a ignorují se; Nekontrolujeme, zda se záznamy obsahově liší.
            **mode=rewrite** - pokud záznam se stejným ID existuje, pak se přepíše vkládanými daty. 
            **mode=merge** - nový záznam přepíše hodnoty v existujících atributech staré verze objektu. 
            Pole jsou doplněna novými unikátními hodnotami. Neexistující pole v novém objektu (či pole s hodnotou null) jsou ignorována
            a nezapisují se do starého objektu (nemažou původní hodnoty).


+ Request (application/json)

        {
            //json data, validni s JSON Schema datasource
        }

+ Response 200 (application/json)

            {
                "valid": true,
                "id" : "saved record Id"
            }

+ Response 200 (application/json)

            {
                "valid": false,
                "error" : {
                    "number" : -11,
                    "description" : "Json schema validation failed",
                    "detail" : "error msg from json validator"
                }
            }


### Získaní záznamu z datového zdroje [GET /DatasetItem/{datasetId}/{dataid}]

Získání záznamu z datového zdroje

+ Request (application/json)
 + Headers
 
            Authorization: Token <najdes na hlidacstatu.cz/api/v1>

+ Parameters
    + datasetId: `rozhodnuti-uohs` (string, required) - ID datasetu
    + dataid: "123" (string, required) - ID požadovaného záznamu


+ Request (application/json)

+ Response 200 (application/json)

        {
            //pozadovany zaznam
        }

+ Response 200 (application/json)

            null // vratí null, pokud záznam neexistuje

+ Response 200 (application/json)

            {
                "valid": false,
                "error" : {
                    "number" : -2,
                    "description" : "dataset not found"
                }
            }


### Ověření existence záznamu v datovém zdroji [GET /DatasetItem_Exists/{datasetId}/{dataid}]

Ověření, zda záznam s identifikátorem `datasetId` v datovém zdroji existuje. Odpovědí je true/false.

+ Request (application/json)
 + Headers
 
            Authorization: Token <najdes na hlidacstatu.cz/api/v1>

+ Parameters
    + datasetId: `rozhodnuti-uohs` (string, required) - ID datasetu
    + dataid: "123" (string, required) - ID požadovaného záznamu


+ Request (application/json)

+ Response 200 (application/json)

        true

+ Response 200 (application/json)

            false

+ Response 200 (application/json)

            {
                "valid": false,
                "error" : {
                    "number" : -2,
                    "description" : "dataset not found"
                }
            }


### Smazání záznamu z datového zdroje [DELETE /DatasetItem/{datasetId}/{dataid}]

Smazat záznam z datového zdroje může pouze ten, kdo datovou sadu založil, anebo administrátor.
Pozor, není důležité, kdo záznam do DB vložil.

+ Request (application/json)
 + Headers
 
            Authorization: Token <najdes na hlidacstatu.cz/api/v1>

+ Parameters
    + datasetId: `rozhodnuti-uohs` (string, required) - ID datasetu
    + dataid: "123" (string, required) - ID mazaného záznamu


+ Request (application/json)

+ Response 200 (application/json)

            {
                "valid" : true
            }

+ Response 200 (application/json)

            {
                "valid": false,
                "error" : {
                    "number" : -2,
                    "description" : "dataset not found"
                }
            }

+ Response 200 (application/json)

            {
                "valid": false,
                "error" : {
                    "number" : -12,
                    "description" : "dataset Item not found"
                }
            }

### Hledání záznamů z datového zdroje [GET /DatasetSearch/{datasetId}?q={q}&page={page}&sort={sort}&desc={desc}]

Získání záznamu z datového zdroje

+ Request (application/json)
 + Headers
 
            Authorization: Token <najdes na hlidacstatu.cz/api/v1>

+ Parameters
    + datasetId: `rozhodnuti-uohs` (string, required) - ID datasetu
    + q: "obec" (string, required) - dotaz
    + page: 1 (int, required) - stránka výsledků. Max. hodnota je 200.
    + sort: "Rok" (string) - třídění výsledků, pokud není uvedeno, je dle relevance.
    + desc: false (bool) - příznak směru třídění. Defaultně vzestupně. pokud neni desc=true, vzdy je vzestupně.


+ Request (application/json)

+ Response 200 (application/json)

            {
                "total": 1025,
                "page": 1,
                "results": [{
                    "Id": "11556",
                    "Url": "http://www.uohs.cz/cs/verejne-zakazky/sbirky-rozhodnuti/detail-11556.html",
                    "Cj": "ÚOHS-S368/2013/VZ-18644/2013/512/IHl",
                    "Instance": "I.",
                    "Ucastnici": [{
                            "Jmeno": "obec Kunčice pod Ondřejníkem",
                            "ICO": "00296856"
                        },
                        {
                            "Jmeno": "van Gansewinkel, a.s.",
                            "ICO": "25848577"
                        },
                        {
                            "Jmeno": ".A.S.A., spol. s r.o.",
                            "ICO": "00546054"
                        }
                    ],
                    "Typ_spravniho_rizeni": "Veřejná zakázka",
                    "Typ_rozhodnuti": "§ 66 odst. 1 písm. g) zák. č. 500/2004 Sb. - zastaveno",
                    "Rok": "2013",
                    "PravniMoc": "2014-06-13T00:00:00+02:00",
                    "SouvisejiciUrl": null,
                    "Rozhodnuti": {
                        "Url": "http://www.uohs.cz",
                        "Html": null,
                        "PlainText": "Č. j.:ÚOHS-S368/2013/VZ-18644/2013/512/IHl,......."
                    },
                    "Uverejneno": null,
                    "Vec": "Svoz odpadů v obci Kunčice pod Ondřejníkem 18/2012"
                }, {
                    "Id": "1502",
                    "Url": "http://www.uohs.cz/cs/verejne-zakazky/sbirky-rozhodnuti/detail-1502.html",
                    "Cj": "ÚOHS-VZ/S073/01",
                    "Instance": "I.",
                    "Ucastnici": [{
                        "Jmeno": "obec Dobronín, PSČ 588 12 Dobronín, ",
                        "ICO": null
                    }],
                    "Typ_spravniho_rizeni": "Veřejná zakázka",
                    "Typ_rozhodnuti": "§ 59 písm. a) - nový výběr",
                    "Rok": "2001",
                    "PravniMoc": "2001-06-06T00:00:00+02:00",
                    "SouvisejiciUrl": null,
                    "Rozhodnuti": {
                        "Url": "http://www.uohs.cz",
                        "Html": null,
                        "PlainText": "Č. j. S 73/01-151/1958/01-če V Brně dne 18. května 2001....."
                    },
                    "Uverejneno": null,
                    "Vec": "ČOV Dobronín"
                }]
            }


+ Response 200 (application/json)

            null // vratí null, pokud záznam neexistuje

+ Response 200 (application/json)

            {
                "valid": false,
                "error" : {
                    "number" : -2,
                    "description" : "dataset not found"
                }
            }


### Poslat notifikace o nově přidaných záznamech [GET /DatasetSendNotifications/{datasetId}]

Hlídač státu sám zajistí zaslání notifikací o nových záznamech každé ráno. 
Ve výjimečných případech je možné vyvolat odeslání notifikací mimo obvyklou dobu. 
V každém případě nikdy nebudou uživatelů zaslány notifikace častěji, než mají nastaveno (obvykle jednou za 24 hodin)

+ Request (application/json)
 + Headers
 
            Authorization: Token <najdes na hlidacstatu.cz/api/v1>

+ Parameters
    + datasetId: `rozhodnuti-uohs` (string, required) - ID datasetu


+ Request (application/json)

+ Response 200 (application/json)

            {
                "valid" : true
            }



### Dohledání OsobaId osoby podle jména [GET /FindOsobaId?jmeno={jmeno}&prijmeni={prijmeni}&narozeni={narozeni}]

Podle jména osoby dohledá není identifikátor v Hlídači státu. Vyhledávání funguje s diakritikou i bez.

>OsobaId je pro Hlídač Státu primární identifikátor pro provázaní osob. 
Pokud zpracováváte datový zdroj, který pracuje s osobami, dohledejte ID osoby
před vložením záznamu do datasetu pomocí tohoto API.
Pote ho pod názvem vlastnosti `OsobaId` uložte do vaší datové struktury
Výrazně tím zlepšíte kvalitu dat v Datasetu.

Upozornění: data nejsou 100% synchronizovaná s obchodním rejstříkem a dalšími rejstříky státu, a zejména změny za poslední měsíc se zde nemusí projevit.


+ Request (application/json)
 + Headers
 
            Authorization: Token <najdes na hlidacstatu.cz/api/v1>

+ Parameters
    + jmeno: Jaroslav (string, required) - jméno osoby
    + prijmeni: Faltýnek (string, required) - jméno osoby
    + narozeni: 1962-04-28 (string, required) - datum narozeni ve formátu yyyy-MM-dd


+ Response 200 (application/json)

            {
                "Jmeno" : "Jaroslav",
                "Prijmeni" : "Faltýnek",
                "Narození" : "1951-04-28",
                "OsobaId": "jaroslav-faltynek"
            }

+ Response 200 (application/json)

            {
            }




### Dohledání IČO subjektu podle jména [GET /FindCompanyId?companyName={companyName}]

Podle jména subjektu dohledá IČO a dostupné datové schránky. Pokud není subjekt nalezen, vrátí se prázdný JSON.
Tento endpoint preferuje přesnost, proto je nutné uvést jméno subjektu přesně.

>IČO je pro Hlídač Státu primární identifikátor pro provázaní subjektů. 
Pokud zpracováváte datový zdroj, který pracuje s firmami, ale neuvádí jejich IČO, dohledejte ho - před vložením záznamu do datasetu - pomocí tohoto API. 
Výrazně tím zlepšíte kvalitu dat v Datasetu.

Upozornění: data nejsou 100% synchronizovaná s obchodním rejstříkem a dalšími rejstříky státu, a zejména změny za poslední měsíc se zde nemusí projevit.


+ Request (application/json)
 + Headers
 
            Authorization: Token <najdes na hlidacstatu.cz/api/v1>

+ Parameters
    + companyName: Metrostav%20a.s. (string, required) - plné jméno společnosti, samozřejmě URL encodovaná.


+ Response 200 (application/json)

            {
                "ICO" : "00014915",
                "Jmeno" : "Metrostav a.s.",
                "DatovaSchranka" : ["bnpcf46"]
            }

+ Response 200 (application/json)

            {
            }




## Group HTML Teplate - syntaxe, funkce

### HTML template pro searchResultTemplate a detailTemplate 

Template je možné definovat dvěma způsoby:

1. pomocí seznamu vlastností - v takovém případě do `properties` dáš textové pole, které obsahuje seznam vlastností, které se mají vypsat.
O vhodný způsob zobrazení se postará Hlídač státu. To je snadná a jednoduchá cesta pro rychlý výpis údajů. Je to vhodné pro testování.
Doporučujeme v takovém případě nastavit v registraci datového zdroje `betaversion = true`. 
Hodnota `body`  musí být `null`.
    ```
    {
        "body": null,
        "properties": ["Id","Cj","Rok","Vec"]
    }
    ```

2. velmi detailně pomocí HTML. K tomu slouží vlastnost `body`. Je to volný template 
```
    {
        "body": "<table><tr><td>Čj</td><td>{{item.Cj}}</td><tr>.....<table>",
        "properties": null
    }
```

Pokud jsou nastaveny jak `body`, tak `properties` nastaveny, `properties` se ignorují. 
Pokud jsou obě `null`, zobrazí se chyba při renderování stránky.

### Syntaxe HTML Template - Scriban

Jedná se o template engine kompatibilní s `liquid`. 

Stručny přehled najdete zde https://github.com/lunet-io/scriban, přehlednou dokumentaci na https://github.com/lunet-io/scriban/tree/master/doc

Hlídač státu zajiští, že se do templatu vloží vždy odpovídající datová struktura

#### Vyhledávání

Do template pro vyhledávání se vkládá .NET datová struktura obdobná dále uvedené struktuře. 
Pro přehlednost je zde uvedena v JSON formě. V `Result` je pole nalezených zaznamů v jejich struktuře

```
{
    "model" : {
        "Total": 10,
        "Page": 1,
        "Q": "hledaný výraz"
        "Result" : [{ "Id" = "id zaznamu" },{"nazev":"Pojmenování"}{"atribut2":"hodnota2"}] 
}
```

Typický `searchResultTemplate` pro vyhledávání vypadá takto:

```
<table class="table table-hover">
    <thead>
        <tr>
            <th>ID</th>
            <th>Název</th>
            <th>Další pole</th>
        </tr>
    </thead>
    <tbody>
                        
{{ for item in model.Result }}
           <tr>
                <td style="white-space: nowrap;">
                    <a href="{{fn_DatasetItemUrl item.Id}}">{{item.Id}}</a>
                </td>
                <td style="white-space: nowrap;">
                    {{item.Nazev}}
                </td>
                <td>
                    {{fn_FormatDate item.atribut2  "dd.MM.yyyy"}}
                </td>
                <td>
                    {{fn_ShortenText item.Vec 200}}
                </td>
            </tr>
{{end }}
</tbody></table>
```

#### Detail záznamu

Do template pro vyhledávání se vkládá .NET datová struktura obdobná dále uvedené struktuře. 
V `model` obsahuje jeden záznam v jejo originál struktuře odpovídající JSON schema.
Pro přehlednost je zde uvedena v JSON formě.

```
{
    "model" : {
        { "Id" = "id zaznamu" },
        {"Nazev":"Pojmenování"}, 
        {"atribut2":"hodnota2"}
    }
}
```

Typický `detailTemplate` pro vyhledávání vypadá takto:

```
{{this.item = model #nepovinne, pouze sjednocení pojmenování záznamu s templatem pro jeden zaznam. Bez tohoto řádku by jste namísto 'item' psali 'model' }}
<table class="table table-hover">
        <tbody>
            <tr>
                <td>Id</td>
                <td>{{item.Id}}</td>
            </tr>
            <tr>
                <td>Pojmenování</td>
                <td>{{item.Nazev}}</td>
            </tr>
            {{ if item.atribut2}}
                <tr>
                    <td>Další pole</td>
                    <td>{{fn_FormatDate item.atribut2  "dd.MM.yyyy"}}</td>
                </tr>
            {{end}}
        </tbody>
    </table>
```


> Pozor! Rozlišují se velká a malá písmena.


### Dostupné funkce pro formátování výstupu

V kódu je možné volat speciální funkce pro formátování hodnot. 
V `Scriban` se funkce volají **s parametry oddělenými mezerou**

`string {{fn_ShortenText "text" 50}}` - zkrácení textu na max. 50 znaků, funkce vrací string

Dále uvádíme seznam dostupných funkcí nad rámec [build-in funkcí Scribanu](https://github.com/lunet-io/scriban/blob/master/doc/builtins.md).

`string fn_ShortenText(string value, int length)` - zkrácení textu na maximální délku `length` znaků.
ke zkrácení dojde na nejbližším konci slova, odstavce či věty.

`string fn_FixPlainText(string plaintext)` - funkce, která upraví čistý text pro lepší čitelnost. Vhodné zejména pro delší texty či obsahy dokumentů.
V praxi se odstraní nadbytečné a příliš se opakující řádky a další speciální znaky. Ná

`string fn_NormalizeText(dynamic text)` - vymaže všechny HTML znáčky a přebytečné neviditelné znaky.

`boolean fn_IsNullOrEmpty(object obj)` - otestuje, zda je object null anebo retezec prazdny. Vhodne pro otestovani existence pole apod. 

`string fn_RenderPersonWithLink(string osobaId, string jmeno, string prijmeni, string rokNarozeni = "")` - vyrendruje jméno, příjmení a rok narození osoby s odkazem na její profil

`string fn_RenderPersonStatistic(string osobaId, bool twoLines = false, string prefix = "", string postfix = "")` - pro existující osobu vrací základní statistiku vztahů na osobu navázaných firem se státem. Jinak prázdný řetezec.

`string fn_RenderPersonWithLink2(string osobaId)` -  vrací jméno, příjmení a rok narození osoby s odkazem na její profil. Pokud osoba neexistuje, vrací prázdný string

`string fn_RenderPersonNoLink(string osobaId, string jmeno="", string prijmeni="", string rokNarozeni ="") - vrací jméno osoby podle osobaId. Pokud není nalezena, vrátí osobu v dalších parametrech nebo prázdný string

`string fn_RenderCompanyWithLink(string ico)` - pro existující firmu vrací její název a odkaz na její profil. Jinak vrátí pouze IČO.

`string fn_RenderCompanyStatistic(string ico, bool twoLines = false, string prefix = "", string postfix = "")` - pro existující firmu vrací základní statistiku vztahů firmy se státem. Pro neexistující IČO prázdný řetezec.

`string fn_FormatDate(datetime value, string format)` - zobrazení data podle určeného formátu. 
Pokud není `format` určen, je null nebo prázdný, použije se formát `d.M.yyyy`. Pro formátování použijte syntaxi [.NET c# custom date and time format](https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings).

`string fn_FormatNumber(dynamic value, string format = null)` - naformátuje číslo. Formát může mít hodnoty "cs" nebo "en". Podle toho je zvolen formát čísla.

`string fn_FormatPrice(dynamic value, string mena = "Kč")` - naformátuje číslo jako cenu s měnou Kč

`string fn_Pluralize(dynamic pocet, string zeroText, string oneText, string twoText, string moreText)` - slova/věty v závislosti podle počtu. příklad: `fn_Pluralize total  "žádné nové zakázky"  "jednu novou zakázku"  "{0} nové zakázky"  "{0} nových zakázek"`



## Group Transparetní účty 

Seznam tranparetních účtů politických stran a jednotlivé položky na transparetních účtech firem.


### Položky transparetního účtu [GET /ucetexport?id={cislouctu}]

+ Request (application/json)
 + Headers
 
            Authorization: Token <najdes na hlidacstatu.cz/api/v1>

+ Parameters
    + cislouctu: 4080247%2F0100 (string, required) - číslo účetu, UrlEncodované

+ Response 200 (application/json)



+ Response 200 (application/json)

        {
            "bankovniUcet": {
                "Active": 1,
                "ApiUrl": "https://www.hlidacstatu.cz/api/v1/ucetexport?id=4080247%2F0100",
                "CisloUctu": "4080247/0100",
                "Id": "4080247/0100",
                "LastSuccessfullParsing": "2018-11-23T07:23:19.6656457+01:00",
                "Mena": "Kč",
                "Nazev": "Parlamentní volby 2017",
                "Subjekt": "ANO 2011",
                "TypSubjektu": "Politická strana",
                "TypUctu": 2,
                "Url": "https://www.kb.cz/cs/transparentni-ucty/ano-2011-volebni-ucet-ano-2011-czk",
                "numTypUctu": 2
            },
            "polozky": [
                {
                    "AddId": "",
                    "BU": {
                        "Active": 1,
                        "ApiUrl": "https://www.hlidacstatu.cz/api/v1/ucetexport?id=4080247%2F0100",
                        "CisloUctu": "4080247/0100",
                        "Id": "4080247/0100",
                        "LastSuccessfullParsing": "2018-11-23T07:23:19.6656457+01:00",
                        "Mena": "Kč",
                        "Nazev": "Parlamentní volby 2017",
                        "Subjekt": "ANO 2011",
                        "TypSubjektu": "Politická strana",
                        "TypUctu": 2,
                        "Url": "https://www.kb.cz/cs/transparentni-ucty/ano-2011-volebni-ucet-ano-2011-czk",
                        "numTypUctu": 2
                    },
                    "Castka": -2700.0,
                    "CisloProtiuctu": "2010201091/0710",
                    "CisloUctu": "4080247/0100",
                    "Comments": [],
                    "Datum": "2017-06-13T00:00:00+02:00",
                    "Id": "0F8D2AEDAE943EEA2D89C7B4580E3E0A",
                    "KS": "3558",
                    "NazevProtiuctu": "–",
                    "PopisTransakce": "Šeky (Platba na vrub vašeho účtu)",
                    "SS": "–",
                    "VS": "71443339",
                    "ZdrojUrl": "https://www.kb.cz/cs/transparentni-ucty/176311179-ano-2011/detail-uctu-4080247-19.shtml",
                    "ZpravaProPrijemce": "9000000029 PYORD0000010547 VOJENSKA ZDRAVOTNI POJISTOVNA CR DRAHOBEJLOVA 1404/4PRAHA 9 ICO:47114975ZP ZAMESTNANEC"
                },
                {
                    "AddId": "",
                    "BU": {
                        "Active": 1,
                        "ApiUrl": "https://www.hlidacstatu.cz/api/v1/ucetexport?id=4080247%2F0100",
                        "CisloUctu": "4080247/0100",
                        "Id": "4080247/0100",
                        "LastSuccessfullParsing": "2018-11-23T07:23:19.6656457+01:00",
                        "Mena": "Kč",
                        "Nazev": "Parlamentní volby 2017",
                        "Subjekt": "ANO 2011",
                        "TypSubjektu": "Politická strana",
                        "TypUctu": 2,
                        "Url": "https://www.kb.cz/cs/transparentni-ucty/ano-2011-volebni-ucet-ano-2011-czk",
                        "numTypUctu": 2
                    },
                    "Castka": -5000.0,
                    "CisloProtiuctu": "970388093/0800",
                    "CisloUctu": "4080247/0100",
                    "Comments": [],
                    "Datum": "2017-07-21T00:00:00+02:00",
                    "Id": "B4142EA2D0D067642EC8F5F885EF9176",
                    "KS": "558",
                    "NazevProtiuctu": "–",
                    "PopisTransakce": "Šeky (Platba na vrub vašeho účtu)",
                    "SS": "–",
                    "VS": "4130000115",
                    "ZdrojUrl": "https://www.kb.cz/cs/transparentni-ucty/176311179-ano-2011/detail-uctu-4080247-16.shtml",
                    "ZpravaProPrijemce": "4130000115 PYORD0000010887 BC. JANA HAJNA DONSKA 941LIBEREC DAT.NAR.:05.06.1976PROVOZNI ZA"
                }
            }
        }


## Group Hlídač státních webů

Statistiky dostupnosti nejdůležitějších webů, API a služeb veřejné správy.
Všechna data mohou mít zpoždění až 15 minut a obnovují se každých přibližně 10 minut.

> **Nestahuj data častěji než každých 10 minut a nezatěžuj tak zbytečně server sobě i ostatním uživatelům.**

Pokud bys potřeboval data téměř v reálném čase, napiš na api@hlidacstatu.cz.

### Monitorované služby [GET /WebList]

Seznam monitorovaných webů, API a služeb, jejich ID a kontrolní řetezce.

+ Request (application/json)
 + Headers
 
            Authorization: Token <najdes na hlidacstatu.cz/api/v1>


+ Response 200 (application/json)

+ Response 200 (application/json)

        [
                {
                    "hash": "6306B57A524363D494F83CED45FFF372",
                    "host": "HTTPS nen.nipez.cz",
                    "hostid": "10107",
                    "opendataUrl": "https://www.hlidacstatu.cz/statniweby/data/10107?h=6306B57A524363D494F83CED45FFF372",
                    "popis": "Elektronický nástroj pro administraci a zadávání veřejných zakázek a koncesí pro všechny kategorie veřejných zakázek a všechny kategorie zadavatelů, vč. sektorových. NEN podporuje všechny rozsahy elektronizace od evidence zadávacích řízení po plně elektronické postupy.",
                    "publicname": "Národní Elektronický Nástroj",
                    "urad": "Ministerstvo pro místní rozvoj",
                    "url": "https://nen.nipez.cz"
                },
                {
                    "hash": "8380EF85E36393EF3F94F8178509C5D7",
                    "host": "HTTPS adisepo.mfcr.cz",
                    "hostid": "10161",
                    "opendataUrl": "https://www.hlidacstatu.cz/statniweby/data/10161?h=8380EF85E36393EF3F94F8178509C5D7",
                    "popis": "Elektronická Podání Pro Finanční Správu",
                    "publicname": "Elektronická podání pro FS",
                    "urad": "Ministerstvo financí",
                    "url": "https://adisepo.mfcr.cz/"
                }
                ///...
            ]

### Dostupnost a údaje služby [GET /WebStatus/{id}?h={hash}]

Statistiky dostupnosti webu, popis a stav HTTPS. Hodnota `Response` je v sekundách.

`ssl.grade` nabývá hodnot A+,A,A-,B,C,D,E,F,M,T,X. Jejich význam najdeš [na webu](https://www.hlidacstatu.cz/StatniWeby/Https).

+ Request (application/json)
 + Headers
 
            Authorization: Token <najdes na hlidacstatu.cz/api/v1>

+ Parameters
    + id: 10354 (int, required) - ID webu
    + hash: "E30C4A49D63CDB7616740F0EEA98D2B4" (string, required) - kontrolní řetezec unikátní pro každý web


+ Request (application/json)

+ Response 200 (application/json)

            {
                "availability": {
                    "Data": [
                        {
                            "HttpStatusCode": 200,
                            "Response": 0.087,
                            "Time": "2018-09-07T12:36:36+02:00"
                        },
                        {
                            "HttpStatusCode": 200,
                            "Response": 0.0457,
                            "Time": "2018-09-07T12:37:37+02:00"
                        },
            ///....
                        {
                            "HttpStatusCode": 200,
                            "Response": 0.0322,
                            "Time": "2018-09-14T13:35:18+02:00"
                        }
                    ],
                    "Host": {
                        "hash": "E30C4A49D63CDB7616740F0EEA98D2B4",
                        "host": "HTTPS www.datoveschranky.info aplikacni-rozhrani",
                        "hostid": "10354",
                        "opendataUrl": "https://www.hlidacstatu.cz/statniweby/data/10354?h=E30C4A49D63CDB7616740F0EEA98D2B4",
                        "popis": "Jádro Datových schránek, API rozhraní pro posílání a příjem DS.",
                        "publicname": "API datových schránek",
                        "urad": "Ministerstvo vnitra",
                        "url": "https://www.datoveschranky.info/dulezite-informace/aplikacni-rozhrani"
                    }
                },
                "ssl": {
                    "copyright": "(c) © Qualys, Inc. https://www.ssllabs.com/",
                    "fullreport": "https://www.ssllabs.com/ssltest/analyze.html?d=ws1.mojedatovaschranka.cz",
                    "grade": "B",
                    "time": "2018-09-14T04:49:54Z"
                }
            }