Module entities/entity.fraction

Fraction related methods

Abgeordnetenwatch API Documentation

Index

Type aliases

Variables

url

Functions

Type aliases

FractionListResult

FractionListResult: { data: EntityFraction[]; meta: ResponseMeta }

List result

Type declaration

data: EntityFraction[]
meta: ResponseMeta

FractionResult

FractionResult: { data: EntityFraction; meta: ResponseEntityMeta }

Single item result

Type declaration

data: EntityFraction
meta: ResponseEntityMeta

Variables

Const url

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

Service Endpoint

Abgeordnetenwatch API documentation

Functions

Const fraction

fraction(id: number): Promise<FractionResult>

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

FractionResult as JSON

Const fractionList

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

- Defined in src/entities/entity.fraction.ts:53
Get a list of Fractions
```
response = await fractionList();
```
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<FractionListResult>

FractionListResult as JSON

Generated using TypeDoc