Nordkirche API
JSON API Specification
This API is compliant with the JSON API specification, meaning that
-
Content Negotiation
-
Document Structure
-
Fetching Data
- Returning only specific fields
- Inclusion of Related Resources
- Sorting
- Pagination
-
Creating, Updating and Deleting Resources
work as described in the specification. Go read it!
Authentication
You need to send the following Headers along with each request:
-
access-tokenThis serves as the user’s password for each request. For now access-tokens are static values that only authenticate a single user. Access tokens may be generated for frontend users via the napi login. These tokens will expire after a certain time of inactivity. Access tokens for institutions have to be created by hand and are not supposed to expire.
-
uidA unique value that is used to identify the user. This is necessary because searching the DB for users by their access token will make the API susceptible to timing attacks.
Unsafe Content!
Be aware that some attributes may contain HTML elements. Use proper sanitazion when displaying unescaped text content!
Caching
All API responses include an ETag HTTP-header that identifies a specific state of the requested resource. (E.g.ETag: W/"6d639eb33b0dbfa2de43f5f71212a56f")
Clients can send a If-None-Match HTTP-header with each request to avoid downloading the same content multiple times.
If the If-None-Match header matches the ETag of the requested resource the API will respond with a 304 Not Modified status code.
Notice that the content of Etag and If-None-Match must be an exact match.
Includes and Fields
Full resources from relations can be included using the include parameter in the request (e.g. events?include=address,organizers).
Multiple relationships may be specified as a comma separated list.
This will result in an additional includes field in the response (see JSON API specification for details).
Nested resources of multiple levels from relations can be included by using a . to specify the requested relations (e.g. events?include=chief_organizer,chief_organizer.address).
All resource requests allow to limit the response data to certain fields by setting a fields parameter.
Multiple fields may be specified as a comma separated list.
The resource itself must be specified for each fields parameter, since includes may allow multiple types of resources to be present in a response (e.g. fields[events]=id,title).
Pagination
List results will be paginated with a default size of 20 entries per page.
The page size can be changed using the page[size]=42 parameter, up to maximum of 500 entries per page.
Use the page[number]=23 parameter to specify the page of results you would like to get.
A list of resources will also contain a links field with links to the first, last, next and previous page of results.
Resource meta data
It is possible to request additional information about a resource by specifying meta information that should be included in the response.
meta[can] and meta[foreign_context] can be requested.
If the access token belongs to a frontend user can will include the permissions for this user on each resource, indicating if the user may edit or delete this resource or create resources of this type.
For requests from non frontent users the permission checks will always return false.
If an institution requests foreign_context information the value of this field indicates if this resource does not belong to this institution or any sub institution.
Where foreign_context is true the client should handle this resource in a way that indicateds it is not part of the current institution.
To include the meta data the corresponding field in the request can be set to any non-empty value (events?meta[can]=1).
While it is possible to include both can and foreign_context meta, can is only relevant for requests from frontent users and foreign_context only for requests from institutions.
UTC Timestamps
Time is represented in UTC time and iso8601 format. Clients are responsible to convert from and to UTC.
Error States
The common HTTP Response Status Codes are used.
Addresses ¶
Addresses ¶
List all AddressesGET/api/v1/addresses{?sort}
Example URI
GET https://www.nordkirche.de/api/v1/addresses?sort=id
URI Parameters
- filter[id]
string(optional) Example: 1,2,3Limit result to a specific set of Ids.
- filter[modified_before]
string(optional) Example: 2017-02-21T15:17:47+00:00Return events that were last modified before the given time.
- filter[modified_after]
string(optional) Example: 2017-02-21T15:17:47+00:00Return events that were last modified after the given time.
- sort
string(optional) Example: idSort the results by a specific field.
The result will be sorted by the given field in ascending order. To change the order to descending prepend a
-to the field name. Allowed sort options for addresses:id,-id,last_modified,-last_modified
Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"links": {
"first": "HOST/api/v1/ressource?page%5Bnumber%5D=1",
"last": "HOST/api/v1/ressource?page%5Bnumber%5D=42",
"next": "HOST/api/v1/ressource?page%5Bnumber%5D=3",
"prev": "HOST/api/v1/ressource?page%5Bnumber%5D=1"
},
"meta": {
"page_count": 3,
"record_count": 42
},
"data": [
{
"id": "1",
"type": "addresses",
"attributes": {
"city": "Hamburg",
"country": "DE",
"district": "Rude",
"latitude": 53.449768,
"longitude": 9.436306,
"po_box": "520354",
"po_box_zip_code": "22593",
"street": "Agathe",
"zip_code": "20149",
"last_modified": "2017-02-21T15:17:47+00:00",
"date_created": "2017-02-21T15:17:47+00:00"
},
"links": {
"self": "'https://www.nordkirche.de/api/v1/addresses/1'"
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"first": {
"type": "string"
},
"last": {
"type": "string"
},
"next": {
"type": "string"
},
"prev": {
"type": "string"
}
}
},
"meta": {
"type": "object",
"properties": {
"page_count": {
"type": "number",
"description": "Total number of pages in the result set"
},
"record_count": {
"type": "number",
"description": "Total number of items in the result set"
}
}
},
"data": {
"type": "array"
}
}
}Address ¶
Create an AddressPOST/api/v1/addresses/
Creates a new address.
Example URI
POST https://www.nordkirche.de/api/v1/addresses/
Request
Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"type": "addresses",
"attributes": {
"city": "Hamburg",
"country": "DE",
"district": "Rude",
"latitude": 53.449768,
"longitude": 9.436306,
"po_box": "520354",
"po_box_zip_code": "22593",
"street": "Agathe",
"zip_code": "20149"
}
}
}Response
201Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"id": "1",
"type": "addresses",
"attributes": {
"city": "Hamburg",
"country": "DE",
"district": "Rude",
"latitude": 53.449768,
"longitude": 9.436306,
"po_box": "520354",
"po_box_zip_code": "22593",
"street": "Agathe",
"zip_code": "20149"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"city": {
"type": "string"
},
"country": {
"type": "string",
"description": "ISO_3166-1"
},
"district": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"po_box": {
"type": "string"
},
"po_box_zip_code": {
"type": "string"
},
"street": {
"type": "string",
"description": "Lasch-Weg 16"
},
"zip_code": {
"type": "string"
}
},
"required": [
"country"
]
}
},
"required": [
"type",
"attributes"
]
}
}
}Address ¶
Retrieve an AddressGET/api/v1/addresses/{id}
Example URI
GET https://www.nordkirche.de/api/v1/addresses/1
URI Parameters
- id
number(required) Example: 1The ID of the desired address.
Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"id": "1",
"type": "addresses",
"attributes": {
"city": "Hamburg",
"country": "DE",
"district": "Rude",
"latitude": 53.449768,
"longitude": 9.436306,
"po_box": "520354",
"po_box_zip_code": "22593",
"street": "Agathe",
"zip_code": "20149",
"last_modified": "2017-02-21T15:17:47+00:00",
"date_created": "2017-02-21T15:17:47+00:00"
},
"links": {
"self": "'https://www.nordkirche.de/api/v1/addresses/1'"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"city": {
"type": "string"
},
"country": {
"type": "string",
"description": "ISO_3166-1"
},
"district": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"po_box": {
"type": "string"
},
"po_box_zip_code": {
"type": "string"
},
"street": {
"type": "string",
"description": "Lasch-Weg 16"
},
"zip_code": {
"type": "string"
},
"last_modified": {
"type": "string",
"description": "[ISO 8601][iso8601]\n\nThe time the ressource was last modified."
},
"date_created": {
"type": "string",
"description": "[ISO 8601][iso8601]\n\nThe time the ressource was created."
}
},
"required": [
"country"
]
},
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
}
},
"required": [
"self"
]
}
},
"required": [
"type",
"links"
]
}
},
"required": [
"data"
]
}Delete an AddressDELETE/api/v1/addresses/{id}
Deletes an address.
Example URI
DELETE https://www.nordkirche.de/api/v1/addresses/1
URI Parameters
- id
number(required) Example: 1The ID of the desired address.
Request
Headers
Content-Type: application/vnd.api+jsonResponse
204Update an AddressPATCH/api/v1/addresses/{id}
Updates an existing address with new values.
Example URI
PATCH https://www.nordkirche.de/api/v1/addresses/1
URI Parameters
- id
number(required) Example: 1The ID of the desired address.
Request
Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"id": "1",
"type": "addresses",
"attributes": {
"city": "Hamburg",
"country": "DE",
"district": "Rude",
"latitude": 53.449768,
"longitude": 9.436306,
"po_box": "520354",
"po_box_zip_code": "22593",
"street": "Agathe",
"zip_code": "20149"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"city": {
"type": "string"
},
"country": {
"type": "string",
"description": "ISO_3166-1"
},
"district": {
"type": "string"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"po_box": {
"type": "string"
},
"po_box_zip_code": {
"type": "string"
},
"street": {
"type": "string",
"description": "Lasch-Weg 16"
},
"zip_code": {
"type": "string"
}
},
"required": [
"country"
]
}
},
"required": [
"type",
"attributes"
]
}
}
}Response
200AgeGroups ¶
AgeGroups ¶
List all AgeGroupsGET/api/v1/age_groups
Example URI
GET https://www.nordkirche.de/api/v1/age_groups
Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"links": {
"first": "HOST/api/v1/ressource?page%5Bnumber%5D=1",
"last": "HOST/api/v1/ressource?page%5Bnumber%5D=42",
"next": "HOST/api/v1/ressource?page%5Bnumber%5D=3",
"prev": "HOST/api/v1/ressource?page%5Bnumber%5D=1"
},
"meta": {
"page_count": 3,
"record_count": 42
},
"data": [
{
"id": "1",
"type": "age_groups",
"attributes": {
"name": "0 - 99 Jahre - alle Altersgruppen",
"last_modified": "2017-02-21T15:17:47+00:00",
"date_created": "2017-02-21T15:17:47+00:00"
},
"links": {
"self": "'https://www.nordkirche.de/api/v1/age_groups/1'"
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"first": {
"type": "string"
},
"last": {
"type": "string"
},
"next": {
"type": "string"
},
"prev": {
"type": "string"
}
}
},
"meta": {
"type": "object",
"properties": {
"page_count": {
"type": "number",
"description": "Total number of pages in the result set"
},
"record_count": {
"type": "number",
"description": "Total number of items in the result set"
}
}
},
"data": {
"type": "array"
}
},
"required": [
"data"
]
}Create an AgeGroupPOST/api/v1/age_groups
Creates a new age group.
Example URI
POST https://www.nordkirche.de/api/v1/age_groups
Request
Headers
Content-Type: application/vnd.api+jsonBody
{
"name": "0 - 99 Jahre - alle Altersgruppen"
}Response
201Headers
Content-Type: application/vnd.api+jsonBody
{
"id": "1",
"type": "age_groups",
"attributes": {
"name": "0 - 99 Jahre - alle Altersgruppen",
"last_modified": "2017-02-21T15:17:47+00:00",
"date_created": "2017-02-21T15:17:47+00:00"
},
"links": {
"self": "'https://www.nordkirche.de/api/v1/age_groups/1'"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"last_modified": {
"type": "string",
"description": "[ISO 8601][iso8601]\n\nThe time the ressource was last modified."
},
"date_created": {
"type": "string",
"description": "[ISO 8601][iso8601]\n\nThe time the ressource was created."
}
}
},
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
}
},
"required": [
"self"
]
}
},
"required": [
"id",
"type",
"attributes",
"links"
]
}AgeGroups ¶
Retrieve an AgeGroupGET/api/v1/age_groups/{id}
Example URI
GET https://www.nordkirche.de/api/v1/age_groups/1
URI Parameters
- id
number(required) Example: 1The ID of the desired age group.
Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"id": "1",
"type": "age_groups",
"attributes": {
"name": "0 - 99 Jahre - alle Altersgruppen",
"last_modified": "2017-02-21T15:17:47+00:00",
"date_created": "2017-02-21T15:17:47+00:00"
},
"links": {
"self": "'https://www.nordkirche.de/api/v1/age_groups/1'"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"last_modified": {
"type": "string",
"description": "[ISO 8601][iso8601]\n\nThe time the ressource was last modified."
},
"date_created": {
"type": "string",
"description": "[ISO 8601][iso8601]\n\nThe time the ressource was created."
}
}
},
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
}
},
"required": [
"self"
]
}
},
"required": [
"id",
"type",
"attributes",
"links"
]
}
},
"required": [
"data"
]
}Delete an AgeGroupDELETE/api/v1/age_groups/{id}
Deletes an age group.
Example URI
DELETE https://www.nordkirche.de/api/v1/age_groups/1
URI Parameters
- id
number(required) Example: 1The ID of the desired age group.
Request
Headers
Content-Type: application/vnd.api+jsonResponse
204Update an AgeGroupPATCH/api/v1/age_groups/{id}
Updates an existing age group with new values.
Example URI
PATCH https://www.nordkirche.de/api/v1/age_groups/1
URI Parameters
- id
number(required) Example: 1The ID of the desired age group.
Request
Headers
Content-Type: application/vnd.api+jsonBody
{
"name": "0 - 99 Jahre - alle Altersgruppen"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}Response
200Categories ¶
Categories ¶
List all CategoriesGET/api/v1/categories{?sort}
Example URI
GET https://www.nordkirche.de/api/v1/categories?sort=id
URI Parameters
- filter[is_church_association]
boolean(required) Example: 1Filter categories by the predicate of being a
church_association- a mechanism utilized to group events related to multiple otherwise unrelated institutions. Also have a look at #events-events-get?filter[church_associations]for more information.- sort
string(required) Example: idSort the results by a specific field.
The result will be sorted by the given field in ascending order. To change the order to descending prepend a
-to the field name. Allowed sort options for categories:id,-id
Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"links": {
"first": "HOST/api/v1/ressource?page%5Bnumber%5D=1",
"last": "HOST/api/v1/ressource?page%5Bnumber%5D=42",
"next": "HOST/api/v1/ressource?page%5Bnumber%5D=3",
"prev": "HOST/api/v1/ressource?page%5Bnumber%5D=1"
},
"meta": {
"page_count": 3,
"record_count": 42
},
"data": [
{
"id": "1",
"type": "categories",
"links": {
"self": "'https://www.nordkirche.de/api/v1/categories/1'"
},
"attributes": {
"name": "News",
"description": "New information",
"is_church_association": false,
"sorting": 256,
"last_modified": "2017-02-21T15:17:47+00:00",
"date_created": "2017-02-21T15:17:47+00:00"
},
"relationships": {
"parent": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
}
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"first": {
"type": "string"
},
"last": {
"type": "string"
},
"next": {
"type": "string"
},
"prev": {
"type": "string"
}
}
},
"meta": {
"type": "object",
"properties": {
"page_count": {
"type": "number",
"description": "Total number of pages in the result set"
},
"record_count": {
"type": "number",
"description": "Total number of items in the result set"
}
}
},
"data": {
"type": "array"
}
},
"required": [
"data"
]
}Categories ¶
Create a CategoryPOST/api/v1/categories/
Creates a new category.
Example URI
POST https://www.nordkirche.de/api/v1/categories/
Request
Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"type": "categories",
"attributes": {
"name": "News",
"description": "New information",
"is_church_association": false,
"sorting": 256
},
"relationships": {
"parent": {
"data": {
"id": "2",
"type": "categories"
}
}
}
}
}Response
201Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"id": "1",
"type": "categories",
"attributes": {
"name": "News",
"description": "New information",
"is_church_association": false,
"sorting": 256
},
"relationships": {
"parent": {
"data": {
"id": "2",
"type": "categories"
}
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_church_association": {
"type": "boolean"
},
"sorting": {
"type": "number"
}
}
},
"relationships": {
"type": "object",
"properties": {
"parent": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"type"
]
}
}
}
}
}
},
"required": [
"type",
"attributes"
]
}
}
}Category ¶
Retrieve a CategoryGET/api/v1/categories/{id}
Get a single category.
Example URI
GET https://www.nordkirche.de/api/v1/categories/1
URI Parameters
- id
number(required) Example: 1The ID of the desired category.
Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"id": "1",
"type": "categories",
"links": {
"self": "'https://www.nordkirche.de/api/v1/categories/1'"
},
"attributes": {
"name": "News",
"description": "New information",
"is_church_association": false,
"sorting": 256,
"last_modified": "2017-02-21T15:17:47+00:00",
"date_created": "2017-02-21T15:17:47+00:00"
},
"relationships": {
"parent": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
}
},
"required": [
"self"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_church_association": {
"type": "boolean"
},
"sorting": {
"type": "number"
},
"last_modified": {
"type": "string",
"description": "[ISO 8601][iso8601]\n\nThe time the resource was last modified."
},
"date_created": {
"type": "string",
"description": "[ISO 8601][iso8601]\n\nThe time the ressource was created."
}
},
"required": [
"last_modified"
]
},
"relationships": {
"type": "object",
"properties": {
"parent": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"type"
]
}
},
"required": [
"links"
],
"description": "The parent category"
}
},
"required": [
"parent"
]
}
},
"required": [
"type",
"links",
"attributes",
"relationships"
]
}
},
"required": [
"data"
]
}Delete a CategoryDELETE/api/v1/categories/{id}
Deletes a category.
Example URI
DELETE https://www.nordkirche.de/api/v1/categories/1
URI Parameters
- id
number(required) Example: 1The ID of the desired category.
Request
Headers
Content-Type: application/vnd.api+jsonResponse
204Update a CategoryPATCH/api/v1/categories/{id}
Updates an existing address with new values.
Example URI
PATCH https://www.nordkirche.de/api/v1/categories/1
URI Parameters
- id
number(required) Example: 1The ID of the desired category.
Request
Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"id": "1",
"type": "categories",
"attributes": {
"name": "News",
"description": "New information",
"is_church_association": false,
"sorting": 256
},
"relationships": {
"parent": {
"data": {
"id": "2",
"type": "categories"
}
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_church_association": {
"type": "boolean"
},
"sorting": {
"type": "number"
}
}
},
"relationships": {
"type": "object",
"properties": {
"parent": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"type"
]
}
}
}
}
}
},
"required": [
"type",
"attributes"
]
}
}
}Response
200Events ¶
EventTypes ¶
(No authentication required)
List all EventTypesGET/api/v1/event_types
A static list containing the following entries (id: title).
-
0:
base -
1:
church_service -
2:
committee -
3:
default -
4:
edu -
5:
event -
6:
leisure -
7:
music -
8:
spirituality
Example URI
GET https://www.nordkirche.de/api/v1/event_types
Response
200Headers
Content-Type: application/json; charset=utf-8Body
{
"data": [
"Hello, world!"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array"
}
},
"required": [
"data"
]
}Event ¶
Retrieve an EventGET/api/v1/events/{id}
Retrieves the Event with the given ID.
Example URI
GET https://www.nordkirche.de/api/v1/events/1
URI Parameters
- id
number(required) Example: 1The ID of the desired Event.
- meta[can]
string(optional) Example: 1Include
canmeta data.- meta[foreign_context]
string(optional) Example: 1Include
foreign_contextmeta data.
Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"id": "1",
"type": "events",
"links": {
"self": "'https://www.nordkirche.de/api/v1/events/1'"
},
"attributes": {
"accessible": true,
"alternate_location": "Maienweg 123, 22337 Hamburg",
"choirs": [
{
"id": "1",
"name": "Kantorei der Matthias-Claudius-Kirche"
}
],
"collection_requested": true,
"combit_event_id": "Hello, world!",
"compositions": [
{
"id": "1",
"first_name": "Johann Sebastian",
"last_name": "Bach",
"title": "Johannespassion"
}
],
"customized_mail": "Hello, world!",
"description": "Airs from Musicke of Sundrie Kindes (Thomas Ford 1607), Lautenmusik von J. Johnson und J. Dowland\\n Werner Faust, Laute\\n Oksana Lubova, Gesang",
"ends_at": "2017-02-21T15:17:47+00:00",
"ensembles": [
{
"id": "1",
"name": "Männervocalensemble"
}
],
"event_type": "Hello, world!",
"external_link": "https://example.com/external/link",
"files": [
{
"file_name": "some.pdf",
"details": {
"description": "Hello, world!",
"alternative": "Hello, world!",
"caption": "Hello, world!",
"license": 1,
"copyright": "Hello, world!",
"related_files": 1
},
"mime_type": "application/pdf",
"size": 291,
"title": "Uploads in Aktion",
"url": "'//some/image/url'"
}
],
"hints": "<p>Veranstaltung der Musikfreunde Kiel<br />Ermäßigungen für Mitglieder, Schüler und Studenten</p>",
"instrumental_soloists": [
{
"first_name": "Hannah",
"id": "1",
"instrument": "Klarinette",
"last_name": "Hilger"
}
],
"kicker": "Gesangssolisten, Kinderchor, zwei Chöre und zwei Orchestern auf historischen Instrumenten",
"lead": "Vorname Nachname, Andere Person",
"location_type": 1,
"numbered_seats": true,
"orchestras": [
{
"id": "1",
"name": "Ensemble aus Hamburg auf historischen Instrumenten"
}
],
"participants_text": "Information und Anmeldung: <br />Jemand +49 (01230) 123456789",
"picture": {
"details": {
"description": "Hello, world!",
"alternative": "Hello, world!",
"caption": "Hello, world!",
"license": 1,
"copyright": "Hello, world!",
"related_files": 1
},
"title": "Meine Datei",
"url": "'//some/image/url'",
"file_name": "some.gif",
"mime_type": "image/gif",
"size": 35,
"image": {
"width": 1,
"height": 1
}
},
"price": {
"range": {
"from": 42,
"to": 84
},
"reduction": true,
"text": "18€ im Vorverkauf, 20€ an der Abendkasse, Schüler und Studenten 10 €, Kinder bis 12 Jahre frei"
},
"recipient_email": "mail@example.com",
"registration_link": "https://example.com/registration/link",
"starts_at": "2017-02-21T15:17:47+00:00",
"tags": [
"Bestattung",
"Landesverein für Innere Mission"
],
"teaser_text": "Für alle abenteuerlustigen Kinder!",
"text_organizers": "Bildungsstelle Nord von Brot fur die Welt",
"ticket_sale": {
"booking_office": true,
"box_office": true,
"community": true
},
"ticket_sale_text": "Bitte melden Sie sich bis sieben Tage vor der jeweiligen Veranstaltung an",
"title": "Slow Tourismus, Reisen zwischen Langsamkeit und Sinnlichkeit",
"vocal_soloists": [
{
"first_name": "Lauter",
"id": "1",
"last_name": "Sänger",
"vocal_range": "Bariton"
}
],
"location_name": "Telemannsaal",
"last_modified": "2017-02-21T15:17:47+00:00",
"date_created": "2017-02-21T15:17:47+00:00"
},
"relationships": {
"address": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
},
"categories": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"chief_organizer": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
},
"host_institution": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
},
"organizers": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"co_organizers": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"participants": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"event_location": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
},
"age_groups": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"target_groups": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
}
},
"meta": {
"can": {
"create": false,
"delete": false,
"edit": false
},
"foreign_context": false
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
}
},
"required": [
"self"
]
},
"attributes": {
"type": "object",
"properties": {
"accessible": {
"type": "boolean"
},
"alternate_location": {
"type": "string"
},
"choirs": {
"type": "array"
},
"collection_requested": {
"type": "boolean"
},
"combit_event_id": {
"type": "string"
},
"compositions": {
"type": "array"
},
"customized_mail": {
"type": "string",
"description": "The mail that gets send when someone signs up for the event"
},
"description": {
"type": "string"
},
"ends_at": {
"type": "string",
"description": "The time the event ends at."
},
"ensembles": {
"type": "array"
},
"event_type": {
"type": "string",
"enum": [
"base",
"church_service",
"committee",
"default",
"edu",
"event",
"leisure",
"music",
"spirituality"
]
},
"external_link": {
"type": "string"
},
"files": {
"type": "array"
},
"hints": {
"type": "string"
},
"instrumental_soloists": {
"type": "array"
},
"kicker": {
"type": "string"
},
"lead": {
"type": "string"
},
"location_type": {
"type": "number",
"description": "Determines what is used to get the event location."
},
"numbered_seats": {
"type": "boolean",
"description": "Platzkarten"
},
"orchestras": {
"type": "array"
},
"participants_text": {
"type": "string"
},
"picture": {
"type": [
"object",
"null"
],
"properties": {
"details": {
"type": [
"object",
"null"
],
"properties": {
"description": {
"type": [
"string",
"null"
]
},
"alternative": {
"type": [
"string",
"null"
]
},
"caption": {
"type": [
"string",
"null"
]
},
"license": {
"type": [
"number",
"null"
]
},
"copyright": {
"type": [
"string",
"null"
]
},
"related_files": {
"type": [
"number",
"null"
]
}
}
},
"title": {
"type": "string"
},
"url": {
"type": "string"
},
"file_name": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"size": {
"type": "number"
},
"image": {
"type": "object",
"properties": {
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"required": [
"width",
"height"
]
}
},
"required": [
"details",
"title",
"file_name",
"mime_type",
"size",
"image"
]
},
"price": {
"type": "object",
"properties": {
"range": {
"type": "object",
"properties": {
"from": {
"type": "number"
},
"to": {
"type": "number"
}
},
"required": [
"from",
"to"
]
},
"reduction": {
"type": "boolean"
},
"text": {
"type": "string"
}
},
"required": [
"reduction",
"text"
]
},
"recipient_email": {
"type": "string"
},
"registration_link": {
"type": "string"
},
"starts_at": {
"type": "string",
"description": "The time the event starts at."
},
"tags": {
"type": "array"
},
"teaser_text": {
"type": "string"
},
"text_organizers": {
"type": "string"
},
"ticket_sale": {
"type": "object",
"properties": {
"booking_office": {
"type": "boolean"
},
"box_office": {
"type": "boolean"
},
"community": {
"type": "boolean"
}
},
"required": [
"booking_office",
"box_office",
"community"
]
},
"ticket_sale_text": {
"type": "string"
},
"title": {
"type": "string"
},
"vocal_soloists": {
"type": "array"
},
"location_name": {
"type": "string"
},
"last_modified": {
"type": "string"
},
"date_created": {
"type": "string"
}
},
"required": [
"alternate_location",
"choirs",
"collection_requested",
"compositions",
"customized_mail",
"description",
"ends_at",
"ensembles",
"event_type",
"external_link",
"files",
"hints",
"instrumental_soloists",
"kicker",
"lead",
"numbered_seats",
"orchestras",
"participants_text",
"picture",
"price",
"recipient_email",
"registration_link",
"starts_at",
"tags",
"teaser_text",
"text_organizers",
"ticket_sale",
"ticket_sale_text",
"title",
"vocal_soloists",
"location_name",
"last_modified"
]
},
"relationships": {
"type": "object",
"properties": {
"address": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"type"
]
}
},
"required": [
"links"
],
"description": "The address of the location the event takes place at"
},
"categories": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": "array"
}
},
"required": [
"links"
],
"description": "A list of categories"
},
"chief_organizer": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"type"
]
}
},
"required": [
"links"
],
"description": "An institution"
},
"host_institution": {
"type": [
"object",
"null"
],
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"type"
]
}
},
"required": [
"links"
],
"description": "The institution the event takes place at"
},
"organizers": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": "array"
}
},
"required": [
"links"
],
"description": "A list of institutions"
},
"co_organizers": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": "array"
}
},
"required": [
"links"
],
"description": "A list of institutions"
},
"participants": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": "array"
}
},
"required": [
"links"
],
"description": "A list of people"
},
"event_location": {
"type": [
"object",
"null"
],
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"type"
]
}
},
"required": [
"links"
],
"description": "An event location"
},
"age_groups": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": "array"
}
},
"required": [
"links"
],
"description": "A list of age groups"
},
"target_groups": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": "array"
}
},
"required": [
"links"
],
"description": "A list of target groups"
}
},
"required": [
"chief_organizer"
]
},
"meta": {
"type": "object",
"properties": {
"can": {
"type": "object",
"properties": {
"create": {
"type": "boolean",
"description": "Indicates that the frontend user can create resources of this type"
},
"delete": {
"type": "boolean",
"description": "Indicates that the frontend user can delete this resource"
},
"edit": {
"type": "boolean",
"description": "Indicates that the frontend user can edit this resource"
}
}
},
"foreign_context": {
"type": "boolean",
"description": "Indicates that this resource does not belong to this institution or any sub institution.\nThe client should handle this resource in a way that indicateds it is not part of the current institution."
}
}
}
},
"required": [
"id",
"type",
"links",
"attributes",
"relationships"
]
}
},
"required": [
"data"
]
}Event ¶
Delete an EventDELETE/api/v1/events/{id}
Deletes an event.
Example URI
DELETE https://www.nordkirche.de/api/v1/events/1
URI Parameters
- id
number(required) Example: 1The ID of the desired Event.
Request
Headers
Content-Type: application/vnd.api+jsonResponse
204Update an EventPATCH/api/v1/events/{id}
Updates an existing event with new values.
Example URI
PATCH https://www.nordkirche.de/api/v1/events/1
URI Parameters
- id
number(required) Example: 1The ID of the desired Event.
Request
Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"id": "1",
"type": "events",
"attributes": {
"accessible": true,
"alternate_location": "Maienweg 123, 22337 Hamburg",
"choirs": [
{
"id": "1",
"name": "Kantorei der Matthias-Claudius-Kirche"
}
],
"collection_requested": false,
"combit_event_id": "",
"compositions": [
{
"id": "1",
"first_name": "Johann Sebastian",
"last_name": "Bach",
"title": "Johannespassion"
}
],
"customized_mail": "",
"description": "Airs from Musicke of Sundrie Kindes (Thomas Ford 1607), Lautenmusik von J. Johnson und J. Dowland\\n Werner Faust, Laute\\n Oksana Lubova, Gesang",
"ends_at": "2017-02-21T15:17:47+00:00",
"ensembles": [
{
"id": "1",
"name": "Männervocalensemble"
}
],
"event_type": "",
"external_link": "https://example.com/external/link",
"files": [
{
"file_name": "some.pdf",
"details": {
"description": null,
"alternative": null,
"caption": null,
"license": null,
"copyright": null,
"related_files": null
},
"title": "Uploads in Aktion",
"base64_enc": "JVBERi0xLjIgCjkgMCBvYmoKPDwKPj4Kc3RyZWFtCkJULyA5IFRmKFRlc3QpJyBFVAplbmRzdHJlYW0KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCA1IDAgUgovQ29udGVudHMgOSAwIFIKPj4KZW5kb2JqCjUgMCBvYmoKPDwKL0tpZHMgWzQgMCBSIF0KL0NvdW50IDEKL1R5cGUgL1BhZ2VzCi9NZWRpYUJveCBbIDAgMCA5OSA5IF0KPj4KZW5kb2JqCjMgMCBvYmoKPDwKL1BhZ2VzIDUgMCBSCi9UeXBlIC9DYXRhbG9nCj4+CmVuZG9iagp0cmFpbGVyCjw8Ci9Sb290IDMgMCBSCj4+CiUlRU9G"
}
],
"hints": "<p>Veranstaltung der Musikfreunde Kiel<br />Ermäßigungen für Mitglieder, Schüler und Studenten</p>",
"instrumental_soloists": [
{
"first_name": "Hannah",
"id": "1",
"instrument": "Klarinette",
"last_name": "Hilger"
}
],
"kicker": "Gesangssolisten, Kinderchor, zwei Chöre und zwei Orchestern auf historischen Instrumenten",
"lead": "Vorname Nachname, Andere Person",
"location_type": 1,
"numbered_seats": false,
"orchestras": [
{
"id": "1",
"name": "Ensemble aus Hamburg auf historischen Instrumenten"
}
],
"participants_text": "Information und Anmeldung: <br />Jemand +49 (01230) 123456789",
"picture": {
"file_name": "some.gif",
"details": {
"description": null,
"alternative": null,
"caption": null,
"license": null,
"copyright": null,
"related_files": null
},
"title": "Meine Datei",
"base64_enc": "R0lGODlhAQABAIAAAP///wAAACwAAAAAAQABAAACAkQBADs="
},
"price": {
"range": {
"from": 42,
"to": 84
},
"reduction": true,
"text": "18€ im Vorverkauf, 20€ an der Abendkasse, Schüler und Studenten 10 €, Kinder bis 12 Jahre frei"
},
"recipient_email": "mail@example.com",
"registration_link": "https://example.com/registration/link",
"starts_at": "2017-02-21T15:17:47+00:00",
"tags": [
"Bestattung",
"Landesverein für Innere Mission"
],
"teaser_text": "Für alle abenteuerlustigen Kinder!",
"text_organizers": "Bildungsstelle Nord von Brot fur die Welt",
"ticket_sale": {
"booking_office": false,
"box_office": false,
"community": false
},
"ticket_sale_text": "Bitte melden Sie sich bis sieben Tage vor der jeweiligen Veranstaltung an",
"title": "Slow Tourismus, Reisen zwischen Langsamkeit und Sinnlichkeit",
"vocal_soloists": [
{
"first_name": "Lauter",
"id": "1",
"last_name": "Sänger",
"vocal_range": "Bariton"
}
]
},
"relationships": {
"categories": {
"data": [
{
"type": "categories",
"id": "1"
}
]
},
"chief_organizer": {
"data": {
"type": "institutions",
"id": "1"
}
},
"host_institution": {
"data": {
"type": "institutions",
"id": "1"
}
},
"co_organizers": {
"data": [
{
"type": "institutions",
"id": "2"
}
]
},
"participants": {
"data": [
{
"type": "people",
"id": "1"
}
]
},
"event_location": {
"data": {
"type": "event_locations",
"id": "1"
}
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"accessible": {
"type": "boolean"
},
"alternate_location": {
"type": "string"
},
"choirs": {
"type": "array"
},
"collection_requested": {
"type": "boolean"
},
"combit_event_id": {
"type": "string"
},
"compositions": {
"type": "array"
},
"customized_mail": {
"type": "string",
"description": "The mail that gets send when someone signs up for the event"
},
"description": {
"type": "string"
},
"ends_at": {
"type": "string",
"description": "The time the event ends at."
},
"ensembles": {
"type": "array"
},
"event_type": {
"type": "string",
"enum": [
"base",
"church_service",
"committee",
"default",
"edu",
"event",
"leisure",
"music",
"spirituality"
]
},
"external_link": {
"type": "string"
},
"files": {
"type": "array"
},
"hints": {
"type": "string"
},
"instrumental_soloists": {
"type": "array"
},
"kicker": {
"type": "string"
},
"lead": {
"type": "string"
},
"location_type": {
"type": "number",
"description": "Determines what is used to get the event location."
},
"numbered_seats": {
"type": "boolean",
"description": "Platzkarten"
},
"orchestras": {
"type": "array"
},
"participants_text": {
"type": "string"
},
"picture": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "number"
},
"file_name": {
"type": "string"
},
"details": {
"type": [
"object",
"null"
],
"properties": {
"description": {
"type": [
"string",
"null"
]
},
"alternative": {
"type": [
"string",
"null"
]
},
"caption": {
"type": [
"string",
"null"
]
},
"license": {
"type": [
"number",
"null"
]
},
"copyright": {
"type": [
"string",
"null"
]
},
"related_files": {
"type": [
"number",
"null"
]
}
}
},
"title": {
"type": "string"
},
"base64_enc": {
"type": "string"
}
},
"required": [
"file_name",
"details",
"title",
"base64_enc"
]
},
"price": {
"type": "object",
"properties": {
"range": {
"type": "object",
"properties": {
"from": {
"type": "number"
},
"to": {
"type": "number"
}
},
"required": [
"from",
"to"
]
},
"reduction": {
"type": "boolean"
},
"text": {
"type": "string"
}
},
"required": [
"reduction",
"text"
]
},
"recipient_email": {
"type": "string"
},
"registration_link": {
"type": "string"
},
"starts_at": {
"type": "string",
"description": "The time the event starts at."
},
"tags": {
"type": "array"
},
"teaser_text": {
"type": "string"
},
"text_organizers": {
"type": "string"
},
"ticket_sale": {
"type": "object",
"properties": {
"booking_office": {
"type": "boolean"
},
"box_office": {
"type": "boolean"
},
"community": {
"type": "boolean"
}
},
"required": [
"booking_office",
"box_office",
"community"
]
},
"ticket_sale_text": {
"type": "string"
},
"title": {
"type": "string"
},
"vocal_soloists": {
"type": "array"
}
},
"required": [
"alternate_location",
"choirs",
"collection_requested",
"compositions",
"customized_mail",
"description",
"ends_at",
"ensembles",
"event_type",
"external_link",
"files",
"hints",
"instrumental_soloists",
"kicker",
"lead",
"numbered_seats",
"orchestras",
"participants_text",
"picture",
"price",
"recipient_email",
"registration_link",
"starts_at",
"tags",
"teaser_text",
"text_organizers",
"ticket_sale",
"ticket_sale_text",
"title",
"vocal_soloists"
]
},
"relationships": {
"type": "object",
"properties": {
"categories": {
"type": "object",
"properties": {
"data": {
"type": "array"
}
},
"description": "A list of categories"
},
"chief_organizer": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"type",
"id"
]
}
},
"description": "The main organizer of the event"
},
"host_institution": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string"
}
}
}
},
"description": "The institution the event takes place at"
},
"co_organizers": {
"type": "object",
"properties": {
"data": {
"type": "array"
}
},
"description": "Institutions that are a co-organizers of this event"
},
"participants": {
"type": "object",
"properties": {
"data": {
"type": "array"
}
},
"description": "People that participate in the event"
},
"event_location": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string"
}
}
}
},
"description": "The event location the event takes place at"
}
}
}
},
"required": [
"type"
]
}
},
"required": [
"data"
]
}Response
200Events ¶
List all EventsGET/api/v1/events{?facets,sort}
Example URI
GET https://www.nordkirche.de/api/v1/events?facets=event_types&sort=time_from
URI Parameters
- filter[id]
string(optional) Example: 1,2,3Limit result to a specific set of Ids.
- filter[categories]
string(optional) Example: 1,2,3Filter by categories.
Return all items that are a member of at least one specified category. Multiple categories should be supplied as a comma separated list of category IDs.
- filter[+categories]
string(optional) Example: 1,2,3Filter by categories using
AND.Return all items that are a member of all specified categories.
- filter[chief_organizer]
number(optional)Filter by the chief organising institution via its
id.- filter[event_type]
string(optional)Filter by the event type via its alias.
- filter[cities]
string(optional) Example: Kiel,HamburgFilter by cities names.
- filter[church_associations]
string(optional) Example: 1,2,3institutionIds
Accepts a list of institutionIds. Maps each institution to all related categories marked as
church_association. Afterwards those categories are mapped to all events belonging to them.Or as Pseudocode:
institutions |> flatMap .categories |> filter .isChurchAssociation |> flatMap .events- filter[geocode]
string(optional) Example: 53.5659382,9.9613604,5Filter by location. Only records with an address within the given radius around the given location are returned. Returns items located within a given radius of the given latitude/longitude. The parameter value is specified by
latitude,longitude,radius, where radius units are assumed to be kilometers.- filter[location]
string(optional)Filter by the following predicates:
-
Events taking place at an Institution via
Institution.name. -
EventLocation.name.
-
- filter[organizers]
string(optional) Example: 1,2,3Filter by chief- and co-organizers.
- filter[organizers_with_parents]
string(optional) Example: 1,2,3Filter by chief- and co-organizer and their parent institutions. (Get all events for an institution and all sub institutions)
- filter[plz]
string(optional) Example: 35641,223*,11111Filter by zip code.
Return all events where the zip code of the address matches any of the items in the list. Wildcards may be used at the end of a partial zip code.
- filter[tags]
string(optional) Example: reformation,kirche,gottesdienstFilter by tags.
- filter[time_from]
string(optional) Example: 2017-02-21T15:17:47+00:00[ISO 8601]
Return events that are starting after given time or are onging at this time.
- filter[time_to]
string(optional) Example: 2017-02-21T15:17:47+00:00[ISO 8601]
Return events that are ending before given time or are onging at this time.
- filter[time_from_start]
string(optional) Example: 2017-02-21T15:17:47+00:00[ISO 8601]
Only return events starting after given time.
- filter[time_to_end]
string(optional) Example: 2017-02-21T15:17:47+00:00[ISO 8601]
Only return events ending before given time.
- filter[modified_before]
string(optional) Example: 2017-02-21T15:17:47+00:00[ISO 8601]
Return events that were last modified before the given time.
- filter[modified_after]
string(optional) Example: 2017-02-21T15:17:47+00:00[ISO 8601]
Return events that were last modified after the given time.
- filter[q]
string(optional) Example: TelemannsaalUTF-8, URL-encoded search query on the following fields.-
title -
description -
categories.name -
cities -
location.name -
organizers.name
-
- meta[can]
string(optional) Example: 1Include
canmeta data.- meta[foreign_context]
string(optional) Example: 1Include
foreign_contextmeta data.- facets
string(optional) Example: event_typesFacets data to include in the result. Allowed facets for events:
event_types- sort
string(optional) Example: time_fromSort the results by a specific field.
The result will be sorted by the given field in ascending order. To change the order to descending prepend a
-to the field name. Allowed sort options for events:id,-id,time_from,-time_from,last_modified,-last_modified
Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"links": {
"first": "HOST/api/v1/ressource?page%5Bnumber%5D=1",
"last": "HOST/api/v1/ressource?page%5Bnumber%5D=42",
"next": "HOST/api/v1/ressource?page%5Bnumber%5D=3",
"prev": "HOST/api/v1/ressource?page%5Bnumber%5D=1"
},
"meta": {
"page_count": 3,
"record_count": 42
},
"data": [
{
"id": "1",
"type": "events",
"links": {
"self": "'https://www.nordkirche.de/api/v1/events/1'"
},
"attributes": {
"accessible": true,
"alternate_location": "Maienweg 123, 22337 Hamburg",
"choirs": [
{
"id": "1",
"name": "Kantorei der Matthias-Claudius-Kirche"
}
],
"collection_requested": true,
"combit_event_id": "Hello, world!",
"compositions": [
{
"id": "1",
"first_name": "Johann Sebastian",
"last_name": "Bach",
"title": "Johannespassion"
}
],
"customized_mail": "Hello, world!",
"description": "Airs from Musicke of Sundrie Kindes (Thomas Ford 1607), Lautenmusik von J. Johnson und J. Dowland\\n Werner Faust, Laute\\n Oksana Lubova, Gesang",
"ends_at": "2017-02-21T15:17:47+00:00",
"ensembles": [
{
"id": "1",
"name": "Männervocalensemble"
}
],
"event_type": "Hello, world!",
"external_link": "https://example.com/external/link",
"files": [
{
"file_name": "some.pdf",
"details": {
"description": "Hello, world!",
"alternative": "Hello, world!",
"caption": "Hello, world!",
"license": 1,
"copyright": "Hello, world!",
"related_files": 1
},
"mime_type": "application/pdf",
"size": 291,
"title": "Uploads in Aktion",
"url": "'//some/image/url'"
}
],
"hints": "<p>Veranstaltung der Musikfreunde Kiel<br />Ermäßigungen für Mitglieder, Schüler und Studenten</p>",
"instrumental_soloists": [
{
"first_name": "Hannah",
"id": "1",
"instrument": "Klarinette",
"last_name": "Hilger"
}
],
"kicker": "Gesangssolisten, Kinderchor, zwei Chöre und zwei Orchestern auf historischen Instrumenten",
"lead": "Vorname Nachname, Andere Person",
"location_type": 1,
"numbered_seats": true,
"orchestras": [
{
"id": "1",
"name": "Ensemble aus Hamburg auf historischen Instrumenten"
}
],
"participants_text": "Information und Anmeldung: <br />Jemand +49 (01230) 123456789",
"picture": {
"details": {
"description": "Hello, world!",
"alternative": "Hello, world!",
"caption": "Hello, world!",
"license": 1,
"copyright": "Hello, world!",
"related_files": 1
},
"title": "Meine Datei",
"url": "'//some/image/url'",
"file_name": "some.gif",
"mime_type": "image/gif",
"size": 35,
"image": {
"width": 1,
"height": 1
}
},
"price": {
"range": {
"from": 42,
"to": 84
},
"reduction": true,
"text": "18€ im Vorverkauf, 20€ an der Abendkasse, Schüler und Studenten 10 €, Kinder bis 12 Jahre frei"
},
"recipient_email": "mail@example.com",
"registration_link": "https://example.com/registration/link",
"starts_at": "2017-02-21T15:17:47+00:00",
"tags": [
"Bestattung",
"Landesverein für Innere Mission"
],
"teaser_text": "Für alle abenteuerlustigen Kinder!",
"text_organizers": "Bildungsstelle Nord von Brot fur die Welt",
"ticket_sale": {
"booking_office": true,
"box_office": true,
"community": true
},
"ticket_sale_text": "Bitte melden Sie sich bis sieben Tage vor der jeweiligen Veranstaltung an",
"title": "Slow Tourismus, Reisen zwischen Langsamkeit und Sinnlichkeit",
"vocal_soloists": [
{
"first_name": "Lauter",
"id": "1",
"last_name": "Sänger",
"vocal_range": "Bariton"
}
],
"location_name": "Telemannsaal",
"last_modified": "2017-02-21T15:17:47+00:00",
"date_created": "2017-02-21T15:17:47+00:00"
},
"relationships": {
"address": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
},
"categories": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"chief_organizer": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
},
"host_institution": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
},
"organizers": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"co_organizers": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"participants": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"event_location": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
},
"age_groups": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"target_groups": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
}
},
"meta": {
"can": {
"create": false,
"delete": false,
"edit": false
},
"foreign_context": false
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"first": {
"type": "string"
},
"last": {
"type": "string"
},
"next": {
"type": "string"
},
"prev": {
"type": "string"
}
}
},
"meta": {
"type": "object",
"properties": {
"page_count": {
"type": "number",
"description": "Total number of pages in the result set"
},
"record_count": {
"type": "number",
"description": "Total number of items in the result set"
}
}
},
"data": {
"type": "array"
}
},
"required": [
"data"
]
}EventLocation ¶
Retrieve an EventLocationGET/api/v1/event_locations/{id}
Retrieves the EventLocation with the given ID.
Example URI
GET https://www.nordkirche.de/api/v1/event_locations/1
URI Parameters
- id
number(required) Example: 1The ID of the desired EventLocation.
- meta[can]
string(optional) Example: 1Include
canmeta data.- meta[foreign_context]
string(optional) Example: 1Include
foreign_contextmeta data.
Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"id": "1",
"type": "event_locations",
"links": {
"self": "'https://www.nordkirche.de/api/v1/event_locations/1'"
},
"attributes": {
"name": "Gastraum der Mehrzweckhalle",
"contact_item": {
"id": "1337",
"type": "Telefon",
"value": "12345678"
},
"last_modified": "2017-02-21T15:17:47+00:00",
"date_created": "2017-02-21T15:17:47+00:00"
},
"relationships": {
"address": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
}
},
"meta": {
"can": {
"create": false,
"delete": false,
"edit": false
},
"foreign_context": false
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
}
},
"required": [
"self"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"contact_item": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id",
"type",
"value"
]
},
"last_modified": {
"type": "string"
},
"date_created": {
"type": "string"
}
},
"required": [
"name"
]
},
"relationships": {
"type": "object",
"properties": {
"address": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"type"
]
}
},
"required": [
"links"
],
"description": "The address of the location"
}
},
"required": [
"address"
]
},
"meta": {
"type": "object",
"properties": {
"can": {
"type": "object",
"properties": {
"create": {
"type": "boolean",
"description": "Indicates that the frontend user can create resources of this type"
},
"delete": {
"type": "boolean",
"description": "Indicates that the frontend user can delete this resource"
},
"edit": {
"type": "boolean",
"description": "Indicates that the frontend user can edit this resource"
}
}
},
"foreign_context": {
"type": "boolean",
"description": "Indicates that this resource does not belong to this institution or any sub institution.\nThe client should handle this resource in a way that indicateds it is not part of the current institution."
}
}
}
},
"required": [
"id",
"type",
"links",
"attributes",
"relationships"
]
}
},
"required": [
"data"
]
}EventLocation ¶
Delete an EventLocationDELETE/api/v1/event_locations/{id}
Deletes an EventLocation.
Example URI
DELETE https://www.nordkirche.de/api/v1/event_locations/1
URI Parameters
- id
number(required) Example: 1The ID of the desired EventLocation.
Request
Headers
Content-Type: application/vnd.api+jsonResponse
204Replace an EventLocationPUT/api/v1/event_locations/{id}
Replace the existing EventLocation with the new one.
Example URI
PUT https://www.nordkirche.de/api/v1/event_locations/1
URI Parameters
- id
number(required) Example: 1The ID of the desired EventLocation.
Request
Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"id": "1",
"type": "event_locations",
"attributes": {
"name": "Gastraum der Mehrzweckhalle",
"contact_item": {
"id": "1337",
"type": "Telefon",
"value": "12345678"
}
},
"relationships": {
"address": {
"data": {
"type": "addresses",
"id": "1"
}
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"contact_item": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id",
"type",
"value"
]
}
},
"required": [
"name"
]
},
"relationships": {
"type": "object",
"properties": {
"address": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string"
}
}
}
}
}
}
}
},
"required": [
"type"
]
}
},
"required": [
"data"
]
}Response
200Update an EventLocationPATCH/api/v1/event_locations/{id}
Updates an existing EventLocation with new values.
Example URI
PATCH https://www.nordkirche.de/api/v1/event_locations/1
URI Parameters
- id
number(required) Example: 1The ID of the desired EventLocation.
Request
Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"id": "1",
"type": "event_locations",
"attributes": {
"name": "Gastraum der Mehrzweckhalle",
"contact_item": {
"id": "1337",
"type": "Telefon",
"value": "12345678"
}
},
"relationships": {
"address": {
"data": {
"type": "addresses",
"id": "1"
}
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"contact_item": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id",
"type",
"value"
]
}
},
"required": [
"name"
]
},
"relationships": {
"type": "object",
"properties": {
"address": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string"
}
}
}
}
}
}
}
},
"required": [
"type"
]
}
},
"required": [
"data"
]
}Response
200Events ¶
List all EventtLocationsGET/api/v1/event_locations{?sort}
Example URI
GET https://www.nordkirche.de/api/v1/event_locations?sort=time_from
URI Parameters
- filter[id]
string(optional) Example: 1,2,3Limit result to a specific set of Ids.
- filter[q]
string(optional) Example: TelemannsaalUTF-8, URL-encoded search query on the following fields.-
name -
description -
categories.name -
cities -
location.name -
organizers.name
-
- meta[can]
string(optional) Example: 1Include
canmeta data.- meta[foreign_context]
string(optional) Example: 1Include
foreign_contextmeta data.- sort
string(optional) Example: time_fromSort the results by a specific field.
The result will be sorted by the given field in ascending order. To change the order to descending prepend a
-to the field name. Allowed sort options for event locations:id,-id,name,-name
Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"links": {
"first": "HOST/api/v1/ressource?page%5Bnumber%5D=1",
"last": "HOST/api/v1/ressource?page%5Bnumber%5D=42",
"next": "HOST/api/v1/ressource?page%5Bnumber%5D=3",
"prev": "HOST/api/v1/ressource?page%5Bnumber%5D=1"
},
"meta": {
"page_count": 3,
"record_count": 42
},
"data": [
{
"id": "1",
"type": "event_locations",
"links": {
"self": "'https://www.nordkirche.de/api/v1/event_locations/1'"
},
"attributes": {
"name": "Gastraum der Mehrzweckhalle",
"contact_item": {
"id": "1337",
"type": "Telefon",
"value": "12345678"
},
"last_modified": "2017-02-21T15:17:47+00:00",
"date_created": "2017-02-21T15:17:47+00:00"
},
"relationships": {
"address": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
}
},
"meta": {
"can": {
"create": false,
"delete": false,
"edit": false
},
"foreign_context": false
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"first": {
"type": "string"
},
"last": {
"type": "string"
},
"next": {
"type": "string"
},
"prev": {
"type": "string"
}
}
},
"meta": {
"type": "object",
"properties": {
"page_count": {
"type": "number",
"description": "Total number of pages in the result set"
},
"record_count": {
"type": "number",
"description": "Total number of items in the result set"
}
}
},
"data": {
"type": "array"
}
},
"required": [
"data"
]
}Institutions ¶
Institution ¶
Retrieve an InstitutionGET/api/v1/institutions/{id}
Retrieves the Institution with the given ID.
Example URI
GET https://www.nordkirche.de/api/v1/institutions/1
URI Parameters
- id
number(required) Example: 1The ID of the desired Institution.
- meta[can]
string(required) Example: 1Include
canmeta data.- meta[foreign_context]
string(required) Example: 1Include
foreign_contextmeta data.
Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"id": "1",
"type": "institutions",
"links": {
"self": "'https://www.nordkirche.de/api/v1/institutions/1'"
},
"attributes": {
"abbreviation": "KDA Nordkirche",
"available_functions": [
{
"id": "1",
"name": "Bischof"
}
],
"bank_details": {
"account_number": "1234567",
"account_owner": "MOGO Hamburg in der Nordkirche e.V.",
"bank_code": "12345678",
"bank_name": "Evangelische Bank eG",
"bic": "GENODEF1EK1",
"iban": "DE32 1234 4567 8901 2345 67",
"id": 1
},
"contact_items": [
{
"id": "1337",
"type": "Telefon",
"value": "12345678"
}
],
"description": "<h2>Zwei Kirchen - eine Gemeinde</h2>",
"infos": [
{
"title": "Öffnungszeiten Kirchenbüro",
"info": "Dienstag und Freitag: 9.00 - 11.00 Uhr"
}
],
"is_authorized_collector": false,
"is_open_church": true,
"logo": {
"details": {
"description": "Hello, world!",
"alternative": "Hello, world!",
"caption": "Hello, world!",
"license": 1,
"copyright": "Hello, world!",
"related_files": 1
},
"title": "Meine Datei",
"url": "'//some/image/url'",
"file_name": "some.gif",
"mime_type": "image/gif",
"size": 35,
"image": {
"width": 1,
"height": 1
}
},
"map_visibility": true,
"media": [
{
"file_name": "some.pdf",
"details": {
"description": "Hello, world!",
"alternative": "Hello, world!",
"caption": "Hello, world!",
"license": 1,
"copyright": "Hello, world!",
"related_files": 1
},
"mime_type": "application/pdf",
"size": 291,
"title": "Uploads in Aktion",
"url": "'//some/image/url'"
}
],
"name": "Christophorus Haus Diakoniestiftung Alt-Hamburg",
"official_name": "Kirchlicher Dienst in der Arbeitswelt der Nordkirche",
"opening_hours": [
{
"day_of_week": 0,
"opening_time": "09:00",
"closing_time": "13:00",
"date": "2019-12-24",
"closed": false
}
],
"picture": {
"details": {
"description": "Hello, world!",
"alternative": "Hello, world!",
"caption": "Hello, world!",
"license": 1,
"copyright": "Hello, world!",
"related_files": 1
},
"title": "Meine Datei",
"url": "'//some/image/url'",
"file_name": "some.gif",
"mime_type": "image/gif",
"size": 35,
"image": {
"width": 1,
"height": 1
}
},
"preferred_event_location": true,
"tourism_key": "Kirchengemeinde Itzehoe",
"vcard_link": "www.erwachsenenbildung.nordkirche.de",
"vcard_type": 1,
"year_of_construction": 1602,
"last_modified": "2017-02-21T15:17:47+00:00",
"date_created": "2017-02-21T15:17:47+00:00"
},
"relationships": {
"address": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
},
"categories": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"institution_type": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
},
"map_children": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"parent_institutions": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"members": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"memberships": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"teams": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
}
},
"meta": {
"can": {
"create": false,
"delete": false,
"edit": false
},
"foreign_context": false
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
}
},
"required": [
"self"
]
},
"attributes": {
"type": "object",
"properties": {
"abbreviation": {
"type": "string"
},
"available_functions": {
"type": "array"
},
"bank_details": {
"type": [
"object",
"null"
],
"properties": {
"account_number": {
"type": "string"
},
"account_owner": {
"type": "string"
},
"bank_code": {
"type": "string"
},
"bank_name": {
"type": "string"
},
"bic": {
"type": "string"
},
"iban": {
"type": "string"
},
"id": {
"type": "number"
}
},
"required": [
"account_number",
"account_owner",
"bank_code",
"bank_name",
"bic",
"iban"
]
},
"contact_items": {
"type": "array"
},
"description": {
"type": "string",
"description": "may be very long"
},
"infos": {
"type": "array"
},
"is_authorized_collector": {
"type": "boolean",
"description": "Whether the institution can be make use of offertories."
},
"is_open_church": {
"type": "boolean"
},
"logo": {
"type": [
"object",
"null"
],
"properties": {
"details": {
"type": [
"object",
"null"
],
"properties": {
"description": {
"type": [
"string",
"null"
]
},
"alternative": {
"type": [
"string",
"null"
]
},
"caption": {
"type": [
"string",
"null"
]
},
"license": {
"type": [
"number",
"null"
]
},
"copyright": {
"type": [
"string",
"null"
]
},
"related_files": {
"type": [
"number",
"null"
]
}
}
},
"title": {
"type": "string"
},
"url": {
"type": "string"
},
"file_name": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"size": {
"type": "number"
},
"image": {
"type": "object",
"properties": {
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"required": [
"width",
"height"
]
}
},
"required": [
"details",
"title",
"file_name",
"mime_type",
"size",
"image"
]
},
"map_visibility": {
"type": "boolean",
"description": "Whether an InstitutionDetailView wants you to show the map initially."
},
"media": {
"type": "array"
},
"name": {
"type": "string"
},
"official_name": {
"type": "string"
},
"opening_hours": {
"type": "array"
},
"picture": {
"type": [
"object",
"null"
],
"properties": {
"details": {
"type": [
"object",
"null"
],
"properties": {
"description": {
"type": [
"string",
"null"
]
},
"alternative": {
"type": [
"string",
"null"
]
},
"caption": {
"type": [
"string",
"null"
]
},
"license": {
"type": [
"number",
"null"
]
},
"copyright": {
"type": [
"string",
"null"
]
},
"related_files": {
"type": [
"number",
"null"
]
}
}
},
"title": {
"type": "string"
},
"url": {
"type": "string"
},
"file_name": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"size": {
"type": "number"
},
"image": {
"type": "object",
"properties": {
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"required": [
"width",
"height"
]
}
},
"required": [
"details",
"title",
"file_name",
"mime_type",
"size",
"image"
]
},
"preferred_event_location": {
"type": "boolean"
},
"tourism_key": {
"type": "string"
},
"vcard_link": {
"type": "string",
"description": "may also be a PageID. (required)"
},
"vcard_type": {
"type": [
"number",
"null"
]
},
"year_of_construction": {
"type": [
"number",
"null"
]
},
"last_modified": {
"type": "string",
"description": "The time the ressource was last modified."
},
"date_created": {
"type": "string",
"description": "The time the ressource was created."
}
},
"required": [
"abbreviation",
"available_functions",
"bank_details",
"contact_items",
"description",
"infos",
"is_authorized_collector",
"is_open_church",
"logo",
"map_visibility",
"media",
"name",
"official_name",
"opening_hours",
"picture",
"tourism_key",
"vcard_type",
"year_of_construction"
]
},
"relationships": {
"type": "object",
"properties": {
"address": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"type"
]
}
},
"required": [
"links"
],
"description": "The address of the institution"
},
"categories": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": "array"
}
},
"required": [
"links"
]
},
"institution_type": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"type"
]
}
},
"required": [
"links"
]
},
"map_children": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": "array"
}
},
"required": [
"links"
]
},
"parent_institutions": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": "array"
}
},
"required": [
"links"
],
"description": "Direct parent institutions of this institution"
},
"members": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": "array"
}
},
"required": [
"links"
],
"description": "Institutions that are a member of this institution"
},
"memberships": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": "array"
}
},
"required": [
"links"
],
"description": "Institutions this institution is a member of"
},
"teams": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": "array"
}
},
"required": [
"links"
],
"description": "Named and ordered groups of functions at this institution"
}
},
"required": [
"address",
"categories",
"institution_type",
"map_children",
"parent_institutions",
"members",
"memberships"
]
},
"meta": {
"type": "object",
"properties": {
"can": {
"type": "object",
"properties": {
"create": {
"type": "boolean",
"description": "Indicates that the frontend user can create resources of this type"
},
"delete": {
"type": "boolean",
"description": "Indicates that the frontend user can delete this resource"
},
"edit": {
"type": "boolean",
"description": "Indicates that the frontend user can edit this resource"
}
}
},
"foreign_context": {
"type": "boolean",
"description": "Indicates that this resource does not belong to this institution or any sub institution.\nThe client should handle this resource in a way that indicateds it is not part of the current institution."
}
}
}
},
"required": [
"id",
"type",
"links",
"attributes",
"relationships"
]
}
}
}Institutions ¶
List all InstitutionsGET/api/v1/institutions/{?facets,sort}
Example URI
GET https://www.nordkirche.de/api/v1/institutions/?facets=institution_types&sort=id
URI Parameters
- filter[id]
string(optional) Example: 1,2,3Limit result to a specific set of Ids.
- filter[ancestor_institutions]
string(optional) Example: 1,2,3Filter institutions by their relation to other institutions.
Only descendants of the given institution IDs are returned.
- filter[ancestor_institutions_or_self]
string(optional) Example: 1,2,3Filter institutions by their relation to other institutions.
Only descendants of the given institution IDs and the institutions with the given institution IDs are returned.
- filter[categories]
string(optional) Example: 1,2,3Filter institutions by categories.
Institutions belonging to at least one of the given category IDs are returned.
- filter[geocode]
string(optional) Example: 53.5659382,9.9613604,5Filter by location. Only records with an address within the given radius around the given location are returned. Returns items located within a given radius of the given latitude/longitude. The parameter value is specified by
latitude,longitude,radius, where radius units are assumed to be kilometers.- filter[parent_institutions]
string(optional) Example: 1,2,3Filter institutions by their relation to other institutions.
Only children of the given institution IDs are returned.
- filter[parent_institutions_or_self]
string(optional) Example: 1,2,3Filter institutions by their relation to other institutions.
Only children of the given institution IDs and the institutions with the given institution IDs are returned.
- filter[institution_type]
string(optional) Example: 1,2,3Filter institutions by given institution type ids.
To determine the IDs of your favorite institution types, have a look at InstitutionType#List
- filter[q]
string(optional) Example: DoreenUTF-8, URL-encoded search query on the following fields.-
`name
-
official_name -
description -
plz -
Category titles
-
institution_type
-
- filter[cities]
string(optional) Example: Kiel,HamburgFilter by cities names.
- filter[plz]
string(optional) Example: 35641,223*,11111Filter by zip code.
Return all events where the zip code of the address matches any of the items in the list. Wildcards may be used at the end of a partial zip code.
- filter[modified_before]
string(optional) Example: 2017-02-21T15:17:47+00:00Return events that were last modified before the given time.
- filter[modified_after]
string(optional) Example: 2017-02-21T15:17:47+00:00Return events that were last modified after the given time.
- meta[can]
string(optional) Example: 1Include
canmeta data.- meta[foreign_context]
string(optional) Example: 1Include
foreign_contextmeta data.- facets
string(optional) Example: institution_typesFacets data to include in the result. Allowed facets for institutions:
institution_types- sort
string(optional) Example: idSort the results by a specific field.
The result will be sorted by the given field in ascending order. To change the order to descending prepend a
-to the field name. Allowed sort options for institutions:id,-id,name,-name,last_modified,-last_modified
Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"links": {
"first": "HOST/api/v1/ressource?page%5Bnumber%5D=1",
"last": "HOST/api/v1/ressource?page%5Bnumber%5D=42",
"next": "HOST/api/v1/ressource?page%5Bnumber%5D=3",
"prev": "HOST/api/v1/ressource?page%5Bnumber%5D=1"
},
"meta": {
"page_count": 3,
"record_count": 42
},
"data": [
{
"id": "1",
"type": "institutions",
"links": {
"self": "'https://www.nordkirche.de/api/v1/institutions/1'"
},
"attributes": {
"abbreviation": "KDA Nordkirche",
"available_functions": [
{
"id": "1",
"name": "Bischof"
}
],
"bank_details": {
"account_number": "1234567",
"account_owner": "MOGO Hamburg in der Nordkirche e.V.",
"bank_code": "12345678",
"bank_name": "Evangelische Bank eG",
"bic": "GENODEF1EK1",
"iban": "DE32 1234 4567 8901 2345 67",
"id": 1
},
"contact_items": [
{
"id": "1337",
"type": "Telefon",
"value": "12345678"
}
],
"description": "<h2>Zwei Kirchen - eine Gemeinde</h2>",
"infos": [
{
"title": "Öffnungszeiten Kirchenbüro",
"info": "Dienstag und Freitag: 9.00 - 11.00 Uhr"
}
],
"is_authorized_collector": false,
"is_open_church": true,
"logo": {
"details": {
"description": "Hello, world!",
"alternative": "Hello, world!",
"caption": "Hello, world!",
"license": 1,
"copyright": "Hello, world!",
"related_files": 1
},
"title": "Meine Datei",
"url": "'//some/image/url'",
"file_name": "some.gif",
"mime_type": "image/gif",
"size": 35,
"image": {
"width": 1,
"height": 1
}
},
"map_visibility": true,
"media": [
{
"file_name": "some.pdf",
"details": {
"description": "Hello, world!",
"alternative": "Hello, world!",
"caption": "Hello, world!",
"license": 1,
"copyright": "Hello, world!",
"related_files": 1
},
"mime_type": "application/pdf",
"size": 291,
"title": "Uploads in Aktion",
"url": "'//some/image/url'"
}
],
"name": "Christophorus Haus Diakoniestiftung Alt-Hamburg",
"official_name": "Kirchlicher Dienst in der Arbeitswelt der Nordkirche",
"opening_hours": [
{
"day_of_week": 0,
"opening_time": "09:00",
"closing_time": "13:00",
"date": "2019-12-24",
"closed": false
}
],
"picture": {
"details": {
"description": "Hello, world!",
"alternative": "Hello, world!",
"caption": "Hello, world!",
"license": 1,
"copyright": "Hello, world!",
"related_files": 1
},
"title": "Meine Datei",
"url": "'//some/image/url'",
"file_name": "some.gif",
"mime_type": "image/gif",
"size": 35,
"image": {
"width": 1,
"height": 1
}
},
"preferred_event_location": true,
"tourism_key": "Kirchengemeinde Itzehoe",
"vcard_link": "www.erwachsenenbildung.nordkirche.de",
"vcard_type": 1,
"year_of_construction": 1602,
"last_modified": "2017-02-21T15:17:47+00:00",
"date_created": "2017-02-21T15:17:47+00:00"
},
"relationships": {
"address": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
},
"categories": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"institution_type": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
},
"map_children": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"parent_institutions": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"members": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"memberships": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"teams": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
}
},
"meta": {
"can": {
"create": false,
"delete": false,
"edit": false
},
"foreign_context": false
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"first": {
"type": "string"
},
"last": {
"type": "string"
},
"next": {
"type": "string"
},
"prev": {
"type": "string"
}
}
},
"meta": {
"type": "object",
"properties": {
"page_count": {
"type": "number",
"description": "Total number of pages in the result set"
},
"record_count": {
"type": "number",
"description": "Total number of items in the result set"
}
}
},
"data": {
"type": "array"
}
}
}Institution ¶
Create an InstitutionPOST/api/v1/institutions/
Creates an Institution
Example URI
POST https://www.nordkirche.de/api/v1/institutions/
Request
Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"type": "institutions",
"attributes": {
"abbreviation": "KDA Nordkirche",
"available_functions": [
{
"id": "1",
"name": "Bischof"
}
],
"bank_details": {
"account_number": "1234567",
"account_owner": "MOGO Hamburg in der Nordkirche e.V.",
"bank_code": "12345678",
"bank_name": "Evangelische Bank eG",
"bic": "GENODEF1EK1",
"iban": "DE32 1234 4567 8901 2345 67",
"id": 0
},
"contact_items": [
{
"id": "1",
"type": "Telefon",
"value": "www.example.com"
}
],
"description": "<h2>Zwei Kirchen - eine Gemeinde</h2>",
"infos": [
{
"title": "Öffnungszeiten Kirchenbüro",
"info": "Dienstag und Freitag: 9.00 - 11.00 Uhr"
}
],
"is_authorized_collector": false,
"is_open_church": true,
"logo": {
"file_name": "some.gif",
"details": {
"description": null,
"alternative": null,
"caption": null,
"license": null,
"copyright": null,
"related_files": null
},
"title": "Meine Datei",
"base64_enc": "R0lGODlhAQABAIAAAP///wAAACwAAAAAAQABAAACAkQBADs="
},
"map_visibility": true,
"media": [
{
"file_name": "some.pdf",
"details": {
"description": null,
"alternative": null,
"caption": null,
"license": null,
"copyright": null,
"related_files": null
},
"title": "Uploads in Aktion",
"base64_enc": "JVBERi0xLjIgCjkgMCBvYmoKPDwKPj4Kc3RyZWFtCkJULyA5IFRmKFRlc3QpJyBFVAplbmRzdHJlYW0KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCA1IDAgUgovQ29udGVudHMgOSAwIFIKPj4KZW5kb2JqCjUgMCBvYmoKPDwKL0tpZHMgWzQgMCBSIF0KL0NvdW50IDEKL1R5cGUgL1BhZ2VzCi9NZWRpYUJveCBbIDAgMCA5OSA5IF0KPj4KZW5kb2JqCjMgMCBvYmoKPDwKL1BhZ2VzIDUgMCBSCi9UeXBlIC9DYXRhbG9nCj4+CmVuZG9iagp0cmFpbGVyCjw8Ci9Sb290IDMgMCBSCj4+CiUlRU9G"
}
],
"name": "Christophorus Haus Diakoniestiftung Alt-Hamburg",
"official_name": "Kirchlicher Dienst in der Arbeitswelt der Nordkirche",
"opening_hours": [
{
"day_of_week": 0,
"opening_time": "09:00",
"closing_time": "13:00",
"date": "2019-12-24",
"closed": false
}
],
"picture": {
"file_name": "some.gif",
"details": {
"description": null,
"alternative": null,
"caption": null,
"license": null,
"copyright": null,
"related_files": null
},
"title": "Meine Datei",
"base64_enc": "R0lGODlhAQABAIAAAP///wAAACwAAAAAAQABAAACAkQBADs="
},
"preferred_event_location": true,
"tourism_key": "Kirchengemeinde Itzehoe",
"vcard_link": "www.erwachsenenbildung.nordkirche.de",
"vcard_type": 1,
"year_of_construction": 1602
},
"relationships": {
"address": {
"data": {
"type": "addresses",
"id": "1"
}
},
"categories": {
"data": [
{
"type": "categories",
"id": "1"
}
]
},
"institution_type": {
"data": {
"type": "institution_types",
"id": "1"
}
},
"parent_institutions": {
"data": [
{
"type": "institutions",
"id": "3"
}
]
},
"members": {
"data": [
{
"type": "institutions",
"id": "4"
}
]
},
"memberships": {
"data": [
{
"type": "institutions",
"id": "5"
}
]
},
"teams": {
"data": [
{
"type": "teams",
"id": "6"
}
]
}
}
}
}Response
201Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"id": "1",
"type": "institutions",
"links": {
"self": "'https://www.nordkirche.de/api/v1/institutions/1'"
},
"attributes": {
"abbreviation": "KDA Nordkirche",
"available_functions": [
{
"id": "1",
"name": "Bischof"
}
],
"bank_details": {
"account_number": "1234567",
"account_owner": "MOGO Hamburg in der Nordkirche e.V.",
"bank_code": "12345678",
"bank_name": "Evangelische Bank eG",
"bic": "GENODEF1EK1",
"iban": "DE32 1234 4567 8901 2345 67",
"id": 1
},
"contact_items": [
{
"id": "1337",
"type": "Telefon",
"value": "12345678"
}
],
"description": "<h2>Zwei Kirchen - eine Gemeinde</h2>",
"infos": [
{
"title": "Öffnungszeiten Kirchenbüro",
"info": "Dienstag und Freitag: 9.00 - 11.00 Uhr"
}
],
"is_authorized_collector": false,
"is_open_church": true,
"logo": {
"details": {
"description": "Hello, world!",
"alternative": "Hello, world!",
"caption": "Hello, world!",
"license": 1,
"copyright": "Hello, world!",
"related_files": 1
},
"title": "Meine Datei",
"url": "'//some/image/url'",
"file_name": "some.gif",
"mime_type": "image/gif",
"size": 35,
"image": {
"width": 1,
"height": 1
}
},
"map_visibility": true,
"media": [
{
"file_name": "some.pdf",
"details": {
"description": "Hello, world!",
"alternative": "Hello, world!",
"caption": "Hello, world!",
"license": 1,
"copyright": "Hello, world!",
"related_files": 1
},
"mime_type": "application/pdf",
"size": 291,
"title": "Uploads in Aktion",
"url": "'//some/image/url'"
}
],
"name": "Christophorus Haus Diakoniestiftung Alt-Hamburg",
"official_name": "Kirchlicher Dienst in der Arbeitswelt der Nordkirche",
"opening_hours": [
{
"day_of_week": 0,
"opening_time": "09:00",
"closing_time": "13:00",
"date": "2019-12-24",
"closed": false
}
],
"picture": {
"details": {
"description": "Hello, world!",
"alternative": "Hello, world!",
"caption": "Hello, world!",
"license": 1,
"copyright": "Hello, world!",
"related_files": 1
},
"title": "Meine Datei",
"url": "'//some/image/url'",
"file_name": "some.gif",
"mime_type": "image/gif",
"size": 35,
"image": {
"width": 1,
"height": 1
}
},
"preferred_event_location": true,
"tourism_key": "Kirchengemeinde Itzehoe",
"vcard_link": "www.erwachsenenbildung.nordkirche.de",
"vcard_type": 1,
"year_of_construction": 1602,
"last_modified": "2017-02-21T15:17:47+00:00",
"date_created": "2017-02-21T15:17:47+00:00"
},
"relationships": {
"address": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
},
"categories": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"institution_type": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
},
"map_children": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"parent_institutions": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"members": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"memberships": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"teams": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
}
},
"meta": {
"can": {
"create": false,
"delete": false,
"edit": false
},
"foreign_context": false
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
}
},
"required": [
"self"
]
},
"attributes": {
"type": "object",
"properties": {
"abbreviation": {
"type": "string"
},
"available_functions": {
"type": "array"
},
"bank_details": {
"type": [
"object",
"null"
],
"properties": {
"account_number": {
"type": "string"
},
"account_owner": {
"type": "string"
},
"bank_code": {
"type": "string"
},
"bank_name": {
"type": "string"
},
"bic": {
"type": "string"
},
"iban": {
"type": "string"
},
"id": {
"type": "number"
}
},
"required": [
"account_number",
"account_owner",
"bank_code",
"bank_name",
"bic",
"iban"
]
},
"contact_items": {
"type": "array"
},
"description": {
"type": "string",
"description": "may be very long"
},
"infos": {
"type": "array"
},
"is_authorized_collector": {
"type": "boolean",
"description": "Whether the institution can be make use of offertories."
},
"is_open_church": {
"type": "boolean"
},
"logo": {
"type": [
"object",
"null"
],
"properties": {
"details": {
"type": [
"object",
"null"
],
"properties": {
"description": {
"type": [
"string",
"null"
]
},
"alternative": {
"type": [
"string",
"null"
]
},
"caption": {
"type": [
"string",
"null"
]
},
"license": {
"type": [
"number",
"null"
]
},
"copyright": {
"type": [
"string",
"null"
]
},
"related_files": {
"type": [
"number",
"null"
]
}
}
},
"title": {
"type": "string"
},
"url": {
"type": "string"
},
"file_name": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"size": {
"type": "number"
},
"image": {
"type": "object",
"properties": {
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"required": [
"width",
"height"
]
}
},
"required": [
"details",
"title",
"file_name",
"mime_type",
"size",
"image"
]
},
"map_visibility": {
"type": "boolean",
"description": "Whether an InstitutionDetailView wants you to show the map initially."
},
"media": {
"type": "array"
},
"name": {
"type": "string"
},
"official_name": {
"type": "string"
},
"opening_hours": {
"type": "array"
},
"picture": {
"type": [
"object",
"null"
],
"properties": {
"details": {
"type": [
"object",
"null"
],
"properties": {
"description": {
"type": [
"string",
"null"
]
},
"alternative": {
"type": [
"string",
"null"
]
},
"caption": {
"type": [
"string",
"null"
]
},
"license": {
"type": [
"number",
"null"
]
},
"copyright": {
"type": [
"string",
"null"
]
},
"related_files": {
"type": [
"number",
"null"
]
}
}
},
"title": {
"type": "string"
},
"url": {
"type": "string"
},
"file_name": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"size": {
"type": "number"
},
"image": {
"type": "object",
"properties": {
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"required": [
"width",
"height"
]
}
},
"required": [
"details",
"title",
"file_name",
"mime_type",
"size",
"image"
]
},
"preferred_event_location": {
"type": "boolean"
},
"tourism_key": {
"type": "string"
},
"vcard_link": {
"type": "string",
"description": "may also be a PageID. (required)"
},
"vcard_type": {
"type": [
"number",
"null"
]
},
"year_of_construction": {
"type": [
"number",
"null"
]
},
"last_modified": {
"type": "string",
"description": "The time the ressource was last modified."
},
"date_created": {
"type": "string",
"description": "The time the ressource was created."
}
},
"required": [
"abbreviation",
"available_functions",
"bank_details",
"contact_items",
"description",
"infos",
"is_authorized_collector",
"is_open_church",
"logo",
"map_visibility",
"media",
"name",
"official_name",
"opening_hours",
"picture",
"tourism_key",
"vcard_type",
"year_of_construction"
]
},
"relationships": {
"type": "object",
"properties": {
"address": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"type"
]
}
},
"required": [
"links"
],
"description": "The address of the institution"
},
"categories": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": "array"
}
},
"required": [
"links"
]
},
"institution_type": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"type"
]
}
},
"required": [
"links"
]
},
"map_children": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": "array"
}
},
"required": [
"links"
]
},
"parent_institutions": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": "array"
}
},
"required": [
"links"
],
"description": "Direct parent institutions of this institution"
},
"members": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": "array"
}
},
"required": [
"links"
],
"description": "Institutions that are a member of this institution"
},
"memberships": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": "array"
}
},
"required": [
"links"
],
"description": "Institutions this institution is a member of"
},
"teams": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": "array"
}
},
"required": [
"links"
],
"description": "Named and ordered groups of functions at this institution"
}
},
"required": [
"address",
"categories",
"institution_type",
"map_children",
"parent_institutions",
"members",
"memberships"
]
},
"meta": {
"type": "object",
"properties": {
"can": {
"type": "object",
"properties": {
"create": {
"type": "boolean",
"description": "Indicates that the frontend user can create resources of this type"
},
"delete": {
"type": "boolean",
"description": "Indicates that the frontend user can delete this resource"
},
"edit": {
"type": "boolean",
"description": "Indicates that the frontend user can edit this resource"
}
}
},
"foreign_context": {
"type": "boolean",
"description": "Indicates that this resource does not belong to this institution or any sub institution.\nThe client should handle this resource in a way that indicateds it is not part of the current institution."
}
}
}
},
"required": [
"id",
"type",
"links",
"attributes",
"relationships"
]
}
}
}Institution ¶
Delete an InstitutionDELETE/api/v1/institutions/{id}
Deletes an Institution
Example URI
DELETE https://www.nordkirche.de/api/v1/institutions/1
URI Parameters
- id
number(required) Example: 1The ID of the desired Institution.
Request
Headers
Content-Type: application/vnd.api+jsonResponse
204Update an InstitutionPATCH/api/v1/institutions/{id}
Updates an existing institution with new values.
Example URI
PATCH https://www.nordkirche.de/api/v1/institutions/1
URI Parameters
- id
number(required) Example: 1The ID of the desired Institution.
Request
Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"id": "1",
"type": "institutions",
"attributes": {
"abbreviation": "KDA Nordkirche",
"available_functions": [
{
"id": "1",
"name": "Bischof"
}
],
"bank_details": {
"account_number": "1234567",
"account_owner": "MOGO Hamburg in der Nordkirche e.V.",
"bank_code": "12345678",
"bank_name": "Evangelische Bank eG",
"bic": "GENODEF1EK1",
"iban": "DE32 1234 4567 8901 2345 67",
"id": 0
},
"contact_items": [
{
"id": "1",
"type": "Telefon",
"value": "www.example.com"
}
],
"description": "<h2>Zwei Kirchen - eine Gemeinde</h2>",
"infos": [
{
"title": "Öffnungszeiten Kirchenbüro",
"info": "Dienstag und Freitag: 9.00 - 11.00 Uhr"
}
],
"is_authorized_collector": false,
"is_open_church": true,
"logo": {
"file_name": "some.gif",
"details": {
"description": null,
"alternative": null,
"caption": null,
"license": null,
"copyright": null,
"related_files": null
},
"title": "Meine Datei",
"base64_enc": "R0lGODlhAQABAIAAAP///wAAACwAAAAAAQABAAACAkQBADs="
},
"map_visibility": true,
"media": [
{
"file_name": "some.pdf",
"details": {
"description": null,
"alternative": null,
"caption": null,
"license": null,
"copyright": null,
"related_files": null
},
"title": "Uploads in Aktion",
"base64_enc": "JVBERi0xLjIgCjkgMCBvYmoKPDwKPj4Kc3RyZWFtCkJULyA5IFRmKFRlc3QpJyBFVAplbmRzdHJlYW0KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCA1IDAgUgovQ29udGVudHMgOSAwIFIKPj4KZW5kb2JqCjUgMCBvYmoKPDwKL0tpZHMgWzQgMCBSIF0KL0NvdW50IDEKL1R5cGUgL1BhZ2VzCi9NZWRpYUJveCBbIDAgMCA5OSA5IF0KPj4KZW5kb2JqCjMgMCBvYmoKPDwKL1BhZ2VzIDUgMCBSCi9UeXBlIC9DYXRhbG9nCj4+CmVuZG9iagp0cmFpbGVyCjw8Ci9Sb290IDMgMCBSCj4+CiUlRU9G"
}
],
"name": "Christophorus Haus Diakoniestiftung Alt-Hamburg",
"official_name": "Kirchlicher Dienst in der Arbeitswelt der Nordkirche",
"opening_hours": [
{
"day_of_week": 0,
"opening_time": "09:00",
"closing_time": "13:00",
"date": "2019-12-24",
"closed": false
}
],
"picture": {
"file_name": "some.gif",
"details": {
"description": null,
"alternative": null,
"caption": null,
"license": null,
"copyright": null,
"related_files": null
},
"title": "Meine Datei",
"base64_enc": "R0lGODlhAQABAIAAAP///wAAACwAAAAAAQABAAACAkQBADs="
},
"preferred_event_location": true,
"tourism_key": "Kirchengemeinde Itzehoe",
"vcard_link": "www.erwachsenenbildung.nordkirche.de",
"vcard_type": 1,
"year_of_construction": 1602
},
"relationships": {
"address": {
"data": {
"type": "addresses",
"id": "1"
}
},
"categories": {
"data": [
{
"type": "categories",
"id": "1"
}
]
},
"institution_type": {
"data": {
"type": "institution_types",
"id": "1"
}
},
"parent_institutions": {
"data": [
{
"type": "institutions",
"id": "3"
}
]
},
"members": {
"data": [
{
"type": "institutions",
"id": "4"
}
]
},
"memberships": {
"data": [
{
"type": "institutions",
"id": "5"
}
]
},
"teams": {
"data": [
{
"type": "teams",
"id": "6"
}
]
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"abbreviation": {
"type": "string"
},
"available_functions": {
"type": "array"
},
"bank_details": {
"type": [
"object",
"null"
],
"properties": {
"account_number": {
"type": "string"
},
"account_owner": {
"type": "string"
},
"bank_code": {
"type": "string"
},
"bank_name": {
"type": "string"
},
"bic": {
"type": "string"
},
"iban": {
"type": "string"
},
"id": {
"type": "number"
}
},
"required": [
"account_number",
"account_owner",
"bank_code",
"bank_name",
"bic",
"iban"
]
},
"contact_items": {
"type": "array"
},
"description": {
"type": "string",
"description": "may be very long"
},
"infos": {
"type": "array"
},
"is_authorized_collector": {
"type": "boolean",
"description": "Whether the institution can be make use of offertories."
},
"is_open_church": {
"type": "boolean"
},
"logo": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "number"
},
"file_name": {
"type": "string"
},
"details": {
"type": [
"object",
"null"
],
"properties": {
"description": {
"type": [
"string",
"null"
]
},
"alternative": {
"type": [
"string",
"null"
]
},
"caption": {
"type": [
"string",
"null"
]
},
"license": {
"type": [
"number",
"null"
]
},
"copyright": {
"type": [
"string",
"null"
]
},
"related_files": {
"type": [
"number",
"null"
]
}
}
},
"title": {
"type": "string"
},
"base64_enc": {
"type": "string"
}
},
"required": [
"file_name",
"details",
"title",
"base64_enc"
]
},
"map_visibility": {
"type": "boolean",
"description": "Whether an InstitutionDetailView wants you to show the map initially."
},
"media": {
"type": "array"
},
"name": {
"type": "string"
},
"official_name": {
"type": "string"
},
"opening_hours": {
"type": "array"
},
"picture": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "number"
},
"file_name": {
"type": "string"
},
"details": {
"type": [
"object",
"null"
],
"properties": {
"description": {
"type": [
"string",
"null"
]
},
"alternative": {
"type": [
"string",
"null"
]
},
"caption": {
"type": [
"string",
"null"
]
},
"license": {
"type": [
"number",
"null"
]
},
"copyright": {
"type": [
"string",
"null"
]
},
"related_files": {
"type": [
"number",
"null"
]
}
}
},
"title": {
"type": "string"
},
"base64_enc": {
"type": "string"
}
},
"required": [
"file_name",
"details",
"title",
"base64_enc"
]
},
"preferred_event_location": {
"type": "boolean"
},
"tourism_key": {
"type": "string"
},
"vcard_link": {
"type": "string",
"description": "may also be a PageID. (required)"
},
"vcard_type": {
"type": [
"number",
"null"
]
},
"year_of_construction": {
"type": [
"number",
"null"
]
}
},
"required": [
"abbreviation",
"available_functions",
"bank_details",
"contact_items",
"description",
"infos",
"is_authorized_collector",
"is_open_church",
"logo",
"map_visibility",
"media",
"name",
"official_name",
"opening_hours",
"picture",
"tourism_key",
"vcard_type",
"year_of_construction"
]
},
"relationships": {
"type": "object",
"properties": {
"address": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"type",
"id"
]
}
},
"description": "The address of the institution"
},
"categories": {
"type": "object",
"properties": {
"data": {
"type": "array"
}
}
},
"institution_type": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"type",
"id"
]
}
}
},
"parent_institutions": {
"type": "object",
"properties": {
"data": {
"type": "array"
}
},
"description": "Direct parent institutions of this institution"
},
"members": {
"type": "object",
"properties": {
"data": {
"type": "array"
}
},
"description": "Institutions that are a member of this institution"
},
"memberships": {
"type": "object",
"properties": {
"data": {
"type": "array"
}
},
"description": "Institutions this institution is a member of"
},
"teams": {
"type": "object",
"properties": {
"data": {
"type": "array"
}
},
"description": "Named and ordered groups of functions at this institution"
}
},
"required": [
"categories"
]
}
},
"required": [
"type"
]
}
},
"required": [
"data"
]
}Response
200InstitutionTypes ¶
List all InstitutionTypesGET/api/v1/institution_types{?sort}
Example URI
GET https://www.nordkirche.de/api/v1/institution_types?sort=id
URI Parameters
- sort
string(optional) Example: idSort the results by a specific field.
The result will be sorted by the given field in ascending order. To change the order to descending prepend a
-to the field name. Allowed sort options for institution types:id,-id,title,-title
Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"links": {
"first": "HOST/api/v1/ressource?page%5Bnumber%5D=1",
"last": "HOST/api/v1/ressource?page%5Bnumber%5D=42",
"next": "HOST/api/v1/ressource?page%5Bnumber%5D=3",
"prev": "HOST/api/v1/ressource?page%5Bnumber%5D=1"
},
"meta": {
"page_count": 3,
"record_count": 42
},
"data": [
{
"id": "42",
"type": "institutiontype",
"links": {
"self": "'https://www.nordkirche.de/api/v1/institution_types/1'"
},
"attributes": {
"name": "Kirchengemeinde",
"icon": "Hello, world!"
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"first": {
"type": "string"
},
"last": {
"type": "string"
},
"next": {
"type": "string"
},
"prev": {
"type": "string"
}
}
},
"meta": {
"type": "object",
"properties": {
"page_count": {
"type": "number",
"description": "Total number of pages in the result set"
},
"record_count": {
"type": "number",
"description": "Total number of items in the result set"
}
}
},
"data": {
"type": "array"
}
}
}Offertories ¶
Offertories ¶
Create an OffertoryPOST/api/v1/offertories/
Creates a new category.
Example URI
POST https://www.nordkirche.de/api/v1/offertories/
Request
Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"type": "offertories",
"attributes": {
"name": "Kollektenname",
"head_image": {
"file_name": "some.gif",
"details": {
"description": null,
"alternative": null,
"caption": null,
"license": null,
"copyright": null,
"related_files": null
},
"title": "Meine Datei",
"base64_enc": "R0lGODlhAQABAIAAAP///wAAACwAAAAAAQABAAACAkQBADs="
},
"images": [
{
"file_name": "some.gif",
"details": {
"description": null,
"alternative": null,
"caption": null,
"license": null,
"copyright": null,
"related_files": null
},
"title": "Meine Datei",
"base64_enc": "R0lGODlhAQABAIAAAP///wAAACwAAAAAAQABAAACAkQBADs="
}
],
"video": "",
"reason": "test_reason",
"short_description": "Beschreibung",
"url": "http://somewhere",
"prior_profit": 0,
"intercession": "",
"discontinuation": "",
"exemptions": [
{
"file_name": "some.pdf",
"details": {
"description": null,
"alternative": null,
"caption": null,
"license": null,
"copyright": null,
"related_files": null
},
"title": "Uploads in Aktion",
"base64_enc": "JVBERi0xLjIgCjkgMCBvYmoKPDwKPj4Kc3RyZWFtCkJULyA5IFRmKFRlc3QpJyBFVAplbmRzdHJlYW0KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCA1IDAgUgovQ29udGVudHMgOSAwIFIKPj4KZW5kb2JqCjUgMCBvYmoKPDwKL0tpZHMgWzQgMCBSIF0KL0NvdW50IDEKL1R5cGUgL1BhZ2VzCi9NZWRpYUJveCBbIDAgMCA5OSA5IF0KPj4KZW5kb2JqCjMgMCBvYmoKPDwKL1BhZ2VzIDUgMCBSCi9UeXBlIC9DYXRhbG9nCj4+CmVuZG9iagp0cmFpbGVyCjw8Ci9Sb290IDMgMCBSCj4+CiUlRU9G"
}
],
"starttime": "",
"endtime": "",
"altruja_usage": "",
"donation_proposal": 0,
"project_account_bic": "LOYDCHGGZCH",
"project_account_holder": "santa",
"project_account_number": "",
"project_account_iban": "DE12500105999648489890",
"project_account_usage": "",
"project_bank_code": "",
"project_bank_name": "elf_bank"
},
"relationships": {
"categories": {
"data": [
{
"type": "categories",
"id": "1"
}
]
},
"institution": {
"data": {
"type": "institutions",
"id": "1"
}
},
"person": {
"data": {
"type": "people",
"id": "1"
}
}
}
}
}Response
201Headers
Content-Type: application/vnd.api+jsonBody
{
"id": "1",
"type": "offertories",
"links": {
"self": "'https://www.nordkirche.de/api/v1/people/1'"
},
"attributes": {
"name": "Kollektenname",
"head_image": {
"details": {
"description": "Hello, world!",
"alternative": "Hello, world!",
"caption": "Hello, world!",
"license": 1,
"copyright": "Hello, world!",
"related_files": 1
},
"title": "Meine Datei",
"url": "'//some/image/url'",
"file_name": "some.gif",
"mime_type": "image/gif",
"size": 35,
"image": {
"width": 1,
"height": 1
}
},
"images": [
{
"details": {
"description": "Hello, world!",
"alternative": "Hello, world!",
"caption": "Hello, world!",
"license": 1,
"copyright": "Hello, world!",
"related_files": 1
},
"title": "Meine Datei",
"url": "'//some/image/url'",
"file_name": "some.gif",
"mime_type": "image/gif",
"size": 35,
"image": {
"width": 1,
"height": 1
}
}
],
"video": "Hello, world!",
"reason": "test_reason",
"short_description": "Beschreibung",
"url": "http://somewhere",
"prior_profit": 1,
"intercession": "Hello, world!",
"discontinuation": "Hello, world!",
"exemptions": [
{
"file_name": "some.pdf",
"details": {
"description": "Hello, world!",
"alternative": "Hello, world!",
"caption": "Hello, world!",
"license": 1,
"copyright": "Hello, world!",
"related_files": 1
},
"mime_type": "application/pdf",
"size": 291,
"title": "Uploads in Aktion",
"url": "'//some/image/url'"
}
],
"starttime": "Hello, world!",
"endtime": "Hello, world!",
"altruja_usage": "Hello, world!",
"donation_proposal": 0,
"project_account_bic": "LOYDCHGGZCH",
"project_account_holder": "santa",
"project_account_number": "Hello, world!",
"project_account_iban": "DE12500105999648489890",
"project_account_usage": "Hello, world!",
"project_bank_code": "Hello, world!",
"project_bank_name": "elf_bank",
"last_modified": "2017-02-21T15:17:47+00:00",
"date_created": "2017-02-21T15:17:47+00:00",
"localization": 0,
"priority": 0
},
"relationships": {
"categories": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"institution": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
},
"person": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
}
},
"meta": {
"can": {
"create": false,
"delete": false,
"edit": false
},
"foreign_context": false
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
}
},
"required": [
"self"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"head_image": {
"type": [
"object",
"null"
],
"properties": {
"details": {
"type": [
"object",
"null"
],
"properties": {
"description": {
"type": [
"string",
"null"
]
},
"alternative": {
"type": [
"string",
"null"
]
},
"caption": {
"type": [
"string",
"null"
]
},
"license": {
"type": [
"number",
"null"
]
},
"copyright": {
"type": [
"string",
"null"
]
},
"related_files": {
"type": [
"number",
"null"
]
}
}
},
"title": {
"type": "string"
},
"url": {
"type": "string"
},
"file_name": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"size": {
"type": "number"
},
"image": {
"type": "object",
"properties": {
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"required": [
"width",
"height"
]
}
},
"required": [
"details",
"title",
"file_name",
"mime_type",
"size",
"image"
]
},
"images": {
"type": "array"
},
"video": {
"type": "string"
},
"reason": {
"type": "string"
},
"short_description": {
"type": "string"
},
"url": {
"type": "string"
},
"prior_profit": {
"type": "number"
},
"intercession": {
"type": "string"
},
"discontinuation": {
"type": "string"
},
"exemptions": {
"type": "array"
},
"starttime": {
"type": "string"
},
"endtime": {
"type": "string"
},
"altruja_usage": {
"type": "string"
},
"donation_proposal": {
"type": "number"
},
"project_account_bic": {
"type": "string"
},
"project_account_holder": {
"type": "string"
},
"project_account_number": {
"type": "string"
},
"project_account_iban": {
"type": "string"
},
"project_account_usage": {
"type": "string"
},
"project_bank_code": {
"type": "string"
},
"project_bank_name": {
"type": "string"
},
"last_modified": {
"type": "string",
"description": "The time the ressource was last modified."
},
"date_created": {
"type": "string",
"description": "The time the ressource was created."
},
"localization": {
"type": "number"
},
"priority": {
"type": "number"
}
},
"required": [
"name",
"head_image",
"images",
"video",
"reason",
"short_description",
"url",
"prior_profit",
"intercession",
"discontinuation",
"exemptions",
"starttime",
"endtime",
"altruja_usage",
"donation_proposal",
"project_account_bic",
"project_account_holder",
"project_account_number",
"project_account_iban",
"project_account_usage",
"project_bank_code",
"project_bank_name",
"localization",
"priority"
]
},
"relationships": {
"type": "object",
"properties": {
"categories": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": "array"
}
},
"required": [
"links"
]
},
"institution": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"type"
]
}
},
"required": [
"links"
]
},
"person": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"type"
]
}
},
"required": [
"links"
]
}
}
},
"meta": {
"type": "object",
"properties": {
"can": {
"type": "object",
"properties": {
"create": {
"type": "boolean",
"description": "Indicates that the frontend user can create resources of this type"
},
"delete": {
"type": "boolean",
"description": "Indicates that the frontend user can delete this resource"
},
"edit": {
"type": "boolean",
"description": "Indicates that the frontend user can edit this resource"
}
}
},
"foreign_context": {
"type": "boolean",
"description": "Indicates that this resource does not belong to this institution or any sub institution.\nThe client should handle this resource in a way that indicateds it is not part of the current institution."
}
}
}
},
"required": [
"id",
"type",
"links",
"attributes"
]
}Offertory ¶
Retrieve an OffertoryGET/api/v1/offertories/{id}
Retrieves the Offertory with the given ID.
Example URI
GET https://www.nordkirche.de/api/v1/offertories/1
URI Parameters
- id
number(required) Example: 1The ID of the desired Offertory.
- meta[can]
string(optional) Example: 1Include
canmeta data.- meta[foreign_context]
string(optional) Example: 1Include
foreign_contextmeta data.
Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"id": "1",
"type": "offertories",
"links": {
"self": "'https://www.nordkirche.de/api/v1/people/1'"
},
"attributes": {
"name": "Kollektenname",
"head_image": {
"details": {
"description": "Hello, world!",
"alternative": "Hello, world!",
"caption": "Hello, world!",
"license": 1,
"copyright": "Hello, world!",
"related_files": 1
},
"title": "Meine Datei",
"url": "'//some/image/url'",
"file_name": "some.gif",
"mime_type": "image/gif",
"size": 35,
"image": {
"width": 1,
"height": 1
}
},
"images": [
{
"details": {
"description": "Hello, world!",
"alternative": "Hello, world!",
"caption": "Hello, world!",
"license": 1,
"copyright": "Hello, world!",
"related_files": 1
},
"title": "Meine Datei",
"url": "'//some/image/url'",
"file_name": "some.gif",
"mime_type": "image/gif",
"size": 35,
"image": {
"width": 1,
"height": 1
}
}
],
"video": "Hello, world!",
"reason": "test_reason",
"short_description": "Beschreibung",
"url": "http://somewhere",
"prior_profit": 1,
"intercession": "Hello, world!",
"discontinuation": "Hello, world!",
"exemptions": [
{
"file_name": "some.pdf",
"details": {
"description": "Hello, world!",
"alternative": "Hello, world!",
"caption": "Hello, world!",
"license": 1,
"copyright": "Hello, world!",
"related_files": 1
},
"mime_type": "application/pdf",
"size": 291,
"title": "Uploads in Aktion",
"url": "'//some/image/url'"
}
],
"starttime": "Hello, world!",
"endtime": "Hello, world!",
"altruja_usage": "Hello, world!",
"donation_proposal": 0,
"project_account_bic": "LOYDCHGGZCH",
"project_account_holder": "santa",
"project_account_number": "Hello, world!",
"project_account_iban": "DE12500105999648489890",
"project_account_usage": "Hello, world!",
"project_bank_code": "Hello, world!",
"project_bank_name": "elf_bank",
"last_modified": "2017-02-21T15:17:47+00:00",
"date_created": "2017-02-21T15:17:47+00:00",
"localization": 0,
"priority": 0
},
"relationships": {
"categories": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"institution": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
},
"person": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
}
},
"meta": {
"can": {
"create": false,
"delete": false,
"edit": false
},
"foreign_context": false
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
}
},
"required": [
"self"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"head_image": {
"type": [
"object",
"null"
],
"properties": {
"details": {
"type": [
"object",
"null"
],
"properties": {
"description": {
"type": [
"string",
"null"
]
},
"alternative": {
"type": [
"string",
"null"
]
},
"caption": {
"type": [
"string",
"null"
]
},
"license": {
"type": [
"number",
"null"
]
},
"copyright": {
"type": [
"string",
"null"
]
},
"related_files": {
"type": [
"number",
"null"
]
}
}
},
"title": {
"type": "string"
},
"url": {
"type": "string"
},
"file_name": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"size": {
"type": "number"
},
"image": {
"type": "object",
"properties": {
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"required": [
"width",
"height"
]
}
},
"required": [
"details",
"title",
"file_name",
"mime_type",
"size",
"image"
]
},
"images": {
"type": "array"
},
"video": {
"type": "string"
},
"reason": {
"type": "string"
},
"short_description": {
"type": "string"
},
"url": {
"type": "string"
},
"prior_profit": {
"type": "number"
},
"intercession": {
"type": "string"
},
"discontinuation": {
"type": "string"
},
"exemptions": {
"type": "array"
},
"starttime": {
"type": "string"
},
"endtime": {
"type": "string"
},
"altruja_usage": {
"type": "string"
},
"donation_proposal": {
"type": "number"
},
"project_account_bic": {
"type": "string"
},
"project_account_holder": {
"type": "string"
},
"project_account_number": {
"type": "string"
},
"project_account_iban": {
"type": "string"
},
"project_account_usage": {
"type": "string"
},
"project_bank_code": {
"type": "string"
},
"project_bank_name": {
"type": "string"
},
"last_modified": {
"type": "string",
"description": "The time the ressource was last modified."
},
"date_created": {
"type": "string",
"description": "The time the ressource was created."
},
"localization": {
"type": "number"
},
"priority": {
"type": "number"
}
},
"required": [
"name",
"head_image",
"images",
"video",
"reason",
"short_description",
"url",
"prior_profit",
"intercession",
"discontinuation",
"exemptions",
"starttime",
"endtime",
"altruja_usage",
"donation_proposal",
"project_account_bic",
"project_account_holder",
"project_account_number",
"project_account_iban",
"project_account_usage",
"project_bank_code",
"project_bank_name",
"localization",
"priority"
]
},
"relationships": {
"type": "object",
"properties": {
"categories": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": "array"
}
},
"required": [
"links"
]
},
"institution": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"type"
]
}
},
"required": [
"links"
]
},
"person": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"type"
]
}
},
"required": [
"links"
]
}
}
},
"meta": {
"type": "object",
"properties": {
"can": {
"type": "object",
"properties": {
"create": {
"type": "boolean",
"description": "Indicates that the frontend user can create resources of this type"
},
"delete": {
"type": "boolean",
"description": "Indicates that the frontend user can delete this resource"
},
"edit": {
"type": "boolean",
"description": "Indicates that the frontend user can edit this resource"
}
}
},
"foreign_context": {
"type": "boolean",
"description": "Indicates that this resource does not belong to this institution or any sub institution.\nThe client should handle this resource in a way that indicateds it is not part of the current institution."
}
}
}
},
"required": [
"id",
"type",
"links",
"attributes"
]
}
}
}Offertory ¶
Delete an OffertoryDELETE/api/v1/offertories/{id}
Deletes an offertory.
Example URI
DELETE https://www.nordkirche.de/api/v1/offertories/1
URI Parameters
- id
number(required) Example: 1The ID of the desired Offertory.
Request
Headers
Content-Type: application/vnd.api+jsonResponse
204Update an OffertoryPATCH/api/v1/offertories/{id}
Updates an existing offertory with new values.
Example URI
PATCH https://www.nordkirche.de/api/v1/offertories/1
URI Parameters
- id
number(required) Example: 1The ID of the desired Offertory.
Request
Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"id": "1",
"type": "offertories",
"attributes": {
"name": "Kollektenname",
"head_image": {
"file_name": "some.gif",
"details": {
"description": null,
"alternative": null,
"caption": null,
"license": null,
"copyright": null,
"related_files": null
},
"title": "Meine Datei",
"base64_enc": "R0lGODlhAQABAIAAAP///wAAACwAAAAAAQABAAACAkQBADs="
},
"images": [
{
"file_name": "some.gif",
"details": {
"description": null,
"alternative": null,
"caption": null,
"license": null,
"copyright": null,
"related_files": null
},
"title": "Meine Datei",
"base64_enc": "R0lGODlhAQABAIAAAP///wAAACwAAAAAAQABAAACAkQBADs="
}
],
"video": "",
"reason": "test_reason",
"short_description": "Beschreibung",
"url": "http://somewhere",
"prior_profit": 0,
"intercession": "",
"discontinuation": "",
"exemptions": [
{
"file_name": "some.pdf",
"details": {
"description": null,
"alternative": null,
"caption": null,
"license": null,
"copyright": null,
"related_files": null
},
"title": "Uploads in Aktion",
"base64_enc": "JVBERi0xLjIgCjkgMCBvYmoKPDwKPj4Kc3RyZWFtCkJULyA5IFRmKFRlc3QpJyBFVAplbmRzdHJlYW0KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCA1IDAgUgovQ29udGVudHMgOSAwIFIKPj4KZW5kb2JqCjUgMCBvYmoKPDwKL0tpZHMgWzQgMCBSIF0KL0NvdW50IDEKL1R5cGUgL1BhZ2VzCi9NZWRpYUJveCBbIDAgMCA5OSA5IF0KPj4KZW5kb2JqCjMgMCBvYmoKPDwKL1BhZ2VzIDUgMCBSCi9UeXBlIC9DYXRhbG9nCj4+CmVuZG9iagp0cmFpbGVyCjw8Ci9Sb290IDMgMCBSCj4+CiUlRU9G"
}
],
"starttime": "",
"endtime": "",
"altruja_usage": "",
"donation_proposal": 0,
"project_account_bic": "LOYDCHGGZCH",
"project_account_holder": "santa",
"project_account_number": "",
"project_account_iban": "DE12500105999648489890",
"project_account_usage": "",
"project_bank_code": "",
"project_bank_name": "elf_bank"
},
"relationships": {
"categories": {
"data": [
{
"type": "categories",
"id": "1"
}
]
},
"institution": {
"data": {
"type": "institutions",
"id": "1"
}
},
"person": {
"data": {
"type": "people",
"id": "1"
}
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"head_image": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"file_name": {
"type": "string"
},
"details": {
"type": [
"object",
"null"
],
"properties": {
"description": {
"type": [
"string",
"null"
]
},
"alternative": {
"type": [
"string",
"null"
]
},
"caption": {
"type": [
"string",
"null"
]
},
"license": {
"type": [
"number",
"null"
]
},
"copyright": {
"type": [
"string",
"null"
]
},
"related_files": {
"type": [
"number",
"null"
]
}
}
},
"title": {
"type": "string"
},
"base64_enc": {
"type": "string"
}
},
"required": [
"file_name",
"details",
"title",
"base64_enc"
]
},
"images": {
"type": "array"
},
"video": {
"type": "string"
},
"reason": {
"type": "string"
},
"short_description": {
"type": "string"
},
"url": {
"type": "string"
},
"prior_profit": {
"type": "number"
},
"intercession": {
"type": "string"
},
"discontinuation": {
"type": "string"
},
"exemptions": {
"type": "array"
},
"starttime": {
"type": "string"
},
"endtime": {
"type": "string"
},
"altruja_usage": {
"type": "string"
},
"donation_proposal": {
"type": "number"
},
"project_account_bic": {
"type": "string"
},
"project_account_holder": {
"type": "string"
},
"project_account_number": {
"type": "string"
},
"project_account_iban": {
"type": "string"
},
"project_account_usage": {
"type": "string"
},
"project_bank_code": {
"type": "string"
},
"project_bank_name": {
"type": "string"
}
},
"required": [
"name",
"images",
"video",
"reason",
"short_description",
"url",
"prior_profit",
"intercession",
"discontinuation",
"exemptions",
"starttime",
"endtime",
"altruja_usage",
"donation_proposal",
"project_account_bic",
"project_account_holder",
"project_account_number",
"project_account_iban",
"project_account_usage",
"project_bank_code",
"project_bank_name"
]
},
"relationships": {
"type": "object",
"properties": {
"categories": {
"type": "object",
"properties": {
"data": {
"type": "array"
}
}
},
"institution": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"type",
"id"
]
}
}
},
"person": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"type",
"id"
]
}
}
}
}
}
},
"required": [
"type"
]
}
}
}Response
200Offertories ¶
List all OffertoriesGET/api/v1/offertories/{?sort}
Example URI
GET https://www.nordkirche.de/api/v1/offertories/?sort=id
URI Parameters
- filter[id]
string(optional) Example: 1,2,3Limit result to a specific set of Ids.
- filter[categories]
string(optional) Example: 1,2,3Filter offertories by categories.
- filter[localization]
string(optional) Example: 1,2,3Filter offertories by localization.
- filter[priority]
string(optional) Example: 1,2,3Filter offertories by priority.
- filter[q]
string(optional) Example: FoobarUTF-8, URL-encoded search query on the following fields.-
name -
reason -
short_description
-
- filter[modified_before]
string(optional) Example: 2017-02-21T15:17:47+00:00Return events that were last modified before the given time.
- filter[modified_after]
string(optional) Example: 2017-02-21T15:17:47+00:00Return events that were last modified after the given time.
- meta[can]
string(optional) Example: 1Include
canmeta data.- meta[foreign_context]
string(optional) Example: 1Include
foreign_contextmeta data.- sort
string(optional) Example: idSort the results by a specific field.
The result will be sorted by the given field in ascending order. To change the order to descending prepend a
-to the field name. Allowed sort options for offertories:id,-id,name,-name,startdate,-startdate,priority,-priority,last_modified,-last_modified
Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"links": {
"first": "HOST/api/v1/ressource?page%5Bnumber%5D=1",
"last": "HOST/api/v1/ressource?page%5Bnumber%5D=42",
"next": "HOST/api/v1/ressource?page%5Bnumber%5D=3",
"prev": "HOST/api/v1/ressource?page%5Bnumber%5D=1"
},
"meta": {
"page_count": 3,
"record_count": 42
},
"data": [
{
"id": "1",
"type": "offertories",
"links": {
"self": "'https://www.nordkirche.de/api/v1/people/1'"
},
"attributes": {
"name": "Kollektenname",
"head_image": {
"details": {
"description": "Hello, world!",
"alternative": "Hello, world!",
"caption": "Hello, world!",
"license": 1,
"copyright": "Hello, world!",
"related_files": 1
},
"title": "Meine Datei",
"url": "'//some/image/url'",
"file_name": "some.gif",
"mime_type": "image/gif",
"size": 35,
"image": {
"width": 1,
"height": 1
}
},
"images": [
{
"details": {
"description": "Hello, world!",
"alternative": "Hello, world!",
"caption": "Hello, world!",
"license": 1,
"copyright": "Hello, world!",
"related_files": 1
},
"title": "Meine Datei",
"url": "'//some/image/url'",
"file_name": "some.gif",
"mime_type": "image/gif",
"size": 35,
"image": {
"width": 1,
"height": 1
}
}
],
"video": "Hello, world!",
"reason": "test_reason",
"short_description": "Beschreibung",
"url": "http://somewhere",
"prior_profit": 1,
"intercession": "Hello, world!",
"discontinuation": "Hello, world!",
"exemptions": [
{
"file_name": "some.pdf",
"details": {
"description": "Hello, world!",
"alternative": "Hello, world!",
"caption": "Hello, world!",
"license": 1,
"copyright": "Hello, world!",
"related_files": 1
},
"mime_type": "application/pdf",
"size": 291,
"title": "Uploads in Aktion",
"url": "'//some/image/url'"
}
],
"starttime": "Hello, world!",
"endtime": "Hello, world!",
"altruja_usage": "Hello, world!",
"donation_proposal": 0,
"project_account_bic": "LOYDCHGGZCH",
"project_account_holder": "santa",
"project_account_number": "Hello, world!",
"project_account_iban": "DE12500105999648489890",
"project_account_usage": "Hello, world!",
"project_bank_code": "Hello, world!",
"project_bank_name": "elf_bank",
"last_modified": "2017-02-21T15:17:47+00:00",
"date_created": "2017-02-21T15:17:47+00:00",
"localization": 0,
"priority": 0
},
"relationships": {
"categories": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"institution": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
},
"person": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
}
},
"meta": {
"can": {
"create": false,
"delete": false,
"edit": false
},
"foreign_context": false
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"first": {
"type": "string"
},
"last": {
"type": "string"
},
"next": {
"type": "string"
},
"prev": {
"type": "string"
}
}
},
"meta": {
"type": "object",
"properties": {
"page_count": {
"type": "number",
"description": "Total number of pages in the result set"
},
"record_count": {
"type": "number",
"description": "Total number of items in the result set"
}
}
},
"data": {
"type": "array"
}
}
}People ¶
Person ¶
Retrieve a PersonGET/api/v1/people/{id}
Retrieves the Person with the given ID.
Example URI
GET https://www.nordkirche.de/api/v1/people/1
URI Parameters
- id
number(required) Example: 1The ID of the desired Person.
- meta[can]
string(optional) Example: 1Include
canmeta data.- meta[foreign_context]
string(optional) Example: 1Include
foreign_contextmeta data.
Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"id": "1",
"type": "people",
"links": {
"self": "'https://www.nordkirche.de/api/v1/people/1'"
},
"attributes": {
"birthday_at": "2017-02-21T15:17:47+00:00",
"contact_items": [
{
"id": "1337",
"type": "Telefon",
"value": "12345678"
}
],
"job": "Hello, world!",
"name": {
"clerical_title": "Pastor",
"first": "Vorname",
"formatted": "Pastor Prof. Dr. Vorname Nachname",
"last": "Nachname",
"salutation": "Herr Pastor Vorname Nachname",
"standard_opening": "Sehr geehrter Herr Pastor Nachname",
"title": "Prof. Dr."
},
"sex": "male",
"status": "active",
"do_not_display": false,
"last_modified": "2017-02-21T15:17:47+00:00",
"date_created": "2017-02-21T15:17:47+00:00",
"picture": {
"details": {
"description": "Hello, world!",
"alternative": "Hello, world!",
"caption": "Hello, world!",
"license": 1,
"copyright": "Hello, world!",
"related_files": 1
},
"title": "Meine Datei",
"url": "'//some/image/url'",
"file_name": "some.gif",
"mime_type": "image/gif",
"size": 35,
"image": {
"width": 1,
"height": 1
}
}
},
"relationships": {
"functions": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"data_administrators": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"address": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
}
},
"meta": {
"can": {
"create": false,
"delete": false,
"edit": false
},
"foreign_context": false
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
}
},
"required": [
"self"
]
},
"attributes": {
"type": "object",
"properties": {
"birthday_at": {
"type": [
"string",
"null"
],
"description": "Formatted Date [ISO 8601]"
},
"contact_items": {
"type": "array"
},
"job": {
"type": "string"
},
"name": {
"type": "object",
"properties": {
"clerical_title": {
"type": "string"
},
"first": {
"type": "string"
},
"formatted": {
"type": "string"
},
"last": {
"type": "string"
},
"salutation": {
"type": "string"
},
"standard_opening": {
"type": "string"
},
"title": {
"type": "string"
}
},
"required": [
"clerical_title",
"first",
"formatted",
"last",
"salutation",
"standard_opening",
"title"
]
},
"sex": {
"type": "string",
"enum": [
"male",
"female",
"other"
]
},
"status": {
"type": "string",
"enum": [
"active",
"inactive",
"dead"
]
},
"do_not_display": {
"type": "boolean",
"description": "This person and their functions should never be shown on the website."
},
"last_modified": {
"type": "string"
},
"date_created": {
"type": "string"
},
"picture": {
"type": [
"object",
"null"
],
"properties": {
"details": {
"type": [
"object",
"null"
],
"properties": {
"description": {
"type": [
"string",
"null"
]
},
"alternative": {
"type": [
"string",
"null"
]
},
"caption": {
"type": [
"string",
"null"
]
},
"license": {
"type": [
"number",
"null"
]
},
"copyright": {
"type": [
"string",
"null"
]
},
"related_files": {
"type": [
"number",
"null"
]
}
}
},
"title": {
"type": "string"
},
"url": {
"type": "string"
},
"file_name": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"size": {
"type": "number"
},
"image": {
"type": "object",
"properties": {
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"required": [
"width",
"height"
]
}
},
"required": [
"details",
"title",
"file_name",
"mime_type",
"size",
"image"
]
}
},
"required": [
"contact_items",
"job",
"name",
"sex",
"status",
"picture"
]
},
"relationships": {
"type": "object",
"properties": {
"data_administrators": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": "array"
}
},
"required": [
"links"
],
"description": "Persons that act as Data Administrators for this Person"
},
"functions": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": "array"
}
},
"required": [
"links"
],
"description": "All functions of this person"
},
"address": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"type"
]
}
},
"required": [
"links"
]
}
},
"required": [
"functions",
"data_administrators"
]
},
"meta": {
"type": "object",
"properties": {
"can": {
"type": "object",
"properties": {
"create": {
"type": "boolean",
"description": "Indicates that the frontend user can create resources of this type"
},
"delete": {
"type": "boolean",
"description": "Indicates that the frontend user can delete this resource"
},
"edit": {
"type": "boolean",
"description": "Indicates that the frontend user can edit this resource"
}
}
},
"foreign_context": {
"type": "boolean",
"description": "Indicates that this resource does not belong to this institution or any sub institution.\nThe client should handle this resource in a way that indicateds it is not part of the current institution."
}
}
}
},
"required": [
"id",
"type",
"links",
"attributes"
]
}
}
}People ¶
List all PeopleGET/api/v1/people/{?facets,sort}
Example URI
GET https://www.nordkirche.de/api/v1/people/?facets=functions,available_functions&sort=id
URI Parameters
- filter[id]
string(optional) Example: 1,2,3Limit result to a specific set of Ids.
- filter[ancestor_institutions]
string(optional) Example: 1,2,3Filter people by their (indirect) membership in the given institutions. All people belonging to a descendant of the given institution are returned.
- filter[institutions]
string(optional) Example: 1,2,3Filter people by their direct membership in the given institutions.
- filter[ancestor_institutions_or_institutions]
string(optional) Example: 1,2,3Filter people by their membership in the given institutions. All people belonging to a given institution or its descendants are returned.
- filter[functions]
string(optional) Example: 1,2,3Filter people by the functions they hold.
- filter[available_functions]
string(optional) Example: 1,2,3Filter people by the available functions they hold.
- filter[q]
string(optional) Example: JemandUTF-8, URL-encoded search query on the following fields.-
first_name -
last_name -
responsibilities -
role_types -
available_roles
-
- filter[modified_before]
string(optional) Example: 2017-02-21T15:17:47+00:00Return events that were last modified before the given time.
- filter[modified_after]
string(optional) Example: 2017-02-21T15:17:47+00:00Return events that were last modified after the given time.
- meta[can]
string(optional) Example: 1Include
canmeta data.- meta[foreign_context]
string(optional) Example: 1Include
foreign_contextmeta data.- facets
string(optional) Example: functions,available_functionsFacets data to include in the result. Allowed facets for functions:
functions,available_functions- sort
string(optional) Example: idSort the results by a specific field.
The result will be sorted by the given field in ascending order. To change the order to descending prepend a
-to the field name. Sort options can be chained, sosort=last_name,first_namewould sort items with the samelast_nameby theirfirst_name. Allowed sort options for people:id,-id,first_name,-first_name,last_name,-last_name,last_modified,-last_modified
Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"links": {
"first": "HOST/api/v1/ressource?page%5Bnumber%5D=1",
"last": "HOST/api/v1/ressource?page%5Bnumber%5D=42",
"next": "HOST/api/v1/ressource?page%5Bnumber%5D=3",
"prev": "HOST/api/v1/ressource?page%5Bnumber%5D=1"
},
"meta": {
"page_count": 3,
"record_count": 42
},
"data": [
{
"id": "1",
"type": "people",
"links": {
"self": "'https://www.nordkirche.de/api/v1/people/1'"
},
"attributes": {
"birthday_at": "2017-02-21T15:17:47+00:00",
"contact_items": [
{
"id": "1337",
"type": "Telefon",
"value": "12345678"
}
],
"job": "Hello, world!",
"name": {
"clerical_title": "Pastor",
"first": "Vorname",
"formatted": "Pastor Prof. Dr. Vorname Nachname",
"last": "Nachname",
"salutation": "Herr Pastor Vorname Nachname",
"standard_opening": "Sehr geehrter Herr Pastor Nachname",
"title": "Prof. Dr."
},
"sex": "male",
"status": "active",
"do_not_display": false,
"last_modified": "2017-02-21T15:17:47+00:00",
"date_created": "2017-02-21T15:17:47+00:00",
"picture": {
"details": {
"description": "Hello, world!",
"alternative": "Hello, world!",
"caption": "Hello, world!",
"license": 1,
"copyright": "Hello, world!",
"related_files": 1
},
"title": "Meine Datei",
"url": "'//some/image/url'",
"file_name": "some.gif",
"mime_type": "image/gif",
"size": 35,
"image": {
"width": 1,
"height": 1
}
}
},
"relationships": {
"functions": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"data_administrators": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"address": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
}
},
"meta": {
"can": {
"create": false,
"delete": false,
"edit": false
},
"foreign_context": false
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"first": {
"type": "string"
},
"last": {
"type": "string"
},
"next": {
"type": "string"
},
"prev": {
"type": "string"
}
}
},
"meta": {
"type": "object",
"properties": {
"page_count": {
"type": "number",
"description": "Total number of pages in the result set"
},
"record_count": {
"type": "number",
"description": "Total number of items in the result set"
}
}
},
"data": {
"type": "array"
}
}
}People ¶
Create a PersonPOST/api/v1/people
Creates a new Person.
Example URI
POST https://www.nordkirche.de/api/v1/people
Request
Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"type": "people",
"attributes": {
"birthday_at": "2017-02-21T15:17:47+00:00",
"contact_items": [
{
"type": "Telefon",
"value": "www.example.com"
}
],
"job": "",
"name": {
"clerical_title": "Pastor",
"first": "Vorname",
"formatted": "Pastor Prof. Dr. Vorname Nachname",
"last": "Nachname",
"salutation": "Herr Pastor Vorname Nachname",
"standard_opening": "Sehr geehrter Herr Pastor Nachname",
"title": "Prof. Dr."
},
"sex": "male",
"status": "active",
"do_not_display": false
},
"relationships": {
"functions": {
"data": [
{}
]
},
"data_administrators": {
"data": [
{
"type": "people",
"id": "1"
}
]
}
}
}
}Response
201Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"id": "1",
"type": "people",
"attributes": {
"birthday_at": "2017-02-21T15:17:47+00:00",
"contact_items": [
{
"id": "1",
"type": "Telefon",
"value": "www.example.com"
}
],
"job": "",
"name": {
"clerical_title": "Pastor",
"first": "Vorname",
"formatted": "Pastor Prof. Dr. Vorname Nachname",
"last": "Nachname",
"salutation": "Herr Pastor Vorname Nachname",
"standard_opening": "Sehr geehrter Herr Pastor Nachname",
"title": "Prof. Dr."
},
"sex": "male",
"status": "active",
"do_not_display": false
},
"relationships": {
"functions": {
"data": [
{}
]
},
"data_administrators": {
"data": [
{
"type": "people",
"id": "1"
}
]
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"birthday_at": {
"type": [
"string",
"null"
],
"description": "Formatted Date [ISO 8601]"
},
"contact_items": {
"type": "array"
},
"job": {
"type": "string"
},
"name": {
"type": "object",
"properties": {
"clerical_title": {
"type": "string"
},
"first": {
"type": "string"
},
"formatted": {
"type": "string"
},
"last": {
"type": "string"
},
"salutation": {
"type": "string"
},
"standard_opening": {
"type": "string"
},
"title": {
"type": "string"
}
},
"required": [
"clerical_title",
"first",
"formatted",
"last",
"salutation",
"standard_opening",
"title"
]
},
"sex": {
"type": "string",
"enum": [
"male",
"female",
"other"
]
},
"status": {
"type": "string",
"enum": [
"active",
"inactive",
"dead"
]
},
"do_not_display": {
"type": "boolean",
"description": "This person and their functions should never be shown on the website."
}
},
"required": [
"contact_items",
"job",
"name",
"sex",
"status"
]
},
"relationships": {
"type": "object",
"properties": {
"functions": {
"type": "object",
"properties": {
"data": {
"type": "array"
}
}
},
"data_administrators": {
"type": "object",
"properties": {
"data": {
"type": "array"
}
},
"description": "Persons that act as Data Administrators for this Person"
}
}
}
},
"required": [
"type"
]
}
}
}People ¶
Update a PersonPATCH/api/v1/people/{id}
Updates an existing person with new values.
Example URI
PATCH https://www.nordkirche.de/api/v1/people/1
URI Parameters
- id
number(required) Example: 1The ID of the desired Person.
Request
Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"id": "1",
"type": "people",
"attributes": {
"birthday_at": "2017-02-21T15:17:47+00:00",
"contact_items": [
{
"id": "1",
"type": "Telefon",
"value": "www.example.com"
}
],
"job": "",
"name": {
"clerical_title": "Pastor",
"first": "Vorname",
"formatted": "Pastor Prof. Dr. Vorname Nachname",
"last": "Nachname",
"salutation": "Herr Pastor Vorname Nachname",
"standard_opening": "Sehr geehrter Herr Pastor Nachname",
"title": "Prof. Dr."
},
"sex": "male",
"status": "active",
"do_not_display": false
},
"relationships": {
"functions": {
"data": [
{}
]
},
"data_administrators": {
"data": [
{
"type": "people",
"id": "1"
}
]
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"birthday_at": {
"type": [
"string",
"null"
],
"description": "Formatted Date [ISO 8601]"
},
"contact_items": {
"type": "array"
},
"job": {
"type": "string"
},
"name": {
"type": "object",
"properties": {
"clerical_title": {
"type": "string"
},
"first": {
"type": "string"
},
"formatted": {
"type": "string"
},
"last": {
"type": "string"
},
"salutation": {
"type": "string"
},
"standard_opening": {
"type": "string"
},
"title": {
"type": "string"
}
},
"required": [
"clerical_title",
"first",
"formatted",
"last",
"salutation",
"standard_opening",
"title"
]
},
"sex": {
"type": "string",
"enum": [
"male",
"female",
"other"
]
},
"status": {
"type": "string",
"enum": [
"active",
"inactive",
"dead"
]
},
"do_not_display": {
"type": "boolean",
"description": "This person and their functions should never be shown on the website."
}
},
"required": [
"contact_items",
"job",
"name",
"sex",
"status"
]
},
"relationships": {
"type": "object",
"properties": {
"functions": {
"type": "object",
"properties": {
"data": {
"type": "array"
}
}
},
"data_administrators": {
"type": "object",
"properties": {
"data": {
"type": "array"
}
},
"description": "Persons that act as Data Administrators for this Person"
}
}
}
},
"required": [
"type"
]
}
}
}Response
200Delete a PersonDELETE/api/v1/people/{id}
Deletes a person.
Example URI
DELETE https://www.nordkirche.de/api/v1/people/1
URI Parameters
- id
number(required) Example: 1The ID of the desired Person.
Request
Headers
Content-Type: application/vnd.api+jsonResponse
204Function ¶
Retrieve a FunctionGET/api/v1/functions/{id}
Retrieves the Function with the given ID.
Example URI
GET https://www.nordkirche.de/api/v1/functions/1
URI Parameters
- id
number(required) Example: 1The ID of the desired Function.
- meta[can]
string(optional) Example: 1Include
canmeta data.- meta[foreign_context]
string(optional) Example: 1Include
foreign_contextmeta data.
Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"id": "1",
"type": "functions",
"links": {
"self": "'https://www.nordkirche.de/api/v1/functions/1'"
},
"attributes": {
"responsibilities": "Hello, world!",
"contact_items": [
{
"id": "1337",
"type": "Telefon",
"value": "12345678"
}
],
"sorting": 11,
"do_not_display": false,
"is_contact_person": false,
"title": "Bischof",
"last_modified": "2017-02-21T15:17:47+00:00",
"date_created": "2017-02-21T15:17:47+00:00"
},
"relationships": {
"address": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
},
"available_function": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
},
"function_type": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
},
"institution": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
},
"person": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
},
"team": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
}
},
"meta": {
"can": {
"create": false,
"delete": false,
"edit": false
},
"foreign_context": false
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
}
},
"required": [
"self"
]
},
"attributes": {
"type": "object",
"properties": {
"responsibilities": {
"type": "string"
},
"contact_items": {
"type": "array"
},
"sorting": {
"type": "number"
},
"do_not_display": {
"type": "boolean"
},
"is_contact_person": {
"type": "boolean"
},
"title": {
"type": "string"
},
"last_modified": {
"type": "string"
},
"date_created": {
"type": "string"
}
},
"required": [
"responsibilities",
"contact_items",
"title"
]
},
"relationships": {
"type": "object",
"properties": {
"address": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"type"
]
}
},
"required": [
"links"
]
},
"available_function": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"type"
]
}
},
"required": [
"links"
]
},
"function_type": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"type"
]
}
},
"required": [
"links"
]
},
"institution": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"type"
]
}
},
"required": [
"links"
]
},
"person": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"type"
]
}
},
"required": [
"links"
]
},
"team": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"type"
]
}
},
"required": [
"links"
]
}
},
"required": [
"address",
"available_function",
"function_type",
"institution",
"person"
]
},
"meta": {
"type": "object",
"properties": {
"can": {
"type": "object",
"properties": {
"create": {
"type": "boolean",
"description": "Indicates that the frontend user can create resources of this type"
},
"delete": {
"type": "boolean",
"description": "Indicates that the frontend user can delete this resource"
},
"edit": {
"type": "boolean",
"description": "Indicates that the frontend user can edit this resource"
}
}
},
"foreign_context": {
"type": "boolean",
"description": "Indicates that this resource does not belong to this institution or any sub institution.\nThe client should handle this resource in a way that indicateds it is not part of the current institution."
}
}
}
},
"required": [
"id",
"type",
"links",
"attributes",
"relationships"
]
}
}
}Functions ¶
List all FunctionsGET/api/v1/functions{?sort}
Example URI
GET https://www.nordkirche.de/api/v1/functions?sort=id
URI Parameters
- filter[id]
string(optional) Example: 1,2,3Limit result to a specific set of Ids.
- filter[modified_before]
string(optional) Example: 2017-02-21T15:17:47+00:00Return events that were last modified before the given time.
- filter[modified_after]
string(optional) Example: 2017-02-21T15:17:47+00:00Return events that were last modified after the given time.
- meta[can]
string(optional) Example: 1Include
canmeta data.- meta[foreign_context]
string(optional) Example: 1Include
foreign_contextmeta data.- sort
string(optional) Example: idSort the results by a specific field.
The result will be sorted by the given field in ascending order. To change the order to descending prepend a
-to the field name. Allowed sort options for functions:id,-id,title,-title,last_modified,-last_modified
Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"links": {
"first": "HOST/api/v1/ressource?page%5Bnumber%5D=1",
"last": "HOST/api/v1/ressource?page%5Bnumber%5D=42",
"next": "HOST/api/v1/ressource?page%5Bnumber%5D=3",
"prev": "HOST/api/v1/ressource?page%5Bnumber%5D=1"
},
"meta": {
"page_count": 3,
"record_count": 42
},
"data": [
{
"id": "1",
"type": "functions",
"links": {
"self": "'https://www.nordkirche.de/api/v1/functions/1'"
},
"attributes": {
"responsibilities": "Hello, world!",
"contact_items": [
{
"id": "1337",
"type": "Telefon",
"value": "12345678"
}
],
"sorting": 11,
"do_not_display": false,
"is_contact_person": false,
"title": "Bischof",
"last_modified": "2017-02-21T15:17:47+00:00",
"date_created": "2017-02-21T15:17:47+00:00"
},
"relationships": {
"address": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
},
"available_function": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
},
"function_type": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
},
"institution": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
},
"person": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
},
"team": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
}
},
"meta": {
"can": {
"create": false,
"delete": false,
"edit": false
},
"foreign_context": false
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"first": {
"type": "string"
},
"last": {
"type": "string"
},
"next": {
"type": "string"
},
"prev": {
"type": "string"
}
}
},
"meta": {
"type": "object",
"properties": {
"page_count": {
"type": "number",
"description": "Total number of pages in the result set"
},
"record_count": {
"type": "number",
"description": "Total number of items in the result set"
}
}
},
"data": {
"type": "array"
}
}
}Function ¶
Create a FunctionPOST/api/v1/functions
Creates a new function.
Example URI
POST https://www.nordkirche.de/api/v1/functions
Request
Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"type": "functions",
"attributes": {
"responsibilities": "",
"contact_items": [
{
"type": "Telefon",
"value": "www.example.com"
}
],
"sorting": 11,
"do_not_display": false,
"is_contact_person": false
},
"relationships": {
"address": {
"data": {
"type": "addresses",
"id": "1"
}
},
"available_function": {
"data": {
"type": "available_functions",
"id": "1"
}
},
"function_type": {
"data": {
"type": "function_types",
"id": "1"
}
},
"institution": {
"data": {
"type": "institutions",
"id": "1"
}
},
"person": {
"data": {
"type": "people",
"id": "1"
}
},
"team": {
"data": {
"type": "teams",
"id": "1"
}
}
}
}
}Response
201Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"id": "1",
"type": "functions",
"attributes": {
"responsibilities": "",
"contact_items": [
{
"id": "1",
"type": "Telefon",
"value": "www.example.com"
}
],
"sorting": 11,
"do_not_display": false,
"is_contact_person": false
},
"relationships": {
"address": {
"data": {
"type": "addresses",
"id": "1"
}
},
"available_function": {
"data": {
"type": "available_functions",
"id": "1"
}
},
"function_type": {
"data": {
"type": "function_types",
"id": "1"
}
},
"institution": {
"data": {
"type": "institutions",
"id": "1"
}
},
"person": {
"data": {
"type": "people",
"id": "1"
}
},
"team": {
"data": {
"type": "teams",
"id": "1"
}
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"responsibilities": {
"type": "string"
},
"contact_items": {
"type": "array"
},
"sorting": {
"type": "number"
},
"do_not_display": {
"type": "boolean"
},
"is_contact_person": {
"type": "boolean"
}
},
"required": [
"responsibilities",
"contact_items"
]
},
"relationships": {
"type": "object",
"properties": {
"address": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string"
}
}
}
}
},
"available_function": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string"
}
}
}
}
},
"function_type": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string"
}
}
}
}
},
"institution": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string"
}
}
}
}
},
"person": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string"
}
}
}
}
},
"team": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string"
}
}
}
}
}
},
"required": [
"available_function",
"function_type",
"person"
]
}
},
"required": [
"type"
]
}
}
}Function ¶
Update a FunctionPATCH/api/v1/functions/{id}
Updates an existing function with new values.
Example URI
PATCH https://www.nordkirche.de/api/v1/functions/1
URI Parameters
- id
number(required) Example: 1The ID of the desired Function.
Request
Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"id": "1",
"type": "functions",
"attributes": {
"responsibilities": "",
"contact_items": [
{
"id": "1",
"type": "Telefon",
"value": "www.example.com"
}
],
"sorting": 11,
"do_not_display": false,
"is_contact_person": false
},
"relationships": {
"address": {
"data": {
"type": "addresses",
"id": "1"
}
},
"available_function": {
"data": {
"type": "available_functions",
"id": "1"
}
},
"function_type": {
"data": {
"type": "function_types",
"id": "1"
}
},
"institution": {
"data": {
"type": "institutions",
"id": "1"
}
},
"person": {
"data": {
"type": "people",
"id": "1"
}
},
"team": {
"data": {
"type": "teams",
"id": "1"
}
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"responsibilities": {
"type": "string"
},
"contact_items": {
"type": "array"
},
"sorting": {
"type": "number"
},
"do_not_display": {
"type": "boolean"
},
"is_contact_person": {
"type": "boolean"
}
},
"required": [
"responsibilities",
"contact_items"
]
},
"relationships": {
"type": "object",
"properties": {
"address": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string"
}
}
}
}
},
"available_function": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string"
}
}
}
}
},
"function_type": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string"
}
}
}
}
},
"institution": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string"
}
}
}
}
},
"person": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string"
}
}
}
}
},
"team": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string"
}
}
}
}
}
},
"required": [
"available_function",
"function_type",
"person"
]
}
},
"required": [
"type"
]
}
}
}Response
200Delete a FunctionDELETE/api/v1/functions/{id}
Deletes a function.
Example URI
DELETE https://www.nordkirche.de/api/v1/functions/1
URI Parameters
- id
number(required) Example: 1The ID of the desired Function.
Request
Headers
Content-Type: application/vnd.api+jsonResponse
204Available Function ¶
Retrieve an Available FunctionGET/api/v1/available_functions/{id}
Retrieves the Available Function with the given ID.
Example URI
GET https://www.nordkirche.de/api/v1/available_functions/1
URI Parameters
- id
number(required) Example: 1The ID of the desired Available Function.
Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"id": "1",
"type": "available_functions",
"links": {
"self": "'https://www.nordkirche.de/api/v1/available_functions/1'"
},
"attributes": {
"name": "Bischof"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
}
},
"required": [
"self"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
]
}
},
"required": [
"id",
"type",
"links",
"attributes"
]
}
}
}Available Functions ¶
List all Available FunctionsGET/api/v1/available_functions{?sort}
Example URI
GET https://www.nordkirche.de/api/v1/available_functions?sort=id
URI Parameters
- sort
string(optional) Example: idSort the results by a specific field.
The result will be sorted by the given field in ascending order. To change the order to descending prepend a
-to the field name. Allowed sort options for available functions:id,-id,name,-name
Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"links": {
"first": "HOST/api/v1/ressource?page%5Bnumber%5D=1",
"last": "HOST/api/v1/ressource?page%5Bnumber%5D=42",
"next": "HOST/api/v1/ressource?page%5Bnumber%5D=3",
"prev": "HOST/api/v1/ressource?page%5Bnumber%5D=1"
},
"meta": {
"page_count": 3,
"record_count": 42
},
"data": [
{
"id": "1",
"type": "available_functions",
"links": {
"self": "'https://www.nordkirche.de/api/v1/available_functions/1'"
},
"attributes": {
"name": "Bischof"
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"first": {
"type": "string"
},
"last": {
"type": "string"
},
"next": {
"type": "string"
},
"prev": {
"type": "string"
}
}
},
"meta": {
"type": "object",
"properties": {
"page_count": {
"type": "number",
"description": "Total number of pages in the result set"
},
"record_count": {
"type": "number",
"description": "Total number of items in the result set"
}
}
},
"data": {
"type": "array"
}
}
}Function Type ¶
Create a Function TypePOST/api/v1/function_types/
Create a new Function Type.
Example URI
POST https://www.nordkirche.de/api/v1/function_types/
Request
Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"type": "function_types",
"attributes": {
"title": "Bischof"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"title": {
"type": "string"
}
},
"required": [
"title"
]
}
},
"required": [
"type"
]
}
}
}Response
201Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"id": "1",
"type": "function_types",
"attributes": {
"title": "Bischof"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"title": {
"type": "string"
}
},
"required": [
"title"
]
}
},
"required": [
"type"
]
}
}
}Function Type ¶
Retrieve a Function TypeGET/api/v1/function_types/{id}
Retrieves the Function Type with the given ID.
Example URI
GET https://www.nordkirche.de/api/v1/function_types/1
URI Parameters
- id
number(required) Example: 1The ID of the desired Function Type.
Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"id": "1",
"type": "function_types",
"links": {
"self": "'https://www.nordkirche.de/api/v1/function_types/1'"
},
"attributes": {
"title": "Bischof"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
}
},
"required": [
"self"
]
},
"attributes": {
"type": "object",
"properties": {
"title": {
"type": "string"
}
},
"required": [
"title"
]
}
},
"required": [
"id",
"type",
"links",
"attributes"
]
}
}
}Delete a Function TypeDELETE/api/v1/function_types/{id}
Deletes a function type.
Example URI
DELETE https://www.nordkirche.de/api/v1/function_types/1
URI Parameters
- id
number(required) Example: 1The ID of the desired Function Type.
Request
Headers
Content-Type: application/vnd.api+jsonResponse
204Update a Function TypePATCH/api/v1/function_types/{id}
Updates an existing function type with new values.
Example URI
PATCH https://www.nordkirche.de/api/v1/function_types/1
URI Parameters
- id
number(required) Example: 1The ID of the desired Function Type.
Request
Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"id": "1",
"type": "function_types",
"attributes": {
"title": "Bischof"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"title": {
"type": "string"
}
},
"required": [
"title"
]
}
},
"required": [
"type"
]
}
}
}Response
200FunctionTypes ¶
List all Function TypesGET/api/v1/function_types{?sort}
Example URI
GET https://www.nordkirche.de/api/v1/function_types?sort=id
URI Parameters
- sort
string(optional) Example: idSort the results by a specific field.
The result will be sorted by the given field in ascending order. To change the order to descending prepend a
-to the field name. Allowed sort options for function types:id,-id,title,-title
Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"links": {
"first": "HOST/api/v1/ressource?page%5Bnumber%5D=1",
"last": "HOST/api/v1/ressource?page%5Bnumber%5D=42",
"next": "HOST/api/v1/ressource?page%5Bnumber%5D=3",
"prev": "HOST/api/v1/ressource?page%5Bnumber%5D=1"
},
"meta": {
"page_count": 3,
"record_count": 42
},
"data": [
{
"id": "1",
"type": "function_types",
"links": {
"self": "'https://www.nordkirche.de/api/v1/function_types/1'"
},
"attributes": {
"title": "Bischof"
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"first": {
"type": "string"
},
"last": {
"type": "string"
},
"next": {
"type": "string"
},
"prev": {
"type": "string"
}
}
},
"meta": {
"type": "object",
"properties": {
"page_count": {
"type": "number",
"description": "Total number of pages in the result set"
},
"record_count": {
"type": "number",
"description": "Total number of items in the result set"
}
}
},
"data": {
"type": "array"
}
}
}Teams ¶
Teams ¶
Retrieve a TeamGET/api/v1/teams/{id}
Retrieves the Team with the given ID.
Example URI
GET https://www.nordkirche.de/api/v1/teams/1
URI Parameters
- id
number(required) Example: 1The ID of the desired Team.
- meta[can]
string(optional) Example: 1Include
canmeta data.- meta[foreign_context]
string(optional) Example: 1Include
foreign_contextmeta data.
Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"id": "1",
"type": "teams",
"links": {
"self": "'https://www.nordkirche.de/api/v1/teams/1'"
},
"attributes": {
"name": "Team",
"highlight": false,
"show_expanded": false
},
"relationships": {
"functions": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"institution": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
},
"function_type": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
}
},
"meta": {
"can": {
"create": false,
"delete": false,
"edit": false
},
"foreign_context": false
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
}
},
"required": [
"self"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name (required)"
},
"highlight": {
"type": "boolean"
},
"show_expanded": {
"type": "boolean"
}
}
},
"relationships": {
"type": "object",
"properties": {
"functions": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": "array"
}
},
"required": [
"links"
]
},
"institution": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"type"
]
}
},
"required": [
"links"
]
},
"function_type": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"type"
]
}
},
"required": [
"links"
]
}
}
},
"meta": {
"type": "object",
"properties": {
"can": {
"type": "object",
"properties": {
"create": {
"type": "boolean",
"description": "Indicates that the frontend user can create resources of this type"
},
"delete": {
"type": "boolean",
"description": "Indicates that the frontend user can delete this resource"
},
"edit": {
"type": "boolean",
"description": "Indicates that the frontend user can edit this resource"
}
}
},
"foreign_context": {
"type": "boolean",
"description": "Indicates that this resource does not belong to this institution or any sub institution.\nThe client should handle this resource in a way that indicateds it is not part of the current institution."
}
}
}
},
"required": [
"id",
"type",
"links",
"attributes"
]
}
}
}Teams ¶
List all TeamsGET/api/v1/teams{?sort}
Example URI
GET https://www.nordkirche.de/api/v1/teams?sort=id
URI Parameters
- filter[id]
string(optional) Example: 1,2,3Limit result to a specific set of Ids.
- filter[name]
string(optional) Example: LandesbischofOnly show teams with a specific name
- meta[can]
string(optional) Example: 1Include
canmeta data.- meta[foreign_context]
string(optional) Example: 1Include
foreign_contextmeta data.- sort
string(optional) Example: idSort the results by a specific field.
The result will be sorted by the given field in ascending order. To change the order to descending prepend a
-to the field name. Allowed sort options for teams:id,-id,sorting,-sorting
Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"links": {
"first": "HOST/api/v1/ressource?page%5Bnumber%5D=1",
"last": "HOST/api/v1/ressource?page%5Bnumber%5D=42",
"next": "HOST/api/v1/ressource?page%5Bnumber%5D=3",
"prev": "HOST/api/v1/ressource?page%5Bnumber%5D=1"
},
"meta": {
"page_count": 3,
"record_count": 42
},
"data": [
{
"id": "1",
"type": "teams",
"links": {
"self": "'https://www.nordkirche.de/api/v1/teams/1'"
},
"attributes": {
"name": "Team",
"highlight": false,
"show_expanded": false
},
"relationships": {
"functions": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"institution": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
},
"function_type": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
}
},
"meta": {
"can": {
"create": false,
"delete": false,
"edit": false
},
"foreign_context": false
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"first": {
"type": "string"
},
"last": {
"type": "string"
},
"next": {
"type": "string"
},
"prev": {
"type": "string"
}
}
},
"meta": {
"type": "object",
"properties": {
"page_count": {
"type": "number",
"description": "Total number of pages in the result set"
},
"record_count": {
"type": "number",
"description": "Total number of items in the result set"
}
}
},
"data": {
"type": "array"
}
}
}Team ¶
Create a TeamPOST/api/v1/teams
Creates a new team.
Example URI
POST https://www.nordkirche.de/api/v1/teams
Request
Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"type": "teams",
"attributes": {
"name": "Team",
"highlight": false,
"show_expanded": false
},
"relationships": {
"functions": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"institution": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
}
}
}
}Response
201Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"id": "1",
"type": "teams",
"attributes": {
"name": "Team",
"highlight": false,
"show_expanded": false
},
"relationships": {
"functions": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name (required)"
},
"highlight": {
"type": "boolean"
},
"show_expanded": {
"type": "boolean"
}
}
},
"relationships": {
"type": "object",
"properties": {
"functions": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": "array"
}
},
"required": [
"links"
]
}
}
}
},
"required": [
"type"
]
}
}
}Team ¶
Update a TeamPATCH/api/v1/teams/{id}
Updates an existing team with new values. Removing a function from the team will return it to the default team.
Example URI
PATCH https://www.nordkirche.de/api/v1/teams/1
URI Parameters
- id
number(required) Example: 1The ID of the desired Team.
Request
Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"id": "1",
"type": "teams",
"attributes": {
"name": "Team",
"highlight": false,
"show_expanded": false
},
"relationships": {
"functions": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name (required)"
},
"highlight": {
"type": "boolean"
},
"show_expanded": {
"type": "boolean"
}
}
},
"relationships": {
"type": "object",
"properties": {
"functions": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": "array"
}
},
"required": [
"links"
]
}
}
}
},
"required": [
"type"
]
}
}
}Response
200Delete a TeamDELETE/api/v1/teams/{id}
Deletes a team. Deleting a team will return all related functions to their default team.
Example URI
DELETE https://www.nordkirche.de/api/v1/teams/1
URI Parameters
- id
number(required) Example: 1The ID of the desired Team.
Request
Headers
Content-Type: application/vnd.api+jsonResponse
204TargetGroups ¶
TargetGroups ¶
List all TargetGroupsGET/api/v1/target_groups
Example URI
GET https://www.nordkirche.de/api/v1/target_groups
Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"links": {
"first": "HOST/api/v1/ressource?page%5Bnumber%5D=1",
"last": "HOST/api/v1/ressource?page%5Bnumber%5D=42",
"next": "HOST/api/v1/ressource?page%5Bnumber%5D=3",
"prev": "HOST/api/v1/ressource?page%5Bnumber%5D=1"
},
"meta": {
"page_count": 3,
"record_count": 42
},
"data": [
{
"id": "1",
"type": "target_groups",
"attributes": {
"name": "True neutral",
"last_modified": "2017-02-21T15:17:47+00:00"
},
"links": {
"self": "'https://www.nordkirche.de/api/v1/target_groups/1'"
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"first": {
"type": "string"
},
"last": {
"type": "string"
},
"next": {
"type": "string"
},
"prev": {
"type": "string"
}
}
},
"meta": {
"type": "object",
"properties": {
"page_count": {
"type": "number",
"description": "Total number of pages in the result set"
},
"record_count": {
"type": "number",
"description": "Total number of items in the result set"
}
}
},
"data": {
"type": "array"
}
},
"required": [
"data"
]
}Create a TargetGroupPOST/api/v1/target_groups
Creates a new target group.
Example URI
POST https://www.nordkirche.de/api/v1/target_groups
Request
Headers
Content-Type: application/vnd.api+jsonBody
{
"name": "True neutral"
}Response
201Headers
Content-Type: application/vnd.api+jsonBody
{
"id": "1",
"type": "target_groups",
"attributes": {
"name": "True neutral",
"last_modified": "2017-02-21T15:17:47+00:00"
},
"links": {
"self": "'https://www.nordkirche.de/api/v1/target_groups/1'"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"last_modified": {
"type": "string"
}
}
},
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
}
},
"required": [
"self"
]
}
},
"required": [
"id",
"type",
"attributes",
"links"
]
}TargetGroups ¶
Retrieve a TargetGroupGET/api/v1/target_groups/{id}
Example URI
GET https://www.nordkirche.de/api/v1/target_groups/1
URI Parameters
- id
number(required) Example: 1The ID of the desired target group.
Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"id": "1",
"type": "target_groups",
"attributes": {
"name": "True neutral",
"last_modified": "2017-02-21T15:17:47+00:00"
},
"links": {
"self": "'https://www.nordkirche.de/api/v1/target_groups/1'"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"last_modified": {
"type": "string"
}
}
},
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
}
},
"required": [
"self"
]
}
},
"required": [
"id",
"type",
"attributes",
"links"
]
}
},
"required": [
"data"
]
}Delete a TargetGroupDELETE/api/v1/target_groups/{id}
Deletes a target group.
Example URI
DELETE https://www.nordkirche.de/api/v1/target_groups/1
URI Parameters
- id
number(required) Example: 1The ID of the desired target group.
Request
Headers
Content-Type: application/vnd.api+jsonResponse
204Update a TargetGroupPATCH/api/v1/target_groups/{id}
Updates an existing target group with new values.
Example URI
PATCH https://www.nordkirche.de/api/v1/target_groups/1
URI Parameters
- id
number(required) Example: 1The ID of the desired target group.
Request
Headers
Content-Type: application/vnd.api+jsonBody
{
"name": "True neutral"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}Response
200Search ¶
Search ¶
SearchGET/api/v1/search/{query}{?facets,resources}
Performs a global fulltext search on events, institutions, people and offertories.
Example URI
GET https://www.nordkirche.de/api/v1/search/Beelzebu*?facets=event_types&resources=people,institutions
URI Parameters
- query
string(required) Example: Beelzebu*UTF-8, URL-encoded search query.May include wildcards. The query string must not contain any periods..- fields[institutions]
string(optional) Example: idLimits the response to certain fields. (Each resource requires their own
fieldsparameter)- facets
string(optional) Example: event_typesFacets to include in the search result.
Notice that the search includes multiple resource types. Not all results will contain the requested facet fields and won’t count for the facet. The allowed facets depend on the resource filter, but will always allow a
typesfacet.typeswill facet the resource types of the result. By default all facets from events, people, institutions and offertories are also allowed:event_types,institution_types,functions,available_functions.- resources
string(optional) Example: people,institutionsLimit the resource type of the results.
Only resources of any of the specified types will be returned. Allowed resource types for this filter are:
events,people,institutions,offertories
Response
200A list containing events, institutions, and people.
Headers
Content-Type: application/vnd.api+jsonBody
{
"links": {
"first": "HOST/api/v1/ressource?page%5Bnumber%5D=1",
"last": "HOST/api/v1/ressource?page%5Bnumber%5D=42",
"next": "HOST/api/v1/ressource?page%5Bnumber%5D=3",
"prev": "HOST/api/v1/ressource?page%5Bnumber%5D=1"
},
"meta": {
"page_count": 3,
"record_count": 42,
"facets": {}
},
"data": [
{
"id": "1",
"type": "events",
"links": {
"self": "'https://www.nordkirche.de/api/v1/events/1'"
},
"attributes": {
"accessible": true,
"alternate_location": "Maienweg 123, 22337 Hamburg",
"choirs": [
{
"id": "1",
"name": "Kantorei der Matthias-Claudius-Kirche"
}
],
"collection_requested": false,
"combit_event_id": "",
"compositions": [
{
"id": "1",
"first_name": "Johann Sebastian",
"last_name": "Bach",
"title": "Johannespassion"
}
],
"customized_mail": "",
"description": "Airs from Musicke of Sundrie Kindes (Thomas Ford 1607), Lautenmusik von J. Johnson und J. Dowland\\n Werner Faust, Laute\\n Oksana Lubova, Gesang",
"ends_at": "2017-02-21T15:17:47+00:00",
"ensembles": [
{
"id": "1",
"name": "Männervocalensemble"
}
],
"event_type": "",
"external_link": "https://example.com/external/link",
"files": [
{
"file_name": "some.pdf",
"details": {
"description": null,
"alternative": null,
"caption": null,
"license": null,
"copyright": null,
"related_files": null
},
"mime_type": "application/pdf",
"size": 291,
"title": "Uploads in Aktion",
"url": "'//some/image/url'"
}
],
"hints": "<p>Veranstaltung der Musikfreunde Kiel<br />Ermäßigungen für Mitglieder, Schüler und Studenten</p>",
"instrumental_soloists": [
{
"first_name": "Hannah",
"id": "1",
"instrument": "Klarinette",
"last_name": "Hilger"
}
],
"kicker": "Gesangssolisten, Kinderchor, zwei Chöre und zwei Orchestern auf historischen Instrumenten",
"lead": "Vorname Nachname, Andere Person",
"location_type": 1,
"numbered_seats": false,
"orchestras": [
{
"id": "1",
"name": "Ensemble aus Hamburg auf historischen Instrumenten"
}
],
"participants_text": "Information und Anmeldung: <br />Jemand +49 (01230) 123456789",
"picture": {
"details": {
"description": null,
"alternative": null,
"caption": null,
"license": null,
"copyright": null,
"related_files": null
},
"title": "Meine Datei",
"url": "'//some/image/url'",
"file_name": "some.gif",
"mime_type": "image/gif",
"size": 35,
"image": {
"width": 1,
"height": 1
}
},
"price": {
"range": {
"from": 42,
"to": 84
},
"reduction": true,
"text": "18€ im Vorverkauf, 20€ an der Abendkasse, Schüler und Studenten 10 €, Kinder bis 12 Jahre frei"
},
"recipient_email": "mail@example.com",
"registration_link": "https://example.com/registration/link",
"starts_at": "2017-02-21T15:17:47+00:00",
"tags": [
"Bestattung",
"Landesverein für Innere Mission"
],
"teaser_text": "Für alle abenteuerlustigen Kinder!",
"text_organizers": "Bildungsstelle Nord von Brot fur die Welt",
"ticket_sale": {
"booking_office": false,
"box_office": false,
"community": false
},
"ticket_sale_text": "Bitte melden Sie sich bis sieben Tage vor der jeweiligen Veranstaltung an",
"title": "Slow Tourismus, Reisen zwischen Langsamkeit und Sinnlichkeit",
"vocal_soloists": [
{
"first_name": "Lauter",
"id": "1",
"last_name": "Sänger",
"vocal_range": "Bariton"
}
],
"location_name": "Telemannsaal",
"last_modified": "2017-02-21T15:17:47+00:00",
"date_created": "2017-02-21T15:17:47+00:00"
},
"relationships": {
"address": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
},
"categories": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"chief_organizer": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
},
"host_institution": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
},
"organizers": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"co_organizers": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"participants": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"event_location": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
},
"age_groups": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"target_groups": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
}
},
"meta": {
"can": {
"create": false,
"delete": false,
"edit": false
},
"foreign_context": false,
"score": "4.54"
}
},
{
"id": "1",
"type": "institutions",
"links": {
"self": "'https://www.nordkirche.de/api/v1/institutions/1'"
},
"attributes": {
"abbreviation": "KDA Nordkirche",
"available_functions": [
{
"id": "1",
"name": "Bischof"
}
],
"bank_details": {
"account_number": "1234567",
"account_owner": "MOGO Hamburg in der Nordkirche e.V.",
"bank_code": "12345678",
"bank_name": "Evangelische Bank eG",
"bic": "GENODEF1EK1",
"iban": "DE32 1234 4567 8901 2345 67",
"id": 0
},
"contact_items": [
{
"id": "1337",
"type": "Telefon",
"value": "12345678"
}
],
"description": "<h2>Zwei Kirchen - eine Gemeinde</h2>",
"infos": [
{
"title": "Öffnungszeiten Kirchenbüro",
"info": "Dienstag und Freitag: 9.00 - 11.00 Uhr"
}
],
"is_authorized_collector": false,
"is_open_church": true,
"logo": {
"details": {
"description": null,
"alternative": null,
"caption": null,
"license": null,
"copyright": null,
"related_files": null
},
"title": "Meine Datei",
"url": "'//some/image/url'",
"file_name": "some.gif",
"mime_type": "image/gif",
"size": 35,
"image": {
"width": 1,
"height": 1
}
},
"map_visibility": true,
"media": [
{
"file_name": "some.pdf",
"details": {
"description": null,
"alternative": null,
"caption": null,
"license": null,
"copyright": null,
"related_files": null
},
"mime_type": "application/pdf",
"size": 291,
"title": "Uploads in Aktion",
"url": "'//some/image/url'"
}
],
"name": "Christophorus Haus Diakoniestiftung Alt-Hamburg",
"official_name": "Kirchlicher Dienst in der Arbeitswelt der Nordkirche",
"opening_hours": [
{
"day_of_week": 0,
"opening_time": "09:00",
"closing_time": "13:00",
"date": "2019-12-24",
"closed": false
}
],
"picture": {
"details": {
"description": null,
"alternative": null,
"caption": null,
"license": null,
"copyright": null,
"related_files": null
},
"title": "Meine Datei",
"url": "'//some/image/url'",
"file_name": "some.gif",
"mime_type": "image/gif",
"size": 35,
"image": {
"width": 1,
"height": 1
}
},
"preferred_event_location": true,
"tourism_key": "Kirchengemeinde Itzehoe",
"vcard_link": "www.erwachsenenbildung.nordkirche.de",
"vcard_type": 1,
"year_of_construction": 1602,
"last_modified": "2017-02-21T15:17:47+00:00",
"date_created": "2017-02-21T15:17:47+00:00"
},
"relationships": {
"address": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
},
"categories": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"institution_type": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
},
"map_children": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"parent_institutions": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"members": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"memberships": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"teams": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
}
},
"meta": {
"can": {
"create": false,
"delete": false,
"edit": false
},
"foreign_context": false,
"score": "4.54"
}
},
{
"id": "1",
"type": "people",
"links": {
"self": "'https://www.nordkirche.de/api/v1/people/1'"
},
"attributes": {
"birthday_at": "2017-02-21T15:17:47+00:00",
"contact_items": [
{
"id": "1337",
"type": "Telefon",
"value": "12345678"
}
],
"job": "",
"name": {
"clerical_title": "Pastor",
"first": "Vorname",
"formatted": "Pastor Prof. Dr. Vorname Nachname",
"last": "Nachname",
"salutation": "Herr Pastor Vorname Nachname",
"standard_opening": "Sehr geehrter Herr Pastor Nachname",
"title": "Prof. Dr."
},
"sex": "male",
"status": "active",
"do_not_display": false,
"last_modified": "2017-02-21T15:17:47+00:00",
"date_created": "2017-02-21T15:17:47+00:00",
"picture": {
"details": {
"description": null,
"alternative": null,
"caption": null,
"license": null,
"copyright": null,
"related_files": null
},
"title": "Meine Datei",
"url": "'//some/image/url'",
"file_name": "some.gif",
"mime_type": "image/gif",
"size": 35,
"image": {
"width": 1,
"height": 1
}
}
},
"relationships": {
"data_administrators": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"functions": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"address": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
}
},
"meta": {
"can": {
"create": false,
"delete": false,
"edit": false
},
"foreign_context": false,
"score": "4.54"
}
},
{
"id": "1",
"type": "offertories",
"links": {
"self": "'https://www.nordkirche.de/api/v1/people/1'"
},
"attributes": {
"name": "Kollektenname",
"head_image": {
"details": {
"description": null,
"alternative": null,
"caption": null,
"license": null,
"copyright": null,
"related_files": null
},
"title": "Meine Datei",
"url": "'//some/image/url'",
"file_name": "some.gif",
"mime_type": "image/gif",
"size": 35,
"image": {
"width": 1,
"height": 1
}
},
"images": [
{
"details": {
"description": null,
"alternative": null,
"caption": null,
"license": null,
"copyright": null,
"related_files": null
},
"title": "Meine Datei",
"url": "'//some/image/url'",
"file_name": "some.gif",
"mime_type": "image/gif",
"size": 35,
"image": {
"width": 1,
"height": 1
}
}
],
"video": "",
"reason": "test_reason",
"short_description": "Beschreibung",
"url": "http://somewhere",
"prior_profit": 0,
"intercession": "",
"discontinuation": "",
"exemptions": [
{
"file_name": "some.pdf",
"details": {
"description": null,
"alternative": null,
"caption": null,
"license": null,
"copyright": null,
"related_files": null
},
"mime_type": "application/pdf",
"size": 291,
"title": "Uploads in Aktion",
"url": "'//some/image/url'"
}
],
"starttime": "",
"endtime": "",
"altruja_usage": "",
"donation_proposal": 0,
"project_account_bic": "LOYDCHGGZCH",
"project_account_holder": "santa",
"project_account_number": "",
"project_account_iban": "DE12500105999648489890",
"project_account_usage": "",
"project_bank_code": "",
"project_bank_name": "elf_bank",
"last_modified": "2017-02-21T15:17:47+00:00",
"date_created": "2017-02-21T15:17:47+00:00",
"localization": 0,
"priority": 0
},
"relationships": {
"categories": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"institution": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
},
"person": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
}
},
"meta": {
"can": {
"create": false,
"delete": false,
"edit": false
},
"foreign_context": false,
"score": "4.54"
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"first": {
"type": "string"
},
"last": {
"type": "string"
},
"next": {
"type": "string"
},
"prev": {
"type": "string"
}
}
},
"meta": {
"type": "object",
"properties": {
"page_count": {
"type": "number",
"description": "total number of pages in the result set"
},
"record_count": {
"type": "number",
"description": "total number of items in the result set"
},
"facets": {
"type": "object",
"properties": {
"type_id": {
"description": "Array of facet data as `{\"Key\": Count}`"
},
"event_type": {
"description": "Array of facet data as `{\"Key\": Count}`"
},
"available_function_ids": {
"description": "Array of facet data as `{\"Key\": Count}`"
},
"function_type_ids": {
"description": "Array of facet data as `{\"Key\": Count}`"
}
}
}
}
},
"data": {
"type": "array"
}
}
}Autosuggest ¶
(No authentication required)
AutosuggestGET/api/v1/suggest/{query}{?types,id}
Offer suggestions to autocomplete the query.
Example URI
GET https://www.nordkirche.de/api/v1/suggest/nap?types=article,events&id=655
URI Parameters
- query
string(required) Example: napUTF-8, URL-encoded search query., should be at least 3 characters long. The query string must not contain any periods..- types
string(optional) Example: article,eventsLimits the search for suggestions to this type of items. Use commas to add multiple types.
Types are:
pages,article,institutions,persons,events.- id
string(optional) Example: 655The id of the page to search for suggestions. Defaults to
655(nordkirche.de).
Response
200A list containing up to 10 suggestions from solr, ordered by relevance.
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": [
"napi",
"napkins",
"naptime"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array"
}
},
"required": [
"data"
]
}Authentication ¶
Login ¶
(No authentication required)
LoginPOST/api/v1/login
Login a frontend user
Example URI
POST https://www.nordkirche.de/api/v1/login
Request
Headers
Content-Type: application/jsonBody
{
"username": "admin",
"password": "12345"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"username": {
"type": "string"
},
"password": {
"type": "string"
}
}
}Response
200An auth token if the login succeeded or an empty object if not. The response will also include additional information about the frontend user.
Most API requests require the id and token of this auth token to be send as HTTP-Headers to authenticate the user.
Headers
Content-Type: application/json; charset=utf-8Body
{
"expires": "2017-04-12T10:42:59.000Z",
"id": 1,
"token": "xxxxxxxxxxxxxxxxxxxx",
"name": "The Name",
"first_name": "First Name",
"last_name": "Last Name",
"user_groups": [
1,
2,
3
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"expires": {
"type": "string"
},
"id": {
"type": "number"
},
"token": {
"type": "string"
},
"name": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"user_groups": {
"type": "array"
}
}
}Logout ¶
LogoutGET/api/v1/logout
Logout a frontend user. If vaild auth headers were sent, the associated auth token will be destroyed. If the authentication fails or the token provided is a permanent one, nothing will happen.
Example URI
GET https://www.nordkirche.de/api/v1/logout
Response
200Headers
Content-Type: application/json; charset=utf-8Body
{
"message": "ok."
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}Images ¶
Image ¶
(No authentication required)
ImageGET/api/v1/images/{id}{?h,w}
Request an image that’s supposed to be processed to be of the given size.
Example URI
GET https://www.nordkirche.de/api/v1/images/1?h=100&w=100
URI Parameters
- id
number(required) Example: 1The ID of the image.
- h
string(required) Example: 100The height.
- w
string(required) Example: 100The width.
Response
302Body
Redirect to the processed image.Current User ¶
Current User ¶
Retrieve the Current UserGET/api/v1/me
Retrieves the Person for the logged in frontend user.
Example URI
GET https://www.nordkirche.de/api/v1/me
Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"id": "1",
"type": "people",
"links": {
"self": "'https://www.nordkirche.de/api/v1/people/1'"
},
"attributes": {
"birthday_at": "2017-02-21T15:17:47+00:00",
"contact_items": [
{
"id": "1337",
"type": "Telefon",
"value": "12345678"
}
],
"job": "Hello, world!",
"name": {
"clerical_title": "Pastor",
"first": "Vorname",
"formatted": "Pastor Prof. Dr. Vorname Nachname",
"last": "Nachname",
"salutation": "Herr Pastor Vorname Nachname",
"standard_opening": "Sehr geehrter Herr Pastor Nachname",
"title": "Prof. Dr."
},
"sex": "male",
"status": "active",
"do_not_display": false,
"last_modified": "2017-02-21T15:17:47+00:00",
"date_created": "2017-02-21T15:17:47+00:00",
"picture": {
"details": {
"description": "Hello, world!",
"alternative": "Hello, world!",
"caption": "Hello, world!",
"license": 1,
"copyright": "Hello, world!",
"related_files": 1
},
"title": "Meine Datei",
"url": "'//some/image/url'",
"file_name": "some.gif",
"mime_type": "image/gif",
"size": 35,
"image": {
"width": 1,
"height": 1
}
}
},
"relationships": {
"functions": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"data_administrators": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"address": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
}
},
"meta": {
"can": {
"create": false,
"delete": false,
"edit": false
},
"foreign_context": false
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
}
},
"required": [
"self"
]
},
"attributes": {
"type": "object",
"properties": {
"birthday_at": {
"type": [
"string",
"null"
],
"description": "Formatted Date [ISO 8601]"
},
"contact_items": {
"type": "array"
},
"job": {
"type": "string"
},
"name": {
"type": "object",
"properties": {
"clerical_title": {
"type": "string"
},
"first": {
"type": "string"
},
"formatted": {
"type": "string"
},
"last": {
"type": "string"
},
"salutation": {
"type": "string"
},
"standard_opening": {
"type": "string"
},
"title": {
"type": "string"
}
},
"required": [
"clerical_title",
"first",
"formatted",
"last",
"salutation",
"standard_opening",
"title"
]
},
"sex": {
"type": "string",
"enum": [
"male",
"female",
"other"
]
},
"status": {
"type": "string",
"enum": [
"active",
"inactive",
"dead"
]
},
"do_not_display": {
"type": "boolean",
"description": "This person and their functions should never be shown on the website."
},
"last_modified": {
"type": "string"
},
"date_created": {
"type": "string"
},
"picture": {
"type": [
"object",
"null"
],
"properties": {
"details": {
"type": [
"object",
"null"
],
"properties": {
"description": {
"type": [
"string",
"null"
]
},
"alternative": {
"type": [
"string",
"null"
]
},
"caption": {
"type": [
"string",
"null"
]
},
"license": {
"type": [
"number",
"null"
]
},
"copyright": {
"type": [
"string",
"null"
]
},
"related_files": {
"type": [
"number",
"null"
]
}
}
},
"title": {
"type": "string"
},
"url": {
"type": "string"
},
"file_name": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"size": {
"type": "number"
},
"image": {
"type": "object",
"properties": {
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"required": [
"width",
"height"
]
}
},
"required": [
"details",
"title",
"file_name",
"mime_type",
"size",
"image"
]
}
},
"required": [
"contact_items",
"job",
"name",
"sex",
"status",
"picture"
]
},
"relationships": {
"type": "object",
"properties": {
"data_administrators": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": "array"
}
},
"required": [
"links"
],
"description": "Persons that act as Data Administrators for this Person"
},
"functions": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": "array"
}
},
"required": [
"links"
],
"description": "All functions of this person"
},
"address": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"required": [
"self",
"related"
]
},
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"type"
]
}
},
"required": [
"links"
]
}
},
"required": [
"functions",
"data_administrators"
]
},
"meta": {
"type": "object",
"properties": {
"can": {
"type": "object",
"properties": {
"create": {
"type": "boolean",
"description": "Indicates that the frontend user can create resources of this type"
},
"delete": {
"type": "boolean",
"description": "Indicates that the frontend user can delete this resource"
},
"edit": {
"type": "boolean",
"description": "Indicates that the frontend user can edit this resource"
}
}
},
"foreign_context": {
"type": "boolean",
"description": "Indicates that this resource does not belong to this institution or any sub institution.\nThe client should handle this resource in a way that indicateds it is not part of the current institution."
}
}
}
},
"required": [
"id",
"type",
"links",
"attributes"
]
}
}
}Institutions of the Current User ¶
InstitutionsGET/api/v1/me/institutions/{?facets,sort}
Example URI
GET https://www.nordkirche.de/api/v1/me/institutions/?facets=institution_types&sort=id
URI Parameters
- filter[id]
string(optional) Example: 1,2,3Limit result to a specific set of Ids.
- filter[ancestor_institutions]
string(optional) Example: 1,2,3Filter institutions by their relation to other institutions.
Only descendants of the given institution IDs are returned.
- filter[ancestor_institutions_or_self]
string(optional) Example: 1,2,3Filter institutions by their relation to other institutions.
Only descendants of the given institution IDs and the institutions with the given institution IDs are returned.
- filter[categories]
string(optional) Example: 1,2,3Filter institutions by categories.
Institutions belonging to at least one of the given category IDs are returned.
- filter[geocode]
string(optional) Example: 53.5659382,9.9613604,5Filter by location. Only records with an address within the given radius around the given location are returned. Returns items located within a given radius of the given latitude/longitude. The parameter value is specified by
latitude,longitude,radius, where radius units are assumed to be kilometers.- filter[parent_institutions]
string(optional) Example: 1,2,3Filter institutions by their relation to other institutions.
Only children of the given institution IDs are returned.
- filter[parent_institutions_or_self]
string(optional) Example: 1,2,3Filter institutions by their relation to other institutions.
Only children of the given institution IDs and the institutions with the given institution IDs are returned.
- filter[institution_type]
string(optional) Example: 1,2,3Filter institutions by given institution type ids.
To determine the IDs of your favorite institution types, have a look at InstitutionType#List
- filter[q]
string(optional) Example: DoreenUTF-8, URL-encoded search query on the following fields.-
`name
-
official_name -
description -
plz -
Category titles
-
institution_type
-
- filter[cities]
string(optional) Example: Kiel,HamburgFilter by cities names.
- filter[plz]
string(optional) Example: 35641,223*,11111Filter by zip code.
Return all events where the zip code of the address matches any of the items in the list. Wildcards may be used at the end of a partial zip code.
- filter[modified_before]
string(optional) Example: 2017-02-21T15:17:47+00:00[ISO 8601]
Return events that were last modified before the given time.
- filter[modified_after]
string(optional) Example: 2017-02-21T15:17:47+00:00[ISO 8601]
Return events that were last modified after the given time.
- meta[can]
string(optional) Example: 1Include
canmeta data.- meta[foreign_context]
string(optional) Example: 1Include
foreign_contextmeta data.- facets
string(optional) Example: institution_typesFacets data to include in the result. Allowed facets for institutions:
institution_types- sort
string(optional) Example: idSort the results by a specific field.
The result will be sorted by the given field in ascending order. To change the order to descending prepend a
-to the field name. Allowed sort options for institutions:id,-id,name,-name,last_modified,-last_modified
Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"links": {
"first": "HOST/api/v1/ressource?page%5Bnumber%5D=1",
"last": "HOST/api/v1/ressource?page%5Bnumber%5D=42",
"next": "HOST/api/v1/ressource?page%5Bnumber%5D=3",
"prev": "HOST/api/v1/ressource?page%5Bnumber%5D=1"
},
"meta": {
"page_count": 3,
"record_count": 42
},
"data": [
{
"id": "1",
"type": "institutions",
"links": {
"self": "'https://www.nordkirche.de/api/v1/institutions/1'"
},
"attributes": {
"abbreviation": "KDA Nordkirche",
"available_functions": [
{
"id": "1",
"name": "Bischof"
}
],
"bank_details": {
"account_number": "1234567",
"account_owner": "MOGO Hamburg in der Nordkirche e.V.",
"bank_code": "12345678",
"bank_name": "Evangelische Bank eG",
"bic": "GENODEF1EK1",
"iban": "DE32 1234 4567 8901 2345 67",
"id": 1
},
"contact_items": [
{
"id": "1337",
"type": "Telefon",
"value": "12345678"
}
],
"description": "<h2>Zwei Kirchen - eine Gemeinde</h2>",
"infos": [
{
"title": "Öffnungszeiten Kirchenbüro",
"info": "Dienstag und Freitag: 9.00 - 11.00 Uhr"
}
],
"is_authorized_collector": false,
"is_open_church": true,
"logo": {
"details": {
"description": "Hello, world!",
"alternative": "Hello, world!",
"caption": "Hello, world!",
"license": 1,
"copyright": "Hello, world!",
"related_files": 1
},
"title": "Meine Datei",
"url": "'//some/image/url'",
"file_name": "some.gif",
"mime_type": "image/gif",
"size": 35,
"image": {
"width": 1,
"height": 1
}
},
"map_visibility": true,
"media": [
{
"file_name": "some.pdf",
"details": {
"description": "Hello, world!",
"alternative": "Hello, world!",
"caption": "Hello, world!",
"license": 1,
"copyright": "Hello, world!",
"related_files": 1
},
"mime_type": "application/pdf",
"size": 291,
"title": "Uploads in Aktion",
"url": "'//some/image/url'"
}
],
"name": "Christophorus Haus Diakoniestiftung Alt-Hamburg",
"official_name": "Kirchlicher Dienst in der Arbeitswelt der Nordkirche",
"opening_hours": [
{
"day_of_week": 0,
"opening_time": "09:00",
"closing_time": "13:00",
"date": "2019-12-24",
"closed": false
}
],
"picture": {
"details": {
"description": "Hello, world!",
"alternative": "Hello, world!",
"caption": "Hello, world!",
"license": 1,
"copyright": "Hello, world!",
"related_files": 1
},
"title": "Meine Datei",
"url": "'//some/image/url'",
"file_name": "some.gif",
"mime_type": "image/gif",
"size": 35,
"image": {
"width": 1,
"height": 1
}
},
"preferred_event_location": true,
"tourism_key": "Kirchengemeinde Itzehoe",
"vcard_link": "www.erwachsenenbildung.nordkirche.de",
"vcard_type": 1,
"year_of_construction": 1602,
"last_modified": "2017-02-21T15:17:47+00:00",
"date_created": "2017-02-21T15:17:47+00:00"
},
"relationships": {
"address": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
},
"categories": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"institution_type": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
},
"map_children": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"parent_institutions": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"members": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"memberships": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"teams": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
}
},
"meta": {
"can": {
"create": false,
"delete": false,
"edit": false
},
"foreign_context": false
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"first": {
"type": "string"
},
"last": {
"type": "string"
},
"next": {
"type": "string"
},
"prev": {
"type": "string"
}
}
},
"meta": {
"type": "object",
"properties": {
"page_count": {
"type": "number",
"description": "Total number of pages in the result set"
},
"record_count": {
"type": "number",
"description": "Total number of items in the result set"
}
}
},
"data": {
"type": "array"
}
}
}Events of the Current User ¶
EventsGET/api/v1/me/events
Retrieves the events of institutions, the user has functions at.
Example URI
GET https://www.nordkirche.de/api/v1/me/events
Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"links": {
"first": "HOST/api/v1/ressource?page%5Bnumber%5D=1",
"last": "HOST/api/v1/ressource?page%5Bnumber%5D=42",
"next": "HOST/api/v1/ressource?page%5Bnumber%5D=3",
"prev": "HOST/api/v1/ressource?page%5Bnumber%5D=1"
},
"meta": {
"page_count": 3,
"record_count": 42
},
"data": [
{
"id": "1",
"type": "events",
"links": {
"self": "'https://www.nordkirche.de/api/v1/events/1'"
},
"attributes": {
"accessible": true,
"alternate_location": "Maienweg 123, 22337 Hamburg",
"choirs": [
{
"id": "1",
"name": "Kantorei der Matthias-Claudius-Kirche"
}
],
"collection_requested": true,
"combit_event_id": "Hello, world!",
"compositions": [
{
"id": "1",
"first_name": "Johann Sebastian",
"last_name": "Bach",
"title": "Johannespassion"
}
],
"customized_mail": "Hello, world!",
"description": "Airs from Musicke of Sundrie Kindes (Thomas Ford 1607), Lautenmusik von J. Johnson und J. Dowland\\n Werner Faust, Laute\\n Oksana Lubova, Gesang",
"ends_at": "2017-02-21T15:17:47+00:00",
"ensembles": [
{
"id": "1",
"name": "Männervocalensemble"
}
],
"event_type": "Hello, world!",
"external_link": "https://example.com/external/link",
"files": [
{
"file_name": "some.pdf",
"details": {
"description": "Hello, world!",
"alternative": "Hello, world!",
"caption": "Hello, world!",
"license": 1,
"copyright": "Hello, world!",
"related_files": 1
},
"mime_type": "application/pdf",
"size": 291,
"title": "Uploads in Aktion",
"url": "'//some/image/url'"
}
],
"hints": "<p>Veranstaltung der Musikfreunde Kiel<br />Ermäßigungen für Mitglieder, Schüler und Studenten</p>",
"instrumental_soloists": [
{
"first_name": "Hannah",
"id": "1",
"instrument": "Klarinette",
"last_name": "Hilger"
}
],
"kicker": "Gesangssolisten, Kinderchor, zwei Chöre und zwei Orchestern auf historischen Instrumenten",
"lead": "Vorname Nachname, Andere Person",
"location_type": 1,
"numbered_seats": true,
"orchestras": [
{
"id": "1",
"name": "Ensemble aus Hamburg auf historischen Instrumenten"
}
],
"participants_text": "Information und Anmeldung: <br />Jemand +49 (01230) 123456789",
"picture": {
"details": {
"description": "Hello, world!",
"alternative": "Hello, world!",
"caption": "Hello, world!",
"license": 1,
"copyright": "Hello, world!",
"related_files": 1
},
"title": "Meine Datei",
"url": "'//some/image/url'",
"file_name": "some.gif",
"mime_type": "image/gif",
"size": 35,
"image": {
"width": 1,
"height": 1
}
},
"price": {
"range": {
"from": 42,
"to": 84
},
"reduction": true,
"text": "18€ im Vorverkauf, 20€ an der Abendkasse, Schüler und Studenten 10 €, Kinder bis 12 Jahre frei"
},
"recipient_email": "mail@example.com",
"registration_link": "https://example.com/registration/link",
"starts_at": "2017-02-21T15:17:47+00:00",
"tags": [
"Bestattung",
"Landesverein für Innere Mission"
],
"teaser_text": "Für alle abenteuerlustigen Kinder!",
"text_organizers": "Bildungsstelle Nord von Brot fur die Welt",
"ticket_sale": {
"booking_office": true,
"box_office": true,
"community": true
},
"ticket_sale_text": "Bitte melden Sie sich bis sieben Tage vor der jeweiligen Veranstaltung an",
"title": "Slow Tourismus, Reisen zwischen Langsamkeit und Sinnlichkeit",
"vocal_soloists": [
{
"first_name": "Lauter",
"id": "1",
"last_name": "Sänger",
"vocal_range": "Bariton"
}
],
"location_name": "Telemannsaal",
"last_modified": "2017-02-21T15:17:47+00:00",
"date_created": "2017-02-21T15:17:47+00:00"
},
"relationships": {
"address": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
},
"categories": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"chief_organizer": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
},
"host_institution": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
},
"organizers": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"co_organizers": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"participants": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"event_location": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
},
"age_groups": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"target_groups": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
}
},
"meta": {
"can": {
"create": false,
"delete": false,
"edit": false
},
"foreign_context": false
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"first": {
"type": "string"
},
"last": {
"type": "string"
},
"next": {
"type": "string"
},
"prev": {
"type": "string"
}
}
},
"meta": {
"type": "object",
"properties": {
"page_count": {
"type": "number",
"description": "Total number of pages in the result set"
},
"record_count": {
"type": "number",
"description": "Total number of items in the result set"
}
}
},
"data": {
"type": "array"
}
}
}Offertories of the Current User ¶
OffertoriesGET/api/v1/me/offertories
Retrieves the offertories of institutions, the user has functions at.
Example URI
GET https://www.nordkirche.de/api/v1/me/offertories
Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"links": {
"first": "HOST/api/v1/ressource?page%5Bnumber%5D=1",
"last": "HOST/api/v1/ressource?page%5Bnumber%5D=42",
"next": "HOST/api/v1/ressource?page%5Bnumber%5D=3",
"prev": "HOST/api/v1/ressource?page%5Bnumber%5D=1"
},
"meta": {
"page_count": 3,
"record_count": 42
},
"data": [
{
"id": "1",
"type": "offertories",
"links": {
"self": "'https://www.nordkirche.de/api/v1/people/1'"
},
"attributes": {
"name": "Kollektenname",
"head_image": {
"details": {
"description": "Hello, world!",
"alternative": "Hello, world!",
"caption": "Hello, world!",
"license": 1,
"copyright": "Hello, world!",
"related_files": 1
},
"title": "Meine Datei",
"url": "'//some/image/url'",
"file_name": "some.gif",
"mime_type": "image/gif",
"size": 35,
"image": {
"width": 1,
"height": 1
}
},
"images": [
{
"details": {
"description": "Hello, world!",
"alternative": "Hello, world!",
"caption": "Hello, world!",
"license": 1,
"copyright": "Hello, world!",
"related_files": 1
},
"title": "Meine Datei",
"url": "'//some/image/url'",
"file_name": "some.gif",
"mime_type": "image/gif",
"size": 35,
"image": {
"width": 1,
"height": 1
}
}
],
"video": "Hello, world!",
"reason": "test_reason",
"short_description": "Beschreibung",
"url": "http://somewhere",
"prior_profit": 1,
"intercession": "Hello, world!",
"discontinuation": "Hello, world!",
"exemptions": [
{
"file_name": "some.pdf",
"details": {
"description": "Hello, world!",
"alternative": "Hello, world!",
"caption": "Hello, world!",
"license": 1,
"copyright": "Hello, world!",
"related_files": 1
},
"mime_type": "application/pdf",
"size": 291,
"title": "Uploads in Aktion",
"url": "'//some/image/url'"
}
],
"starttime": "Hello, world!",
"endtime": "Hello, world!",
"altruja_usage": "Hello, world!",
"donation_proposal": 0,
"project_account_bic": "LOYDCHGGZCH",
"project_account_holder": "santa",
"project_account_number": "Hello, world!",
"project_account_iban": "DE12500105999648489890",
"project_account_usage": "Hello, world!",
"project_bank_code": "Hello, world!",
"project_bank_name": "elf_bank",
"last_modified": "2017-02-21T15:17:47+00:00",
"date_created": "2017-02-21T15:17:47+00:00",
"localization": 0,
"priority": 0
},
"relationships": {
"categories": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"institution": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
},
"person": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
}
},
"meta": {
"can": {
"create": false,
"delete": false,
"edit": false
},
"foreign_context": false
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"first": {
"type": "string"
},
"last": {
"type": "string"
},
"next": {
"type": "string"
},
"prev": {
"type": "string"
}
}
},
"meta": {
"type": "object",
"properties": {
"page_count": {
"type": "number",
"description": "Total number of pages in the result set"
},
"record_count": {
"type": "number",
"description": "Total number of items in the result set"
}
}
},
"data": {
"type": "array"
}
}
}Modifyable people of the Current User ¶
PeopleGET/api/v1/me/people
Retrieves the people of institutions, the user has functions at.
Example URI
GET https://www.nordkirche.de/api/v1/me/people
Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"links": {
"first": "HOST/api/v1/ressource?page%5Bnumber%5D=1",
"last": "HOST/api/v1/ressource?page%5Bnumber%5D=42",
"next": "HOST/api/v1/ressource?page%5Bnumber%5D=3",
"prev": "HOST/api/v1/ressource?page%5Bnumber%5D=1"
},
"meta": {
"page_count": 3,
"record_count": 42
},
"data": [
{
"id": "1",
"type": "people",
"links": {
"self": "'https://www.nordkirche.de/api/v1/people/1'"
},
"attributes": {
"birthday_at": "2017-02-21T15:17:47+00:00",
"contact_items": [
{
"id": "1337",
"type": "Telefon",
"value": "12345678"
}
],
"job": "Hello, world!",
"name": {
"clerical_title": "Pastor",
"first": "Vorname",
"formatted": "Pastor Prof. Dr. Vorname Nachname",
"last": "Nachname",
"salutation": "Herr Pastor Vorname Nachname",
"standard_opening": "Sehr geehrter Herr Pastor Nachname",
"title": "Prof. Dr."
},
"sex": "male",
"status": "active",
"do_not_display": false,
"last_modified": "2017-02-21T15:17:47+00:00",
"date_created": "2017-02-21T15:17:47+00:00",
"picture": {
"details": {
"description": "Hello, world!",
"alternative": "Hello, world!",
"caption": "Hello, world!",
"license": 1,
"copyright": "Hello, world!",
"related_files": 1
},
"title": "Meine Datei",
"url": "'//some/image/url'",
"file_name": "some.gif",
"mime_type": "image/gif",
"size": 35,
"image": {
"width": 1,
"height": 1
}
}
},
"relationships": {
"functions": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"data_administrators": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": [
{
"id": "1",
"type": "relationshipType"
}
]
},
"address": {
"links": {
"self": "url/to/self",
"related": "url/to/relationship"
},
"data": {
"id": "1",
"type": "relationshipType"
}
}
},
"meta": {
"can": {
"create": false,
"delete": false,
"edit": false
},
"foreign_context": false
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"first": {
"type": "string"
},
"last": {
"type": "string"
},
"next": {
"type": "string"
},
"prev": {
"type": "string"
}
}
},
"meta": {
"type": "object",
"properties": {
"page_count": {
"type": "number",
"description": "Total number of pages in the result set"
},
"record_count": {
"type": "number",
"description": "Total number of items in the result set"
}
}
},
"data": {
"type": "array"
}
}
}