Module entities/entity.vote

Vote related methods

Abgeordnetenwatch API Documentation

Index

Type aliases

Variables

url

Functions

Type aliases

VoteListResult

VoteListResult: { data: EntityVote[]; meta: ResponseMeta }

List result

Type declaration

data: EntityVote[]
meta: ResponseMeta

VoteResult

VoteResult: { data: EntityVote; meta: ResponseEntityMeta }

Single item result

Type declaration

data: EntityVote
meta: ResponseEntityMeta

Variables

Const url

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

Service Endpoint

Abgeordnetenwatch API documentation

Functions

Const vote

vote(id: number): Promise<VoteResult>

- Defined in src/entities/entity.vote.ts:70
Get a single Vote
```
response = await vote(5);
```
Parameters
- id: number
  
  Id of the CandidacyMandate.
Returns Promise<VoteResult>

VoteResult as JSON

Const voteList

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

- Defined in src/entities/entity.vote.ts:52
Get a list of Votes
```
response = await voteList();
```
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<VoteListResult>

VoteListResult as JSON

Generated using TypeDoc