Module entities/entity.topic

Topic related methods

Abgeordnetenwatch API Documentation

Index

Type aliases

Variables

url

Functions

Type aliases

TopicListResult

TopicListResult: { data: EntityTopic[]; meta: ResponseMeta }

List result

Type declaration

data: EntityTopic[]
meta: ResponseMeta

TopicResult

TopicResult: { data: EntityTopic; meta: ResponseEntityMeta }

Single item result

Type declaration

data: EntityTopic
meta: ResponseEntityMeta

Variables

Const url

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

Service Endpoint

Abgeordnetenwatch API documentation

Functions

Const topic

topic(id: number): Promise<TopicResult>

- Defined in src/entities/entity.topic.ts:72
Get a single Topic
```
response = await candidacyMandate(5);
```
Parameters
- id: number
  
  Id of the Topic.
Returns Promise<TopicResult>

TopicResult as JSON

Const topicList

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

- Defined in src/entities/entity.topic.ts:53
Get a list of Topics
```
response = await topicList();
```
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<TopicListResult>

TopicListResult as JSON

Generated using TypeDoc