NOTE: This is a publicly accessible dataset, therefore only an access_key is required to access it.
Retrieves all place fields for the CMS.
| Method | URL |
|---|---|
GET |
/v2/place-fields |
| Response format | JSON |
| Paginated? | No |
| 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 |
https://cmsapi.cofeportal.org/v2/place-fields?api_id={api_id}&data={data}&sig={sig}
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 |
A JSON object containing none or more CMS place fields or an error response.