Module entities/entity.constituency

Constituency related methods

Abgeordnetenwatch API Documentation

Index

Type aliases

Variables

url

Functions

Type aliases

ConstituencyListResult

ConstituencyListResult: { data: EntityConstituency[]; meta: ResponseMeta }

List result

Type declaration

data: EntityConstituency[]
meta: ResponseMeta

ConstituencyResult

ConstituencyResult: { data: EntityConstituency; meta: ResponseEntityMeta }

Single item result

Type declaration

data: EntityConstituency
meta: ResponseEntityMeta

Variables

Const url

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

Service Endpoint

Abgeordnetenwatch API documentation

Functions

Const constituency

constituency(id: number): Promise<ConstituencyResult>

- Defined in src/entities/entity.constituency.ts:71
Get a single Constituency
```
response = await constituency(5);
```
Parameters
- id: number
  
  Id of the Constituency.
Returns Promise<ConstituencyResult>

ConstituencyResult as JSON

Const constituencyList

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

- Defined in src/entities/entity.constituency.ts:53
Get a list of Constituencies
```
response = await constituencyList();
```
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<ConstituencyListResult>

ConstituencyListResult as JSON

Generated using TypeDoc