{"swagger":"2.0","info":{"description":"This Swagger API console provides an overview of the Europeana Search & Record API. You can build and test anything from the simplest search to a complex query using facetList such as dates, geotags and permissions. For more help and information, head to our comprehensive online documentation.","version":"version unknown","title":"Europeana Search & Record API","termsOfService":"https://www.europeana.eu/en/rights/api-terms-of-use","contact":{"name":"https://pro.europeana.eu/page/intro#general"},"license":{"name":"API terms of use","url":"https://www.europeana.eu/en/rights/api-terms-of-use"}},"host":"api.europeana.eu","basePath":"/","tags":[{"name":"Record"},{"name":"Search"}],"paths":{"/record/v2/opensearch.rss":{"get":{"tags":["Search"],"summary":"basic search function following the OpenSearch specification","operationId":"openSearch","produces":["application/xml","application/rss+xml","application/xhtml+xml"],"parameters":[{"name":"count","in":"query","description":"count","required":false,"type":"integer","default":12,"format":"int32"},{"name":"searchTerms","in":"query","description":"searchTerms","required":true,"type":"string"},{"name":"startIndex","in":"query","description":"startIndex","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ModelAndView"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/record/v2/search.json":{"get":{"tags":["Search"],"summary":"search for records","operationId":"searchRecords","produces":["application/json"],"parameters":[{"name":"boost","in":"query","description":"boost","required":false,"type":"string"},{"name":"callback","in":"query","description":"callback","required":false,"type":"string"},{"name":"colourpalette","in":"query","description":"colourpalette","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"cursor","in":"query","description":"cursor","required":false,"type":"string"},{"name":"facet","in":"query","description":"facet","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"hit.fl","in":"query","description":"hit.fl","required":false,"type":"string"},{"name":"hit.selectors","in":"query","description":"hit.selectors","required":false,"type":"string"},{"name":"landingpage","in":"query","description":"landingpage","required":false,"type":"boolean"},{"name":"lang","in":"query","description":"lang","required":false,"type":"string"},{"name":"media","in":"query","description":"media","required":false,"type":"boolean"},{"name":"profile","in":"query","description":"profile","required":false,"type":"string","default":"standard"},{"name":"q.source","in":"query","description":"q.source","required":false,"type":"string"},{"name":"q.target","in":"query","description":"q.target","required":false,"type":"string"},{"name":"qf","in":"query","description":"qf","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"query","in":"query","description":"query","required":true,"type":"string"},{"name":"reusability","in":"query","description":"reusability","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"rows","in":"query","description":"rows","required":false,"type":"integer","default":12,"format":"int32"},{"name":"sort","in":"query","description":"sort","required":false,"type":"string"},{"name":"start","in":"query","description":"start","required":false,"type":"integer","default":1,"format":"int32"},{"name":"text_fulltext","in":"query","description":"text_fulltext","required":false,"type":"boolean"},{"name":"theme","in":"query","description":"theme","required":false,"type":"string"},{"name":"thumbnail","in":"query","description":"thumbnail","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ModelAndView"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false},"post":{"tags":["Search"],"summary":"search for records post","operationId":"searchRecordsPost","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"searchRequest","description":"searchRequest","required":true,"schema":{"$ref":"#/definitions/SearchRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ModelAndView"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/record/v2/{collectionId}/{recordId}.json":{"get":{"tags":["Record"],"summary":"get a single record in JSON format","operationId":"getSingleRecordJson","produces":["application/json;charset=UTF-8"],"parameters":[{"name":"callback","in":"query","description":"callback","required":false,"type":"string"},{"name":"collectionId","in":"path","description":"collectionId","required":true,"type":"string"},{"name":"lang","in":"query","description":"lang","required":false,"type":"string"},{"name":"profile","in":"query","description":"profile","required":false,"type":"string","default":"standard"},{"name":"recordId","in":"path","description":"recordId","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ModelAndView"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/record/v2/{collectionId}/{recordId}.jsonld":{"get":{"tags":["Record"],"summary":"get single record in JSON LD format","operationId":"getSingleRecordJsonLD","produces":["application/json;charset=UTF-8","application/ld+json;charset=UTF-8"],"parameters":[{"name":"callback","in":"query","description":"callback","required":false,"type":"string"},{"name":"collectionId","in":"path","description":"collectionId","required":true,"type":"string"},{"name":"lang","in":"query","description":"lang","required":false,"type":"string"},{"name":"profile","in":"query","description":"profile","required":false,"type":"string","default":"standard"},{"name":"recordId","in":"path","description":"recordId","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ModelAndView"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/record/v2/{collectionId}/{recordId}.rdf":{"get":{"tags":["Record"],"summary":"get single record in RDF format)","operationId":"getSingleRecordRDF","produces":["application/rdf+xml;charset=UTF-8"],"parameters":[{"name":"collectionId","in":"path","description":"collectionId","required":true,"type":"string"},{"name":"lang","in":"query","description":"lang","required":false,"type":"string"},{"name":"profile","in":"query","description":"profile","required":false,"type":"string","default":"standard"},{"name":"recordId","in":"path","description":"recordId","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ModelAndView"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/record/v2/{collectionId}/{recordId}.schema.jsonld":{"get":{"tags":["Record"],"summary":"get single record in Schema.org JSON LD format","operationId":"getSingleRecordSchemaOrg","produces":["application/json;charset=UTF-8","application/ld+json;charset=UTF-8"],"parameters":[{"name":"callback","in":"query","description":"callback","required":false,"type":"string"},{"name":"collectionId","in":"path","description":"collectionId","required":true,"type":"string"},{"name":"lang","in":"query","description":"lang","required":false,"type":"string"},{"name":"profile","in":"query","description":"profile","required":false,"type":"string","default":"standard"},{"name":"recordId","in":"path","description":"recordId","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ModelAndView"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/record/v2/{collectionId}/{recordId}.ttl":{"get":{"tags":["Record"],"summary":"get single record in turtle format)","operationId":"getSingleRecordTurtle","produces":["application/x-turtle","text/turtle","application/turtle"],"parameters":[{"name":"collectionId","in":"path","description":"collectionId","required":true,"type":"string"},{"name":"lang","in":"query","description":"lang","required":false,"type":"string"},{"name":"profile","in":"query","description":"profile","required":false,"type":"string","default":"standard"},{"name":"recordId","in":"path","description":"recordId","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ModelAndView"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}}},"definitions":{"Hit":{"type":"object","properties":{"fl":{"type":"string"},"selectors":{"type":"string"}},"title":"Hit"},"ModelAndView":{"type":"object","properties":{"empty":{"type":"boolean"},"model":{"type":"object"},"modelMap":{"type":"object","additionalProperties":{"type":"object"}},"reference":{"type":"boolean"},"status":{"type":"string","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]},"view":{"$ref":"#/definitions/View"},"viewName":{"type":"string"}},"title":"ModelAndView"},"SearchRequest":{"type":"object","required":["query"],"properties":{"boost":{"type":"string"},"callback":{"type":"string"},"colourPalette":{"type":"array","items":{"type":"string"}},"cursor":{"type":"string"},"facet":{"type":"array","items":{"type":"string"}},"hit":{"$ref":"#/definitions/Hit"},"landingPage":{"type":"boolean"},"media":{"type":"boolean"},"profile":{"type":"array","items":{"type":"string"}},"qf":{"type":"array","items":{"type":"string"}},"query":{"type":"string"},"reusability":{"type":"array","items":{"type":"string"}},"rows":{"type":"integer","format":"int32"},"sort":{"type":"array","items":{"type":"string"}},"start":{"type":"integer","format":"int32"},"textFulltext":{"type":"boolean"},"theme":{"type":"string"},"thumbnail":{"type":"boolean"}},"title":"SearchRequest"},"View":{"type":"object","properties":{"contentType":{"type":"string"}},"title":"View"}}}