Piratské Integrační API

Version 2.2.2 - OpenAPI 3.0.3

About

Piratské Integrační API

License

Artistic License 2.0

Contact information

andrej@x2.cz

Servers

Resources

CSUVotesResults

Volební vysledky za okresy a obce

Parameters

Name In Type Required Description
type path string Yes Typ voleb
year path integer Yes Rok voleb
region query string Yes Kod kraje (dle ciselniku NUTS)
subject query integer Yes Cislo volebniho subjektu

Response 200

Vysledky voleb
{"application\/json":{"schema":{"items":{"$ref":"#\/components\/schemas\/VotesMunicipality"},"type":"array"}}}

Response 400

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 404

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 500

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 501

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Calendar

Veřejný kalendář z mraku

Parameters

Name In Type Required Description
token path string Yes Calendar token
begin query string No Začátek období
days query integer No Počet dnů

Response 200

Veřejný kalendář
{"application\/json":{"schema":{"properties":{"days":{"description":"Seznam udalosti","items":{"$ref":"#\/components\/schemas\/CalendarDay"},"type":"array"},"name":{"description":"Nazev","type":"string"},"owner":{"description":"Vlastnik (login)","type":"string"},"url":{"description":"Webova adresa","type":"string"}},"type":"object"}}}

Response 400

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 404

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 500

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 501

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Group

Uzivatelska skupina z fora

Parameters

Name In Type Required Description
id path integer Yes Identifikator

Response 200

Skupina
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Group"}}}

Response 400

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 404

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 500

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 501

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

GroupMembers

Uzivatele fora ve skupine

Parameters

Name In Type Required Description
id path integer Yes identifikator skupiny
with_generated_email query boolean No Doplnovat email generovany z username

Response 200

Seznam uzivatelu
{"application\/json":{"schema":{"items":{"$ref":"#\/components\/schemas\/UserInList"},"type":"array"}}}

Response 400

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 404

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 500

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 501

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Groups

Hledani skupiny na foru

Parameters

Name In Type Required Description
search query string No Search query

Response 200

Seznam skupin z foru
{"application\/json":{"schema":{"items":{"$ref":"#\/components\/schemas\/GroupInList"},"type":"array"}}}

Response 400

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 404

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 500

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 501

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

MemberGroupSize

Velikost skupiny členů

Skupinou členů se rozumí jen taková skupina, která čítá aspoň stanovený počet členů strany, kteří podpořili určitý návrh. Počet členů se stanoví u návrhu na zahájení jednání jako dvojnásobek druhé odmocniny z počtu přítomných členů, nejméně však jedna setina a nejvýše jedna pětina z počtu přítomných členů. U návrhu na již zahájeném jednání se takto stanovený počet snižuje na polovinu.

Parameters

Name In Type Required Description
team_size query integer No Celkový počet clenů

Response 200

This resource is not documented.

null

Response 400

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 404

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 500

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 501

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

OctopusGroups

Hledani skupiny v Chobotnici

Parameters

Name In Type Required Description
search query string No Search query

Response 200

Seznam skupin
{"application\/json":{"schema":{"items":{"$ref":"#\/components\/schemas\/GroupInList"},"type":"array"}}}

Response 400

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 404

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 500

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 501

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

OctopusGroupsByIds

Skupiny z Chobotnici dle id

Parameters

Name In Type Required Description
ids path array Yes Search query

Response 200

Seznam skupin
{"application\/json":{"schema":{"items":{"$ref":"#\/components\/schemas\/GroupInList"},"type":"array"}}}

Response 400

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 404

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 500

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 501

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

OctopusUser

Uzivatel v Chobotnici

Parameters

Name In Type Required Description
id path string Yes Identifikator (interni nebo keycloak)

Response 200

Uzivatel v chubotnici
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/OctoUser"}}}

Response 400

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 404

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 500

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 501

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

OctopusUsers

Hledani uzivatele v Chobotnici

Parameters

Name In Type Required Description
search query string No Search query

Response 200

Seznam uzivatelu
{"application\/json":{"schema":{"items":{"$ref":"#\/components\/schemas\/OctoUser"},"type":"array"}}}

Response 400

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 404

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 500

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 501

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

User

Uzivatel

Parameters

Name In Type Required Description
username query string Yes Uzivatelske jmeno

Response 200

Uzivatel
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/User"}}}

Response 400

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 404

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 500

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 501

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

UserInGroup

Oveřeni členstvi uživatele ve skupine

Parameters

Name In Type Required Description
id path integer Yes Identifikátor skupiny
username query string Yes Uživatelské jméno

Response 200

Členstvi ve skupine
{"application\/json":{"schema":{"properties":{"has_user":{"type":"boolean"}},"type":"object"}}}

Response 400

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 404

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 500

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 501

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Users

Seznam uzivatelu

Parameters

Name In Type Required Description
search query string Yes Search query

Response 200

Seznam uzivatelu
{"application\/json":{"schema":{"items":{"$ref":"#\/components\/schemas\/UserInList"},"type":"array"}}}

Response 400

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 404

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 500

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 501

Default response.
{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Parameters

Components

  • CalendarDay
  • CalendarEvent
  • DefaultResponse
  • Group
  • GroupInList
  • GroupSize
  • OctoUser
  • User
  • UserInList
  • VotesMunicipality