Search
Preparing search index...
The search index is not available
@malereg/aowatch-client - v1.3.3
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
@malereg/aowatch-client - v1.3.3
types
Module types
Index
Type aliases
Entity
Candidacy
Mandate
Entity
City
Entity
Committee
Entity
Committee
Membership
Entity
Constituency
Entity
Country
Entity
Election
Program
Entity
Electoral
List
Entity
Fraction
Entity
Parliament
Entity
Parliament
Period
Entity
Party
Entity
Politician
Entity
Poll
Entity
Related
Data
Entity
Sidejob
Entity
Sidejob
Organization
Entity
Topic
Entity
Vote
Filter
Parameter
Value
Filter
Parameters
Meta
Api
Version
Meta
Result
Meta
Result
Entity
Meta
Status
Operator
Operator
Filter
Parameters
Pager
Parameters
Range
Parameters
Request
Parameters
Response
Entity
Meta
Response
Meta
Sort
Parameters
String
Sort
Direction
Type aliases
Entity
Candidacy
Mandate
Entity
Candidacy
Mandate
:
{
api_url
:
string
;
electoral_data
:
any
;
end_date
:
string
;
entity_type
:
string
;
fraction_membership
:
any
;
id
:
number
;
id_external_administration
:
string
;
id_external_administration_description
:
string
;
info
:
string
;
label
:
string
;
parliament_period
:
EntityParliamentPeriod
;
party
:
any
;
politician
:
EntityPolitician
;
related_data
?:
any
;
start_date
:
string
;
type
:
"candidacy"
|
"mandate"
}
Type declaration
api_
url
:
string
electoral_
data
:
any
end_
date
:
string
entity_
type
:
string
fraction_
membership
:
any
id
:
number
id_
external_
administration
:
string
id_
external_
administration_
description
:
string
info
:
string
label
:
string
parliament_
period
:
EntityParliamentPeriod
party
:
any
politician
:
EntityPolitician
Optional
related_
data
?:
any
start_
date
:
string
type
:
"candidacy"
|
"mandate"
Entity
City
Entity
City
:
{
api_url
:
string
;
entity_type
:
string
;
id
:
number
;
label
:
string
}
Type declaration
api_
url
:
string
entity_
type
:
string
id
:
number
label
:
string
Entity
Committee
Entity
Committee
:
{
abgeordnetenwatch_url
:
string
;
api_url
:
string
;
entity_type
:
string
;
field_legislature
:
EntityParliamentPeriod
;
field_topics
:
any
[]
;
id
:
number
;
label
:
string
;
related_data
?:
any
}
Type declaration
abgeordnetenwatch_
url
:
string
api_
url
:
string
entity_
type
:
string
field_
legislature
:
EntityParliamentPeriod
field_
topics
:
any
[]
id
:
number
label
:
string
Optional
related_
data
?:
any
Entity
Committee
Membership
Entity
Committee
Membership
:
{
api_url
:
string
;
candidacy_mandate
:
any
;
committee
:
EntityCommittee
;
committee_role
:
string
;
entity_type
:
string
;
id
:
number
;
label
:
string
}
Type declaration
api_
url
:
string
candidacy_
mandate
:
any
committee
:
EntityCommittee
committee_
role
:
string
entity_
type
:
string
id
:
number
label
:
string
Entity
Constituency
Entity
Constituency
:
{
api_url
:
string
;
entity_type
:
string
;
id
:
number
;
label
:
string
;
name
:
string
;
number
:
number
;
parliament_period
:
EntityParliamentPeriod
}
Type declaration
api_
url
:
string
entity_
type
:
string
id
:
number
label
:
string
name
:
string
number
:
number
parliament_
period
:
EntityParliamentPeriod
Entity
Country
Entity
Country
:
{
api_url
:
string
;
entity_type
:
string
;
id
:
number
;
label
:
string
}
Type declaration
api_
url
:
string
entity_
type
:
string
id
:
number
label
:
string
Entity
Election
Program
Entity
Election
Program
:
{
api_url
:
string
;
entity_type
:
string
;
file
:
string
;
id
:
number
;
label
:
string
;
link
:
any
;
parliament_period
:
EntityParliamentPeriod
;
party
:
EntityParty
}
Type declaration
api_
url
:
string
entity_
type
:
string
file
:
string
id
:
number
label
:
string
link
:
any
parliament_
period
:
EntityParliamentPeriod
party
:
EntityParty
Entity
Electoral
List
Entity
Electoral
List
:
{
api_url
:
string
;
entity_type
:
string
;
id
:
number
;
label
:
string
;
name
:
string
;
parliament_period
:
EntityParliamentPeriod
}
Type declaration
api_
url
:
string
entity_
type
:
string
id
:
number
label
:
string
name
:
string
parliament_
period
:
EntityParliamentPeriod
Entity
Fraction
Entity
Fraction
:
{
abgeordnetenwatch_url
:
string
;
api_url
:
string
;
entity_type
:
string
;
full_name
:
string
;
id
:
number
;
label
:
string
;
legislature
:
string
;
short_name
:
string
}
Type declaration
abgeordnetenwatch_
url
:
string
api_
url
:
string
entity_
type
:
string
full_
name
:
string
id
:
number
label
:
string
legislature
:
string
short_
name
:
string
Entity
Parliament
Entity
Parliament
:
{
abgeordnetenwatch_url
:
string
;
api_url
:
string
;
current_project
:
EntityParliamentPeriod
;
entity_type
:
string
;
id
:
number
;
label
:
string
;
label_external_long
:
string
;
related_data
?:
any
}
Type declaration
abgeordnetenwatch_
url
:
string
api_
url
:
string
current_
project
:
EntityParliamentPeriod
entity_
type
:
string
id
:
number
label
:
string
label_
external_
long
:
string
Optional
related_
data
?:
any
Entity
Parliament
Period
Entity
Parliament
Period
:
{
abgeordnetenwatch_url
:
string
;
api_url
:
string
;
election_date
:
string
|
null
;
end_date_period
:
string
;
entity_type
:
string
;
id
:
number
;
label
:
string
;
parliament
:
EntityParliament
;
previous_peroid
:
EntityParliamentPeriod
;
related_data
?:
any
;
start_date_period
:
string
;
type
:
string
}
Type declaration
abgeordnetenwatch_
url
:
string
api_
url
:
string
election_
date
:
string
|
null
end_
date_
period
:
string
entity_
type
:
string
id
:
number
label
:
string
parliament
:
EntityParliament
previous_
peroid
:
EntityParliamentPeriod
Optional
related_
data
?:
any
start_
date_
period
:
string
type
:
string
Entity
Party
Entity
Party
:
{
api_url
:
string
;
entity_type
:
string
;
full_name
:
string
;
id
:
number
;
label
:
string
;
related_data
?:
any
}
Type declaration
api_
url
:
string
entity_
type
:
string
full_
name
:
string
id
:
number
label
:
string
Optional
related_
data
?:
any
Entity
Politician
Entity
Politician
:
{
abgeordnetenwatch_url
:
string
;
api_url
:
string
;
birth_name
:
string
;
deceased
:
boolean
;
deceased_date
:
string
;
education
:
string
;
entity_type
:
string
;
field_title
:
string
;
first_name
:
string
;
id
:
number
;
label
:
string
;
last_name
:
string
;
occupation
:
string
;
party
:
any
;
party_past
:
string
;
qid_wikidata
:
string
;
related_data
?:
any
;
residence
:
string
;
sex
:
string
;
statistic_questions
:
string
;
statistic_questions_answered
:
string
;
year_of_birth
:
number
}
Type declaration
abgeordnetenwatch_
url
:
string
api_
url
:
string
birth_
name
:
string
deceased
:
boolean
deceased_
date
:
string
education
:
string
entity_
type
:
string
field_
title
:
string
first_
name
:
string
id
:
number
label
:
string
last_
name
:
string
occupation
:
string
party
:
any
party_
past
:
string
qid_
wikidata
:
string
Optional
related_
data
?:
any
residence
:
string
sex
:
string
statistic_
questions
:
string
statistic_
questions_
answered
:
string
year_
of_
birth
:
number
Entity
Poll
Entity
Poll
:
{
abgeordnetenwatch_url
:
string
;
api_url
:
string
;
entity_type
:
string
;
field_committees
:
EntityCommittee
;
field_intro
:
string
;
field_legislature
:
EntityParliamentPeriod
;
field_poll_date
:
string
;
field_related_links
:
any
[]
;
field_topics
:
any
[]
;
id
:
number
;
label
:
string
;
related_data
?:
any
}
Type declaration
abgeordnetenwatch_
url
:
string
api_
url
:
string
entity_
type
:
string
field_
committees
:
EntityCommittee
field_
intro
:
string
field_
legislature
:
EntityParliamentPeriod
field_
poll_
date
:
string
field_
related_
links
:
any
[]
field_
topics
:
any
[]
id
:
number
label
:
string
Optional
related_
data
?:
any
Entity
Related
Data
Entity
Related
Data
:
{
all_parliament_periods
?:
EntityRelatedData
;
elections
?:
any
;
legislatures
?:
any
}
Type declaration
Optional
all_
parliament_
periods
?:
EntityRelatedData
Optional
elections
?:
any
Optional
legislatures
?:
any
Entity
Sidejob
Entity
Sidejob
:
{
additional_information
:
string
;
api_url
:
string
;
category
:
string
;
created
:
number
;
data_change_date
:
string
;
entity_type
:
string
;
field_city
:
EntityCity
;
field_country
:
EntityCountry
;
id
:
number
;
income_level
:
string
;
interval
:
string
;
label
:
string
;
mandates
:
EntityCandidacyMandate
[]
;
sidejob_organization
:
EntitySidejobOrganization
;
topics
:
EntityTopic
[]
}
Type declaration
additional_
information
:
string
api_
url
:
string
category
:
string
created
:
number
data_
change_
date
:
string
entity_
type
:
string
field_
city
:
EntityCity
field_
country
:
EntityCountry
id
:
number
income_
level
:
string
interval
:
string
label
:
string
mandates
:
EntityCandidacyMandate
[]
sidejob_
organization
:
EntitySidejobOrganization
topics
:
EntityTopic
[]
Entity
Sidejob
Organization
Entity
Sidejob
Organization
:
{
api_url
:
string
;
entity_type
:
string
;
field_city
:
EntityCity
;
field_country
:
EntityCountry
;
field_topics
:
EntityTopic
[]
;
id
:
number
;
label
:
string
}
Type declaration
api_
url
:
string
entity_
type
:
string
field_
city
:
EntityCity
field_
country
:
EntityCountry
field_
topics
:
EntityTopic
[]
id
:
number
label
:
string
Entity
Topic
Entity
Topic
:
{
abgeordnetenwatch_url
:
string
;
api_url
:
string
;
description
:
string
;
entity_type
:
string
;
id
:
number
;
label
:
string
;
parent
?:
EntityTopic
}
Type declaration
abgeordnetenwatch_
url
:
string
api_
url
:
string
description
:
string
entity_
type
:
string
id
:
number
label
:
string
Optional
parent
?:
EntityTopic
Entity
Vote
Entity
Vote
:
{
api_url
:
string
;
entity_type
:
string
;
id
:
number
;
label
:
string
;
mandate
:
EntityCandidacyMandate
;
poll
:
EntityPoll
;
reason_no_show
:
string
;
reason_no_show_other
:
string
;
vote
:
string
}
Type declaration
api_
url
:
string
entity_
type
:
string
id
:
number
label
:
string
mandate
:
EntityCandidacyMandate
poll
:
EntityPoll
reason_
no_
show
:
string
reason_
no_
show_
other
:
string
vote
:
string
Filter
Parameter
Value
Filter
Parameter
Value
:
{}
Type declaration
[
x:
string
]:
string
|
number
Filter
Parameters
Filter
Parameters
:
{}
Type declaration
[
x:
string
]:
string
|
number
Meta
Api
Version
Meta
Api
Version
:
"2.0"
Meta
Result
Meta
Result
:
{
count
:
number
;
range_end
:
number
;
range_start
:
number
;
total
:
number
}
Type declaration
count
:
number
range_
end
:
number
range_
start
:
number
total
:
number
Meta
Result
Entity
Meta
Result
Entity
:
{
entity_id
:
string
;
entity_type
:
string
}
Type declaration
entity_
id
:
string
entity_
type
:
string
Meta
Status
Meta
Status
:
"error"
|
"ok"
Operator
Operator
:
"eq"
|
"gt"
|
"gte"
|
"lt"
|
"lte"
|
"ne"
|
"sw"
|
"cn"
|
"ew"
Operator
Filter
Parameters
Operator
Filter
Parameters
:
{
field
:
string
;
operator
:
Operator
;
value
:
string
|
number
}
Type declaration
field
:
string
operator
:
Operator
value
:
string
|
number
Pager
Parameters
Pager
Parameters
:
{
page
:
number
;
pager_limit
:
number
}
Type declaration
page
:
number
pager_
limit
:
number
Range
Parameters
Range
Parameters
:
{
range_end
:
number
;
range_start
:
number
}
Type declaration
range_
end
:
number
range_
start
:
number
Request
Parameters
Request
Parameters
:
{}
Type declaration
[
x:
string
]:
string
|
number
|
any
|
FilterParameterValue
Response
Entity
Meta
Response
Entity
Meta
:
{
abgeordnetenwatch_api
:
{
documentation
:
string
;
version
:
MetaApiVersion
}
;
result
:
MetaResultEntity
;
status
:
MetaStatus
;
status_message
:
string
}
Type declaration
abgeordnetenwatch_
api
:
{
documentation
:
string
;
version
:
MetaApiVersion
}
documentation
:
string
version
:
MetaApiVersion
result
:
MetaResultEntity
status
:
MetaStatus
status_
message
:
string
Response
Meta
Response
Meta
:
{
abgeordnetenwatch_api
:
{
documentation
:
string
;
version
:
MetaApiVersion
}
;
result
:
MetaResult
|
MetaResultEntity
;
status
:
MetaStatus
;
status_message
:
string
}
Type declaration
abgeordnetenwatch_
api
:
{
documentation
:
string
;
version
:
MetaApiVersion
}
documentation
:
string
version
:
MetaApiVersion
result
:
MetaResult
|
MetaResultEntity
status
:
MetaStatus
status_
message
:
string
Sort
Parameters
Sort
Parameters
:
{
sort_by
:
string
;
sort_direction
:
StringSortDirection
}
Type declaration
sort_
by
:
string
sort_
direction
:
StringSortDirection
String
Sort
Direction
String
Sort
Direction
:
"asc"
|
"desc"
Modules
aowatch-
client
create-
request-
query
entities/entity.candidacy-
mandate
entities/entity.city
entities/entity.committee
entities/entity.committee-
membership
entities/entity.constituency
entities/entity.country
entities/entity.election-
program
entities/entity.electoral-
list
entities/entity.fraction
entities/entity.parliament
entities/entity.parliament-
period
entities/entity.party
entities/entity.politician
entities/entity.poll
entities/entity.sidejob
entities/entity.sidejob-
organization
entities/entity.topic
entities/entity.vote
extract-
links
is-
filter-
parameters
list-
all
types
Entity
Candidacy
Mandate
Entity
City
Entity
Committee
Entity
Committee
Membership
Entity
Constituency
Entity
Country
Entity
Election
Program
Entity
Electoral
List
Entity
Fraction
Entity
Parliament
Entity
Parliament
Period
Entity
Party
Entity
Politician
Entity
Poll
Entity
Related
Data
Entity
Sidejob
Entity
Sidejob
Organization
Entity
Topic
Entity
Vote
Filter
Parameter
Value
Filter
Parameters
Meta
Api
Version
Meta
Result
Meta
Result
Entity
Meta
Status
Operator
Operator
Filter
Parameters
Pager
Parameters
Range
Parameters
Request
Parameters
Response
Entity
Meta
Response
Meta
Sort
Parameters
String
Sort
Direction
Generated using
TypeDoc