Module entities/entity.sidejob-organization

Sidejob organization related methods

Abgeordnetenwatch API Documentation

Index

Type aliases

Variables

url

Functions

Type aliases

SidejobOrganizationListResult

SidejobOrganizationListResult: { data: EntitySidejobOrganization[]; meta: ResponseMeta }

List result

Type declaration

data: EntitySidejobOrganization[]
meta: ResponseMeta

SidejobOrganizationResult

SidejobOrganizationResult: { data: EntitySidejobOrganization; meta: ResponseEntityMeta }

Single item result

Type declaration

data: EntitySidejobOrganization
meta: ResponseEntityMeta

Variables

Const url

url: "https://www.abgeordnetenwatch.de/api/v2/sidejob-organizations" = 'https://www.abgeordnetenwatch.de/api/v2/sidejob-organizations'

Service Endpoint

Abgeordnetenwatch API documentation

Functions

Const sidejobOrganization

sidejobOrganization(id: number): Promise<SidejobOrganizationResult>

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

SidejobOrganizationResult as JSON

Const sidejobOrganizationList

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

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

SidejobOrganizationListResult as JSON

Generated using TypeDoc