Module entities/entity.sidejob

Sidejob related methods

Abgeordnetenwatch API Documentation

Index

Type aliases

Variables

url

Functions

Type aliases

SidejobListResult

SidejobListResult: { data: EntitySidejob[]; meta: ResponseMeta }

List result

Type declaration

data: EntitySidejob[]
meta: ResponseMeta

SidejobResult

SidejobResult: { data: EntitySidejob; meta: ResponseEntityMeta }

Single item result

Type declaration

data: EntitySidejob
meta: ResponseEntityMeta

Variables

Const url

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

Service Endpoint

Abgeordnetenwatch API documentation

Functions

Const sidejob

sidejob(id: number): Promise<SidejobResult>

- Defined in src/entities/entity.sidejob.ts:70
Get a single Sidejob
```
response = await sidejob(5);
```
Parameters
- id: number
  
  Id of the Sidejob.
Returns Promise<SidejobResult>

SidejobResult as JSON

Const sidejobList

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

- Defined in src/entities/entity.sidejob.ts:53
Get a list of Sidejobs
```
response = await sidejobList();
```
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<SidejobListResult>

SidejobListResult as JSON

Generated using TypeDoc