NOTE: This is a publicly accessible dataset, therefore only an access_key is required to access it.
Retrieves a collection of place records from the CMS API v2.4 based on the supplied parameters.
| Method | URL |
|---|---|
GET |
v2/places |
| Response format | JSON |
| Paginated? | Yes (more information) |
| Rate Limited? | Yes (more information) |
This API endpoint supports the following request parameters:
| Parameter | Description | Notes |
|---|---|---|
| api_id (or) access_key |
The api_id is given to you with your access credentials.As this is a publicly accessible dataset, an access_key can be used instead of an api_id.
|
Required |
| data | The URL encoded JSON data string of search parameters. | Required |
| sig | The HMAC signature for this request. | Required when using an api_id |
| end_date | Only return records that were updated on or before this date. Dates must be formatted in the following format: YYYY-MM-DD HH:MM. |
|
| fields |
A URL encoded JSON string of fields that should be included with the response. If fields are not included then the CMS API v2.4 will use a default set of fields. For example: {
"place" : [
"name",
"national_reference",
"diocesan_reference"
],
"building" : [
"address_line1",
"address_line2",
"town",
"postcode"
],
"place_type" : [
"name"
]
}
To retrieve a list of available place fields the CMS API v2.4 supports, please refer to the following API endpoint: |
|
| limit | The number of records to return. The default is 100 records. The maximum records you can return in one response is 1000. | |
| offset | The number of rows to skip before beginning the returned rows. | |
| start_date | Only return records that were updated on or after this date. Dates must be formatted in the following format: YYYY-MM-DD HH:MM. |
https://cmsapi.cofeportal.org/v2/places?api_id={api_id}&data={data}&sig={sig}&end_date={end_date}&fields={fields}&limit={limit}&offset={offset}&start_date={start_date}
For more details, please see the section on request parameters.
The following search parameters can be used as part of the JSON data string:
| Name | Type | Notes |
|---|---|---|
| diocese_id | Integer | Required when using an api_id |
| places | Array | This is a list of place id’s to refine the results for. Submit the values as an array. |
| place_type | Array | This is optional and is a list of id’s specifying which place types to return. Current place types are listed below. |
| sort_order | String | Options are:
|
The following lists details the id's and description for all the place types currently supported within the CMS.
| ID | Description |
|---|---|
| 1 | Archdeaconry |
| 2 | Benefice |
| 3 | Church |
| 4 | Deanery |
| 5 | Diocese |
| 6 | Extra Parochial |
| 7 | NonParochial |
| 8 | Parish |
| 9 | School |
| 10 | District |
| 12 | Office |
| 13 | Clergy Residence |
| 14 | Group |
| 15 | Hall |
| 16 | Department |
| 23 | Episcopal Area |
| 24 | Team Ministry |
| 25 | Burial Ground/Cemetery |
| 26 | Churchyard |
| 27 | Chapel of Ease |
A JSON object containing none or more CMS places or an error response. The fields return will either be the default set of fields available for the CMS API v2.4 or a limited set fields based on the field list supplied with the request.
If no fields are specified as part of the request, the following default fields will be return with the response:
| Name | Type | Notes |
|---|---|---|
| id | Integer | ID of the place. |
| parent_id | Integer | ID of the parent place. |
| place_type_id | Integer | The ID of the place type. |
| building_id | Integer | The ID of the building, if building data has been associated to this place. |
| name | String | |
| alternative_name | String | |
| national_reference | String | |
| diocesan_reference | String | |
| other_reference | String | |
| charity_commission_reference | String | |
| website | String | |
| comments | Text | |
| plurality | String | |
| patron | String | |
| population | String | |
| electoral_roll | String | |
| created_at | Timestamp | The date and time the record was created. |
| updated_at | Timestamp | The date and time the record was last updated. |
| deleted_at | Timestamp | The date and time the record was deleted. |
| redundant_at | Timestamp | The date and time the record was made redundant. |
Places can optionally have building data associated to them, so in addition to the place fields, the returned data shall also include the following building fields.
| Name | Type | Notes |
|---|---|---|
| longitude | String | |
| latitude | String | |
| chr_asset_id | String | The ID for the place on the third party website Church Heritage Record. |
| address_line1 | String | |
| address_line2 | String | |
| address_line3 | String | |
| town | String | |
| county | String | |
| postcode | String | |
| country | String | |
| phone | String | |
| fax | String | |
| email_address | String | |
| notes | String | |
| profile_photo | String | |
| alternative_phone | String | |
| church_listing | String | |
| opening_times | String | |
| conservation_area | String | |
| quinquennial_inspections | String | |
| braile | String | |
| choir | String | |
| music | String | |
| church_type | String | |
| acny_id | String | The ID for the place on the third party website A Church Near You. |
| accomodation | String | |
| year_built | String | |
| local_authority | String | |
| deanery_synod_number | String | |
| bishop_permission | String | |
| bishop_permission_date | String | |
| lep | String | |
| usaa | String | |
| disabled_access | String | |
| hearing_loop | String | |
| large_print_resources | String | |
| parking | String | |
| wc | String | |
| fair_trade | String | |
| youth_work | String | |
| sunday_school | String | |
| creche | String | |
| baby_change_facilities | String | |
| church_hall | String | |
| churchyard | String | |
| bells | String | |
| disabled_partial | String | |
| disabled_wc | String | |
| projector | String | |
| siams_report | String | |
| local_education_authority | String | |
| area | String | |
| school_status | String | |
| range | String | |
| dfe_number | String | |
| ofsted_urn | String | |
| national_society_reference | String | |
| children_on_roll | String | |
| num_governors | String | |
| num_foundation_governors | String |
Each place has been assigned a specific a place type. In addition to the place_type_id included as part of the place fields, the returned data will also include the following place type fields. A list of possible place types can be found above.
| Name | Type | Notes |
|---|---|---|
| name | String |