Module entities/entity.electoral-list

Electoral list related methods

Abgeordnetenwatch API Documentation

Index

Type aliases

Variables

url

Functions

Type aliases

ElectoralListListResult

ElectoralListListResult: { data: EntityElectoralList[]; meta: ResponseMeta }

List result

Type declaration

data: EntityElectoralList[]
meta: ResponseMeta

ElectoralListResult

ElectoralListResult: { data: EntityElectoralList; meta: ResponseEntityMeta }

Single item result

Type declaration

data: EntityElectoralList
meta: ResponseEntityMeta

Variables

Const url

url: "https://www.abgeordnetenwatch.de/api/v2/electoral-lists" = 'https://www.abgeordnetenwatch.de/api/v2/electoral-lists'

Service Endpoint

Abgeordnetenwatch API documentation

Functions

Const electoralList

electoralList(id: number): Promise<ElectoralListResult>

- Defined in src/entities/entity.electoral-list.ts:72
Get a single ElectoralList
```
response = await electoralList(5);
```
Parameters
- id: number
  
  Id of the ElectoralList
Returns Promise<ElectoralListResult>

ElectoralListResult as JSON

Const electoralListList

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

- Defined in src/entities/entity.electoral-list.ts:53
Get a list of ElectoralLists
```
response = await electoralListList();
```
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<ElectoralListListResult>

ElectoralListListResult as JSON

Generated using TypeDoc