Module entities/entity.parliament

Parliament related methods

Abgeordnetenwatch API Documentation

Index

Type aliases

Variables

url

Functions

Type aliases

ParliamentListResult

ParliamentListResult: { data: EntityParliament[]; meta: ResponseMeta }

List result

Type declaration

data: EntityParliament[]
meta: ResponseMeta

ParliamentRelatedDataParameter

ParliamentRelatedDataParameter: "show_information" | "legislatures" | "elections" | "all_parliament_periods"

Possible extra data that you can include on the response for a single item

ParliamentResult

ParliamentResult: { data: EntityParliament; meta: ResponseEntityMeta }

Single item result

Type declaration

data: EntityParliament
meta: ResponseEntityMeta

Variables

Const url

url: "https://www.abgeordnetenwatch.de/api/v2/parliaments" = 'https://www.abgeordnetenwatch.de/api/v2/parliaments'

Service Endpoint

Abgeordnetenwatch API documentation

Functions

Const parliament

parliament(id: number, relatedData?: null | "show_information" | "legislatures" | "elections" | "all_parliament_periods"): Promise<ParliamentResult>

- Defined in src/entities/entity.parliament.ts:77
Get a single Parliament
```
response = await parliament(5);
```
Parameters
- id: number
  
  Id of the Parliament.
- relatedData: null | "show_information" | "legislatures" | "elections" | "all_parliament_periods" = null
  
  Possible related Data you can include in the result
Returns Promise<ParliamentResult>

ParliamentResult as JSON

Const parliamentList

parliamentList(params?: null | PagerParameters | RangeParameters, sort?: null | SortParameters, filter?: FilterParameters | OperatorFilterParameters[]): Promise<ParliamentListResult>

- Defined in src/entities/entity.parliament.ts:58
Get a list of Parliaments
```
response = await parliamentList();
```
Parameters
- Optional params: null | PagerParameters | RangeParameters
  
  PagerParameters for Paging, RangeParameters for limiting the results or null
- Optional sort: null | SortParameters
  
  Sort simply by a property or more complex by a list of properties
- Optional filter: FilterParameters | OperatorFilterParameters[]
Returns Promise<ParliamentListResult>

ParliamentListResult as JSON

Generated using TypeDoc