{"definitions":{},"info":{"title":"","version":"4.0.0"},"paths":{"/api/applications":{"post":{"description":"Create an application [Authenticated, not public]","parameters":[{"description":"
Go to 'DASHBOARD' and 'Settings' to find your API key. If there is no key, click 'Generate a new API key'. If you do not see that button, contact us.","in":"query","name":"api_key","required":true,"type":"string"},{"description":"
\n Application JSON that you would like to create or update. The contents should comply with the schema displayed in the\n GET (Retrieve) an application route.\n Explicit documentation for the structure of this data is available.\n Partial updates are not allowed; you have to supply the full JSON.
","in":"body","name":"application_json","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Resource created successfully, response contains the new resource ID and location.","schema":{"properties":{"id":{"type":"string"},"location":{"type":"string"},"status":{"type":"string"}}}},"400":{"description":"Bad Request. Your request body was missing a required field, or the data in one of the fields did not match the schema above (e.g. string of latin letters in an integer field). In the Bulk API it may mean that one of the records in the bulk operation failed. See the \"error\" part of the response for details.","schema":{"properties":{"error":{"type":"string"},"status":{"type":"string"}}}},"401":{"description":"Access to this route/resource requires authentication, but you did not provide any credentials.","schema":{"properties":{"error":{"type":"string"},"status":{"type":"string"}}}},"409":{"description":"This resource or one it depends on is currently locked for editing by another user, and you may not submit changes to it at this time","schema":{"properties":{"error":{"type":"string"},"status":{"type":"string"}}}}},"summary":"Create an application [Authenticated, not public]","tags":["CRUD Applications"]}},"/api/applications/{application_id}":{"delete":{"description":"Delete an application [Authenticated, not public]","parameters":[{"description":"
Go to 'DASHBOARD' and 'Settings' to find your API key. If there is no key, click 'Generate a new API key'. If you do not see that button, contact us.","in":"query","name":"api_key","required":true,"type":"string"},{"description":"
DOAJ application ID. E.g. 4cf8b72139a749c88d043129f00e1b07 .
","in":"path","name":"application_id","required":true,"type":"string"}],"responses":{"204":{"description":"OK (Request succeeded), No Content"},"401":{"description":"Access to this route/resource requires authentication, but you did not provide any credentials.","schema":{"properties":{"error":{"type":"string"},"status":{"type":"string"}}}},"403":{"description":"Access to this route/resource requires authentication, and you provided the wrong credentials. This includes situations where you are authenticated successfully via your API key, but you are not the owner of a specific resource and are therefore barred from updating/deleting it.","schema":{"properties":{"error":{"type":"string"},"status":{"type":"string"}}}},"404":{"description":"Resource not found","schema":{"properties":{"error":{"type":"string"},"status":{"type":"string"}}}},"409":{"description":"This resource or one it depends on is currently locked for editing by another user, and you may not submit changes to it at this time","schema":{"properties":{"error":{"type":"string"},"status":{"type":"string"}}}}},"summary":"Delete an application [Authenticated, not public]","tags":["CRUD Applications"]},"get":{"description":"Retrieve an application [Authenticated, not public]","parameters":[{"description":"
Go to 'DASHBOARD' and 'Settings' to find your API key. If there is no key, click 'Generate a new API key'. If you do not see that button, contact us.","in":"query","name":"api_key","required":true,"type":"string"},{"description":"
DOAJ application ID. E.g. 4cf8b72139a749c88d043129f00e1b07 .
","in":"path","name":"application_id","required":true,"type":"string"}],"responses":{"200":{"description":"A successful request/response","schema":{"properties":{"admin":{"properties":{"application_status":{"type":"string"},"current_journal":{"type":"string"},"date_applied":{"type":"string"},"owner":{"type":"string"}},"title":"admin","type":"object"},"bibjson":{"properties":{"alternative_title":{"type":"string"},"apc":{"properties":{"has_apc":{"type":"boolean"},"max":{"items":{"properties":{"currency":{"type":"string"},"price":{"type":"integer"}},"title":"bibjson.apc.max","type":"object"},"type":"array"},"url":{"format":"url","type":"string"}},"title":"bibjson.apc","type":"object"},"article":{"properties":{"i4oc_open_citations":{"type":"boolean"},"license_display":{"items":{"type":"string"},"type":"array"},"license_display_example_url":{"format":"url","type":"string"},"orcid":{"type":"boolean"}},"title":"bibjson.article","type":"object"},"boai":{"type":"boolean"},"copyright":{"properties":{"author_retains":{"type":"boolean"},"url":{"format":"url","type":"string"}},"required":["url"],"title":"bibjson.copyright","type":"object"},"deposit_policy":{"properties":{"has_policy":{"type":"boolean"},"is_registered":{"type":"boolean"},"service":{"items":{"type":"string"},"type":"array"},"url":{"format":"url","type":"string"}},"title":"bibjson.deposit_policy","type":"object"},"discontinued_date":{"type":"string"},"editorial":{"properties":{"board_url":{"format":"url","type":"string"},"review_process":{"items":{"type":"string"},"type":"array"},"review_url":{"format":"url","type":"string"}},"required":["review_process","review_url"],"title":"bibjson.editorial","type":"object"},"eissn":{"type":"string"},"institution":{"properties":{"country":{"format":"country_code","type":"string"},"name":{"type":"string"}},"title":"bibjson.institution","type":"object"},"is_replaced_by":{"items":{"type":"string"},"type":"array"},"keywords":{"items":{"type":"string"},"type":"array"},"language":{"items":{"type":"string"},"type":"array"},"license":{"items":{"properties":{"BY":{"type":"boolean"},"NC":{"type":"boolean"},"ND":{"type":"boolean"},"SA":{"type":"boolean"},"type":{"type":"string"},"url":{"format":"url","type":"string"}},"title":"bibjson.license","type":"object"},"type":"array"},"oa_start":{"type":"integer"},"other_charges":{"properties":{"has_other_charges":{"type":"boolean"},"url":{"format":"url","type":"string"}},"title":"bibjson.other_charges","type":"object"},"pid_scheme":{"properties":{"has_pid_scheme":{"type":"boolean"},"scheme":{"items":{"type":"string"},"type":"array"}},"title":"bibjson.pid_scheme","type":"object"},"pissn":{"type":"string"},"plagiarism":{"properties":{"detection":{"type":"boolean"},"url":{"format":"url","type":"string"}},"required":["detection","url"],"title":"bibjson.plagiarism","type":"object"},"preservation":{"properties":{"has_preservation":{"type":"boolean"},"national_library":{"items":{"type":"string"},"type":"array"},"service":{"items":{"type":"string"},"type":"array"},"url":{"format":"url","type":"string"}},"title":"bibjson.preservation","type":"object"},"publication_time_weeks":{"type":"integer"},"publisher":{"properties":{"country":{"format":"country_code","type":"string"},"name":{"type":"string"}},"required":["name"],"title":"bibjson.publisher","type":"object"},"ref":{"properties":{"aims_scope":{"format":"url","type":"string"},"author_instructions":{"format":"url","type":"string"},"journal":{"format":"url","type":"string"},"license_terms":{"format":"url","type":"string"},"oa_statement":{"format":"url","type":"string"}},"required":["journal"],"title":"bibjson.ref","type":"object"},"replaces":{"items":{"type":"string"},"type":"array"},"subject":{"items":{"properties":{"code":{"type":"string"},"scheme":{"type":"string"},"term":{"type":"string"}},"title":"bibjson.subject","type":"object"},"type":"array"},"title":{"type":"string"},"waiver":{"properties":{"has_waiver":{"type":"boolean"},"url":{"format":"url","type":"string"}},"title":"bibjson.waiver","type":"object"}},"required":["copyright","deposit_policy","editorial","eissn","keywords","language","license","ref","pid_scheme","pissn","plagiarism","preservation","publication_time_weeks","publisher","oa_start","other_charges","waiver","title"],"title":"bibjson","type":"object"},"created_date":{"format":"date-time","type":"string"},"id":{"type":"string"},"last_manual_update":{"format":"date-time","type":"string"},"last_updated":{"format":"date-time","type":"string"}},"required":["admin","bibjson"],"title":"Application schema"}},"401":{"description":"Access to this route/resource requires authentication, but you did not provide any credentials.","schema":{"properties":{"error":{"type":"string"},"status":{"type":"string"}}}},"404":{"description":"Resource not found","schema":{"properties":{"error":{"type":"string"},"status":{"type":"string"}}}}},"summary":"Retrieve an application [Authenticated, not public]","tags":["CRUD Applications"]},"put":{"description":"Update an application [Authenticated, not public]","parameters":[{"description":"
Go to 'DASHBOARD' and 'Settings' to find your API key. If there is no key, click 'Generate a new API key'. If you do not see that button, contact us.","in":"query","name":"api_key","required":true,"type":"string"},{"description":"
DOAJ application ID. E.g. 4cf8b72139a749c88d043129f00e1b07 .
","in":"path","name":"application_id","required":true,"type":"string"},{"description":"
\n Application JSON that you would like to create or update. The contents should comply with the schema displayed in the\n GET (Retrieve) an application route.\n Explicit documentation for the structure of this data is available.\n Partial updates are not allowed; you have to supply the full JSON.
","in":"body","name":"application_json","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"OK (Request succeeded), No Content"},"400":{"description":"Bad Request. Your request body was missing a required field, or the data in one of the fields did not match the schema above (e.g. string of latin letters in an integer field). In the Bulk API it may mean that one of the records in the bulk operation failed. See the \"error\" part of the response for details.","schema":{"properties":{"error":{"type":"string"},"status":{"type":"string"}}}},"401":{"description":"Access to this route/resource requires authentication, but you did not provide any credentials.","schema":{"properties":{"error":{"type":"string"},"status":{"type":"string"}}}},"403":{"description":"Access to this route/resource requires authentication, and you provided the wrong credentials. This includes situations where you are authenticated successfully via your API key, but you are not the owner of a specific resource and are therefore barred from updating/deleting it.","schema":{"properties":{"error":{"type":"string"},"status":{"type":"string"}}}},"404":{"description":"Resource not found","schema":{"properties":{"error":{"type":"string"},"status":{"type":"string"}}}},"409":{"description":"This resource or one it depends on is currently locked for editing by another user, and you may not submit changes to it at this time","schema":{"properties":{"error":{"type":"string"},"status":{"type":"string"}}}}},"summary":"Update an application [Authenticated, not public]","tags":["CRUD Applications"]}},"/api/articles":{"post":{"description":"Create an article [Authenticated, not public]","parameters":[{"description":"
Go to 'DASHBOARD' and 'Settings' to find your API key. If there is no key, click 'Generate a new API key'. If you do not see that button, contact us.","in":"query","name":"api_key","required":true,"type":"string"},{"description":"
\n Article JSON that you would like to create or update. The contents should comply with the schema displayed\n in the GET (Retrieve) an article route.\n Explicit documentation for the structure of this data is available.\n Partial updates are not allowed; you have to supply the full JSON.
","in":"body","name":"article_json","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Resource created successfully, response contains the new resource ID and location.","schema":{"properties":{"id":{"type":"string"},"location":{"type":"string"},"status":{"type":"string"}}}},"400":{"description":"Bad Request. Your request body was missing a required field, or the data in one of the fields did not match the schema above (e.g. string of latin letters in an integer field). In the Bulk API it may mean that one of the records in the bulk operation failed. See the \"error\" part of the response for details.","schema":{"properties":{"error":{"type":"string"},"status":{"type":"string"}}}},"401":{"description":"Access to this route/resource requires authentication, but you did not provide any credentials.","schema":{"properties":{"error":{"type":"string"},"status":{"type":"string"}}}},"403":{"description":"Access to this route/resource requires authentication, and you provided the wrong credentials. This includes situations where you are authenticated successfully via your API key, but you are not the owner of a specific resource and are therefore barred from updating/deleting it.","schema":{"properties":{"error":{"type":"string"},"status":{"type":"string"}}}}},"summary":"Create an article [Authenticated, not public]","tags":["CRUD Articles"]}},"/api/articles/{article_id}":{"delete":{"description":"Delete an article [Authenticated, not public]","parameters":[{"description":"
Go to 'DASHBOARD' and 'Settings' to find your API key. If there is no key, click 'Generate a new API key'. If you do not see that button, contact us.","in":"query","name":"api_key","required":true,"type":"string"},{"description":"
DOAJ article ID. E.g. 4cf8b72139a749c88d043129f00e1b07 .
","in":"path","name":"article_id","required":true,"type":"string"}],"responses":{"204":{"description":"OK (Request succeeded), No Content"},"401":{"description":"Access to this route/resource requires authentication, but you did not provide any credentials.","schema":{"properties":{"error":{"type":"string"},"status":{"type":"string"}}}},"403":{"description":"Access to this route/resource requires authentication, and you provided the wrong credentials. This includes situations where you are authenticated successfully via your API key, but you are not the owner of a specific resource and are therefore barred from updating/deleting it.","schema":{"properties":{"error":{"type":"string"},"status":{"type":"string"}}}},"404":{"description":"Resource not found","schema":{"properties":{"error":{"type":"string"},"status":{"type":"string"}}}}},"summary":"Delete an article [Authenticated, not public]","tags":["CRUD Articles"]},"get":{"description":"Retrieve an article","parameters":[{"description":"
Note this parameter is optional for this route - you could, but don't have to supply a key. Doing so grants you access to records of yours that are not public, in addition to all public records. Go to 'MY ACCOUNT' and 'Settings' to find your API key. If there is no key, click 'Generate a new API key'. If you do not see that button, contact us.","in":"query","name":"api_key","required":false,"type":"string"},{"description":"
DOAJ article ID. E.g. 4cf8b72139a749c88d043129f00e1b07 .
","in":"path","name":"article_id","required":true,"type":"string"}],"responses":{"200":{"description":"A successful request/response","schema":{"properties":{"admin":{"properties":{"in_doaj":{"type":"boolean"},"publisher_record_id":{"type":"string"},"seal":{"type":"boolean"},"upload_id":{"type":"string"}},"title":"admin","type":"object"},"bibjson":{"properties":{"abstract":{"type":"string"},"author":{"items":{"properties":{"affiliation":{"type":"string"},"name":{"type":"string"},"orcid_id":{"type":"string"}},"required":["name"],"title":"bibjson.author","type":"object"},"type":"array"},"identifier":{"items":{"properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["type","id"],"title":"bibjson.identifier","type":"object"},"type":"array"},"journal":{"properties":{"country":{"type":"string"},"end_page":{"type":"string"},"language":{"items":{"type":"string"},"type":"array"},"number":{"type":"string"},"publisher":{"type":"string"},"start_page":{"type":"string"},"title":{"type":"string"},"volume":{"type":"string"}},"title":"bibjson.journal","type":"object"},"keywords":{"items":{"type":"string"},"type":"array"},"link":{"items":{"properties":{"content_type":{"format":"link_content_type","type":"string"},"type":{"format":"link_type","type":"string"},"url":{"format":"url","type":"string"}},"required":["type","url"],"title":"bibjson.link","type":"object"},"type":"array"},"month":{"type":"string"},"subject":{"items":{"properties":{"code":{"type":"string"},"scheme":{"type":"string"},"term":{"type":"string"}},"title":"bibjson.subject","type":"object"},"type":"array"},"title":{"type":"string"},"year":{"type":"string"}},"required":["title","identifier"],"title":"bibjson","type":"object"},"created_date":{"format":"date-time","type":"string"},"es_type":{"type":"string"},"id":{"type":"string"},"last_updated":{"format":"date-time","type":"string"}},"required":["bibjson"],"title":"Article schema"}},"401":{"description":"Access to this route/resource requires authentication, but you did not provide any credentials.","schema":{"properties":{"error":{"type":"string"},"status":{"type":"string"}}}},"404":{"description":"Resource not found","schema":{"properties":{"error":{"type":"string"},"status":{"type":"string"}}}},"500":{"description":"Unable to retrieve the recource. This record contains bad data","schema":{"properties":{"error":{"type":"string"},"status":{"type":"string"}}}}},"summary":"Retrieve an article","tags":["CRUD Articles"]},"put":{"description":"Update an article [Authenticated, not public]","parameters":[{"description":"
Go to 'DASHBOARD' and 'Settings' to find your API key. If there is no key, click 'Generate a new API key'. If you do not see that button, contact us.","in":"query","name":"api_key","required":true,"type":"string"},{"description":"
DOAJ article ID. E.g. 4cf8b72139a749c88d043129f00e1b07 .
","in":"path","name":"article_id","required":true,"type":"string"},{"description":"
\n Article JSON that you would like to create or update. The contents should comply with the schema displayed\n in the GET (Retrieve) an article route.\n Explicit documentation for the structure of this data is available.\n Partial updates are not allowed; you have to supply the full JSON.
","in":"body","name":"article_json","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"OK (Request succeeded), No Content"},"400":{"description":"Bad Request. Your request body was missing a required field, or the data in one of the fields did not match the schema above (e.g. string of latin letters in an integer field). In the Bulk API it may mean that one of the records in the bulk operation failed. See the \"error\" part of the response for details.","schema":{"properties":{"error":{"type":"string"},"status":{"type":"string"}}}},"401":{"description":"Access to this route/resource requires authentication, but you did not provide any credentials.","schema":{"properties":{"error":{"type":"string"},"status":{"type":"string"}}}},"404":{"description":"Resource not found","schema":{"properties":{"error":{"type":"string"},"status":{"type":"string"}}}}},"summary":"Update an article [Authenticated, not public]","tags":["CRUD Articles"]}},"/api/bulk/applications":{"delete":{"description":"Delete applications in bulk [Authenticated, not public]","parameters":[{"description":"
Go to 'DASHBOARD' and 'Settings' to find your API key. If there is no key, click 'Generate a new API key'. If you do not see that button, contact us.","in":"query","name":"api_key","required":true,"type":"string"},{"description":"
List of DOAJ application IDs to be deleted. You must own all the IDs, and none of them should have entered the DOAJ workflow yet. Otherwise, processing will stop. e.g. [4cf8b72139a749c88d043129f00e1b07, 8e896b60-35f1-4cd3-b3f9-07f7f29d8a98].
","in":"body","name":"application_ids","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"OK (Request succeeded), No Content"},"400":{"description":"Bad Request. Your request body was missing a required field, or the data in one of the fields did not match the schema above (e.g. string of latin letters in an integer field). In the Bulk API it may mean that one of the records in the bulk operation failed. See the \"error\" part of the response for details.","schema":{"properties":{"error":{"type":"string"},"status":{"type":"string"}}}}},"summary":"Delete applications in bulk [Authenticated, not public]","tags":["Bulk API"]},"post":{"description":"Create applications in bulk [Authenticated, not public]","parameters":[{"description":"
Go to 'DASHBOARD' and 'Settings' to find your API key. If there is no key, click 'Generate a new API key'. If you do not see that button, contact us.","in":"query","name":"api_key","required":true,"type":"string"},{"description":"
List of Application JSON objects that you would like to create. Each element of the list should comply with the schema displayed in the GET (Retrieve) an application route.
","in":"body","name":"application_json","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Resources created successfully, response contains the new resource IDs and locations.","schema":{"items":{"properties":{"id":{"type":"string"},"location":{"type":"string"},"status":{"type":"string"}},"type":"object"},"type":"array"}},"400":{"description":"Bad Request. Your request body was missing a required field, or the data in one of the fields did not match the schema above (e.g. string of latin letters in an integer field). In the Bulk API it may mean that one of the records in the bulk operation failed. See the \"error\" part of the response for details.","schema":{"properties":{"error":{"type":"string"},"status":{"type":"string"}}}}},"summary":"Create applications in bulk [Authenticated, not public]","tags":["Bulk API"]}},"/api/bulk/articles":{"delete":{"description":"Bulk article delete [Authenticated, not public]","parameters":[{"description":"
A list/array of DOAJ article IDs. E.g. [\"4cf8b72139a749c88d043129f00e1b07\", \"232b53726fb74cc4a8eb4717e5a43193\"].
","in":"body","name":"article_ids","required":true,"schema":{"type":"string"}},{"description":"
Go to 'DASHBOARD' and 'Settings' to find your API key. If there is no key, click 'Generate a new API key'. If you do not see that button, contact us.","in":"query","name":"api_key","required":true,"type":"string"}],"responses":{"204":{"description":"OK (Request succeeded), No Content"},"400":{"description":"Bad Request. Your request body was missing a required field, or the data in one of the fields did not match the schema above (e.g. string of latin letters in an integer field). In the Bulk API it may mean that one of the records in the bulk operation failed. See the \"error\" part of the response for details.","schema":{"properties":{"error":{"type":"string"},"status":{"type":"string"}}}},"401":{"description":"Access to this route/resource requires authentication, but you did not provide any credentials.","schema":{"properties":{"error":{"type":"string"},"status":{"type":"string"}}}}},"summary":"Bulk article delete [Authenticated, not public]","tags":["Bulk API"]},"post":{"description":"Bulk article creation (asynchronous) [Authenticated, not public]","parameters":[{"description":"

A list/array of article JSON objects that you would like to create or update. The contents should be a list, and each object in the list should comply with the schema displayed in the GET (Retrieve) an article route. Partial updates are not allowed; you have to supply the full JSON.

This request is asynchronous; the response will contain an upload_id. You can use this id to query the task status.

","in":"body","name":"article_json","required":true,"schema":{"type":"string"}},{"description":"
Go to 'DASHBOARD' and 'Settings' to find your API key. If there is no key, click 'Generate a new API key'. If you do not see that button, contact us.","in":"query","name":"api_key","required":true,"type":"string"}],"responses":{"202":{"description":"Resources are being created asynchronously; response contains the task IDs ","schema":{"properties":{"msg":{"type":"string"},"status":{"description":"Link to the status URL for the task","type":"string"},"upload_id":{"description":"The upload id of the task, User can use this ID to check the bulk upload status.","type":"string"}},"type":"object"}},"400":{"description":"Bad Request. Your request body was missing a required field, or the data in one of the fields did not match the schema above (e.g. string of latin letters in an integer field). In the Bulk API it may mean that one of the records in the bulk operation failed. See the \"error\" part of the response for details.","schema":{"properties":{"error":{"type":"string"},"status":{"type":"string"}}}}},"summary":"Bulk article creation (asynchronous) [Authenticated, not public]","tags":["Bulk API"]}},"/api/bulk/articles/{upload_id}":{"get":{"description":"Get bulk article creation status [Authenticated, not public]","parameters":[{"description":"
The upload id of the task, User can use this id to check the bulk upload status.
","in":"path","name":"upload_id","required":true,"type":"string"},{"description":"
Go to 'DASHBOARD' and 'Settings' to find your API key. If there is no key, click 'Generate a new API key'. If you do not see that button, contact us.","in":"query","name":"api_key","required":true,"type":"string"}],"responses":{"200":{"description":"Return status of upload ids","schema":{"properties":{"id":{"description":"The status of the task","type":"string"},"results":{"description":"The result of the upload","properties":{"failed":{"description":"The number of articles failed to import","type":"integer"},"imported":{"description":"The number of articles imported","type":"integer"},"new":{"description":"The number of articles created","type":"integer"},"update":{"description":"The number of articles updated","type":"integer"}},"type":"object"},"status":{"description":"The status of the task","enum":["pending","validated","failed","processed","processed_partial"],"type":"string"}},"type":"object"}},"400":{"description":"Fail get status reason","schema":{"properties":{"msg":{"description":"The error message","type":"string"}},"type":"object"}}},"summary":"Get bulk article creation status [Authenticated, not public]","tags":["Bulk API"]}},"/api/journals/{journal_id}":{"get":{"description":"Retrieve a journal by ID","parameters":[{"description":"
DOAJ journal ID. E.g. 4cf8b72139a749c88d043129f00e1b07 .
","in":"path","name":"journal_id","required":true,"type":"string"}],"responses":{"200":{"description":"Detailed documentation on the response format is available. ","schema":{"properties":{"admin":{"properties":{"in_doaj":{"type":"boolean"},"seal":{"type":"boolean"},"ticked":{"type":"boolean"}},"title":"admin","type":"object"},"bibjson":{"properties":{},"title":"bibjson","type":"object"},"created_date":{"format":"date-time","type":"string"},"es_type":{"type":"string"},"id":{"type":"string"},"last_manual_update":{"format":"date-time","type":"string"},"last_updated":{"format":"date-time","type":"string"}},"title":"Journal schema"}},"404":{"description":"Resource not found","schema":{"properties":{"error":{"type":"string"},"status":{"type":"string"}}}}},"summary":"Retrieve a journal by ID","tags":["CRUD Journals"]}},"/api/search/applications/{search_query}":{"get":{"description":"Search your applications [Authenticated, not public]","parameters":[{"description":"
Go to 'DASHBOARD' and 'Settings' to find your API key. If there is no key, click 'Generate a new API key'. If you do not see that button, contact us.","in":"query","name":"api_key","required":true,"type":"string"},{"description":"
What you are searching for, e.g. computers.

You can search in any field in the results or schema. More details
For example, to search for all journals tagged with the keyword \"heritage\" 
bibjson.keywords:heritage
Short-hand names are available for some fields 
issn:2212-4276
publisher:sciendo
","in":"path","name":"search_query","required":true,"type":"string"},{"description":"Which page of the results you wish to see","in":"query","name":"page","required":false,"type":"integer"},{"description":"How many results per page you wish to see; the default is 10 The page size limit is 100","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"
Substitutions are also available here for convenience
  • title - order by the normalised, unpunctuated version of the title
  • issn - sort by issn
For example 
title:asc
issn:desc
","in":"query","name":"sort","required":false,"type":"string"}],"responses":{"200":{"description":"Search was successful","schema":{"properties":{"page":{"type":"integer"},"pageSize":{"type":"integer"},"query":{"type":"string"},"results":{"items":{"properties":{"bibjson":{"properties":{"alternative_title":{"type":"string"},"apc":{"properties":{"currency":{"type":"string"},"max_price":{"type":"string"}},"title":"apc","type":"object"},"apc_url":{"type":"string"},"author_pays":{"type":"string"},"author_pays_url":{"type":"string"},"copyright":{"properties":{"author_retains":{"type":"string"},"url":{"type":"string"}},"title":"copyright","type":"object"},"country":{"type":"string"},"deposit_policy":{"items":{"properties":{"service":{"items":{"title":"service","type":"string"},"type":"array"},"url":{"type":"string"}},"title":"deposit_policy","type":"object"},"type":"array"},"editorial_review":{"properties":{"process":{"type":"string"},"url":{"type":"string"}},"title":"editorial_review","type":"object"},"identifier":{"items":{"properties":{"id":{"type":"string"},"type":{"type":"string"}},"title":"identifier","type":"object"},"type":"array"},"institution":{"type":"string"},"keywords":{"items":{"type":"string"},"type":"array"},"license":{"items":{"properties":{"BY":{"type":"boolean"},"NC":{"type":"boolean"},"ND":{"type":"boolean"},"SA":{"type":"boolean"},"embedded":{"type":"string"},"embedded_example_url":{"type":"string"},"open_access":{"type":"string"},"type":{"type":"string"},"url":{"type":"string"}},"title":"license","type":"object"},"type":"array"},"link":{"items":{"properties":{"type":{"type":"string"},"url":{"type":"string"}},"title":"link","type":"object"},"type":"array"},"other_charges_url":{"type":"string"},"pid_scheme":{"items":{"type":"string"},"type":"array"},"plagiarism_detection":{"properties":{"detection":{"type":"boolean"},"url":{"type":"string"}},"title":"plagiarism_detection","type":"object"},"preservation":{"properties":{"services":{"items":{"type":"string"},"type":"array"},"url":{"type":"string"}},"title":"preservation","type":"object"},"publication_time_weeks":{"type":"string"},"publisher":{"type":"string"},"subject":{"items":{"properties":{"code":{"type":"string"},"scheme":{"type":"string"},"term":{"type":"string"}},"title":"subject","type":"object"},"type":"array"},"title":{"type":"string"}},"title":"bibjson","type":"object"},"created_date":{"format":"dateTime","type":"string"},"id":{"type":"string"},"last_updated":{"format":"dateTime","type":"string"}},"title":"Journal","type":"object"},"type":"array"},"timestamp":{"format":"dateTime","type":"string"},"total":{"type":"integer"}},"title":"Journal search"}},"400":{"description":"Bad Request"}},"summary":"Search your applications [Authenticated, not public]","tags":["Search"]}},"/api/search/articles/{search_query}":{"get":{"description":"Search articles","parameters":[{"description":"
What you are searching for, e.g. computers

You can search inside any field you see in the results or the schema. More details
For example, to search for all articles with abstracts containing the word \"shadow\" 
bibjson.abstract:\"shadow\"
Short-hand names are available for some fields 
doi:10.3389/fpsyg.2013.00479
issn:1874-9496
license:CC-BY
title:hydrostatic pressure
","in":"path","name":"search_query","required":true,"type":"string"},{"description":"Which page of the results you want to see.","in":"query","name":"page","required":false,"type":"integer"},{"description":"How many results per page you want to see. The default is 10. The page size limit is 100","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"
Substitutions are also available here for convenience
  • title - order by the normalised, unpunctuated version of the title
For example 
title:asc
","in":"query","name":"sort","required":false,"type":"string"}],"responses":{"200":{"description":"Search was successful","schema":{"properties":{"page":{"type":"integer"},"pageSize":{"type":"integer"},"query":{"type":"string"},"results":{"items":{"properties":{"bibjson":{"properties":{"abstract":{"type":"string"},"author":{"items":{"properties":{"affiliation":{"type":"string"},"email":{"type":"string"},"name":{"type":"string"},"orcid_id":{"type":"string"}},"title":"author","type":"object"},"type":"array"},"end_page":{"type":"string"},"identifier":{"items":{"properties":{"id":{"type":"string"},"type":{"type":"string"}},"title":"identifier","type":"object"},"type":"array"},"journal":{"properties":{"country":{"type":"string"},"language":{"items":{"type":"string"},"type":"array"},"number":{"type":"string"},"publisher":{"type":"string"},"title":{"type":"string"},"volume":{"type":"string"}},"title":"journal","type":"object"},"keywords":{"items":{"type":"string"},"type":"array"},"link":{"items":{"properties":{"content_type":{"type":"string"},"type":{"type":"string"},"url":{"type":"string"}},"title":"link","type":"object"},"type":"array"},"month":{"type":"string"},"start_page":{"type":"integer"},"subject":{"items":{"properties":{"code":{"type":"string"},"scheme":{"type":"string"},"term":{"type":"string"}},"title":"subject","type":"object"},"type":"array"},"title":{"type":"string"},"year":{"type":"string"}},"title":"bibjson","type":"object"},"created_date":{"format":"dateTime","type":"string"},"id":{"type":"string"},"last_updated":{"format":"dateTime","type":"string"}},"title":"Article","type":"object"},"type":"array"},"timestamp":{"format":"dateTime","type":"string"},"total":{"type":"integer"}},"title":"Article search"}},"400":{"description":"Bad Request"}},"summary":"Search articles","tags":["Search"]}},"/api/search/journals/{search_query}":{"get":{"description":"Search journals","parameters":[{"description":"
What you are searching for, e.g. computers

You can search inside any field you see in the results or the schema. More details
For example, to search for all journals tagged with the keyword \"heritage\" 
bibjson.keywords:heritage
Short-hand names are available for some fields 
issn:1874-9496
publisher:dove
","in":"path","name":"search_query","required":true,"type":"string"},{"description":"Which page of the results you want to see.","in":"query","name":"page","required":false,"type":"integer"},{"description":"How many results per page you want to see. The default is 10. The page size limit is 100","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"
Substitutions are also available here for convenience
  • title - order by the normalised, unpunctuated version of the title
  • issn - sort by issn
For example 
title:asc
issn:desc
","in":"query","name":"sort","required":false,"type":"string"}],"responses":{"200":{"description":"Search was successful","schema":{"properties":{"page":{"type":"integer"},"pageSize":{"type":"integer"},"query":{"type":"string"},"results":{"items":{"properties":{"bibjson":{"properties":{"alternative_title":{"type":"string"},"apc":{"properties":{"currency":{"type":"string"},"max_price":{"type":"string"}},"title":"apc","type":"object"},"apc_url":{"type":"string"},"author_pays":{"type":"string"},"author_pays_url":{"type":"string"},"copyright":{"properties":{"author_retains":{"type":"string"},"url":{"type":"string"}},"title":"copyright","type":"object"},"country":{"type":"string"},"deposit_policy":{"items":{"properties":{"service":{"items":{"title":"service","type":"string"},"type":"array"},"url":{"type":"string"}},"title":"deposit_policy","type":"object"},"type":"array"},"editorial_review":{"properties":{"process":{"type":"string"},"url":{"type":"string"}},"title":"editorial_review","type":"object"},"identifier":{"items":{"properties":{"id":{"type":"string"},"type":{"type":"string"}},"title":"identifier","type":"object"},"type":"array"},"institution":{"type":"string"},"keywords":{"items":{"type":"string"},"type":"array"},"license":{"items":{"properties":{"BY":{"type":"boolean"},"NC":{"type":"boolean"},"ND":{"type":"boolean"},"SA":{"type":"boolean"},"embedded":{"type":"string"},"embedded_example_url":{"type":"string"},"open_access":{"type":"string"},"type":{"type":"string"},"url":{"type":"string"}},"title":"license","type":"object"},"type":"array"},"link":{"items":{"properties":{"type":{"type":"string"},"url":{"type":"string"}},"title":"link","type":"object"},"type":"array"},"other_charges_url":{"type":"string"},"pid_scheme":{"items":{"type":"string"},"type":"array"},"plagiarism_detection":{"properties":{"detection":{"type":"boolean"},"url":{"type":"string"}},"title":"plagiarism_detection","type":"object"},"preservation":{"properties":{"services":{"items":{"type":"string"},"type":"array"},"url":{"type":"string"}},"title":"preservation","type":"object"},"publication_time_weeks":{"type":"string"},"publisher":{"type":"string"},"subject":{"items":{"properties":{"code":{"type":"string"},"scheme":{"type":"string"},"term":{"type":"string"}},"title":"subject","type":"object"},"type":"array"},"title":{"type":"string"}},"title":"bibjson","type":"object"},"created_date":{"format":"date-time","type":"string"},"id":{"type":"string"},"last_updated":{"format":"date-time","type":"string"}},"title":"Journal","type":"object"},"type":"array"},"timestamp":{"format":"date-time","type":"string"},"total":{"type":"integer"}},"title":"Journal search"}},"400":{"description":"Bad Request"}},"summary":"Search journals","tags":["Search"]}}},"swagger":"2.0"}