Module entities/entity.election-program

Election program related methods

Abgeordnetenwatch API Documentation

Index

Type aliases

Variables

url

Functions

Type aliases

ElectionProgramListResult

ElectionProgramListResult: { data: EntityElectionProgram[]; meta: ResponseMeta }

List result

Type declaration

data: EntityElectionProgram[]
meta: ResponseMeta

ElectionProgramResult

ElectionProgramResult: { data: EntityElectionProgram; meta: ResponseEntityMeta }

Single item result

Type declaration

data: EntityElectionProgram
meta: ResponseEntityMeta

Variables

Const url

url: "https://www.abgeordnetenwatch.de/api/v2/election-program" = 'https://www.abgeordnetenwatch.de/api/v2/election-program'

Service Endpoint

Abgeordnetenwatch API documentation

Functions

Const electionProgram

electionProgram(id: number): Promise<ElectionProgramResult>

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

ElectionProgramResult as JSON

Const electionProgramList

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

- Defined in src/entities/entity.election-program.ts:53
Get a list of ElectionPrograms
```
response = await electionProgramList();
```
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<ElectionProgramListResult>

ElectionProgramListResult as JSON

Generated using TypeDoc