Module entities/entity.committee-membership

Commitee membership related methods

Abgeordnetenwatch API Documentation

Index

Type aliases

Variables

url

Functions

Type aliases

CommitteeMembershipListResult

CommitteeMembershipListResult: { data: EntityCommitteeMembership[]; meta: ResponseMeta }

List result

Type declaration

data: EntityCommitteeMembership[]
meta: ResponseMeta

CommitteeMembershipResult

CommitteeMembershipResult: { data: EntityCommitteeMembership; meta: ResponseEntityMeta }

Single item result

Type declaration

data: EntityCommitteeMembership
meta: ResponseEntityMeta

Variables

Const url

url: "https://www.abgeordnetenwatch.de/api/v2/committee-memberships" = 'https://www.abgeordnetenwatch.de/api/v2/committee-memberships'

Service Endpoint

Abgeordnetenwatch API documentation

Functions

Const committeeMembership

committeeMembership(id: number): Promise<CommitteeMembershipResult>

- Defined in src/entities/entity.committee-membership.ts:71
Get a single CommitteeMembership
```
response = await committeeMembership(5);
```
Parameters
- id: number
  
  Id of the CommitteeMembership
Returns Promise<CommitteeMembershipResult>

CommitteeMembershipResult as JSON

Const committeeMembershipList

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

- Defined in src/entities/entity.committee-membership.ts:53
Get a list of CommitteeMemberships
```
response = await committeeMembershipList();
```
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<CommitteeMembershipListResult>

CommitteeMembershipListResult as JSON

Generated using TypeDoc