Openpolis Data Manager API
All APIs in OPDM.
api-list
api-mappepotere
v1 > areas > list
Return a list of all the existing Area resources
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
search | A search term. |
ordering | Which field to use when ordering the results. |
name__iexact | Filter areas by exact name. Case insensitive. Example: "Roma" |
name__icontains | Filter areas by string in name. Case insensitive. Example: "Piemonte 1" |
identifier__istartswith | Get areas by main identifier's prefix. |
parent__identifier | Filter areas by identifier of the parent. Example: RM. |
min_inhabitants | Minimum number of inhabitants |
max_inhabitants | Maximum number of inhabitants |
classification | Geonames classification: ADM1, ADM2, ADM3, ... |
istat_classification | ISTAT classifications: RIP, REG, PROV, CM, COM |
active_status | Status of the items: current, past or future. |
active_at | Filters items active at the given date. Dates can be expressed as: YYYY-MM-DD, YYYY-MM or YYYY. |
active_from | Filters items active since the given date. Dates can be expressed as: YYYY-MM-DD, YYYY-MM or YYYY. |
active_to | Filters items active up to the given date. Dates can be expressed as: YYYY-MM-DD, YYYY-MM or YYYY. |
start_date | Get items having this exact start date. Dates can be expressed as: YYYY-MM-DD, YYYY-MM or YYYY. |
end_date | Get items having this exact end date. Dates can be expressed as: YYYY-MM-DD, YYYY-MM or YYYY. |
created_after | Filters items created in the database after the given date and time. Date and time must be expressed according to ISO 8601. |
updated_after | Filters items updated in the database after the given date and time. Date and time must be expressed according to ISO 8601. |
identifier_scheme | Lookup items with identifiers having this scheme. See `/identifier_types` for available schemes |
identifier_value | Lookup items with identifiers having this value. Usually used together with identifier_scheme. |
op_id | Get areas by Openpolis ID |
identifier | Get areas by main identifier. An identifier can be a cadastral code for municipalities (e.g. H501), a province acronym for provinces (e.g. RM), a region code for regions (e.g. 12). |
v1 > areas > create
Create a new Area resource.
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | The official, issued name |
identifier required | The main issued identifier |
classification | An area category, according to GEONames definitions: http://www.geonames.org/export/codes.html |
istat_classification required | An area category, according to ISTAT: Ripartizione Geografica, Regione, Provincia, Città Metropolitana, Comune |
is_provincial_capital | If the city is a provincial capital.Takes the Null value if not a municipality. |
inhabitants | Il numero totale di abitanti |
parent required | |
start_date | Data di inizio validità del dato |
end_date | Data di fine validità del dato |
end_reason | The reason why the entity isn't valid any longer (eg: merge) |
v1 > areas > autocompleter
Values for area auto-completer. The same parameters of the list
section apply
v1 > areas > comuni_with_prov_and_istat_identifiers
Returs all comuni, with prov and ISTAT identifiers
v1 > areas > identifier_types
Gets the list of all distinct Identifier types used so far.
:return: A paginated Response, containing the list of all used identifier values as of now.
:rtype: Response
v1 > areas > read
Return the given Area resource
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Area geografica. |
v1 > areas > update
Update the given Area resource.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Area geografica. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | The official, issued name |
identifier required | The main issued identifier |
classification | An area category, according to GEONames definitions: http://www.geonames.org/export/codes.html |
istat_classification required | An area category, according to ISTAT: Ripartizione Geografica, Regione, Provincia, Città Metropolitana, Comune |
is_provincial_capital | If the city is a provincial capital.Takes the Null value if not a municipality. |
inhabitants | Il numero totale di abitanti |
parent required | |
start_date | Data di inizio validità del dato |
end_date | Data di fine validità del dato |
end_reason | The reason why the entity isn't valid any longer (eg: merge) |
v1 > areas > partial_update
Update the given Area resource.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Area geografica. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | The official, issued name |
identifier | The main issued identifier |
classification | An area category, according to GEONames definitions: http://www.geonames.org/export/codes.html |
istat_classification | An area category, according to ISTAT: Ripartizione Geografica, Regione, Provincia, Città Metropolitana, Comune |
is_provincial_capital | If the city is a provincial capital.Takes the Null value if not a municipality. |
inhabitants | Il numero totale di abitanti |
parent | |
start_date | Data di inizio validità del dato |
end_date | Data di fine validità del dato |
end_reason | The reason why the entity isn't valid any longer (eg: merge) |
v1 > areas > delete
Delete the given Area resource.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Area geografica. |
v1 > areas > children
Shows all areas children of a given one
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Area geografica. |
v1 > areas > former_children
Shows an area's former children
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Area geografica. |
v1 > areas > organizations
Shows all organizations of a given area
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Area geografica. |
v1 > candidate_results > list
A serializer for ElectoralCandidateResult model.
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
v1 > candidate_results > create
A serializer for ElectoralCandidateResult model.
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | |
result required | |
votes | |
votes_perc | |
is_counselor | |
is_top | |
tmp_candidate |
v1 > candidate_results > read
A serializer for ElectoralCandidateResult model.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Electoral candidate result. |
v1 > candidate_results > update
A serializer for ElectoralCandidateResult model.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Electoral candidate result. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | |
result required | |
votes | |
votes_perc | |
is_counselor | |
is_top | |
tmp_candidate |
v1 > candidate_results > partial_update
A serializer for ElectoralCandidateResult model.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Electoral candidate result. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | |
result | |
votes | |
votes_perc | |
is_counselor | |
is_top | |
tmp_candidate |
v1 > candidate_results > delete
A serializer for ElectoralCandidateResult model.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Electoral candidate result. |
v1 > classifications > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
search | A search term. |
ordering | Which field to use when ordering the results. |
scheme | |
code | |
descr | |
active_status | Status of the items: current, past or future. |
active_at | Filters items active at the given date. Dates can be expressed as: YYYY-MM-DD, YYYY-MM or YYYY. |
active_from | Filters items active since the given date. Dates can be expressed as: YYYY-MM-DD, YYYY-MM or YYYY. |
active_to | Filters items active up to the given date. Dates can be expressed as: YYYY-MM-DD, YYYY-MM or YYYY. |
start_date | Get items having this exact start date. Dates can be expressed as: YYYY-MM-DD, YYYY-MM or YYYY. |
end_date | Get items having this exact end date. Dates can be expressed as: YYYY-MM-DD, YYYY-MM or YYYY. |
created_after | Filters items created in the database after the given date and time. Date and time must be expressed according to ISO 8601. |
updated_after | Filters items updated in the database after the given date and time. Date and time must be expressed according to ISO 8601. |
v1 > classifications > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
scheme required | A classification scheme, e.g. ATECO, or FORMA_GIURIDICA |
code required | An alphanumerical code in use within the scheme |
descr required | The extended, textual description of the classification |
parent required |
v1 > classifications > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Classification. |
v1 > classifications > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Classification. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
scheme required | A classification scheme, e.g. ATECO, or FORMA_GIURIDICA |
code required | An alphanumerical code in use within the scheme |
descr required | The extended, textual description of the classification |
parent required |
v1 > classifications > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Classification. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
scheme | A classification scheme, e.g. ATECO, or FORMA_GIURIDICA |
code | An alphanumerical code in use within the scheme |
descr | The extended, textual description of the classification |
parent |
v1 > classifications > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Classification. |
v1 > electoral_results > list
A serializer for ElectoralResult model.
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
search | A search term. |
ordering | Which field to use when ordering the results. |
electoral_event__id | |
electoral_event__event_type | |
has_second_round | Select Yes for results with second round. |
institution__id | |
constituency__id |
v1 > electoral_results > read
A serializer for ElectoralResult model.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Electoral result. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
ordering | Which field to use when ordering the results. |
electoral_event__id | |
electoral_event__event_type | |
has_second_round | Select Yes for results with second round. |
institution__id | |
constituency__id |
v1 > electoral_results > candidate_results
Return electoral candidate results for the event.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Electoral result. |
v1 > electoral_results > list_results
Return electoral list results for the event.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Electoral result. |
v1 > keyevents > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
search | A search term. |
ordering | Which field to use when ordering the results. |
name | Filter key events by name |
event_type | Filter key events by type: ELE: election, XAD: external adm , ITL: italian leg., EUL: eu leg. |
identifier | Filter key events by identifier |
v1 > keyevents > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | A primary, generic name, e.g.: Local elections 2016 |
event_type | The electoral type, e.g.: election, legislature, ... |
identifier | L'identificativo principale |
start_date required | Data di inizio validità del dato |
end_date | Data di fine validità del dato |
end_reason | The reason why the entity isn't valid any longer (eg: merge) |
v1 > keyevents > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Key event. |
v1 > keyevents > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Key event. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | A primary, generic name, e.g.: Local elections 2016 |
event_type | The electoral type, e.g.: election, legislature, ... |
identifier | L'identificativo principale |
start_date required | Data di inizio validità del dato |
end_date | Data di fine validità del dato |
end_reason | The reason why the entity isn't valid any longer (eg: merge) |
v1 > keyevents > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Key event. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | A primary, generic name, e.g.: Local elections 2016 |
event_type | The electoral type, e.g.: election, legislature, ... |
identifier | L'identificativo principale |
start_date | Data di inizio validità del dato |
end_date | Data di fine validità del dato |
end_reason | The reason why the entity isn't valid any longer (eg: merge) |
v1 > keyevents > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Key event. |
v1 > list_results > list
A serializer for ElectoralListResult model.
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
v1 > list_results > create
A serializer for ElectoralListResult model.
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
result required | |
name required | |
image | |
votes | |
votes_perc | |
seats | |
candidate_result required | |
political_colour required | |
parties required | |
tmp_lists | A list of electoral list names stored in the electoral_list_descr_tmp field, containing all lists connected to this electoral result. |
v1 > list_results > read
A serializer for ElectoralListResult model.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Electoral list result. |
v1 > list_results > update
A serializer for ElectoralListResult model.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Electoral list result. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
result required | |
name required | |
image | |
votes | |
votes_perc | |
seats | |
candidate_result required | |
political_colour required | |
parties required | |
tmp_lists | A list of electoral list names stored in the electoral_list_descr_tmp field, containing all lists connected to this electoral result. |
v1 > list_results > partial_update
A serializer for ElectoralListResult model.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Electoral list result. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
result | |
name | |
image | |
votes | |
votes_perc | |
seats | |
candidate_result | |
political_colour | |
parties | |
tmp_lists | A list of electoral list names stored in the electoral_list_descr_tmp field, containing all lists connected to this electoral result. |
v1 > list_results > delete
A serializer for ElectoralListResult model.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Electoral list result. |
v1 > list_results > memberships
Return memberships connected to this electoral list.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Electoral list result. |
v1 > memberships > list
Return a list of all the existing Membership resources.
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
search | A search term. |
ordering | Which field to use when ordering the results. |
label | |
role | |
organization__id | |
person__id | |
active_status | Status of the items: current, past or future. |
active_at | Filters items active at the given date. Dates can be expressed as: YYYY-MM-DD, YYYY-MM or YYYY. |
active_from | Filters items active since the given date. Dates can be expressed as: YYYY-MM-DD, YYYY-MM or YYYY. |
active_to | Filters items active up to the given date. Dates can be expressed as: YYYY-MM-DD, YYYY-MM or YYYY. |
start_date | Get items having this exact start date. Dates can be expressed as: YYYY-MM-DD, YYYY-MM or YYYY. |
end_date | Get items having this exact end date. Dates can be expressed as: YYYY-MM-DD, YYYY-MM or YYYY. |
created_after | Filters items created in the database after the given date and time. Date and time must be expressed according to ISO 8601. |
updated_after | Filters items updated in the database after the given date and time. Date and time must be expressed according to ISO 8601. |
v1 > memberships > create
Transform the request.data before creating the membership record:
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
label | La denominazione che descrive la membership |
role | Il ruolo ricoperto dalla persona nell'organizzazione |
person required | |
member_organization required | |
on_behalf_of required | |
organization required | |
electoral_event required | |
post required | |
start_date | Data di inizio validità del dato |
end_date | Data di fine validità del dato |
end_reason | The reason why the entity isn't valid any longer (eg: merge) |
area required | |
classifications required | |
appointed_by required | |
is_appointment_locked | A flag that shows if this appointment is locked (set to true when manually creating the appointment) |
appointment_note | A textual note for this appointment, if needed. |
appointees required | |
constituency_descr_tmp | |
electoral_list_descr_tmp | |
contact_details required | |
links required | |
sources required |
v1 > memberships > partial_update
Partially update a collection of Mermbership resources.
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
label | La denominazione che descrive la membership |
role | Il ruolo ricoperto dalla persona nell'organizzazione |
person | |
member_organization | |
on_behalf_of | |
organization | |
electoral_event | |
post | |
start_date | Data di inizio validità del dato |
end_date | Data di fine validità del dato |
end_reason | The reason why the entity isn't valid any longer (eg: merge) |
area | |
classifications | |
appointed_by | |
is_appointment_locked | A flag that shows if this appointment is locked (set to true when manually creating the appointment) |
appointment_note | A textual note for this appointment, if needed. |
appointees | |
constituency_descr_tmp | |
electoral_list_descr_tmp | |
contact_details | |
links | |
sources |
v1 > memberships > classification_types
Gets the list of all distinct Classification types used so far.
:return: A paginated Response, containing the list of all used classification values as of now.
:rtype: Response
v1 > memberships > tmp_lists
List of all distinct values of tmp_lists for the memberships. organization_id needs to be specified in filters, electoral_event_id can be specified
A limit of 100 is imposed, to avoid problems whenever filters are not set
Null values are purged from the list
v1 > memberships > read
Return the given Membership resource.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Membership. |
v1 > memberships > update
Transform the request.data before updating the membership record:
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Membership. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
label | La denominazione che descrive la membership |
role | Il ruolo ricoperto dalla persona nell'organizzazione |
person required | |
member_organization required | |
on_behalf_of required | |
organization required | |
electoral_event required | |
post required | |
start_date | Data di inizio validità del dato |
end_date | Data di fine validità del dato |
end_reason | The reason why the entity isn't valid any longer (eg: merge) |
area required | |
classifications required | |
appointed_by required | |
is_appointment_locked | A flag that shows if this appointment is locked (set to true when manually creating the appointment) |
appointment_note | A textual note for this appointment, if needed. |
appointees required | |
constituency_descr_tmp | |
electoral_list_descr_tmp | |
contact_details required | |
links required | |
sources required |
v1 > memberships > partial_update_0
Transform the request.data before patching the membership record:
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Membership. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
label | La denominazione che descrive la membership |
role | Il ruolo ricoperto dalla persona nell'organizzazione |
person | |
member_organization | |
on_behalf_of | |
organization | |
electoral_event | |
post | |
start_date | Data di inizio validità del dato |
end_date | Data di fine validità del dato |
end_reason | The reason why the entity isn't valid any longer (eg: merge) |
area | |
classifications | |
appointed_by | |
is_appointment_locked | A flag that shows if this appointment is locked (set to true when manually creating the appointment) |
appointment_note | A textual note for this appointment, if needed. |
appointees | |
constituency_descr_tmp | |
electoral_list_descr_tmp | |
contact_details | |
links | |
sources |
v1 > memberships > delete
Delete the given Membership resource.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Membership. |
v1 > memberships > appointees
Shows all memberships appointed by this one. The usual filters for memberships can be used, for example:
/memberships/{id}/appointees?status=current
will only show current appointed memberships in the organization.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Membership. |
v1 > memberships > electoral_list_results
Return electoral list results connected to this membership.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Membership. |
v1 > organization_relationships > list
Return a list of all the existing OrganizationRelationship resources
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
search | A search term. |
ordering | Which field to use when ordering the results. |
source_organization__id | |
dest_organization__id | |
source_organization__name | |
dest_organization__name | |
classification | |
weight | |
descr | |
active_status | Status of the items: current, past or future. |
active_at | Filters items active at the given date. Dates can be expressed as: YYYY-MM-DD, YYYY-MM or YYYY. |
active_from | Filters items active since the given date. Dates can be expressed as: YYYY-MM-DD, YYYY-MM or YYYY. |
active_to | Filters items active up to the given date. Dates can be expressed as: YYYY-MM-DD, YYYY-MM or YYYY. |
start_date | Get items having this exact start date. Dates can be expressed as: YYYY-MM-DD, YYYY-MM or YYYY. |
end_date | Get items having this exact end date. Dates can be expressed as: YYYY-MM-DD, YYYY-MM or YYYY. |
created_after | Filters items created in the database after the given date and time. Date and time must be expressed according to ISO 8601. |
updated_after | Filters items updated in the database after the given date and time. Date and time must be expressed according to ISO 8601. |
v1 > organization_relationships > create
Create a new OrganizationRelationship resource.
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
source_organization required | |
dest_organization required | |
weight | The relationship weight, from strongly negative, to strongly positive |
descr | Some details on the relationship (not much, though) |
classification required | |
start_date | Data di inizio validità del dato |
end_date | Data di fine validità del dato |
end_reason | The reason why the entity isn't valid any longer (eg: merge) |
sources required |
v1 > organization_relationships > read
Return the given OrganizationRelationship resource
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Organization relationship. |
v1 > organization_relationships > update
Update the given OrganizationRelationship resource.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Organization relationship. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
source_organization required | |
dest_organization required | |
weight | The relationship weight, from strongly negative, to strongly positive |
descr | Some details on the relationship (not much, though) |
classification required | |
start_date | Data di inizio validità del dato |
end_date | Data di fine validità del dato |
end_reason | The reason why the entity isn't valid any longer (eg: merge) |
sources required |
v1 > organization_relationships > partial_update
Update the given OrganizationRelationship resource.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Organization relationship. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
source_organization | |
dest_organization | |
weight | The relationship weight, from strongly negative, to strongly positive |
descr | Some details on the relationship (not much, though) |
classification | |
start_date | Data di inizio validità del dato |
end_date | Data di fine validità del dato |
end_reason | The reason why the entity isn't valid any longer (eg: merge) |
sources |
v1 > organization_relationships > delete
Delete the given OrganizationRelationship resource.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Organization relationship. |
v1 > organizations > list
Return a list of all the existing Organization resources.
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
search | A search term. |
ordering | Which field to use when ordering the results. |
active_status | Status of the items: current, past or future. |
active_at | Filters items active at the given date. Dates can be expressed as: YYYY-MM-DD, YYYY-MM or YYYY. |
active_from | Filters items active since the given date. Dates can be expressed as: YYYY-MM-DD, YYYY-MM or YYYY. |
active_to | Filters items active up to the given date. Dates can be expressed as: YYYY-MM-DD, YYYY-MM or YYYY. |
start_date | Get items having this exact start date. Dates can be expressed as: YYYY-MM-DD, YYYY-MM or YYYY. |
end_date | Get items having this exact end date. Dates can be expressed as: YYYY-MM-DD, YYYY-MM or YYYY. |
created_after | Filters items created in the database after the given date and time. Date and time must be expressed according to ISO 8601. |
updated_after | Filters items updated in the database after the given date and time. Date and time must be expressed according to ISO 8601. |
identifier_scheme | Lookup items with identifiers having this scheme. See `/identifier_types` for available schemes |
identifier_value | Lookup items with identifiers having this value. Usually used together with identifier_scheme. |
area_identifier | Filter organizations by the main identifier of the parent. |
parent_area_identifier | Filter organizations by the main identifier of the parent's area. |
identifier | Get organization by main identifier (Fiscal Code). |
min_employees | Minimum number of employees |
max_employees | Maximum number of employees |
min_revenue | Minimum revenue (in euro) |
max_revenue | Maximum revenue (in euro) |
min_capital_stock | Minimum capital_stock (in euro) |
max_capital_stock | Maximum capital_stock (in euro) |
classification | |
forma_giuridica | Filter organizations by the legal form. For example: Comune, Regione, Consiglio Comunale. |
classification_id | Filter organizations by a known Classification object (ID). For example: 207 (FORMA_GIURIDICA_ISTAT_BDAP=Provincia). |
founding_date | Get organizations having this exact founding_date date. Dates can be expressed as: YYYY-MM-DD, YYYY-MM or YYYY. |
dissolution_date | Get organizations having this exact dissolution_date. Dates can be expressed as: YYYY-MM-DD, YYYY-MM or YYYY. |
name__icontains | Get organizations containing the specified value in the `name` field. Case insensitive. |
contesto | Get organizations by context |
v1 > organizations > create
Create a new Organization resource.
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
area required | |
parent required | |
children required | |
new_orgs required | |
key_events required | |
contact_details required | |
identifiers required | |
classifications required | |
other_names required | |
links required | |
sources required |
v1 > organizations > classification_types
Gets the list of all distinct Classification types used so far.
:return: A paginated Response, containing the list of all used classification values as of now.
:rtype: Response
v1 > organizations > identifier_types
Gets the list of all distinct Identifier types used so far.
:return: A paginated Response, containing the list of all used identifier values as of now.
:rtype: Response
v1 > organizations > search
Returns results of search with given parameters
:param request: the current request :return:
v1 > organizations > read
Return the given Organization resource.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Organizzazione. |
v1 > organizations > update
Update the given Organization resource.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Organizzazione. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
area required | |
parent required | |
children required | |
new_orgs required | |
key_events required | |
contact_details required | |
identifiers required | |
classifications required | |
other_names required | |
links required | |
sources required |
v1 > organizations > partial_update
Update the given Organization resource.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Organizzazione. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
area | |
parent | |
children | |
new_orgs | |
key_events | |
contact_details | |
identifiers | |
classifications | |
other_names | |
links | |
sources |
v1 > organizations > delete
Delete the given Organization resource.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Organizzazione. |
v1 > organizations > memberships
Shows all memberships belonging to given Organization
.
The usual filters for memberships can be used, for example:
/organizations/{id}/memberships?status=current
will only show current memberships in the organization.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Organizzazione. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
ordering | Which field to use when ordering the results. |
active_status | Status of the items: current, past or future. |
active_at | Filters items active at the given date. Dates can be expressed as: YYYY-MM-DD, YYYY-MM or YYYY. |
active_from | Filters items active since the given date. Dates can be expressed as: YYYY-MM-DD, YYYY-MM or YYYY. |
active_to | Filters items active up to the given date. Dates can be expressed as: YYYY-MM-DD, YYYY-MM or YYYY. |
start_date | Get items having this exact start date. Dates can be expressed as: YYYY-MM-DD, YYYY-MM or YYYY. |
end_date | Get items having this exact end date. Dates can be expressed as: YYYY-MM-DD, YYYY-MM or YYYY. |
created_after | Filters items created in the database after the given date and time. Date and time must be expressed according to ISO 8601. |
updated_after | Filters items updated in the database after the given date and time. Date and time must be expressed according to ISO 8601. |
identifier_scheme | Lookup items with identifiers having this scheme. See `/identifier_types` for available schemes |
identifier_value | Lookup items with identifiers having this value. Usually used together with identifier_scheme. |
area_identifier | Filter organizations by the main identifier of the parent. |
parent_area_identifier | Filter organizations by the main identifier of the parent's area. |
identifier | Get organization by main identifier (Fiscal Code). |
min_employees | Minimum number of employees |
max_employees | Maximum number of employees |
min_revenue | Minimum revenue (in euro) |
max_revenue | Maximum revenue (in euro) |
min_capital_stock | Minimum capital_stock (in euro) |
max_capital_stock | Maximum capital_stock (in euro) |
classification | |
forma_giuridica | Filter organizations by the legal form. For example: Comune, Regione, Consiglio Comunale. |
classification_id | Filter organizations by a known Classification object (ID). For example: 207 (FORMA_GIURIDICA_ISTAT_BDAP=Provincia). |
founding_date | Get organizations having this exact founding_date date. Dates can be expressed as: YYYY-MM-DD, YYYY-MM or YYYY. |
dissolution_date | Get organizations having this exact dissolution_date. Dates can be expressed as: YYYY-MM-DD, YYYY-MM or YYYY. |
name__icontains | Get organizations containing the specified value in the `name` field. Case insensitive. |
contesto | Get organizations by context |
v1 > organizations > n_memberships_by_dates
Shows numbers of memberships in this organization for start and end dates.
This is internally used to detect starting and ending dates of legislatures and governments.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Organizzazione. |
v1 > organizations > ownerships_as_owned
Shows all organizations owning the given Organization
.
The usual filters for ownerships can be used, for example:
/organizations/{id}/ownerships_as_owned?status=current
will only show current owning organizations for the organization.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Organizzazione. |
v1 > organizations > ownerships_as_owner
Shows all organizations owned by the given Organization
.
The usual filters for ownerships can be used, for example:
/organizations/{id}/ownerships_as_owner?status=current
will only show current owned organizations for the organization.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Organizzazione. |
v1 > organizations > posts
Shows all posts belonging to given Organization
.
The usual filters for posts can be used, for example:
/organizations/{id}/posts?status=current
will only show current posts in the organization.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Organizzazione. |
v1 > organizations > relations_from_organizations
Shows all relations coming from other organizations, belonging to a given Organization
.
The relations can be filtered by scheme and other parameters:
/organizations/{id}/from_relations?status=current
will only show current relations of the organization.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Organizzazione. |
v1 > organizations > relations_to_organizations
Shows all relations with other organization belonging to a given Organization
.
The relations can be filtered by scheme and other parameters:
/organizations/{id}/to_relations?status=current
will only show current relations of the organization.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Organizzazione. |
v1 > ownerships > list
Return a list of all the existing Ownership resources.
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
search | A search term. |
ordering | Which field to use when ordering the results. |
owned_organization__id | |
owner_organization__id | |
owner_person__id | |
owned_organization__name | |
owner_organization__name | |
owner_person__name | |
active_status | Status of the items: current, past or future. |
active_at | Filters items active at the given date. Dates can be expressed as: YYYY-MM-DD, YYYY-MM or YYYY. |
active_from | Filters items active since the given date. Dates can be expressed as: YYYY-MM-DD, YYYY-MM or YYYY. |
active_to | Filters items active up to the given date. Dates can be expressed as: YYYY-MM-DD, YYYY-MM or YYYY. |
start_date | Get items having this exact start date. Dates can be expressed as: YYYY-MM-DD, YYYY-MM or YYYY. |
end_date | Get items having this exact end date. Dates can be expressed as: YYYY-MM-DD, YYYY-MM or YYYY. |
created_after | Filters items created in the database after the given date and time. Date and time must be expressed according to ISO 8601. |
updated_after | Filters items updated in the database after the given date and time. Date and time must be expressed according to ISO 8601. |
v1 > ownerships > create
Transform the request.data before creating the membership record:
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
owned_organization required | |
owner_organization required | |
owner_person required | |
sources required |
v1 > ownerships > read
Return the given Ownership resource.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Ownership. |
v1 > ownerships > update
Transform the request.data before updating the membership record:
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Ownership. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
owned_organization required | |
owner_organization required | |
owner_person required | |
sources required |
v1 > ownerships > partial_update
Transform the request.data before patching the membership record:
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Ownership. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
owned_organization | |
owner_organization | |
owner_person | |
sources |
v1 > ownerships > delete
Delete the given Ownership resource.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Ownership. |
v1 > persons > list
Return a list of all the existing Person resources
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
search | A search term. |
ordering | Which field to use when ordering the results. |
active_status | Stato della persona (vivo o deceduto) |
active_at | Filters items active at the given date. Dates can be expressed as: YYYY-MM-DD, YYYY-MM or YYYY. |
active_from | Filters items active since the given date. Dates can be expressed as: YYYY-MM-DD, YYYY-MM or YYYY. |
active_to | Filters items active up to the given date. Dates can be expressed as: YYYY-MM-DD, YYYY-MM or YYYY. |
start_date | Get items having this exact start date. Dates can be expressed as: YYYY-MM-DD, YYYY-MM or YYYY. |
end_date | Get items having this exact end date. Dates can be expressed as: YYYY-MM-DD, YYYY-MM or YYYY. |
created_after | Filters items created in the database after the given date and time. Date and time must be expressed according to ISO 8601. |
updated_after | Filters items updated in the database after the given date and time. Date and time must be expressed according to ISO 8601. |
identifier_scheme | Lookup items with identifiers having this scheme. See `/identifier_types` for available schemes |
identifier_value | Lookup items with identifiers having this value. Usually used together with identifier_scheme. |
birth_date | Estrai le persone che hanno questa data di nascita esatta. Le date possono essere espress come: AAAA-MM-DD, AAAA-MM o AAAA. |
death_date | Get persons having this exact death date. Dates can be expressed as: YYYY-MM-DD, YYYY-MM or YYYY. |
given_name | Get persons by given name. Case insensitive. |
family_name | Get persons by family name. Case insensitive. |
gender | Get persons by gender. |
gender_not_specified | Select Yes to get all persons whose gender is unknown |
op_id | Get persons by Openpolis ID |
cf_id | Get persons by Fiscal Code |
classification_id | Filter persons by a known Classification object (ID). For example: 2605 (OPDM_PERSON_LABEL=Politico locale). |
contesto | Filter members or owners of organizations in a context (BandiCovid, PNRR, ...) |
v1 > persons > create
Create a new Person resource.
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
contact_details required | |
identifiers required | |
other_names required | |
links required | |
sources required | |
memberships required | |
ownerships required | |
classifications required | |
related_persons required |
v1 > persons > classification_types
Gets the list of all distinct Classification types used so far.
:return: A paginated Response, containing the list of all used classification values as of now.
:rtype: Response
v1 > persons > identifier_types
Gets the list of all distinct Identifier types used so far.
:return: A paginated Response, containing the list of all used identifier values as of now.
:rtype: Response
v1 > persons > search
Returns results of search with given parameters
:param request: the current request :return:
v1 > persons > read
Return the given Person resource
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Persona. |
v1 > persons > update
Update the given Person resource.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Persona. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
contact_details required | |
identifiers required | |
other_names required | |
links required | |
sources required | |
memberships required | |
ownerships required | |
classifications required | |
related_persons required |
v1 > persons > partial_update
Update the given Person resource.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Persona. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
contact_details | |
identifiers | |
other_names | |
links | |
sources | |
memberships | |
ownerships | |
classifications | |
related_persons |
v1 > persons > delete
Delete the given Person resource.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Persona. |
v1 > persons > akas > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
search | A search term. |
ordering | Which field to use when ordering the results. |
is_resolved | |
search_given_name | Get AKAs through given name searched |
search_family_name | Get AKAs through family name searched |
op_context | Get AKAs through operations context (regioni|metro|province|comuni) |
loc_desc | Get AKAs with this location |
person_id | Get solved AKAs pointing to the person having the ID |
v1 > persons > akas > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Similarità AKA. |
v1 > persons > akas > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Similarità AKA. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
search_params required | |
n_similarities required | |
loader_context required | |
is_resolved required | |
object_id |
v1 > persons > akas > partial_update
Performs internal logic, based on data passed in body, before patching the AKA record:
See login inside source code.
A request to solve (set is_resolved
to true) for an AKA record that has already been solved
will result in a 422 (Unprocessable Entity) exception response.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Similarità AKA. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
search_params | |
n_similarities | |
loader_context | |
is_resolved | |
object_id |
v1 > persons > education_levels > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
search | A search term. |
ordering | Which field to use when ordering the results. |
v1 > persons > education_levels > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | Education level name |
identifiers |
v1 > persons > education_levels > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Normalized education level. |
v1 > persons > education_levels > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Normalized education level. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | Education level name |
identifiers |
v1 > persons > education_levels > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Normalized education level. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | Education level name |
identifiers |
v1 > persons > education_levels > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Normalized education level. |
v1 > persons > original_education_levels > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
search | A search term. |
ordering | Which field to use when ordering the results. |
v1 > persons > original_education_levels > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
normalized_education_level required |
v1 > persons > original_education_levels > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Original education level. |
v1 > persons > original_education_levels > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Original education level. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
normalized_education_level required |
v1 > persons > original_education_levels > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Original education level. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
normalized_education_level |
v1 > persons > original_education_levels > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Original education level. |
v1 > persons > original_professions > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
search | A search term. |
ordering | Which field to use when ordering the results. |
v1 > persons > original_professions > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
normalized_profession required |
v1 > persons > original_professions > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Original profession. |
v1 > persons > original_professions > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Original profession. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
normalized_profession required |
v1 > persons > original_professions > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Original profession. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
normalized_profession |
v1 > persons > original_professions > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Original profession. |
v1 > persons > professions > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
search | A search term. |
ordering | Which field to use when ordering the results. |
v1 > persons > professions > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | Normalized profession name |
identifiers |
v1 > persons > professions > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Normalized profession. |
v1 > persons > professions > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Normalized profession. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | Normalized profession name |
identifiers |
v1 > persons > professions > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Normalized profession. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | Normalized profession name |
identifiers |
v1 > persons > professions > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Normalized profession. |
v1 > persons > role_types > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
search | A search term. |
label | Filter role types by label: Assessore Regionale, Consigliere regionale, ... |
other_label | Filter role types by other label: Amm. Del., Amm. Unico, Dir. Gen. |
classification | |
forma_giuridica | Filter role types for given legal form classification: Giunta regionale, Consiglio regionale, ... |
organization | Filter role types for given organization (ID): |
ordering | Which field to use when ordering the results. |
v1 > persons > role_types > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
label required | A label describing the post, better keep it unique and put the classification descr into it |
other_label | La denominazione alternativa, es: abbreviazione (AD) |
classification required | |
priority | The priority of this role type, within the same classification group |
is_appointer | Whether this is a role able to appoint other roles |
is_appointable | Whether this is role can be appointed (by appointers) |
v1 > persons > role_types > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Role type. |
v1 > persons > role_types > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Role type. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
label required | A label describing the post, better keep it unique and put the classification descr into it |
other_label | La denominazione alternativa, es: abbreviazione (AD) |
classification required | |
priority | The priority of this role type, within the same classification group |
is_appointer | Whether this is a role able to appoint other roles |
is_appointable | Whether this is role can be appointed (by appointers) |
v1 > persons > role_types > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Role type. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
label | A label describing the post, better keep it unique and put the classification descr into it |
other_label | La denominazione alternativa, es: abbreviazione (AD) |
classification | |
priority | The priority of this role type, within the same classification group |
is_appointer | Whether this is a role able to appoint other roles |
is_appointable | Whether this is role can be appointed (by appointers) |
v1 > persons > role_types > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Role type. |
v1 > political_colours > list
A serializer for PoliticalColour model.
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
v1 > political_colours > read
A serializer for PoliticalColour model.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Political colour. |
v1 > posts > list
Return a list of all the existing Post resources.
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
search | A search term. |
label | |
role | |
other_label | |
active_status | Status of the items: current, past or future. |
active_at | Filters items active at the given date. Dates can be expressed as: YYYY-MM-DD, YYYY-MM or YYYY. |
active_from | Filters items active since the given date. Dates can be expressed as: YYYY-MM-DD, YYYY-MM or YYYY. |
active_to | Filters items active up to the given date. Dates can be expressed as: YYYY-MM-DD, YYYY-MM or YYYY. |
start_date | Get items having this exact start date. Dates can be expressed as: YYYY-MM-DD, YYYY-MM or YYYY. |
end_date | Get items having this exact end date. Dates can be expressed as: YYYY-MM-DD, YYYY-MM or YYYY. |
created_after | Filters items created in the database after the given date and time. Date and time must be expressed according to ISO 8601. |
updated_after | Filters items updated in the database after the given date and time. Date and time must be expressed according to ISO 8601. |
ordering | Which field to use when ordering the results. |
v1 > posts > create
Create a new Post resource.
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
role_type required | |
organization required | |
area required | |
appointed_by required | |
holders required |
v1 > posts > read
Return the given Post resource.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Impiego. |
v1 > posts > update
Update the given Post resource.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Impiego. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
role_type required | |
organization required | |
area required | |
appointed_by required | |
holders required |
v1 > posts > partial_update
Update the given Post resource.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Impiego. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
role_type | |
organization | |
area | |
appointed_by | |
holders |
v1 > posts > delete
Delete the given Post resource.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Impiego. |
v1 > posts > appointed_posts
Shows all posts appointed by this one. The usual filters for posts can be used, for example:
/posts/{id}/appointed_posts?status=current
will only show current appointed posts
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Impiego. |
v1 > posts > memberships
Shows all memberships belonging to given Post
.
The usual filters for memberships can be used, for example:
/posts/{id}/memberships?status=current
will only show current memberships in the organization.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Impiego. |
api-openparlamento
v1 > acts > list
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required |
v1 > bill_signer > list
Returns all available memberships, paged, filtered, sorted ....
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
search | A search term. |
ordering | Which field to use when ordering the results. |
is_first_signer | Filter member votes for first signers |
person | Filter votings based on the person slug |
v1 > bill_signer > read
Returns a single membership selected by id
.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required | |
id required |
v1 > bills > list
Returns all bills, paged, filtered, sorted ....
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
search | A search term. |
ordering | Which field to use when ordering the results. |
is_key_act | Filter bills based on whether they are key acts |
is_ratification | Filter bills based on whether they are ratification acts |
branch | Filtra le votazioni in base al ramo dove sono avvenute (ASS-CAMERA-18, ASS-SENATO-19, ...) |
initiative | Filter bills based on initiative |
type | Filter bills based on type |
typology | Filter bills based on typology |
status | Filter bills based on macro status |
first_signer | Filter votings based on the person slug |
government | Filter bills based on government period |
v1 > bills > aggregate
Mostra i progetti correlati
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required |
v1 > bills > read
Returns a single bill selected by id
.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required | |
pk2 required |
v1 > events > list
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
search | A search term. |
ordering | Which field to use when ordering the results. |
year | Filter votings based on the year of the event date |
month | Filter votings based on the month of the event date |
is_key_event | Filter events based on whether they are key events |
event_category | Filter bills based on type |
branch | Filter events based on branch |
v1 > events > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required | |
id required |
v1 > faqs > list
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
search | A search term. |
ordering | Which field to use when ordering the results. |
v1 > faqs > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required | |
id required |
v1 > govbills > list
Returns all bills, paged, filtered, sorted ....
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
search | A search term. |
ordering | Which field to use when ordering the results. |
government | Filter bills based on government period |
is_key_act | Filter bills based on whether they are key acts |
v1 > govbills > aggregate
Mostra i progetti correlati
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required |
v1 > govbills > read
Returns a single bill selected by id
.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required | |
pk2 required |
v1 > govdecrees > list
Returns all bills, paged, filtered, sorted ....
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
search | A search term. |
ordering | Which field to use when ordering the results. |
typology | Filter bills based on typology |
status | Filter bills based on status |
government | Filtra le votazioni in bas al governo in carica al momento della votazione (ID Organizzazione) |
v1 > govdecrees > aggregate
Mostra i progetti correlati
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required |
v1 > govdecrees > read
Returns a single bill selected by id
.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required | |
pk2 required |
v1 > governments > list
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
v1 > governments > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required | |
pk2 required |
v1 > groups_votes > list
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
search | A search term. |
ordering | Which field to use when ordering the results. |
is_key_vote | Filter member votes for key votes |
group | Filter votings based on the group id |
v1 > groups_votes > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required | |
id required |
v1 > home > list
APPROFONDIMENTI
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required |
v1 > implementingdecrees > list
Returns all bills, paged, filtered, sorted ....
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
search | A search term. |
ordering | Which field to use when ordering the results. |
is_adopted | Filter bills based on whether they are key acts |
is_next_30_days | Filter bills based on whether deadline is in 30 days |
government | |
mins_proposer | |
policy | |
type_law | Filter implementing decree based on type reference law |
govbill | Filter implementing govbill based on slug |
govdecree | Filter implementing govdecree based on slug |
bill | Filter implementing bill based on slug |
status |
v1 > implementingdecrees > aggregate
Mostra i progetti correlati
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required |
v1 > implementingdecrees > read
Returns a single bill selected by id
.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required | |
id required |
v1 > legislative_activity > list
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required |
v1 > memberships > list
Returns all available memberships, paged, filtered, sorted ....
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
search | A search term. |
ordering | Which field to use when ordering the results. |
role | Filter memberships based on the role (Senator, Deputy, ...) |
supports_majority | Filter memberships based on whether they support majority |
is_active | Filter memberships based on whether they are active |
gender_type | Filter votings based on the gender |
election_area | Filter memberships based on the election area they were elected into |
election_macro_area | Filter memberships based on the election macro area they were elected into |
latest_group | Filter memberships based on the latest group the member is in |
v1 > memberships > codelists
All memberships' codelists
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required |
v1 > memberships > read
Returns a single membership selected by id
.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required | |
pk2 required |
v1 > memberships_votes > list
Returns all available memberships, paged, filtered, sorted ....
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
search | A search term. |
ordering | Which field to use when ordering the results. |
is_key_vote | Filter member votes for key votes |
is_rebel_vote | Filter member votes for rebel votes |
is_confidence_vote | Filter member votes for confidence votes |
person | Filter votings based on the person slug |
v1 > memberships_votes > read
Returns a single membership selected by id
.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required | |
id required |
v1 > parl_assemblies > list
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
v1 > parl_assemblies > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required | |
id required |
v1 > parl_assemblies > bichambers > list
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
v1 > parl_assemblies > bichambers > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required | |
id required |
v1 > parl_assemblies > camera > commission_councils > list
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
v1 > parl_assemblies > camera > commission_councils > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required | |
id required |
v1 > parl_assemblies > camera > groups > list
Returns all bills, paged, filtered, sorted ....
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
search | A search term. |
ordering | Which field to use when ordering the results. |
v1 > parl_assemblies > camera > groups > aggregate
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required |
v1 > parl_assemblies > camera > groups > read
Returns a single bill selected by id
.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required | |
pk2 required |
v1 > parl_assemblies > camera > presidency > list
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
v1 > parl_assemblies > camera > presidency > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required | |
id required |
v1 > parl_assemblies > senato > commission_councils > list
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
v1 > parl_assemblies > senato > commission_councils > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required | |
id required |
v1 > parl_assemblies > senato > groups > list
Returns all bills, paged, filtered, sorted ....
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
search | A search term. |
ordering | Which field to use when ordering the results. |
v1 > parl_assemblies > senato > groups > aggregate
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required |
v1 > parl_assemblies > senato > groups > read
Returns a single bill selected by id
.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required | |
pk2 required |
v1 > parl_assemblies > senato > presidency > list
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
v1 > parl_assemblies > senato > presidency > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required | |
id required |
v1 > persons > list
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
search | A search term. |
is_gov | Filter bills based on whether they are key acts |
role | Filter memberships based on the role (Senator, Deputy, ...) |
ordering | Which field to use when ordering the results. |
v1 > persons > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required | |
pk2 required |
v1 > persons > carreer_positions
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required | |
pk2 required |
v1 > persons > pp_index > list
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
search | A search term. |
is_gov | Filter bills based on whether they are key acts |
role | Filter memberships based on the role (Senator, Deputy, ...) |
ordering | Which field to use when ordering the results. |
v1 > persons > pp_index > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required | |
pk2 required |
v1 > persons > pp_index > carreer_positions
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required | |
pk2 required |
v1 > votings > list
Returns all available votings, paged, filtered, sorted, ....
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
search | A search term. |
ordering | Which field to use when ordering the results. |
year | Filtra le votazioni in base all'anno della seduta |
bill | Filter votings based on the bill slug |
branch | Filtra le votazioni in base al ramo dove sono avvenute (ASS-CAMERA-18, ASS-SENATO-19, ...) |
main_vote_type | Filtra le votazioni in base al tipo di voto (is_final, is_confidence, is_key_vote) |
sub_vote_type | Filtra le votazioni in base al tipo di voto (is_final, is_confidence, is_key_vote) |
government | Filtra le votazioni in bas al governo in carica al momento della votazione (ID Organizzazione) |
vm_cohesion_rate | Filtra le votazioni in base al tasso di coesione della maggioranza |
outcome |
v1 > votings > read
Returns a single voting selected by id
.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
legislature required | |
pk2 required |
api-token-auth
create
Custom TokenObtainSlidingView
spcialization,
that uses the CustomTokenObtainSlidingSerializer
as serializer.
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
username required | |
password required |
api-token-refresh
create
Takes a sliding JSON web token and returns a new, refreshed version if the token's refresh period has not expired.
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
token required |
api-token-verify
create
Takes a token and indicates if it is valid. This view provides no information about a token's fitness for a particular use.
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
token required |