Place List List – Django REST framework

Using the place endpoint

Here, locations for events are listed. Events in each location can be found at the event endpoint using the query parameter location. Most locations use the id format tprek:28473. An easy way to locate service points is to browse our Service Map, which uses the same location ids, e.g. servicemap.hel.fi/unit/28473. Default ordering is decreasing order by the number of events found.

Place text

To find places that contain a specific string, use the query parameter text.

Example:

place/?text=tuomiokirkko

See the result

District

To restrict the retrieved places to city district(s), use the query parameter division, separating values by commas if you wish to query for several divisions.

City of Helsinki neighborhoods (kaupunginosa), districts (peruspiiri) and subdistricts (osa-alue) are supported. Check the divisions on the Helsinki map service.

You may query either by specific OCD division type peruspiiri:malmi, or by division name malmi. The latter query checks all divisions with the name, regardless of division type.

Example:

place/?division=malmi

See the result

Place source

Will restrict places to a specific data source.

Example:

place/?data_source=tprek

See the result

Show only places with the upcoming events

To show only the places which are used in the upcoming events supply the has_upcoming_events query parameter.

Example:

place/?has_upcoming_events=true

See the result

Showing all places

By default, only those locations which have listed events are displayed. You may display locations with zero n_events with the query parameter show_all_places.

Example:

place/?show_all_places=true

See the result

Showing deleted places

By default, deleted places are not displayed. You may also display deleted places with the query parameter show_deleted.

For example:

place/?show_deleted=True

See the result

Ordering

Default ordering is decreasing order by the number of events found. You may also order results by name, street_address or postal_code.

For example:

place/?sort=name

See the result

GET /v1/place/?format=api&page=7571&show_all_places=true

HTTP 200 OK
Allow: GET, POST, HEAD, OPTIONS
Content-Type: application/json ;utf-8
Vary: Accept

{
    "meta": {
        "count": 151403,
        "next": null,
        "previous": "https://linkedevents.api.test.hel.ninja/v1/place/?format=api&page=7570&show_all_places=true"
    },
    "data": [
        {
            "id": "harrastushaku:2632",
            "has_user_editable_resources": false,
            "data_source": "harrastushaku",
            "publisher": "ahjo:u48040030",
            "divisions": [],
            "created_time": "2023-08-17T04:54:49.679185Z",
            "last_modified_time": "2023-08-17T04:54:49.679204Z",
            "custom_data": null,
            "email": null,
            "contact_type": null,
            "address_region": null,
            "postal_code": "00180",
            "post_office_box_num": null,
            "address_country": null,
            "deleted": false,
            "has_upcoming_events": false,
            "n_events": 0,
            "image": null,
            "parent": null,
            "replaced_by": null,
            "position": null,
            "name": {
                "fi": "Zodiak - Uuden tanssin keskus"
            },
            "street_address": {
                "fi": "Kaapelitehdas, Tallberginkatu 1 B"
            },
            "info_url": {
                "fi": "www.zodiak.fi"
            },
            "address_locality": {
                "fi": "Helsinki"
            },
            "description": null,
            "telephone": null,
            "@id": "https://linkedevents.api.test.hel.ninja/v1/place/harrastushaku:2632/?format=api",
            "@context": "http://schema.org",
            "@type": "Place"
        },
        {
            "id": "harrastushaku:987",
            "has_user_editable_resources": false,
            "data_source": "harrastushaku",
            "publisher": "ahjo:u48040030",
            "divisions": [],
            "created_time": "2023-08-17T04:43:18.475214Z",
            "last_modified_time": "2023-08-17T04:43:18.475232Z",
            "custom_data": null,
            "email": null,
            "contact_type": null,
            "address_region": null,
            "postal_code": "07900",
            "post_office_box_num": null,
            "address_country": null,
            "deleted": false,
            "has_upcoming_events": false,
            "n_events": 0,
            "image": null,
            "parent": null,
            "replaced_by": null,
            "position": null,
            "name": {
                "fi": "Österstjernan ry"
            },
            "street_address": {
                "fi": "Laivasilta"
            },
            "info_url": null,
            "address_locality": {
                "fi": "Loviisa"
            },
            "description": null,
            "telephone": null,
            "@id": "https://linkedevents.api.test.hel.ninja/v1/place/harrastushaku:987/?format=api",
            "@context": "http://schema.org",
            "@type": "Place"
        },
        {
            "id": "harrastushaku:1041",
            "has_user_editable_resources": false,
            "data_source": "harrastushaku",
            "publisher": "ahjo:u48040030",
            "divisions": [],
            "created_time": "2023-08-17T04:43:21.682716Z",
            "last_modified_time": "2023-08-17T04:43:21.682734Z",
            "custom_data": null,
            "email": null,
            "contact_type": null,
            "address_region": null,
            "postal_code": null,
            "post_office_box_num": null,
            "address_country": null,
            "deleted": false,
            "has_upcoming_events": false,
            "n_events": 0,
            "image": null,
            "parent": null,
            "replaced_by": null,
            "position": null,
            "name": null,
            "street_address": null,
            "info_url": null,
            "address_locality": null,
            "description": null,
            "telephone": null,
            "@id": "https://linkedevents.api.test.hel.ninja/v1/place/harrastushaku:1041/?format=api",
            "@context": "http://schema.org",
            "@type": "Place"
        }
    ]
}