Hi API dokumentace

Generátor oslovení pro česká jména a příjmení

Download .zip Download .tar.gz View on GitHub

Hi

Generátor oslovení pro česká jména a příjmení.

API wrapper pro PHP lze nalézt na https://github.com/ondrs/Hi

Použití

API rozhraní je přistupné přes URL http://hi.ondraplsek.cz s následujícími parametry:

name 
    - textový řetězec 
    - povinný parametr
    - 1.pád (nominativ) jména nebo příjmení, pro které chceme zjistit 5.pád (vocativ)

type 
    - textový řetězec 
    - může nabývat dvou hodnot: 'name' nebo 'surname'
    - nepovinný parametr
    - určuje zda se jedná o jméno nebo příjmení

gender
    - textový řetězec 
    - může nabývat dvou hodnot: 'male' nebo 'female'
    - nepovinný parametr
    - určuje pohlaví

Ukázkové volání

http://hi.ondraplsek.cz?name=plšek&type=surname&gender=male

Navrátová hodnota je JSON objekt s následujícmi vlastnostmi:

succes
    - boolean
    - true pokud se podařilo nalézt alespoň jedno oslovení, false pokud se nepodařilo nalézt ani jedno oslovení

count
    - number
    - počet nalezených oslovení

results
    - array
    - pole JSON objektů obsahující oslovení

        - nominativ
            - string
            - 1.pád

        - vocativ
            - string
            - 5. pád, požadované oslovení

        - type
            - string, nabývá hodnot 'name' nebo 'surname'
            - zda se jedná o jméno nebo příjmení

        - gender
            - string, nabývá hodnot 'male' nebo 'female'
            - určuje pohlaví

declension:
    - JSON objekt
    - vygenerované pády pro jednotné a množné číslo

Ukázkový výstup:

{
    "success": true,
    "count": 1,
    "results": [
        {
            "nominativ": "Plšek",
            "vocativ": "Plšku",
            "type": "surname",
            "gender": "male"
        }
    ],
    declension: {
            1: "plšek",
            2: "plška",
            3: "plškovi",
            4: "plška",
            5: "plšku",
            6: "plškovi",
            7: "plškem",
            8: "plškové",
            9: "plšků",
            10: "plškům",
            11: "plšky",
            12: "plškové",
            13: "plšcích",
            14: "plšky"
    }
}