Module entities/entity.city

City related methods

Abgeordnetenwatch API Documentation

Index

Type aliases

Variables

url

Functions

Type aliases

CityListResult

CityListResult: { data: EntityCity[]; meta: ResponseMeta }

List result

Type declaration

data: EntityCity[]
meta: ResponseMeta

CityResult

CityResult: { data: EntityCity; meta: ResponseEntityMeta }

Single item result

Type declaration

data: EntityCity
meta: ResponseEntityMeta

Variables

Const url

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

Service Endpoint

Abgeordnetenwatch API documentation

Functions

Const city

city(id: number): Promise<CityResult>

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

CityResult as JSON

Const cityList

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

- Defined in src/entities/entity.city.ts:53
Get a list of Cities
```
response = await cityList();
```
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<CityListResult>

CityListResult as JSON

Generated using TypeDoc