Module entities/entity.poll

Poll related methods

Abgeordnetenwatch API Documentation

Index

Type aliases

Variables

url

Functions

Type aliases

PollListResult

PollListResult: { data: EntityPoll[]; meta: ResponseMeta }

List result

Type declaration

data: EntityPoll[]
meta: ResponseMeta

PollRelatedDataParameter

PollRelatedDataParameter: "show_information" | "votes"

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

PollResult

PollResult: { data: EntityPoll; meta: ResponseEntityMeta }

Single item result

Type declaration

data: EntityPoll
meta: ResponseEntityMeta

Variables

Const url

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

Service Endpoint

Abgeordnetenwatch API documentation

Functions

Const poll

poll(id: number, relatedData?: null | "show_information" | "votes"): Promise<PollResult>

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

PollResult as JSON

Const pollList

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

- Defined in src/entities/entity.poll.ts:58
Get a list of Polls
```
response = await pollList();
```
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<PollListResult>

PollListResult as JSON

Generated using TypeDoc