Module entities/entity.country

Country related methods

Abgeordnetenwatch API Documentation

Index

Type aliases

Variables

url

Functions

Type aliases

CountryListResult

CountryListResult: { data: EntityCountry[]; meta: ResponseMeta }

List result

Type declaration

data: EntityCountry[]
meta: ResponseMeta

CountryResult

CountryResult: { data: EntityCountry; meta: ResponseEntityMeta }

Single item result

Type declaration

data: EntityCountry
meta: ResponseEntityMeta

Variables

Const url

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

Service Endpoint

Abgeordnetenwatch API documentation

Functions

Const country

country(id: number): Promise<CountryResult>

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

CountryResult as JSON

Const countryList

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

- Defined in src/entities/entity.country.ts:53
Get a list of Countries
```
response = await countryList();
```
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<CountryListResult>

CountryListResult as JSON

Generated using TypeDoc