Module entities/entity.committee

Commitee related methods

Abgeordnetenwatch API Documentation

Index

Type aliases

Variables

url

Functions

Type aliases

CommitteeListResult

CommitteeListResult: { data: EntityCommittee[]; meta: ResponseMeta }

List result

Type declaration

data: EntityCommittee[]
meta: ResponseMeta

CommitteeRelatedDataParameter

CommitteeRelatedDataParameter: "show_information" | "committee_memberships" | "polls"

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

CommitteeResult

CommitteeResult: { data: EntityCommittee; meta: ResponseEntityMeta }

Single item result

Type declaration

data: EntityCommittee
meta: ResponseEntityMeta

Variables

Const url

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

Service Endpoint

Abgeordnetenwatch API documentation

Functions

Const committee

committee(id: number, relatedData?: null | "show_information" | "committee_memberships" | "polls"): Promise<CommitteeResult>

- Defined in src/entities/entity.committee.ts:78
Get a single Committee
```
response = await committee(5);
```
Parameters
- id: number
  
  Id of the Committee.
- relatedData: null | "show_information" | "committee_memberships" | "polls" = null
  
  Possible related Data you can include in the result
Returns Promise<CommitteeResult>

CommitteeResult as JSON

Const committeeList

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

- Defined in src/entities/entity.committee.ts:59
Get a list of Committees
```
response = await committeeList();
```
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<CommitteeListResult>

CommitteeListResult as JSON

Generated using TypeDoc