Module entities/entity.politician

Politician related methods

Abgeordnetenwatch API Documentation

Index

Type aliases

Variables

url

Functions

Type aliases

PoliticanRelatedDataParameter

PoliticanRelatedDataParameter: "show_information" | "mandates" | "candidacies" | "all_candidacies_mandates" | "votes"

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

PoliticianListResult

PoliticianListResult: { data: EntityPolitician[]; meta: ResponseMeta }

List result

Type declaration

data: EntityPolitician[]
meta: ResponseMeta

PoliticianResult

PoliticianResult: { data: EntityPolitician; meta: ResponseEntityMeta }

Single item result

Type declaration

data: EntityPolitician
meta: ResponseEntityMeta

Variables

Const url

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

Service Endpoint

Abgeordnetenwatch API documentation

Functions

Const politician

politician(id: number, relatedData?: null | "show_information" | "votes" | "mandates" | "candidacies" | "all_candidacies_mandates"): Promise<PoliticianResult>

- Defined in src/entities/entity.politician.ts:77
Get a single Politician
```
response = await politician(5);
```
Parameters
- id: number
  
  Id of the Politician.
- relatedData: null | "show_information" | "votes" | "mandates" | "candidacies" | "all_candidacies_mandates" = null
  
  Possible related Data you can include in the result
Returns Promise<PoliticianResult>

PoliticianResult as JSON

Const politicianList

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

- Defined in src/entities/entity.politician.ts:58
Get a list of Politicians
```
response = await politicianList();
```
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<PoliticianListResult>

PoliticianListResult as JSON

Generated using TypeDoc