Module entities/entity.candidacy-mandate

Candicay mandate related methods

Abgeordnetenwatch API Documentation

Index

Type aliases

Variables

url

Functions

Type aliases

CandidacyMandateListResult

CandidacyMandateListResult: { data: EntityCandidacyMandate[]; meta: ResponseMeta }

List result

Type declaration

data: EntityCandidacyMandate[]
meta: ResponseMeta

CandidacyMandateRelatedDataParameter

CandidacyMandateRelatedDataParameter: "show_information" | "politician" | "votes"

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

CandidacyMandateResult

CandidacyMandateResult: { data: EntityCandidacyMandate; meta: ResponseEntityMeta }

Single item result

Type declaration

data: EntityCandidacyMandate
meta: ResponseEntityMeta

Variables

Const url

url: "https://www.abgeordnetenwatch.de/api/v2/candidacies-mandates" = 'https://www.abgeordnetenwatch.de/api/v2/candidacies-mandates'

Service Endpoint

Abgeordnetenwatch API documentation

Functions

Const candidacyMandate

candidacyMandate(id: number, relatedData?: null | "show_information" | "politician" | "votes"): Promise<CandidacyMandateResult>

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

CandidacyMandateResult as JSON

Const candidacyMandateList

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

- Defined in src/entities/entity.candidacy-mandate.ts:58
Get a list of CandidacyMandates
```
response = await candidacyMandateList();
```
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<CandidacyMandateListResult>

CandidacyMandateResult as JSON

Generated using TypeDoc