{"openapi":"3.0.2","info":{"title":"EventSearch API","description":"\n## Intro\nThis API gives access to events from various digital edition projects made available in the TEI-XML format. The data is read with Scrapy and temporarily stored in a database and then output via this interface.\n\n## Requests\nThe data can be queried with GET requests to the different endpoints and specified more precisely using query parameters. There are three categories of requests: 1. requests to events, 2.requests to related entities of events (labels, persons, places) and 3. search queries. \n\n## Responses\nEach response contains three parts:\n - `data`: an area with the results of the query\n - `links`: an area with relevant URLs such as the query URL (`self`) and URLs for pagination of the response (` first`, `last`,` next`, `previous`), in case `data` is a list of results.\n - `meta`: an area where the query with its parameters is broken down exactly (`query`), the time to answer the query (` execution_time`) and the number of results for the query (`total_number`). \n\n## Examples\n<https://edition.onb.ac.at/eventsearch/events> returns a list of all events in the system. The first event can be queried via <https://edition.onb.ac.at/eventsearch/events/1> and associated entities (e.g. labels) can be queried via <https://edition.onb.ac.at/eventsearch/events/1/labels>.\n\n<https://edition.onb.ac.at/eventsearch/labels> contains a list of all labels. All events associated to this label can be retrieved via the `/events` endpoint e.g. <https://edition.onb.ac.at/eventsearch/labels/1/events> \n\nA simple search can be done via the `/search` endpoint using the `q` query parameter. It returns a list of events, labels, persons or places which match the keyword. E.g. <https://edition.onb.ac.at/eventsearch/search?q=wien>\n\n### Contact\n","termsOfService":"https://edition.onb.ac.at/o:ode.EventSearchInfo","contact":{"name":"Austrian National Library","url":"https://www.onb.ac.at","email":"edition@onb.ac.at"},"version":"1.0.0"},"servers":[{"url":"/eventsearch"}],"paths":{"/events":{"get":{"tags":["events"],"summary":"List Events","operationId":"list_events_events_get","parameters":[{"description":"Returns only events on the given day. Date format must be in ISO 8601 (eg. 1950-07-01).","required":false,"schema":{"title":"Event date","type":"string","description":"Returns only events on the given day. Date format must be in ISO 8601 (eg. 1950-07-01).","format":"date"},"name":"when","in":"query"},{"description":"Returns only events on or after the given day. Date format must be in ISO 8601 (eg. 1950-07-01).","required":false,"schema":{"title":"Lower date limit","type":"string","description":"Returns only events on or after the given day. Date format must be in ISO 8601 (eg. 1950-07-01).","format":"date"},"name":"from","in":"query"},{"description":"Returns only events before the given day. Date format must be in ISO 8601 (eg. 1950-07-01).","required":false,"schema":{"title":"Upper date limit","type":"string","description":"Returns only events before the given day. Date format must be in ISO 8601 (eg. 1950-07-01).","format":"date"},"name":"to","in":"query"},{"description":"Number of elements to be contained in a single response. Further results can be retrieved using pagination via the query-parameter 'offset'.","required":false,"schema":{"title":"Number of results","maximum":100.0,"minimum":1.0,"type":"integer","description":"Number of elements to be contained in a single response. Further results can be retrieved using pagination via the query-parameter 'offset'.","default":10},"name":"count","in":"query"},{"description":"Skip certain number of results for pagination.","required":false,"schema":{"title":"Starting index for results","minimum":0.0,"type":"integer","description":"Skip certain number of results for pagination.","default":0},"name":"offset","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/events/{uid}":{"get":{"tags":["events"],"summary":"Show Event","operationId":"show_event_events__uid__get","parameters":[{"description":"ID of the event","required":true,"schema":{"title":"Event ID","minimum":1.0,"type":"integer","description":"ID of the event"},"name":"uid","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SingleItemResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/events/{uid}/labels":{"get":{"tags":["events"],"summary":"List Event Labels","operationId":"list_event_labels_events__uid__labels_get","parameters":[{"description":"ID of the event","required":true,"schema":{"title":"Event ID","minimum":1.0,"type":"integer","description":"ID of the event"},"name":"uid","in":"path"},{"description":"Number of elements to be contained in a single response. Further results can be retrieved using pagination via the query-parameter 'offset'.","required":false,"schema":{"title":"Number of results","maximum":100.0,"minimum":1.0,"type":"integer","description":"Number of elements to be contained in a single response. Further results can be retrieved using pagination via the query-parameter 'offset'.","default":10},"name":"count","in":"query"},{"description":"Skip certain number of results for pagination.","required":false,"schema":{"title":"Starting index for results","minimum":0.0,"type":"integer","description":"Skip certain number of results for pagination.","default":0},"name":"offset","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/events/{uid}/persons":{"get":{"tags":["events"],"summary":"List Event Persons","operationId":"list_event_persons_events__uid__persons_get","parameters":[{"description":"ID of the event","required":true,"schema":{"title":"Event ID","minimum":1.0,"type":"integer","description":"ID of the event"},"name":"uid","in":"path"},{"description":"Number of elements to be contained in a single response. Further results can be retrieved using pagination via the query-parameter 'offset'.","required":false,"schema":{"title":"Number of results","maximum":100.0,"minimum":1.0,"type":"integer","description":"Number of elements to be contained in a single response. Further results can be retrieved using pagination via the query-parameter 'offset'.","default":10},"name":"count","in":"query"},{"description":"Skip certain number of results for pagination.","required":false,"schema":{"title":"Starting index for results","minimum":0.0,"type":"integer","description":"Skip certain number of results for pagination.","default":0},"name":"offset","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/events/{uid}/places":{"get":{"tags":["events"],"summary":"List Event Places","operationId":"list_event_places_events__uid__places_get","parameters":[{"description":"ID of the event","required":true,"schema":{"title":"Event ID","minimum":1.0,"type":"integer","description":"ID of the event"},"name":"uid","in":"path"},{"description":"Number of elements to be contained in a single response. Further results can be retrieved using pagination via the query-parameter 'offset'.","required":false,"schema":{"title":"Number of results","maximum":100.0,"minimum":1.0,"type":"integer","description":"Number of elements to be contained in a single response. Further results can be retrieved using pagination via the query-parameter 'offset'.","default":10},"name":"count","in":"query"},{"description":"Skip certain number of results for pagination.","required":false,"schema":{"title":"Starting index for results","minimum":0.0,"type":"integer","description":"Skip certain number of results for pagination.","default":0},"name":"offset","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/labels":{"get":{"tags":["labels"],"summary":"List Labels","operationId":"list_labels_labels_get","parameters":[{"description":"Number of elements to be contained in a single response. Further results can be retrieved using pagination via the query-parameter 'offset'.","required":false,"schema":{"title":"Number of results","maximum":100.0,"minimum":1.0,"type":"integer","description":"Number of elements to be contained in a single response. Further results can be retrieved using pagination via the query-parameter 'offset'.","default":10},"name":"count","in":"query"},{"description":"Skip certain number of results for pagination.","required":false,"schema":{"title":"Starting index for results","minimum":0.0,"type":"integer","description":"Skip certain number of results for pagination.","default":0},"name":"offset","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/labels/{uid}":{"get":{"tags":["labels"],"summary":"Show Label","operationId":"show_label_labels__uid__get","parameters":[{"description":"ID of the label","required":true,"schema":{"title":"Label ID","minimum":1.0,"type":"integer","description":"ID of the label"},"name":"uid","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SingleItemResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/labels/{uid}/events":{"get":{"tags":["labels"],"summary":"List Label Events","operationId":"list_label_events_labels__uid__events_get","parameters":[{"description":"ID of the label","required":true,"schema":{"title":"Label ID","minimum":1.0,"type":"integer","description":"ID of the label"},"name":"uid","in":"path"},{"description":"Number of elements to be contained in a single response. Further results can be retrieved using pagination via the query-parameter 'offset'.","required":false,"schema":{"title":"Number of results","maximum":100.0,"minimum":1.0,"type":"integer","description":"Number of elements to be contained in a single response. Further results can be retrieved using pagination via the query-parameter 'offset'.","default":10},"name":"count","in":"query"},{"description":"Skip certain number of results for pagination.","required":false,"schema":{"title":"Starting index for results","minimum":0.0,"type":"integer","description":"Skip certain number of results for pagination.","default":0},"name":"offset","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/persons":{"get":{"tags":["persons"],"summary":"List Labels","operationId":"list_labels_persons_get","parameters":[{"description":"Number of elements to be contained in a single response. Further results can be retrieved using pagination via the query-parameter 'offset'.","required":false,"schema":{"title":"Number of results","maximum":100.0,"minimum":1.0,"type":"integer","description":"Number of elements to be contained in a single response. Further results can be retrieved using pagination via the query-parameter 'offset'.","default":10},"name":"count","in":"query"},{"description":"Skip certain number of results for pagination.","required":false,"schema":{"title":"Starting index for results","minimum":0.0,"type":"integer","description":"Skip certain number of results for pagination.","default":0},"name":"offset","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/persons/{uid}":{"get":{"tags":["persons"],"summary":"Show Label","operationId":"show_label_persons__uid__get","parameters":[{"description":"ID of the person","required":true,"schema":{"title":"Person ID","minimum":1.0,"type":"integer","description":"ID of the person"},"name":"uid","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SingleItemResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/persons/{uid}/events":{"get":{"tags":["persons"],"summary":"List Label Events","operationId":"list_label_events_persons__uid__events_get","parameters":[{"description":"ID of the person","required":true,"schema":{"title":"Person ID","minimum":1.0,"type":"integer","description":"ID of the person"},"name":"uid","in":"path"},{"description":"Number of elements to be contained in a single response. Further results can be retrieved using pagination via the query-parameter 'offset'.","required":false,"schema":{"title":"Number of results","maximum":100.0,"minimum":1.0,"type":"integer","description":"Number of elements to be contained in a single response. Further results can be retrieved using pagination via the query-parameter 'offset'.","default":10},"name":"count","in":"query"},{"description":"Skip certain number of results for pagination.","required":false,"schema":{"title":"Starting index for results","minimum":0.0,"type":"integer","description":"Skip certain number of results for pagination.","default":0},"name":"offset","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/places":{"get":{"tags":["places"],"summary":"List Labels","operationId":"list_labels_places_get","parameters":[{"description":"Number of elements to be contained in a single response. Further results can be retrieved using pagination via the query-parameter 'offset'.","required":false,"schema":{"title":"Number of results","maximum":100.0,"minimum":1.0,"type":"integer","description":"Number of elements to be contained in a single response. Further results can be retrieved using pagination via the query-parameter 'offset'.","default":10},"name":"count","in":"query"},{"description":"Skip certain number of results for pagination.","required":false,"schema":{"title":"Starting index for results","minimum":0.0,"type":"integer","description":"Skip certain number of results for pagination.","default":0},"name":"offset","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/places/{uid}":{"get":{"tags":["places"],"summary":"Show Label","operationId":"show_label_places__uid__get","parameters":[{"description":"ID of the place","required":true,"schema":{"title":"Place ID","minimum":1.0,"type":"integer","description":"ID of the place"},"name":"uid","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SingleItemResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/places/{uid}/events":{"get":{"tags":["places"],"summary":"List Label Events","operationId":"list_label_events_places__uid__events_get","parameters":[{"description":"ID of the place","required":true,"schema":{"title":"Place ID","minimum":1.0,"type":"integer","description":"ID of the place"},"name":"uid","in":"path"},{"description":"Number of elements to be contained in a single response. Further results can be retrieved using pagination via the query-parameter 'offset'.","required":false,"schema":{"title":"Number of results","maximum":100.0,"minimum":1.0,"type":"integer","description":"Number of elements to be contained in a single response. Further results can be retrieved using pagination via the query-parameter 'offset'.","default":10},"name":"count","in":"query"},{"description":"Skip certain number of results for pagination.","required":false,"schema":{"title":"Starting index for results","minimum":0.0,"type":"integer","description":"Skip certain number of results for pagination.","default":0},"name":"offset","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/search":{"get":{"tags":["search"],"summary":"Search Entities","operationId":"search_entities_search_get","parameters":[{"description":"Search for query string in entities.","required":true,"schema":{"title":"Query string","type":"string","description":"Search for query string in entities."},"example":"Wien","name":"q","in":"query"},{"description":"Mark which entity types should be shown in the result. If no 'type' parameter is given all entity types will be returned.","required":false,"schema":{"title":"Entity types","type":"array","items":{"$ref":"#/components/schemas/EntityTypes"},"description":"Mark which entity types should be shown in the result. If no 'type' parameter is given all entity types will be returned."},"name":"types","in":"query"},{"description":"Number of elements to be contained in a single response. Further results can be retrieved using pagination via the query-parameter 'offset'.","required":false,"schema":{"title":"Number of results","maximum":100.0,"minimum":1.0,"type":"integer","description":"Number of elements to be contained in a single response. Further results can be retrieved using pagination via the query-parameter 'offset'.","default":10},"name":"count","in":"query"},{"description":"Skip certain number of results for pagination.","required":false,"schema":{"title":"Starting index for results","minimum":0.0,"type":"integer","description":"Skip certain number of results for pagination.","default":0},"name":"offset","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"EntityTypes":{"title":"EntityTypes","enum":["events","labels","persons","places"],"type":"string","description":"An enumeration."},"Event":{"title":"Event","required":["ID","created_at","modified_at","source","head"],"type":"object","properties":{"ID":{"title":"Id","type":"integer"},"created_at":{"title":"Created At","type":"string","format":"date-time"},"modified_at":{"title":"Modified At","type":"string","format":"date-time"},"type":{"title":"Type","type":"string","default":"event"},"source":{"title":"Source","type":"string"},"head":{"title":"Head","type":"string"},"attribute__xml_id":{"title":"Attribute  Xml Id","type":"string"},"attribute__from":{"title":"Attribute  From","type":"string"},"attribute__to":{"title":"Attribute  To","type":"string"},"attribute__when":{"title":"Attribute  When","type":"string"},"attribute__notBefore":{"title":"Attribute  Notbefore","type":"string"},"attribute__notAfter":{"title":"Attribute  Notafter","type":"string"},"attribute__calendar":{"title":"Attribute  Calendar","type":"string"},"attribute__source":{"title":"Attribute  Source","type":"string"},"from_date":{"title":"From Date","type":"string","format":"date-time"},"to_date":{"title":"To Date","type":"string","format":"date-time"},"labels":{"title":"Labels","type":"array","items":{"$ref":"#/components/schemas/Label"},"default":[]},"persons":{"title":"Persons","type":"array","items":{"$ref":"#/components/schemas/Person"},"default":[]},"places":{"title":"Places","type":"array","items":{"$ref":"#/components/schemas/Place"},"default":[]}}},"HTTPValidationError":{"title":"HTTPValidationError","type":"object","properties":{"detail":{"title":"Detail","type":"array","items":{"$ref":"#/components/schemas/ValidationError"}}}},"Label":{"title":"Label","required":["ID","created_at","modified_at","designation"],"type":"object","properties":{"ID":{"title":"Id","type":"integer"},"created_at":{"title":"Created At","type":"string","format":"date-time"},"modified_at":{"title":"Modified At","type":"string","format":"date-time"},"type":{"title":"Type","type":"string","default":"label"},"designation":{"title":"Designation","type":"string"}}},"ListResponse":{"title":"ListResponse","required":["data"],"type":"object","properties":{"meta":{"title":"Meta","type":"object","default":{}},"links":{"title":"Links","type":"object","default":{}},"data":{"title":"Data","anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/Event"}},{"type":"array","items":{"$ref":"#/components/schemas/Label"}},{"type":"array","items":{"$ref":"#/components/schemas/Person"}},{"type":"array","items":{"$ref":"#/components/schemas/Place"}},{"type":"array","items":{"$ref":"#/components/schemas/SearchResult"}}]}}},"Person":{"title":"Person","required":["ID","created_at","modified_at","name"],"type":"object","properties":{"ID":{"title":"Id","type":"integer"},"created_at":{"title":"Created At","type":"string","format":"date-time"},"modified_at":{"title":"Modified At","type":"string","format":"date-time"},"type":{"title":"Type","type":"string","default":"person"},"name":{"title":"Name","type":"string"}}},"Place":{"title":"Place","required":["ID","created_at","modified_at","name"],"type":"object","properties":{"ID":{"title":"Id","type":"integer"},"created_at":{"title":"Created At","type":"string","format":"date-time"},"modified_at":{"title":"Modified At","type":"string","format":"date-time"},"type":{"title":"Type","type":"string","default":"place"},"name":{"title":"Name","type":"string"}}},"SearchResult":{"title":"SearchResult","required":["ID","created_at","modified_at"],"type":"object","properties":{"ID":{"title":"Id","type":"integer"},"created_at":{"title":"Created At","type":"string","format":"date-time"},"modified_at":{"title":"Modified At","type":"string","format":"date-time"},"type":{"title":"Type","type":"string"},"name":{"title":"Name","type":"string"},"designation":{"title":"Designation","type":"string"},"head":{"title":"Head","type":"string"},"tag__reg":{"title":"Tag  Reg","type":"string"}}},"SingleItemResponse":{"title":"SingleItemResponse","required":["data"],"type":"object","properties":{"meta":{"title":"Meta","type":"object","default":{}},"links":{"title":"Links","type":"object","default":{}},"data":{"title":"Data","anyOf":[{"$ref":"#/components/schemas/Event"},{"$ref":"#/components/schemas/Label"},{"$ref":"#/components/schemas/Person"},{"$ref":"#/components/schemas/Place"}]}}},"ValidationError":{"title":"ValidationError","required":["loc","msg","type"],"type":"object","properties":{"loc":{"title":"Location","type":"array","items":{"type":"string"}},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}}}}},"tags":[{"name":"events","description":"Operations with events the main entity type of this API."},{"name":"labels","description":"Operations with labels which can be associated to events."},{"name":"persons","description":"Operations with persons which can be associated to events."},{"name":"places","description":"Operations with places which can be associated to events."},{"name":"search","description":"Provides a simple search option for events, labels, persons and places"}]}