Module entities/entity.party

Party related methods

Abgeordnetenwatch API Documentation

Index

Type aliases

Variables

url

Functions

Type aliases

PartyListResult

PartyListResult: { data: EntityParty[]; meta: ResponseMeta }

List result

Type declaration

data: EntityParty[]
meta: ResponseMeta

PartyRelatedDataParameter

PartyRelatedDataParameter: "show_information" | "members"

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

PartyResult

PartyResult: { data: EntityParty; meta: ResponseEntityMeta }

Single item result

Type declaration

data: EntityParty
meta: ResponseEntityMeta

Variables

Const url

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

Service Endpoint

Abgeordnetenwatch API documentation

Functions

Const party

party(id: number, relatedData?: null | "show_information" | "members"): Promise<PartyResult>

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

PartyResult as JSON

Const partyList

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

- Defined in src/entities/entity.party.ts:58
Get a list of Parties
```
response = await partyList();
```
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<PartyListResult>

PartyListResult as JSON

Generated using TypeDoc