diff --git a/dev/api/ojs/3.4.html b/dev/api/ojs/3.4.html index bb6b741c4f9c..7a59933be74c 100644 --- a/dev/api/ojs/3.4.html +++ b/dev/api/ojs/3.4.html @@ -2202,7 +2202,7 @@ -
PKP Developer Docs
API docs by Redocly
PKP Developer Docs
API docs by Redocly
://example.com/index.php/journalpath/api/v1/submissions

Administrators can access some endpoints, such as /contexts, at a site-wide endpoint that spans all journals.

-
https://example.com/index/api/v1/contexts
+
https://example.com/_/api/v1/contexts

Authentication

Only authenticated users can access the REST API endpoints. Authentication can be done with cookies or by using the API token.

Cookies

Cookie-based authentication can be used when you are making a request from the same domain name as the application. When a request is made from the user's browser, the browser will send the cookies to the server.

-

A CSRF token must be sent with every POST, PUT or DELETE request when using cookie-based authentication. Read more about the CSRF Token.

+

A CSRF token must be sent with every POST, PUT or DELETE request when using cookie-based authentication. Read more about the CSRF Token.

API Token

The apiToken will not validate if the api_secret_key setting has not been set in the application's config.inc.php file.

Your API token can be found by going to User Profile > API Key in the application. Add the API Token in an Authorization header with every request made to the API.

Authorization: Bearer eyJ0e...6vJU
+

Connection Issues

In some Apache configurations, the Authorization Header may be stripped. Additional server configuration may be necessary for Apache to pass the Authorization header to PHP.

Pagination

Most API endpoints follow the same convention to return subsequent pages of results. The following would return the second "page" of results, if each page contained 30 results.

https://example.com/api/v1/submissions?count=30offset=30
@@ -2325,14 +2326,14 @@
status
Array of integers
Items Enum: 1 3 4 5

Filter results by one or more submission statuses. Must match the value of one of the PKPSubmission::STATUS_QUEUED, PKPSubmission::STATUS_SCHEDULED, PKPSubmission::STATUS_PUBLISHED or PKPSubmission::STATUS_DECLINED constants.

Responses

Response samples

Content type
application/json
{
  • "itemsMax": 0,
  • "items": [
    ]
}

Create a new submission.

Request Body schema: application/json

Details about the submission that should be created.

+

Response samples

Content type
application/json
{
  • "itemsMax": 0,
  • "items": [
    ]
}

Create a new submission.

Request Body schema: application/json

Details about the submission that should be created.

commentsForTheEditors
string

Optional. Comments from the submitting author to the editors. This is only available for submissions that have not yet been submitted. Once submitted, the message is converted to a discussion and you can not read or write to this property.

locale
string

The primary language of this submission.

sectionId
integer

The section this submission should be assigned to. This can only be passed when creating a new submission and the data is assigned to the first publication. After the submission is created, edit the publication to change the sectionId.

userGroupId
integer

Optional. The submitting user will be assigned to the submission in the user group under which they submit. Leave this empty to have the user automatically assigned as an author, when an author user group allows self-registration. Changing this property will have no effect after a submission is submitted.

Responses

Request samples

Content type
application/json
{
  • "commentsForTheEditors": "string",
  • "locale": "string",
  • "sectionId": 0,
  • "userGroupId": 0
}

Response samples

Content type
application/json
{
  • "_href": "string",
  • "commentsForTheEditors": "string",
  • "contextId": 0,
  • "currentPublicationId": 0,
  • "dateLastActivity": "string",
  • "dateSubmitted": "string",
  • "id": 0,
  • "lastModified": "string",
  • "locale": "string",
  • "publications": [
    ],
  • "reviewAssignments": [
    ],
  • "reviewRounds": [
    ],
  • "stageId": 1,
  • "stages": [
    ],
  • "status": 1,
  • "statusLabel": "string",
  • "submissionProgress": "",
  • "urlAuthorWorkflow": "string",
  • "urlEditorialWorkflow": "string",
  • "urlPublished": "string",
  • "urlSubmissionWizard": "string",
  • "urlWorkflow": "string"
}

Get a submission by ID.

    +

Request samples

Content type
application/json
{
  • "commentsForTheEditors": "string",
  • "locale": "string",
  • "sectionId": 0,
  • "userGroupId": 0
}

Response samples

Content type
application/json
{
  • "_href": "string",
  • "commentsForTheEditors": "string",
  • "contextId": 0,
  • "currentPublicationId": 0,
  • "dateLastActivity": "string",
  • "dateSubmitted": "string",
  • "id": 0,
  • "lastModified": "string",
  • "locale": "string",
  • "publications": [
    ],
  • "reviewAssignments": [
    ],
  • "reviewRounds": [
    ],
  • "stageId": 1,
  • "stages": [
    ],
  • "status": 1,
  • "statusLabel": "string",
  • "submissionProgress": "",
  • "urlAuthorWorkflow": "string",
  • "urlEditorialWorkflow": "string",
  • "urlPublished": "string",
  • "urlSubmissionWizard": "string",
  • "urlWorkflow": "string"
}

Get a submission by ID.

  • Unpublished submissions are only returned for assigned participants, editors and admins.
  • abstract includes HTML markup.
  • pages is usually a string. But in some cases it may return an array of arrays. Each array contains two items: the start and end page. Example: [[25, 31], [45, 62]].
    • @@ -2344,7 +2345,7 @@

Responses

Response samples

Content type
application/json
{
  • "_href": "string",
  • "commentsForTheEditors": "string",
  • "contextId": 0,
  • "currentPublicationId": 0,
  • "dateLastActivity": "string",
  • "dateSubmitted": "string",
  • "id": 0,
  • "lastModified": "string",
  • "locale": "string",
  • "publications": [
    ],
  • "reviewAssignments": [
    ],
  • "reviewRounds": [
    ],
  • "stageId": 1,
  • "stages": [
    ],
  • "status": 1,
  • "statusLabel": "string",
  • "submissionProgress": "",
  • "urlAuthorWorkflow": "string",
  • "urlEditorialWorkflow": "string",
  • "urlPublished": "string",
  • "urlSubmissionWizard": "string",
  • "urlWorkflow": "string"
}

Edit a submission.

path Parameters
submissionId
required
integer

Submission ID

+

Response samples

Content type
application/json
{
  • "_href": "string",
  • "commentsForTheEditors": "string",
  • "contextId": 0,
  • "currentPublicationId": 0,
  • "dateLastActivity": "string",
  • "dateSubmitted": "string",
  • "id": 0,
  • "lastModified": "string",
  • "locale": "string",
  • "publications": [
    ],
  • "reviewAssignments": [
    ],
  • "reviewRounds": [
    ],
  • "stageId": 1,
  • "stages": [
    ],
  • "status": 1,
  • "statusLabel": "string",
  • "submissionProgress": "",
  • "urlAuthorWorkflow": "string",
  • "urlEditorialWorkflow": "string",
  • "urlPublished": "string",
  • "urlSubmissionWizard": "string",
  • "urlWorkflow": "string"
}

Edit a submission.

path Parameters
submissionId
required
integer

Submission ID

Request Body schema: application/json

The details about the submission that you want to edit. All params are optional. When a param is omitted, the existing value of that param will not be modified.

commentsForTheEditors
string

Optional. Comments from the submitting author to the editors. This is only available for submissions that have not yet been submitted. Once submitted, the message is converted to a discussion and you can not read or write to this property.

locale
string

The primary language of this submission.

@@ -2354,19 +2355,19 @@

Request samples

Content type
application/json
{
  • "commentsForTheEditors": "string",
  • "locale": "string",
  • "sectionId": 0,
  • "userGroupId": 0
}

Response samples

Content type
application/json
{
  • "_href": "string",
  • "commentsForTheEditors": "string",
  • "contextId": 0,
  • "currentPublicationId": 0,
  • "dateLastActivity": "string",
  • "dateSubmitted": "string",
  • "id": 0,
  • "lastModified": "string",
  • "locale": "string",
  • "publications": [
    ],
  • "reviewAssignments": [
    ],
  • "reviewRounds": [
    ],
  • "stageId": 1,
  • "stages": [
    ],
  • "status": 1,
  • "statusLabel": "string",
  • "submissionProgress": "",
  • "urlAuthorWorkflow": "string",
  • "urlEditorialWorkflow": "string",
  • "urlPublished": "string",
  • "urlSubmissionWizard": "string",
  • "urlWorkflow": "string"
}

Delete a submission.

Only journal managers and subeditors can make a request to this endpoint.

+

Request samples

Content type
application/json
{
  • "commentsForTheEditors": "string",
  • "locale": "string",
  • "sectionId": 0,
  • "userGroupId": 0
}

Response samples

Content type
application/json
{
  • "_href": "string",
  • "commentsForTheEditors": "string",
  • "contextId": 0,
  • "currentPublicationId": 0,
  • "dateLastActivity": "string",
  • "dateSubmitted": "string",
  • "id": 0,
  • "lastModified": "string",
  • "locale": "string",
  • "publications": [
    ],
  • "reviewAssignments": [
    ],
  • "reviewRounds": [
    ],
  • "stageId": 1,
  • "stages": [
    ],
  • "status": 1,
  • "statusLabel": "string",
  • "submissionProgress": "",
  • "urlAuthorWorkflow": "string",
  • "urlEditorialWorkflow": "string",
  • "urlPublished": "string",
  • "urlSubmissionWizard": "string",
  • "urlWorkflow": "string"
}

Delete a submission.

Only journal managers and subeditors can make a request to this endpoint.

path Parameters
submissionId
required
integer

Submission ID

Responses

Response samples

Content type
application/json
{
  • "_href": "string",
  • "commentsForTheEditors": "string",
  • "contextId": 0,
  • "currentPublicationId": 0,
  • "dateLastActivity": "string",
  • "dateSubmitted": "string",
  • "id": 0,
  • "lastModified": "string",
  • "locale": "string",
  • "publications": [
    ],
  • "reviewAssignments": [
    ],
  • "reviewRounds": [
    ],
  • "stageId": 1,
  • "stages": [
    ],
  • "status": 1,
  • "statusLabel": "string",
  • "submissionProgress": "",
  • "urlAuthorWorkflow": "string",
  • "urlEditorialWorkflow": "string",
  • "urlPublished": "string",
  • "urlSubmissionWizard": "string",
  • "urlWorkflow": "string"
}

Save a submission for later

Sets the current step of the submission in the submission wizard and sends an email to the submitting author with a link to resume their submission. This API endpoint does not save any data about the submission. Use the regular PUT endpoints to save data for submissions, publications, files, and authors.

+

Response samples

Content type
application/json
{
  • "_href": "string",
  • "commentsForTheEditors": "string",
  • "contextId": 0,
  • "currentPublicationId": 0,
  • "dateLastActivity": "string",
  • "dateSubmitted": "string",
  • "id": 0,
  • "lastModified": "string",
  • "locale": "string",
  • "publications": [
    ],
  • "reviewAssignments": [
    ],
  • "reviewRounds": [
    ],
  • "stageId": 1,
  • "stages": [
    ],
  • "status": 1,
  • "statusLabel": "string",
  • "submissionProgress": "",
  • "urlAuthorWorkflow": "string",
  • "urlEditorialWorkflow": "string",
  • "urlPublished": "string",
  • "urlSubmissionWizard": "string",
  • "urlWorkflow": "string"
}

Save a submission for later

Sets the current step of the submission in the submission wizard and sends an email to the submitting author with a link to resume their submission. This API endpoint does not save any data about the submission. Use the regular PUT endpoints to save data for submissions, publications, files, and authors.

path Parameters
submissionId
required
integer

Submission ID

Request Body schema: application/json
step
string
Enum: "details" "files" "contributors" "editors" "review"

The step of the submission wizard to open when the author resumes their submission.

Responses

Request samples

Content type
application/json
{
  • "step": "details"
}

Response samples

Content type
application/json
{
  • "_href": "string",
  • "commentsForTheEditors": "string",
  • "contextId": 0,
  • "currentPublicationId": 0,
  • "dateLastActivity": "string",
  • "dateSubmitted": "string",
  • "id": 0,
  • "lastModified": "string",
  • "locale": "string",
  • "publications": [
    ],
  • "reviewAssignments": [
    ],
  • "reviewRounds": [
    ],
  • "stageId": 1,
  • "stages": [
    ],
  • "status": 1,
  • "statusLabel": "string",
  • "submissionProgress": "",
  • "urlAuthorWorkflow": "string",
  • "urlEditorialWorkflow": "string",
  • "urlPublished": "string",
  • "urlSubmissionWizard": "string",
  • "urlWorkflow": "string"
}

Submit a submission

Submits a submission for editorial review. Any automated editorial assignments, comments for the editor, or other submission events will be triggered.

+

Request samples

Content type
application/json
{
  • "step": "details"
}

Response samples

Content type
application/json
{
  • "_href": "string",
  • "commentsForTheEditors": "string",
  • "contextId": 0,
  • "currentPublicationId": 0,
  • "dateLastActivity": "string",
  • "dateSubmitted": "string",
  • "id": 0,
  • "lastModified": "string",
  • "locale": "string",
  • "publications": [
    ],
  • "reviewAssignments": [
    ],
  • "reviewRounds": [
    ],
  • "stageId": 1,
  • "stages": [
    ],
  • "status": 1,
  • "statusLabel": "string",
  • "submissionProgress": "",
  • "urlAuthorWorkflow": "string",
  • "urlEditorialWorkflow": "string",
  • "urlPublished": "string",
  • "urlSubmissionWizard": "string",
  • "urlWorkflow": "string"
}

Submit a submission

Submits a submission for editorial review. Any automated editorial assignments, comments for the editor, or other submission events will be triggered.

path Parameters
submissionId
required
integer

Submission ID

Request Body schema: application/json
_validateOnly
boolean

When true, the validation checks will be performed but the submission will not be submitted.

confirmCopyright
boolean

Pass true to indicate that the author has agreed to the copyright notice. An entry will be added to the submission's activity log to record the author's acceptance of the copyright agreement.

@@ -2374,7 +2375,7 @@

Request samples

Content type
application/json
{
  • "_validateOnly": true,
  • "confirmCopyright": true
}

Response samples

Content type
application/json
{
  • "_href": "string",
  • "commentsForTheEditors": "string",
  • "contextId": 0,
  • "currentPublicationId": 0,
  • "dateLastActivity": "string",
  • "dateSubmitted": "string",
  • "id": 0,
  • "lastModified": "string",
  • "locale": "string",
  • "publications": [
    ],
  • "reviewAssignments": [
    ],
  • "reviewRounds": [
    ],
  • "stageId": 1,
  • "stages": [
    ],
  • "status": 1,
  • "statusLabel": "string",
  • "submissionProgress": "",
  • "urlAuthorWorkflow": "string",
  • "urlEditorialWorkflow": "string",
  • "urlPublished": "string",
  • "urlSubmissionWizard": "string",
  • "urlWorkflow": "string"
}

Submissions / Decisions

Use these endpoints to get or record editorial decisions on a submission. Editorial decisions include actions like accepting or declining a submission, sending a submission to the next stage, and requesting revisions. Editorial decisions can not be edited or deleted after they are recorded. Learn more about Decisions.

+

Request samples

Content type
application/json
{
  • "_validateOnly": true,
  • "confirmCopyright": true
}

Response samples

Content type
application/json
{
  • "_href": "string",
  • "commentsForTheEditors": "string",
  • "contextId": 0,
  • "currentPublicationId": 0,
  • "dateLastActivity": "string",
  • "dateSubmitted": "string",
  • "id": 0,
  • "lastModified": "string",
  • "locale": "string",
  • "publications": [
    ],
  • "reviewAssignments": [
    ],
  • "reviewRounds": [
    ],
  • "stageId": 1,
  • "stages": [
    ],
  • "status": 1,
  • "statusLabel": "string",
  • "submissionProgress": "",
  • "urlAuthorWorkflow": "string",
  • "urlEditorialWorkflow": "string",
  • "urlPublished": "string",
  • "urlSubmissionWizard": "string",
  • "urlWorkflow": "string"
}

Submissions / Decisions

Use these endpoints to get or record editorial decisions on a submission. Editorial decisions include actions like accepting or declining a submission, sending a submission to the next stage, and requesting revisions. Editorial decisions can not be edited or deleted after they are recorded. Learn more about Decisions.

Get decisions for a submission.

Get the editorial decisions that have been recorded for this submission.

path Parameters
submissionId
required
integer

Submission ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Submissions / Publications

Get a submission's publications.

path Parameters
submissionId
required
integer

Submission ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a publication.

Create a new publication for a submission.

+

Response samples

Content type
application/json
[
  • {
    }
]

Create a publication.

Create a new publication for a submission.

path Parameters
publicationId
required
integer

Publication ID

submissionId
required
integer

Submission ID

Request Body schema: application/json

Details about the publication that should be created.

@@ -2538,11 +2539,11 @@
version
integer

The version number of this publication. Version numbers should increment by one so that the third publication of a submission will have the version number 3. Version numbers should typically be set automatically and editorial staff should not be encouraged to modify them.

Responses

Request samples

Content type
application/json
{
  • "abstract": {
    },
  • "accessStatus": 0,
  • "categoryIds": [
    ],
  • "citationsRaw": "string",
  • "copyrightHolder": {
    },
  • "copyrightYear": 0,
  • "coverImage": {
    },
  • "coverage": {
    },
  • "dataAvailability": {
    },
  • "datePublished": "string",
  • "disciplines": [
    ],
  • "doiId": 0,
  • "hideAuthor": false,
  • "issueId": 0,
  • "keywords": [
    ],
  • "languages": [
    ],
  • "lastModified": "string",
  • "licenseUrl": "string",
  • "pages": "string",
  • "prefix": {
    },
  • "primaryContactId": 0,
  • "pub-id::publisher-id": "string",
  • "rights": {
    },
  • "sectionId": 0,
  • "seq": 0,
  • "source": {
    },
  • "status": 1,
  • "subjects": [
    ],
  • "submissionId": 0,
  • "subtitle": {
    },
  • "supportingAgencies": [
    ],
  • "title": {
    },
  • "type": {
    },
  • "urlPath": "string",
  • "version": 0
}

Response samples

Content type
application/json
{
  • "_href": "http://example.com",
  • "abstract": {
    },
  • "accessStatus": 0,
  • "authors": [
    ],
  • "authorsString": "string",
  • "authorsStringIncludeInBrowse": "string",
  • "authorsStringShort": "string",
  • "categoryIds": [
    ],
  • "citations": [
    ],
  • "citationsRaw": "string",
  • "copyrightHolder": {
    },
  • "copyrightYear": 0,
  • "coverImage": {
    },
  • "coverage": {
    },
  • "dataAvailability": {
    },
  • "datePublished": "string",
  • "disciplines": [
    ],
  • "doiObject": {
    },
  • "fullTitle": {
    },
  • "galleys": [
    ],
  • "hideAuthor": false,
  • "id": 0,
  • "issueId": 0,
  • "keywords": [
    ],
  • "languages": [
    ],
  • "lastModified": "string",
  • "licenseUrl": "string",
  • "locale": "string",
  • "pages": "string",
  • "prefix": {
    },
  • "primaryContactId": 0,
  • "pub-id::publisher-id": "string",
  • "rights": {
    },
  • "sectionId": 0,
  • "seq": 0,
  • "source": {
    },
  • "status": 1,
  • "subjects": [
    ],
  • "submissionId": 0,
  • "subtitle": {
    },
  • "supportingAgencies": [
    ],
  • "title": {
    },
  • "type": {
    },
  • "urlPath": "string",
  • "urlPublished": "string",
  • "version": 0
}

Get a publication.

path Parameters
publicationId
required
integer

Publication ID

+

Request samples

Content type
application/json
{
  • "abstract": {
    },
  • "accessStatus": 0,
  • "categoryIds": [
    ],
  • "citationsRaw": "string",
  • "copyrightHolder": {
    },
  • "copyrightYear": 0,
  • "coverImage": {
    },
  • "coverage": {
    },
  • "dataAvailability": {
    },
  • "datePublished": "string",
  • "disciplines": [
    ],
  • "doiId": 0,
  • "hideAuthor": false,
  • "issueId": 0,
  • "keywords": [
    ],
  • "languages": [
    ],
  • "lastModified": "string",
  • "licenseUrl": "string",
  • "pages": "string",
  • "prefix": {
    },
  • "primaryContactId": 0,
  • "pub-id::publisher-id": "string",
  • "rights": {
    },
  • "sectionId": 0,
  • "seq": 0,
  • "source": {
    },
  • "status": 1,
  • "subjects": [
    ],
  • "submissionId": 0,
  • "subtitle": {
    },
  • "supportingAgencies": [
    ],
  • "title": {
    },
  • "type": {
    },
  • "urlPath": "string",
  • "version": 0
}

Response samples

Content type
application/json
{
  • "_href": "http://example.com",
  • "abstract": {
    },
  • "accessStatus": 0,
  • "authors": [
    ],
  • "authorsString": "string",
  • "authorsStringIncludeInBrowse": "string",
  • "authorsStringShort": "string",
  • "categoryIds": [
    ],
  • "citations": [
    ],
  • "citationsRaw": "string",
  • "copyrightHolder": {
    },
  • "copyrightYear": 0,
  • "coverImage": {
    },
  • "coverage": {
    },
  • "dataAvailability": {
    },
  • "datePublished": "string",
  • "disciplines": [
    ],
  • "doiObject": {
    },
  • "fullTitle": {
    },
  • "galleys": [
    ],
  • "hideAuthor": false,
  • "id": 0,
  • "issueId": 0,
  • "keywords": [
    ],
  • "languages": [
    ],
  • "lastModified": "string",
  • "licenseUrl": "string",
  • "locale": "string",
  • "pages": "string",
  • "prefix": {
    },
  • "primaryContactId": 0,
  • "pub-id::publisher-id": "string",
  • "rights": {
    },
  • "sectionId": 0,
  • "seq": 0,
  • "source": {
    },
  • "status": 1,
  • "subjects": [
    ],
  • "submissionId": 0,
  • "subtitle": {
    },
  • "supportingAgencies": [
    ],
  • "title": {
    },
  • "type": {
    },
  • "urlPath": "string",
  • "urlPublished": "string",
  • "version": 0
}

Get a publication.

path Parameters
publicationId
required
integer

Publication ID

submissionId
required
integer

Submission ID

Responses

Response samples

Content type
application/json
{
  • "_href": "http://example.com",
  • "abstract": {
    },
  • "accessStatus": 0,
  • "authors": [
    ],
  • "authorsString": "string",
  • "authorsStringIncludeInBrowse": "string",
  • "authorsStringShort": "string",
  • "categoryIds": [
    ],
  • "citations": [
    ],
  • "citationsRaw": "string",
  • "copyrightHolder": {
    },
  • "copyrightYear": 0,
  • "coverImage": {
    },
  • "coverage": {
    },
  • "dataAvailability": {
    },
  • "datePublished": "string",
  • "disciplines": [
    ],
  • "doiObject": {
    },
  • "fullTitle": {
    },
  • "galleys": [
    ],
  • "hideAuthor": false,
  • "id": 0,
  • "issueId": 0,
  • "keywords": [
    ],
  • "languages": [
    ],
  • "lastModified": "string",
  • "licenseUrl": "string",
  • "locale": "string",
  • "pages": "string",
  • "prefix": {
    },
  • "primaryContactId": 0,
  • "pub-id::publisher-id": "string",
  • "rights": {
    },
  • "sectionId": 0,
  • "seq": 0,
  • "source": {
    },
  • "status": 1,
  • "subjects": [
    ],
  • "submissionId": 0,
  • "subtitle": {
    },
  • "supportingAgencies": [
    ],
  • "title": {
    },
  • "type": {
    },
  • "urlPath": "string",
  • "urlPublished": "string",
  • "version": 0
}

Edit a publication.

path Parameters
publicationId
required
integer

Publication ID

+

Response samples

Content type
application/json
{
  • "_href": "http://example.com",
  • "abstract": {
    },
  • "accessStatus": 0,
  • "authors": [
    ],
  • "authorsString": "string",
  • "authorsStringIncludeInBrowse": "string",
  • "authorsStringShort": "string",
  • "categoryIds": [
    ],
  • "citations": [
    ],
  • "citationsRaw": "string",
  • "copyrightHolder": {
    },
  • "copyrightYear": 0,
  • "coverImage": {
    },
  • "coverage": {
    },
  • "dataAvailability": {
    },
  • "datePublished": "string",
  • "disciplines": [
    ],
  • "doiObject": {
    },
  • "fullTitle": {
    },
  • "galleys": [
    ],
  • "hideAuthor": false,
  • "id": 0,
  • "issueId": 0,
  • "keywords": [
    ],
  • "languages": [
    ],
  • "lastModified": "string",
  • "licenseUrl": "string",
  • "locale": "string",
  • "pages": "string",
  • "prefix": {
    },
  • "primaryContactId": 0,
  • "pub-id::publisher-id": "string",
  • "rights": {
    },
  • "sectionId": 0,
  • "seq": 0,
  • "source": {
    },
  • "status": 1,
  • "subjects": [
    ],
  • "submissionId": 0,
  • "subtitle": {
    },
  • "supportingAgencies": [
    ],
  • "title": {
    },
  • "type": {
    },
  • "urlPath": "string",
  • "urlPublished": "string",
  • "version": 0
}

Edit a publication.

path Parameters
publicationId
required
integer

Publication ID

submissionId
required
integer

Submission ID

Request Body schema: application/json

The details about the publication that you want to edit. All params are optional. When a param is omitted, the existing value of that param will not be modified.

abstract
object (LocaleObject)

Key/value pairs containing data stored by locale key.

@@ -2575,19 +2576,19 @@

Request samples

Content type
application/json
{
  • "abstract": {
    },
  • "accessStatus": 0,
  • "categoryIds": [
    ],
  • "citationsRaw": "string",
  • "copyrightHolder": {
    },
  • "copyrightYear": 0,
  • "coverImage": {
    },
  • "coverage": {
    },
  • "dataAvailability": {
    },
  • "datePublished": "string",
  • "disciplines": [
    ],
  • "doiId": 0,
  • "hideAuthor": false,
  • "issueId": 0,
  • "keywords": [
    ],
  • "languages": [
    ],
  • "lastModified": "string",
  • "licenseUrl": "string",
  • "pages": "string",
  • "prefix": {
    },
  • "primaryContactId": 0,
  • "pub-id::publisher-id": "string",
  • "rights": {
    },
  • "sectionId": 0,
  • "seq": 0,
  • "source": {
    },
  • "status": 1,
  • "subjects": [
    ],
  • "submissionId": 0,
  • "subtitle": {
    },
  • "supportingAgencies": [
    ],
  • "title": {
    },
  • "type": {
    },
  • "urlPath": "string",
  • "version": 0
}

Response samples

Content type
application/json
{
  • "_href": "http://example.com",
  • "abstract": {
    },
  • "accessStatus": 0,
  • "authors": [
    ],
  • "authorsString": "string",
  • "authorsStringIncludeInBrowse": "string",
  • "authorsStringShort": "string",
  • "categoryIds": [
    ],
  • "citations": [
    ],
  • "citationsRaw": "string",
  • "copyrightHolder": {
    },
  • "copyrightYear": 0,
  • "coverImage": {
    },
  • "coverage": {
    },
  • "dataAvailability": {
    },
  • "datePublished": "string",
  • "disciplines": [
    ],
  • "doiObject": {
    },
  • "fullTitle": {
    },
  • "galleys": [
    ],
  • "hideAuthor": false,
  • "id": 0,
  • "issueId": 0,
  • "keywords": [
    ],
  • "languages": [
    ],
  • "lastModified": "string",
  • "licenseUrl": "string",
  • "locale": "string",
  • "pages": "string",
  • "prefix": {
    },
  • "primaryContactId": 0,
  • "pub-id::publisher-id": "string",
  • "rights": {
    },
  • "sectionId": 0,
  • "seq": 0,
  • "source": {
    },
  • "status": 1,
  • "subjects": [
    ],
  • "submissionId": 0,
  • "subtitle": {
    },
  • "supportingAgencies": [
    ],
  • "title": {
    },
  • "type": {
    },
  • "urlPath": "string",
  • "urlPublished": "string",
  • "version": 0
}

Delete a publication.

Only journal managers and subeditors can make a request to this endpoint.

+

Request samples

Content type
application/json
{
  • "abstract": {
    },
  • "accessStatus": 0,
  • "categoryIds": [
    ],
  • "citationsRaw": "string",
  • "copyrightHolder": {
    },
  • "copyrightYear": 0,
  • "coverImage": {
    },
  • "coverage": {
    },
  • "dataAvailability": {
    },
  • "datePublished": "string",
  • "disciplines": [
    ],
  • "doiId": 0,
  • "hideAuthor": false,
  • "issueId": 0,
  • "keywords": [
    ],
  • "languages": [
    ],
  • "lastModified": "string",
  • "licenseUrl": "string",
  • "pages": "string",
  • "prefix": {
    },
  • "primaryContactId": 0,
  • "pub-id::publisher-id": "string",
  • "rights": {
    },
  • "sectionId": 0,
  • "seq": 0,
  • "source": {
    },
  • "status": 1,
  • "subjects": [
    ],
  • "submissionId": 0,
  • "subtitle": {
    },
  • "supportingAgencies": [
    ],
  • "title": {
    },
  • "type": {
    },
  • "urlPath": "string",
  • "version": 0
}

Response samples

Content type
application/json
{
  • "_href": "http://example.com",
  • "abstract": {
    },
  • "accessStatus": 0,
  • "authors": [
    ],
  • "authorsString": "string",
  • "authorsStringIncludeInBrowse": "string",
  • "authorsStringShort": "string",
  • "categoryIds": [
    ],
  • "citations": [
    ],
  • "citationsRaw": "string",
  • "copyrightHolder": {
    },
  • "copyrightYear": 0,
  • "coverImage": {
    },
  • "coverage": {
    },
  • "dataAvailability": {
    },
  • "datePublished": "string",
  • "disciplines": [
    ],
  • "doiObject": {
    },
  • "fullTitle": {
    },
  • "galleys": [
    ],
  • "hideAuthor": false,
  • "id": 0,
  • "issueId": 0,
  • "keywords": [
    ],
  • "languages": [
    ],
  • "lastModified": "string",
  • "licenseUrl": "string",
  • "locale": "string",
  • "pages": "string",
  • "prefix": {
    },
  • "primaryContactId": 0,
  • "pub-id::publisher-id": "string",
  • "rights": {
    },
  • "sectionId": 0,
  • "seq": 0,
  • "source": {
    },
  • "status": 1,
  • "subjects": [
    ],
  • "submissionId": 0,
  • "subtitle": {
    },
  • "supportingAgencies": [
    ],
  • "title": {
    },
  • "type": {
    },
  • "urlPath": "string",
  • "urlPublished": "string",
  • "version": 0
}

Delete a publication.

Only journal managers and subeditors can make a request to this endpoint.

path Parameters
publicationId
required
integer

Publication ID

submissionId
required
integer

Submission ID

Responses

Response samples

Content type
application/json
{
  • "_href": "http://example.com",
  • "abstract": {
    },
  • "accessStatus": 0,
  • "authors": [
    ],
  • "authorsString": "string",
  • "authorsStringIncludeInBrowse": "string",
  • "authorsStringShort": "string",
  • "categoryIds": [
    ],
  • "citations": [
    ],
  • "citationsRaw": "string",
  • "copyrightHolder": {
    },
  • "copyrightYear": 0,
  • "coverImage": {
    },
  • "coverage": {
    },
  • "dataAvailability": {
    },
  • "datePublished": "string",
  • "disciplines": [
    ],
  • "doiObject": {
    },
  • "fullTitle": {
    },
  • "galleys": [
    ],
  • "hideAuthor": false,
  • "id": 0,
  • "issueId": 0,
  • "keywords": [
    ],
  • "languages": [
    ],
  • "lastModified": "string",
  • "licenseUrl": "string",
  • "locale": "string",
  • "pages": "string",
  • "prefix": {
    },
  • "primaryContactId": 0,
  • "pub-id::publisher-id": "string",
  • "rights": {
    },
  • "sectionId": 0,
  • "seq": 0,
  • "source": {
    },
  • "status": 1,
  • "subjects": [
    ],
  • "submissionId": 0,
  • "subtitle": {
    },
  • "supportingAgencies": [
    ],
  • "title": {
    },
  • "type": {
    },
  • "urlPath": "string",
  • "urlPublished": "string",
  • "version": 0
}

Create a new version of a publication.

Duplicate a publication, including author and galley records, in order to create a new version of a publication that can be edited.

+

Response samples

Content type
application/json
{
  • "_href": "http://example.com",
  • "abstract": {
    },
  • "accessStatus": 0,
  • "authors": [
    ],
  • "authorsString": "string",
  • "authorsStringIncludeInBrowse": "string",
  • "authorsStringShort": "string",
  • "categoryIds": [
    ],
  • "citations": [
    ],
  • "citationsRaw": "string",
  • "copyrightHolder": {
    },
  • "copyrightYear": 0,
  • "coverImage": {
    },
  • "coverage": {
    },
  • "dataAvailability": {
    },
  • "datePublished": "string",
  • "disciplines": [
    ],
  • "doiObject": {
    },
  • "fullTitle": {
    },
  • "galleys": [
    ],
  • "hideAuthor": false,
  • "id": 0,
  • "issueId": 0,
  • "keywords": [
    ],
  • "languages": [
    ],
  • "lastModified": "string",
  • "licenseUrl": "string",
  • "locale": "string",
  • "pages": "string",
  • "prefix": {
    },
  • "primaryContactId": 0,
  • "pub-id::publisher-id": "string",
  • "rights": {
    },
  • "sectionId": 0,
  • "seq": 0,
  • "source": {
    },
  • "status": 1,
  • "subjects": [
    ],
  • "submissionId": 0,
  • "subtitle": {
    },
  • "supportingAgencies": [
    ],
  • "title": {
    },
  • "type": {
    },
  • "urlPath": "string",
  • "urlPublished": "string",
  • "version": 0
}

Create a new version of a publication.

Duplicate a publication, including author and galley records, in order to create a new version of a publication that can be edited.

path Parameters
publicationId
required
integer

Publication ID

submissionId
required
integer

Submission ID

Responses

Response samples

Content type
application/json
{
  • "_href": "http://example.com",
  • "abstract": {
    },
  • "accessStatus": 0,
  • "authors": [
    ],
  • "authorsString": "string",
  • "authorsStringIncludeInBrowse": "string",
  • "authorsStringShort": "string",
  • "categoryIds": [
    ],
  • "citations": [
    ],
  • "citationsRaw": "string",
  • "copyrightHolder": {
    },
  • "copyrightYear": 0,
  • "coverImage": {
    },
  • "coverage": {
    },
  • "dataAvailability": {
    },
  • "datePublished": "string",
  • "disciplines": [
    ],
  • "doiObject": {
    },
  • "fullTitle": {
    },
  • "galleys": [
    ],
  • "hideAuthor": false,
  • "id": 0,
  • "issueId": 0,
  • "keywords": [
    ],
  • "languages": [
    ],
  • "lastModified": "string",
  • "licenseUrl": "string",
  • "locale": "string",
  • "pages": "string",
  • "prefix": {
    },
  • "primaryContactId": 0,
  • "pub-id::publisher-id": "string",
  • "rights": {
    },
  • "sectionId": 0,
  • "seq": 0,
  • "source": {
    },
  • "status": 1,
  • "subjects": [
    ],
  • "submissionId": 0,
  • "subtitle": {
    },
  • "supportingAgencies": [
    ],
  • "title": {
    },
  • "type": {
    },
  • "urlPath": "string",
  • "urlPublished": "string",
  • "version": 0
}

Publish a publication.

If the publication is assigned to an issue that is not yet published, it will be scheduled for publication and the status will be set to PKPSubmission::STATUS_SCHEDULED. If the issue is already published, it will be published immediately and the status will be set to PKPSubmission::STATUS_PUBLISHED.

+

Response samples

Content type
application/json
{
  • "_href": "http://example.com",
  • "abstract": {
    },
  • "accessStatus": 0,
  • "authors": [
    ],
  • "authorsString": "string",
  • "authorsStringIncludeInBrowse": "string",
  • "authorsStringShort": "string",
  • "categoryIds": [
    ],
  • "citations": [
    ],
  • "citationsRaw": "string",
  • "copyrightHolder": {
    },
  • "copyrightYear": 0,
  • "coverImage": {
    },
  • "coverage": {
    },
  • "dataAvailability": {
    },
  • "datePublished": "string",
  • "disciplines": [
    ],
  • "doiObject": {
    },
  • "fullTitle": {
    },
  • "galleys": [
    ],
  • "hideAuthor": false,
  • "id": 0,
  • "issueId": 0,
  • "keywords": [
    ],
  • "languages": [
    ],
  • "lastModified": "string",
  • "licenseUrl": "string",
  • "locale": "string",
  • "pages": "string",
  • "prefix": {
    },
  • "primaryContactId": 0,
  • "pub-id::publisher-id": "string",
  • "rights": {
    },
  • "sectionId": 0,
  • "seq": 0,
  • "source": {
    },
  • "status": 1,
  • "subjects": [
    ],
  • "submissionId": 0,
  • "subtitle": {
    },
  • "supportingAgencies": [
    ],
  • "title": {
    },
  • "type": {
    },
  • "urlPath": "string",
  • "urlPublished": "string",
  • "version": 0
}

Publish a publication.

If the publication is assigned to an issue that is not yet published, it will be scheduled for publication and the status will be set to PKPSubmission::STATUS_SCHEDULED. If the issue is already published, it will be published immediately and the status will be set to PKPSubmission::STATUS_PUBLISHED.

The publication will be validated against any publishing requirements before it is published and a 400 response will be returned if it fails validation.

path Parameters
publicationId
required
integer

Publication ID

submissionId
required
integer

Submission ID

@@ -2595,22 +2596,23 @@

Response samples

Content type
application/json
{
  • "_href": "http://example.com",
  • "abstract": {
    },
  • "accessStatus": 0,
  • "authors": [
    ],
  • "authorsString": "string",
  • "authorsStringIncludeInBrowse": "string",
  • "authorsStringShort": "string",
  • "categoryIds": [
    ],
  • "citations": [
    ],
  • "citationsRaw": "string",
  • "copyrightHolder": {
    },
  • "copyrightYear": 0,
  • "coverImage": {
    },
  • "coverage": {
    },
  • "dataAvailability": {
    },
  • "datePublished": "string",
  • "disciplines": [
    ],
  • "doiObject": {
    },
  • "fullTitle": {
    },
  • "galleys": [
    ],
  • "hideAuthor": false,
  • "id": 0,
  • "issueId": 0,
  • "keywords": [
    ],
  • "languages": [
    ],
  • "lastModified": "string",
  • "licenseUrl": "string",
  • "locale": "string",
  • "pages": "string",
  • "prefix": {
    },
  • "primaryContactId": 0,
  • "pub-id::publisher-id": "string",
  • "rights": {
    },
  • "sectionId": 0,
  • "seq": 0,
  • "source": {
    },
  • "status": 1,
  • "subjects": [
    ],
  • "submissionId": 0,
  • "subtitle": {
    },
  • "supportingAgencies": [
    ],
  • "title": {
    },
  • "type": {
    },
  • "urlPath": "string",
  • "urlPublished": "string",
  • "version": 0
}

Unpublish a publication.

path Parameters
publicationId
required
integer

Publication ID

+

Response samples

Content type
application/json
{
  • "_href": "http://example.com",
  • "abstract": {
    },
  • "accessStatus": 0,
  • "authors": [
    ],
  • "authorsString": "string",
  • "authorsStringIncludeInBrowse": "string",
  • "authorsStringShort": "string",
  • "categoryIds": [
    ],
  • "citations": [
    ],
  • "citationsRaw": "string",
  • "copyrightHolder": {
    },
  • "copyrightYear": 0,
  • "coverImage": {
    },
  • "coverage": {
    },
  • "dataAvailability": {
    },
  • "datePublished": "string",
  • "disciplines": [
    ],
  • "doiObject": {
    },
  • "fullTitle": {
    },
  • "galleys": [
    ],
  • "hideAuthor": false,
  • "id": 0,
  • "issueId": 0,
  • "keywords": [
    ],
  • "languages": [
    ],
  • "lastModified": "string",
  • "licenseUrl": "string",
  • "locale": "string",
  • "pages": "string",
  • "prefix": {
    },
  • "primaryContactId": 0,
  • "pub-id::publisher-id": "string",
  • "rights": {
    },
  • "sectionId": 0,
  • "seq": 0,
  • "source": {
    },
  • "status": 1,
  • "subjects": [
    ],
  • "submissionId": 0,
  • "subtitle": {
    },
  • "supportingAgencies": [
    ],
  • "title": {
    },
  • "type": {
    },
  • "urlPath": "string",
  • "urlPublished": "string",
  • "version": 0
}

Unpublish a publication.

path Parameters
publicationId
required
integer

Publication ID

submissionId
required
integer

Submission ID

Responses

Response samples

Content type
application/json
{
  • "_href": "http://example.com",
  • "abstract": {
    },
  • "accessStatus": 0,
  • "authors": [
    ],
  • "authorsString": "string",
  • "authorsStringIncludeInBrowse": "string",
  • "authorsStringShort": "string",
  • "categoryIds": [
    ],
  • "citations": [
    ],
  • "citationsRaw": "string",
  • "copyrightHolder": {
    },
  • "copyrightYear": 0,
  • "coverImage": {
    },
  • "coverage": {
    },
  • "dataAvailability": {
    },
  • "datePublished": "string",
  • "disciplines": [
    ],
  • "doiObject": {
    },
  • "fullTitle": {
    },
  • "galleys": [
    ],
  • "hideAuthor": false,
  • "id": 0,
  • "issueId": 0,
  • "keywords": [
    ],
  • "languages": [
    ],
  • "lastModified": "string",
  • "licenseUrl": "string",
  • "locale": "string",
  • "pages": "string",
  • "prefix": {
    },
  • "primaryContactId": 0,
  • "pub-id::publisher-id": "string",
  • "rights": {
    },
  • "sectionId": 0,
  • "seq": 0,
  • "source": {
    },
  • "status": 1,
  • "subjects": [
    ],
  • "submissionId": 0,
  • "subtitle": {
    },
  • "supportingAgencies": [
    ],
  • "title": {
    },
  • "type": {
    },
  • "urlPath": "string",
  • "urlPublished": "string",
  • "version": 0
}

Submissions / Publications / Contributors

Get a publication's contributors.

path Parameters
publicationId
required
integer

Publication ID

+

Response samples

Content type
application/json
{
  • "_href": "http://example.com",
  • "abstract": {
    },
  • "accessStatus": 0,
  • "authors": [
    ],
  • "authorsString": "string",
  • "authorsStringIncludeInBrowse": "string",
  • "authorsStringShort": "string",
  • "categoryIds": [
    ],
  • "citations": [
    ],
  • "citationsRaw": "string",
  • "copyrightHolder": {
    },
  • "copyrightYear": 0,
  • "coverImage": {
    },
  • "coverage": {
    },
  • "dataAvailability": {
    },
  • "datePublished": "string",
  • "disciplines": [
    ],
  • "doiObject": {
    },
  • "fullTitle": {
    },
  • "galleys": [
    ],
  • "hideAuthor": false,
  • "id": 0,
  • "issueId": 0,
  • "keywords": [
    ],
  • "languages": [
    ],
  • "lastModified": "string",
  • "licenseUrl": "string",
  • "locale": "string",
  • "pages": "string",
  • "prefix": {
    },
  • "primaryContactId": 0,
  • "pub-id::publisher-id": "string",
  • "rights": {
    },
  • "sectionId": 0,
  • "seq": 0,
  • "source": {
    },
  • "status": 1,
  • "subjects": [
    ],
  • "submissionId": 0,
  • "subtitle": {
    },
  • "supportingAgencies": [
    ],
  • "title": {
    },
  • "type": {
    },
  • "urlPath": "string",
  • "urlPublished": "string",
  • "version": 0
}

Submissions / Publications / Contributors

Get a publication's contributors.

path Parameters
publicationId
required
integer

Publication ID

submissionId
required
integer

Submission ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a contributor.

Create a new contributor for a publication.

+

Response samples

Content type
application/json
[
  • {
    }
]

Create a contributor.

Create a new contributor for a publication.

path Parameters
publicationId
required
integer

Publication ID

submissionId
required
integer

Submission ID

Request Body schema: application/json

Details about the contributor that should be created.

affiliation
object (LocaleObject)

Key/value pairs containing data stored by locale key.

biography
object (LocaleObject)

Key/value pairs containing data stored by locale key.

+
competingInterests
object (LocaleObject)

Key/value pairs containing data stored by locale key.

country
string

The author's country in a two-letter code (ISO 3166-1). See all codes.

email
string
familyName
object (LocaleObject)

Key/value pairs containing data stored by locale key.

givenName
object (LocaleObject)

Key/value pairs containing data stored by locale key.

@@ -2624,18 +2626,19 @@

Request samples

Content type
application/json
{
  • "affiliation": {
    },
  • "biography": {
    },
  • "country": "string",
  • "email": "string",
  • "familyName": {
    },
  • "givenName": {
    },
  • "id": 0,
  • "includeInBrowse": true,
  • "orcid": "string",
  • "preferredPublicName": {
    },
  • "publicationId": 0,
  • "seq": 0,
  • "url": "string",
  • "userGroupId": 0
}

Response samples

Content type
application/json
{
  • "affiliation": {
    },
  • "biography": {
    },
  • "country": "string",
  • "email": "string",
  • "familyName": {
    },
  • "fullName": "string",
  • "givenName": {
    },
  • "id": 0,
  • "includeInBrowse": true,
  • "locale": "string",
  • "orcid": "string",
  • "preferredPublicName": {
    },
  • "publicationId": 0,
  • "seq": 0,
  • "url": "string",
  • "userGroupId": 0,
  • "userGroupName": "string"
}

Get a contributor.

path Parameters
contributorId
required
integer

Contributor ID

+

Request samples

Content type
application/json
{
  • "affiliation": {
    },
  • "biography": {
    },
  • "competingInterests": {
    },
  • "country": "string",
  • "email": "string",
  • "familyName": {
    },
  • "givenName": {
    },
  • "id": 0,
  • "includeInBrowse": true,
  • "orcid": "string",
  • "preferredPublicName": {
    },
  • "publicationId": 0,
  • "seq": 0,
  • "url": "string",
  • "userGroupId": 0
}

Response samples

Content type
application/json
{
  • "affiliation": {
    },
  • "biography": {
    },
  • "competingInterests": {
    },
  • "country": "string",
  • "email": "string",
  • "familyName": {
    },
  • "fullName": "string",
  • "givenName": {
    },
  • "id": 0,
  • "includeInBrowse": true,
  • "locale": "string",
  • "orcid": "string",
  • "preferredPublicName": {
    },
  • "publicationId": 0,
  • "seq": 0,
  • "url": "string",
  • "userGroupId": 0,
  • "userGroupName": "string"
}

Get a contributor.

path Parameters
contributorId
required
integer

Contributor ID

publicationId
required
integer

Publication ID

submissionId
required
integer

Submission ID

Responses

Response samples

Content type
application/json
{
  • "affiliation": {
    },
  • "biography": {
    },
  • "country": "string",
  • "email": "string",
  • "familyName": {
    },
  • "fullName": "string",
  • "givenName": {
    },
  • "id": 0,
  • "includeInBrowse": true,
  • "locale": "string",
  • "orcid": "string",
  • "preferredPublicName": {
    },
  • "publicationId": 0,
  • "seq": 0,
  • "url": "string",
  • "userGroupId": 0,
  • "userGroupName": "string"
}

Edit a Contributor.

path Parameters
contributorId
required
integer

Contributor ID

+

Response samples

Content type
application/json
{
  • "affiliation": {
    },
  • "biography": {
    },
  • "competingInterests": {
    },
  • "country": "string",
  • "email": "string",
  • "familyName": {
    },
  • "fullName": "string",
  • "givenName": {
    },
  • "id": 0,
  • "includeInBrowse": true,
  • "locale": "string",
  • "orcid": "string",
  • "preferredPublicName": {
    },
  • "publicationId": 0,
  • "seq": 0,
  • "url": "string",
  • "userGroupId": 0,
  • "userGroupName": "string"
}

Edit a Contributor.

path Parameters
contributorId
required
integer

Contributor ID

publicationId
required
integer

Publication ID

submissionId
required
integer

Submission ID

Request Body schema: application/json

The details about the contributor that you want to edit. All params are optional. When a param is omitted, the existing value of that param will not be modified.

affiliation
object (LocaleObject)

Key/value pairs containing data stored by locale key.

biography
object (LocaleObject)

Key/value pairs containing data stored by locale key.

+
competingInterests
object (LocaleObject)

Key/value pairs containing data stored by locale key.

country
string

The author's country in a two-letter code (ISO 3166-1). See all codes.

email
string
familyName
object (LocaleObject)

Key/value pairs containing data stored by locale key.

givenName
object (LocaleObject)

Key/value pairs containing data stored by locale key.

@@ -2649,20 +2652,20 @@

Request samples

Content type
application/json
{
  • "affiliation": {
    },
  • "biography": {
    },
  • "country": "string",
  • "email": "string",
  • "familyName": {
    },
  • "givenName": {
    },
  • "id": 0,
  • "includeInBrowse": true,
  • "orcid": "string",
  • "preferredPublicName": {
    },
  • "publicationId": 0,
  • "seq": 0,
  • "url": "string",
  • "userGroupId": 0
}

Response samples

Content type
application/json
{
  • "affiliation": {
    },
  • "biography": {
    },
  • "country": "string",
  • "email": "string",
  • "familyName": {
    },
  • "fullName": "string",
  • "givenName": {
    },
  • "id": 0,
  • "includeInBrowse": true,
  • "locale": "string",
  • "orcid": "string",
  • "preferredPublicName": {
    },
  • "publicationId": 0,
  • "seq": 0,
  • "url": "string",
  • "userGroupId": 0,
  • "userGroupName": "string"
}

Delete a contributor.

path Parameters
contributorId
required
integer

Contributor ID

+

Request samples

Content type
application/json
{
  • "affiliation": {
    },
  • "biography": {
    },
  • "competingInterests": {
    },
  • "country": "string",
  • "email": "string",
  • "familyName": {
    },
  • "givenName": {
    },
  • "id": 0,
  • "includeInBrowse": true,
  • "orcid": "string",
  • "preferredPublicName": {
    },
  • "publicationId": 0,
  • "seq": 0,
  • "url": "string",
  • "userGroupId": 0
}

Response samples

Content type
application/json
{
  • "affiliation": {
    },
  • "biography": {
    },
  • "competingInterests": {
    },
  • "country": "string",
  • "email": "string",
  • "familyName": {
    },
  • "fullName": "string",
  • "givenName": {
    },
  • "id": 0,
  • "includeInBrowse": true,
  • "locale": "string",
  • "orcid": "string",
  • "preferredPublicName": {
    },
  • "publicationId": 0,
  • "seq": 0,
  • "url": "string",
  • "userGroupId": 0,
  • "userGroupName": "string"
}

Delete a contributor.

path Parameters
contributorId
required
integer

Contributor ID

publicationId
required
integer

Publication ID

submissionId
required
integer

Submission ID

Responses

Response samples

Content type
application/json
{
  • "affiliation": {
    },
  • "biography": {
    },
  • "country": "string",
  • "email": "string",
  • "familyName": {
    },
  • "fullName": "string",
  • "givenName": {
    },
  • "id": 0,
  • "includeInBrowse": true,
  • "locale": "string",
  • "orcid": "string",
  • "preferredPublicName": {
    },
  • "publicationId": 0,
  • "seq": 0,
  • "url": "string",
  • "userGroupId": 0,
  • "userGroupName": "string"
}

Reorder publication's contributors

Change the order of the contributor's as they are listed in the publication.

+

Response samples

Content type
application/json
{
  • "affiliation": {
    },
  • "biography": {
    },
  • "competingInterests": {
    },
  • "country": "string",
  • "email": "string",
  • "familyName": {
    },
  • "fullName": "string",
  • "givenName": {
    },
  • "id": 0,
  • "includeInBrowse": true,
  • "locale": "string",
  • "orcid": "string",
  • "preferredPublicName": {
    },
  • "publicationId": 0,
  • "seq": 0,
  • "url": "string",
  • "userGroupId": 0,
  • "userGroupName": "string"
}

Reorder publication's contributors

Change the order of the contributor's as they are listed in the publication.

path Parameters
publicationId
required
integer

Publication ID

submissionId
required
integer

Submission ID

Request Body schema: application/json
Array of objects (Contributor)

An array of contributor objects in the order they should be listed.

Responses

Request samples

Content type
application/json
{
  • "sortedAuthors": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Issues

Get a list of issues.

Results are eordered by datePublished.

+

Request samples

Content type
application/json
{
  • "sortedAuthors": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Issues

Get a list of issues.

Results are eordered by datePublished.

query Parameters
count
integer
Default: 20

How many results to return in a single request. Max is 100.

isPublished
boolean

Filter returned issues by those that have been published. Pass a false value to return only unpublished issues. Only administrators and journal managers are allowed to access unpublished issues.

numbers
string

Filter returned issues by those assigned a specific number.

@@ -2676,11 +2679,11 @@

Response samples

Content type
application/json
[
  • {
    }
]

Get the current issue.

Responses

Response samples

Content type
application/json
{
  • "_href": "string",
  • "accessStatus": 0,
  • "articles": [
    ],
  • "coverImage": {
    },
  • "coverImageAltText": {
    },
  • "coverImageUrl": {
    },
  • "dateNotified": "string",
  • "datePublished": "string",
  • "description": {
    },
  • "doiObject": {
    },
  • "galleys": [
    ],
  • "id": 0,
  • "identification": "string",
  • "journalId": 0,
  • "lastModified": "string",
  • "number": "string",
  • "openAccessDate": "string",
  • "originalStyleFileName": "string",
  • "published": true,
  • "publishedUrl": "string",
  • "sections": [
    ],
  • "showNumber": true,
  • "showTitle": true,
  • "showVolume": true,
  • "showYear": true,
  • "styleFileName": "string",
  • "title": {
    },
  • "urlPath": "string",
  • "volume": 0,
  • "year": 0
}

Get an issue by ID.

If the issue has a custom section order, the seq property of each SectionSummary will reflect the sequence for that issue.

+

Response samples

Content type
application/json
{
  • "_href": "string",
  • "accessStatus": 0,
  • "articles": [
    ],
  • "coverImage": {
    },
  • "coverImageAltText": {
    },
  • "coverImageUrl": {
    },
  • "dateNotified": "string",
  • "datePublished": "string",
  • "description": {
    },
  • "doiObject": {
    },
  • "galleys": [
    ],
  • "id": 0,
  • "identification": "string",
  • "journalId": 0,
  • "lastModified": "string",
  • "number": "string",
  • "openAccessDate": "string",
  • "originalStyleFileName": "string",
  • "published": true,
  • "publishedUrl": "string",
  • "sections": [
    ],
  • "showNumber": true,
  • "showTitle": true,
  • "showVolume": true,
  • "showYear": true,
  • "styleFileName": "string",
  • "title": {
    },
  • "urlPath": "string",
  • "volume": 0,
  • "year": 0
}

Get an issue by ID.

If the issue has a custom section order, the seq property of each SectionSummary will reflect the sequence for that issue.

path Parameters
issueId
required
integer

Issue ID

Responses

Response samples

Content type
application/json
{
  • "_href": "string",
  • "accessStatus": 0,
  • "articles": [
    ],
  • "coverImage": {
    },
  • "coverImageAltText": {
    },
  • "coverImageUrl": {
    },
  • "dateNotified": "string",
  • "datePublished": "string",
  • "description": {
    },
  • "doiObject": {
    },
  • "galleys": [
    ],
  • "id": 0,
  • "identification": "string",
  • "journalId": 0,
  • "lastModified": "string",
  • "number": "string",
  • "openAccessDate": "string",
  • "originalStyleFileName": "string",
  • "published": true,
  • "publishedUrl": "string",
  • "sections": [
    ],
  • "showNumber": true,
  • "showTitle": true,
  • "showVolume": true,
  • "showYear": true,
  • "styleFileName": "string",
  • "title": {
    },
  • "urlPath": "string",
  • "volume": 0,
  • "year": 0
}

Users

Only admins, journal editors, and subeditors can access these endpoints.

+

Response samples

Content type
application/json
{
  • "_href": "string",
  • "accessStatus": 0,
  • "articles": [
    ],
  • "coverImage": {
    },
  • "coverImageAltText": {
    },
  • "coverImageUrl": {
    },
  • "dateNotified": "string",
  • "datePublished": "string",
  • "description": {
    },
  • "doiObject": {
    },
  • "galleys": [
    ],
  • "id": 0,
  • "identification": "string",
  • "journalId": 0,
  • "lastModified": "string",
  • "number": "string",
  • "openAccessDate": "string",
  • "originalStyleFileName": "string",
  • "published": true,
  • "publishedUrl": "string",
  • "sections": [
    ],
  • "showNumber": true,
  • "showTitle": true,
  • "showVolume": true,
  • "showYear": true,
  • "styleFileName": "string",
  • "title": {
    },
  • "urlPath": "string",
  • "volume": 0,
  • "year": 0
}

Users

Only admins, journal editors, and subeditors can access these endpoints.

Get a list of users.

query Parameters
assignedToSection
integer

Filter the results by those assigned as section editors to this section ID.

assignedToSubmission
integer

Filter results by those assigned to this submission ID.

assignedToSubmissionStage
integer

Filter results by those assigned to this submission stage. Will be ignored if no assignedToSubmission parameter exists.

@@ -2735,7 +2738,7 @@
contactEmail
string
contactName
string
contactPhone
string
contributorsHelp
object (LocaleObject)

Key/value pairs containing data stored by locale key.

copyrightHolderOther
object (LocaleObject)

Key/value pairs containing data stored by locale key.

copyrightHolderType
string
Enum: "author" "context" "other"
copyrightNotice
object (LocaleObject)

Key/value pairs containing data stored by locale key.

-
copyrightYearBasis
string
Default: "issue"
Enum: "issue" "submission"
copySubmissionAckAddress
string
Default: ""

A copy of the submission acknowledgement email will be sent to any of the email addresses entered here. Separate multiple email addresses with a comma. Example: one@example.com,two@example.com

+
copyrightYearBasis
string
Default: "issue"
Enum: "issue" "submission"
copySubmissionAckAddress
string
Default: ""

A copy of the submission acknowledgement email will be sent to any of the email addresses entered here. Separate multiple email addresses with a comma. Example: one@example.com,two@example.com

copySubmissionAckPrimaryContact
boolean
Default: false

A copy of the submission acknowledgement email will be sent to this context's primary contact when true.

country
string
coverage
string
Enum: "0" "enable" "request" "require"

Enable coverage metadata. 0 is disabled. enable will make it available in the workflow. request will allow an author to enter a value during submission. require will require that the author enter a value during submission.

currency
string
currentIssueId
integer
customHeaders
object (LocaleObject)

Key/value pairs containing data stored by locale key.

@@ -2770,10 +2773,10 @@
object
paymentPluginName
string
paymentsEnabled
boolean
primaryLocale
string
printIssn
string
privacyStatement
object (LocaleObject)

Key/value pairs containing data stored by locale key.

publicationFee
number
Default: 0
publicationFeeDescription
object (LocaleObject)

Key/value pairs containing data stored by locale key.

publicationFeeName
object (LocaleObject)

Key/value pairs containing data stored by locale key.

-
publisherInstitution
string
publishingMode
integer
Enum: 0 1 2
purchaseArticleFee
number
Default: 0
purchaseArticleFeeDescription
object (LocaleObject)

Key/value pairs containing data stored by locale key.

+
publisherInstitution
string
publisherUrl
string
publishingMode
integer
Enum: 0 1 2
purchaseArticleFee
number
Default: 0
purchaseArticleFeeDescription
object (LocaleObject)

Key/value pairs containing data stored by locale key.

purchaseArticleFeeEnabled
boolean
purchaseArticleFeeName
object (LocaleObject)

Key/value pairs containing data stored by locale key.

purchaseIssueFee
number
purchaseIssueFeeEnabled
boolean
rateReviewerOnQuality
boolean
readerInformation
object (LocaleObject)

Key/value pairs containing data stored by locale key.

-
registrationAgency
string
Default: ""
restrictArticleAccess
boolean
restrictOnlyPdf
boolean
restrictReviewerFileAccess
boolean
restrictSiteAccess
boolean
reviewerAccessKeysEnabled
boolean
reviewGuidelines
object (LocaleObject)

Key/value pairs containing data stored by locale key.

+
registrationAgency
string
Default: ""
requireAuthorCompetingInterests
boolean
restrictArticleAccess
boolean
restrictOnlyPdf
boolean
restrictReviewerFileAccess
boolean
restrictSiteAccess
boolean
reviewerAccessKeysEnabled
boolean
reviewGuidelines
object (LocaleObject)

Key/value pairs containing data stored by locale key.

reviewHelp
object (LocaleObject)

Key/value pairs containing data stored by locale key.

rights
string
Enum: "0" "enable" "request" "require"

Enable rights metadata. 0 is disabled. enable will make it available in the workflow. request will allow an author to enter a value during submission. require will require that the author enter a value during submission.

searchDescription
object (LocaleObject)

Key/value pairs containing data stored by locale key.

@@ -2790,11 +2793,11 @@
uploadFilesHelp
object (LocaleObject)

Key/value pairs containing data stored by locale key.

urlPath
string

Responses

Request samples

Content type
application/json
{
  • "abbreviation": {
    },
  • "about": {
    },
  • "acronym": {
    },
  • "additionalHomeContent": {
    },
  • "agencies": "0",
  • "announcementsIntroduction": {
    },
  • "authorGuidelines": {
    },
  • "authorInformation": {
    },
  • "automaticDoiDeposit": true,
  • "beginSubmissionHelp": {
    },
  • "citations": "0",
  • "clockssLicense": {
    },
  • "competingInterests": {
    },
  • "contactAffiliation": {
    },
  • "contactEmail": "string",
  • "contactName": "string",
  • "contactPhone": "string",
  • "contributorsHelp": {
    },
  • "copySubmissionAckAddress": "",
  • "copySubmissionAckPrimaryContact": false,
  • "copyrightHolderOther": {
    },
  • "copyrightHolderType": "author",
  • "copyrightNotice": {
    },
  • "copyrightYearBasis": "issue",
  • "country": "string",
  • "coverage": "0",
  • "currency": "string",
  • "currentIssueId": 0,
  • "customHeaders": {
    },
  • "dataAvailability": "0",
  • "dateFormatLong": {
    },
  • "dateFormatShort": {
    },
  • "datetimeFormatLong": {
    },
  • "datetimeFormatShort": {
    },
  • "defaultMetricType": "string",
  • "defaultReviewMode": 1,
  • "delayedOpenAccessDuration": 0,
  • "delayedOpenAccessPolicy": {
    },
  • "description": {
    },
  • "detailsHelp": {
    },
  • "disableBulkEmailUserGroups": [
    ],
  • "disableSubmissions": false,
  • "disableUserReg": true,
  • "disciplines": "0",
  • "doiCreationTime": "copyEditCreationTime",
  • "doiIssueSuffixPattern": "string",
  • "doiPrefix": "string",
  • "doiPublicationSuffixPattern": "string",
  • "doiRepresentationSuffixPattern": "string",
  • "doiSuffixType": "default",
  • "doiVersioning": false,
  • "editorialStatsEmail": true,
  • "editorialTeam": {
    },
  • "emailSignature": "string",
  • "enableAnnouncements": true,
  • "enableClockss": true,
  • "enableDois": true,
  • "enableGeoUsageStats": "disabled",
  • "enableInstitutionUsageStats": false,
  • "enableLockss": true,
  • "enableOai": 1,
  • "enableOpenAccessNotification": true,
  • "enablePublisherId": [
    ],
  • "enableSubscriptionOnlinePaymentNotificationPurchaseIndividual": true,
  • "enableSubscriptionOnlinePaymentNotificationPurchaseInstitutional": true,
  • "enableSubscriptionOnlinePaymentNotificationRenewIndividual": true,
  • "enableSubscriptionOnlinePaymentNotificationRenewInstitutional": true,
  • "enabled": true,
  • "enabledDoiTypes": [
    ],
  • "envelopeSender": "string",
  • "favicon": {
    },
  • "forTheEditorsHelp": {
    },
  • "homepageImage": {
    },
  • "isSushiApiPublic": true,
  • "itemsPerPage": 25,
  • "journalThumbnail": {
    },
  • "keywords": "0",
  • "languages": "0",
  • "librarianInformation": {
    },
  • "licenseTerms": {
    },
  • "licenseUrl": "string",
  • "lockssLicense": {
    },
  • "mailingAddress": "string",
  • "membershipFee": 0,
  • "membershipFeeDescription": {
    },
  • "membershipFeeName": {
    },
  • "name": {
    },
  • "notifyAllAuthors": true,
  • "numAnnouncementsHomepage": 0,
  • "numDaysBeforeInviteReminder": 0,
  • "numDaysBeforeSubmitReminder": 0,
  • "numMonthsAfterSubscriptionExpiryReminder": 0,
  • "numMonthsBeforeSubscriptionExpiryReminder": 0,
  • "numPageLinks": 10,
  • "numWeeksAfterSubscriptionExpiryReminder": 0,
  • "numWeeksBeforeSubscriptionExpiryReminder": 0,
  • "numWeeksPerResponse": 4,
  • "numWeeksPerReview": 4,
  • "onlineIssn": "string",
  • "openAccessPolicy": {
    },
  • "pageFooter": {
    },
  • "pageHeaderLogoImage": {
    },
  • "paymentPluginName": "string",
  • "paymentsEnabled": true,
  • "primaryLocale": "string",
  • "printIssn": "string",
  • "privacyStatement": {
    },
  • "publicationFee": 0,
  • "publicationFeeDescription": {
    },
  • "publicationFeeName": {
    },
  • "publisherInstitution": "string",
  • "publishingMode": 0,
  • "purchaseArticleFee": 0,
  • "purchaseArticleFeeDescription": {
    },
  • "purchaseArticleFeeEnabled": true,
  • "purchaseArticleFeeName": {
    },
  • "purchaseIssueFee": 0,
  • "purchaseIssueFeeEnabled": true,
  • "rateReviewerOnQuality": true,
  • "readerInformation": {
    },
  • "registrationAgency": "",
  • "restrictArticleAccess": true,
  • "restrictOnlyPdf": true,
  • "restrictReviewerFileAccess": true,
  • "restrictSiteAccess": true,
  • "reviewGuidelines": {
    },
  • "reviewHelp": {
    },
  • "reviewerAccessKeysEnabled": true,
  • "rights": "0",
  • "searchDescription": {
    },
  • "seq": 0,
  • "showEnsuringLink": true,
  • "sidebar": [
    ],
  • "source": "0",
  • "styleSheet": {
    },
  • "subjects": "0",
  • "submissionAcknowledgement": "",
  • "submissionChecklist": {
    },
  • "submissionFee": 0,
  • "submissionFeeDescription": {
    },
  • "submissionFeeName": {
    },
  • "submitWithCategories": false,
  • "subscriptionAdditionalInformation": {
    },
  • "subscriptionEmail": "string",
  • "subscriptionExpiryPartial": true,
  • "subscriptionMailingAddress": "string",
  • "subscriptionName": "string",
  • "subscriptionPhone": "string",
  • "supportEmail": "string",
  • "supportName": "string",
  • "supportPhone": "string",
  • "supportedFormLocales": [
    ],
  • "supportedLocales": [
    ],
  • "supportedSubmissionLocales": [
    ],
  • "themePluginPath": "default",
  • "timeFormat": {
    },
  • "type": "0",
  • "uploadFilesHelp": {
    },
  • "urlPath": "string"
}

Response samples

Content type
application/json
{
  • "_href": "http://example.com",
  • "abbreviation": {
    },
  • "about": {
    },
  • "acronym": {
    },
  • "additionalHomeContent": {
    },
  • "agencies": "0",
  • "announcementsIntroduction": {
    },
  • "authorGuidelines": {
    },
  • "authorInformation": {
    },
  • "automaticDoiDeposit": true,
  • "beginSubmissionHelp": {
    },
  • "citations": "0",
  • "clockssLicense": {
    },
  • "competingInterests": {
    },
  • "contactAffiliation": {
    },
  • "contactEmail": "string",
  • "contactName": "string",
  • "contactPhone": "string",
  • "contributorsHelp": {
    },
  • "copySubmissionAckAddress": "",
  • "copySubmissionAckPrimaryContact": false,
  • "copyrightHolderOther": {
    },
  • "copyrightHolderType": "author",
  • "copyrightNotice": {
    },
  • "copyrightYearBasis": "issue",
  • "country": "string",
  • "coverage": "0",
  • "currency": "string",
  • "currentIssueId": 0,
  • "customHeaders": {
    },
  • "dataAvailability": "0",
  • "dateFormatLong": {
    },
  • "dateFormatShort": {
    },
  • "datetimeFormatLong": {
    },
  • "datetimeFormatShort": {
    },
  • "defaultMetricType": "string",
  • "defaultReviewMode": 1,
  • "delayedOpenAccessDuration": 0,
  • "delayedOpenAccessPolicy": {
    },
  • "description": {
    },
  • "detailsHelp": {
    },
  • "disableBulkEmailUserGroups": [
    ],
  • "disableSubmissions": false,
  • "disableUserReg": true,
  • "disciplines": "0",
  • "doiCreationTime": "copyEditCreationTime",
  • "doiIssueSuffixPattern": "string",
  • "doiPrefix": "string",
  • "doiPublicationSuffixPattern": "string",
  • "doiRepresentationSuffixPattern": "string",
  • "doiSuffixType": "default",
  • "doiVersioning": false,
  • "editorialStatsEmail": true,
  • "editorialTeam": {
    },
  • "emailSignature": "string",
  • "enableAnnouncements": true,
  • "enableClockss": true,
  • "enableDois": true,
  • "enableGeoUsageStats": "disabled",
  • "enableInstitutionUsageStats": false,
  • "enableLockss": true,
  • "enableOai": 1,
  • "enableOpenAccessNotification": true,
  • "enablePublisherId": [
    ],
  • "enableSubscriptionOnlinePaymentNotificationPurchaseIndividual": true,
  • "enableSubscriptionOnlinePaymentNotificationPurchaseInstitutional": true,
  • "enableSubscriptionOnlinePaymentNotificationRenewIndividual": true,
  • "enableSubscriptionOnlinePaymentNotificationRenewInstitutional": true,
  • "enabled": true,
  • "enabledDoiTypes": [
    ],
  • "envelopeSender": "string",
  • "favicon": {
    },
  • "forTheEditorsHelp": {
    },
  • "homepageImage": {
    },
  • "id": 0,
  • "isSushiApiPublic": true,
  • "itemsPerPage": 25,
  • "journalThumbnail": {
    },
  • "keywords": "0",
  • "languages": "0",
  • "librarianInformation": {
    },
  • "licenseTerms": {
    },
  • "licenseUrl": "string",
  • "lockssLicense": {
    },
  • "mailingAddress": "string",
  • "membershipFee": 0,
  • "membershipFeeDescription": {
    },
  • "membershipFeeName": {
    },
  • "name": {
    },
  • "notifyAllAuthors": true,
  • "numAnnouncementsHomepage": 0,
  • "numDaysBeforeInviteReminder": 0,
  • "numDaysBeforeSubmitReminder": 0,
  • "numMonthsAfterSubscriptionExpiryReminder": 0,
  • "numMonthsBeforeSubscriptionExpiryReminder": 0,
  • "numPageLinks": 10,
  • "numWeeksAfterSubscriptionExpiryReminder": 0,
  • "numWeeksBeforeSubscriptionExpiryReminder": 0,
  • "numWeeksPerResponse": 4,
  • "numWeeksPerReview": 4,
  • "onlineIssn": "string",
  • "openAccessPolicy": {
    },
  • "pageFooter": {
    },
  • "pageHeaderLogoImage": {
    },
  • "paymentPluginName": "string",
  • "paymentsEnabled": true,
  • "primaryLocale": "string",
  • "printIssn": "string",
  • "privacyStatement": {
    },
  • "publicationFee": 0,
  • "publicationFeeDescription": {
    },
  • "publicationFeeName": {
    },
  • "publisherInstitution": "string",
  • "publishingMode": 0,
  • "purchaseArticleFee": 0,
  • "purchaseArticleFeeDescription": {
    },
  • "purchaseArticleFeeEnabled": true,
  • "purchaseArticleFeeName": {
    },
  • "purchaseIssueFee": 0,
  • "purchaseIssueFeeEnabled": true,
  • "rateReviewerOnQuality": true,
  • "readerInformation": {
    },
  • "registrationAgency": "",
  • "restrictArticleAccess": true,
  • "restrictOnlyPdf": true,
  • "restrictReviewerFileAccess": true,
  • "restrictSiteAccess": true,
  • "reviewGuidelines": {
    },
  • "reviewHelp": {
    },
  • "reviewerAccessKeysEnabled": true,
  • "rights": "0",
  • "searchDescription": {
    },
  • "seq": 0,
  • "showEnsuringLink": true,
  • "sidebar": [
    ],
  • "source": "0",
  • "styleSheet": {
    },
  • "subjects": "0",
  • "submissionAcknowledgement": "",
  • "submissionChecklist": {
    },
  • "submissionFee": 0,
  • "submissionFeeDescription": {
    },
  • "submissionFeeName": {
    },
  • "submitWithCategories": false,
  • "subscriptionAdditionalInformation": {
    },
  • "subscriptionEmail": "string",
  • "subscriptionExpiryPartial": true,
  • "subscriptionMailingAddress": "string",
  • "subscriptionName": "string",
  • "subscriptionPhone": "string",
  • "supportEmail": "string",
  • "supportName": "string",
  • "supportPhone": "string",
  • "supportedFormLocales": [
    ],
  • "supportedLocales": [
    ],
  • "supportedSubmissionLocales": [
    ],
  • "themePluginPath": "default",
  • "timeFormat": {
    },
  • "type": "0",
  • "uploadFilesHelp": {
    },
  • "url": "string",
  • "urlPath": "string"
}

Get a context.

path Parameters
contextId
required
integer

Context ID

+

Request samples

Content type
application/json
{
  • "abbreviation": {
    },
  • "about": {
    },
  • "acronym": {
    },
  • "additionalHomeContent": {
    },
  • "agencies": "0",
  • "announcementsIntroduction": {
    },
  • "authorGuidelines": {
    },
  • "authorInformation": {
    },
  • "automaticDoiDeposit": true,
  • "beginSubmissionHelp": {
    },
  • "citations": "0",
  • "clockssLicense": {
    },
  • "competingInterests": {
    },
  • "contactAffiliation": {
    },
  • "contactEmail": "string",
  • "contactName": "string",
  • "contactPhone": "string",
  • "contributorsHelp": {
    },
  • "copySubmissionAckAddress": "",
  • "copySubmissionAckPrimaryContact": false,
  • "copyrightHolderOther": {
    },
  • "copyrightHolderType": "author",
  • "copyrightNotice": {
    },
  • "copyrightYearBasis": "issue",
  • "country": "string",
  • "coverage": "0",
  • "currency": "string",
  • "currentIssueId": 0,
  • "customHeaders": {
    },
  • "dataAvailability": "0",
  • "dateFormatLong": {
    },
  • "dateFormatShort": {
    },
  • "datetimeFormatLong": {
    },
  • "datetimeFormatShort": {
    },
  • "defaultMetricType": "string",
  • "defaultReviewMode": 1,
  • "delayedOpenAccessDuration": 0,
  • "delayedOpenAccessPolicy": {
    },
  • "description": {
    },
  • "detailsHelp": {
    },
  • "disableBulkEmailUserGroups": [
    ],
  • "disableSubmissions": false,
  • "disableUserReg": true,
  • "disciplines": "0",
  • "doiCreationTime": "copyEditCreationTime",
  • "doiIssueSuffixPattern": "string",
  • "doiPrefix": "string",
  • "doiPublicationSuffixPattern": "string",
  • "doiRepresentationSuffixPattern": "string",
  • "doiSuffixType": "default",
  • "doiVersioning": false,
  • "editorialStatsEmail": true,
  • "editorialTeam": {
    },
  • "emailSignature": "string",
  • "enableAnnouncements": true,
  • "enableClockss": true,
  • "enableDois": true,
  • "enableGeoUsageStats": "disabled",
  • "enableInstitutionUsageStats": false,
  • "enableLockss": true,
  • "enableOai": 1,
  • "enableOpenAccessNotification": true,
  • "enablePublisherId": [
    ],
  • "enableSubscriptionOnlinePaymentNotificationPurchaseIndividual": true,
  • "enableSubscriptionOnlinePaymentNotificationPurchaseInstitutional": true,
  • "enableSubscriptionOnlinePaymentNotificationRenewIndividual": true,
  • "enableSubscriptionOnlinePaymentNotificationRenewInstitutional": true,
  • "enabled": true,
  • "enabledDoiTypes": [
    ],
  • "envelopeSender": "string",
  • "favicon": {
    },
  • "forTheEditorsHelp": {
    },
  • "homepageImage": {
    },
  • "isSushiApiPublic": true,
  • "itemsPerPage": 25,
  • "journalThumbnail": {
    },
  • "keywords": "0",
  • "languages": "0",
  • "librarianInformation": {
    },
  • "licenseTerms": {
    },
  • "licenseUrl": "string",
  • "lockssLicense": {
    },
  • "mailingAddress": "string",
  • "membershipFee": 0,
  • "membershipFeeDescription": {
    },
  • "membershipFeeName": {
    },
  • "name": {
    },
  • "notifyAllAuthors": true,
  • "numAnnouncementsHomepage": 0,
  • "numDaysBeforeInviteReminder": 0,
  • "numDaysBeforeSubmitReminder": 0,
  • "numMonthsAfterSubscriptionExpiryReminder": 0,
  • "numMonthsBeforeSubscriptionExpiryReminder": 0,
  • "numPageLinks": 10,
  • "numWeeksAfterSubscriptionExpiryReminder": 0,
  • "numWeeksBeforeSubscriptionExpiryReminder": 0,
  • "numWeeksPerResponse": 4,
  • "numWeeksPerReview": 4,
  • "onlineIssn": "string",
  • "openAccessPolicy": {
    },
  • "pageFooter": {
    },
  • "pageHeaderLogoImage": {
    },
  • "paymentPluginName": "string",
  • "paymentsEnabled": true,
  • "primaryLocale": "string",
  • "printIssn": "string",
  • "privacyStatement": {
    },
  • "publicationFee": 0,
  • "publicationFeeDescription": {
    },
  • "publicationFeeName": {
    },
  • "publisherInstitution": "string",
  • "publisherUrl": "string",
  • "publishingMode": 0,
  • "purchaseArticleFee": 0,
  • "purchaseArticleFeeDescription": {
    },
  • "purchaseArticleFeeEnabled": true,
  • "purchaseArticleFeeName": {
    },
  • "purchaseIssueFee": 0,
  • "purchaseIssueFeeEnabled": true,
  • "rateReviewerOnQuality": true,
  • "readerInformation": {
    },
  • "registrationAgency": "",
  • "requireAuthorCompetingInterests": true,
  • "restrictArticleAccess": true,
  • "restrictOnlyPdf": true,
  • "restrictReviewerFileAccess": true,
  • "restrictSiteAccess": true,
  • "reviewGuidelines": {
    },
  • "reviewHelp": {
    },
  • "reviewerAccessKeysEnabled": true,
  • "rights": "0",
  • "searchDescription": {
    },
  • "seq": 0,
  • "showEnsuringLink": true,
  • "sidebar": [
    ],
  • "source": "0",
  • "styleSheet": {
    },
  • "subjects": "0",
  • "submissionAcknowledgement": "",
  • "submissionChecklist": {
    },
  • "submissionFee": 0,
  • "submissionFeeDescription": {
    },
  • "submissionFeeName": {
    },
  • "submitWithCategories": false,
  • "subscriptionAdditionalInformation": {
    },
  • "subscriptionEmail": "string",
  • "subscriptionExpiryPartial": true,
  • "subscriptionMailingAddress": "string",
  • "subscriptionName": "string",
  • "subscriptionPhone": "string",
  • "supportEmail": "string",
  • "supportName": "string",
  • "supportPhone": "string",
  • "supportedFormLocales": [
    ],
  • "supportedLocales": [
    ],
  • "supportedSubmissionLocales": [
    ],
  • "themePluginPath": "default",
  • "timeFormat": {
    },
  • "type": "0",
  • "uploadFilesHelp": {
    },
  • "urlPath": "string"
}

Response samples

Content type
application/json
{
  • "_href": "http://example.com",
  • "abbreviation": {
    },
  • "about": {
    },
  • "acronym": {
    },
  • "additionalHomeContent": {
    },
  • "agencies": "0",
  • "announcementsIntroduction": {
    },
  • "authorGuidelines": {
    },
  • "authorInformation": {
    },
  • "automaticDoiDeposit": true,
  • "beginSubmissionHelp": {
    },
  • "citations": "0",
  • "clockssLicense": {
    },
  • "competingInterests": {
    },
  • "contactAffiliation": {
    },
  • "contactEmail": "string",
  • "contactName": "string",
  • "contactPhone": "string",
  • "contributorsHelp": {
    },
  • "copySubmissionAckAddress": "",
  • "copySubmissionAckPrimaryContact": false,
  • "copyrightHolderOther": {
    },
  • "copyrightHolderType": "author",
  • "copyrightNotice": {
    },
  • "copyrightYearBasis": "issue",
  • "country": "string",
  • "coverage": "0",
  • "currency": "string",
  • "currentIssueId": 0,
  • "customHeaders": {
    },
  • "dataAvailability": "0",
  • "dateFormatLong": {
    },
  • "dateFormatShort": {
    },
  • "datetimeFormatLong": {
    },
  • "datetimeFormatShort": {
    },
  • "defaultMetricType": "string",
  • "defaultReviewMode": 1,
  • "delayedOpenAccessDuration": 0,
  • "delayedOpenAccessPolicy": {
    },
  • "description": {
    },
  • "detailsHelp": {
    },
  • "disableBulkEmailUserGroups": [
    ],
  • "disableSubmissions": false,
  • "disableUserReg": true,
  • "disciplines": "0",
  • "doiCreationTime": "copyEditCreationTime",
  • "doiIssueSuffixPattern": "string",
  • "doiPrefix": "string",
  • "doiPublicationSuffixPattern": "string",
  • "doiRepresentationSuffixPattern": "string",
  • "doiSuffixType": "default",
  • "doiVersioning": false,
  • "editorialStatsEmail": true,
  • "editorialTeam": {
    },
  • "emailSignature": "string",
  • "enableAnnouncements": true,
  • "enableClockss": true,
  • "enableDois": true,
  • "enableGeoUsageStats": "disabled",
  • "enableInstitutionUsageStats": false,
  • "enableLockss": true,
  • "enableOai": 1,
  • "enableOpenAccessNotification": true,
  • "enablePublisherId": [
    ],
  • "enableSubscriptionOnlinePaymentNotificationPurchaseIndividual": true,
  • "enableSubscriptionOnlinePaymentNotificationPurchaseInstitutional": true,
  • "enableSubscriptionOnlinePaymentNotificationRenewIndividual": true,
  • "enableSubscriptionOnlinePaymentNotificationRenewInstitutional": true,
  • "enabled": true,
  • "enabledDoiTypes": [
    ],
  • "envelopeSender": "string",
  • "favicon": {
    },
  • "forTheEditorsHelp": {
    },
  • "homepageImage": {
    },
  • "id": 0,
  • "isSushiApiPublic": true,
  • "itemsPerPage": 25,
  • "journalThumbnail": {
    },
  • "keywords": "0",
  • "languages": "0",
  • "librarianInformation": {
    },
  • "licenseTerms": {
    },
  • "licenseUrl": "string",
  • "lockssLicense": {
    },
  • "mailingAddress": "string",
  • "membershipFee": 0,
  • "membershipFeeDescription": {
    },
  • "membershipFeeName": {
    },
  • "name": {
    },
  • "notifyAllAuthors": true,
  • "numAnnouncementsHomepage": 0,
  • "numDaysBeforeInviteReminder": 0,
  • "numDaysBeforeSubmitReminder": 0,
  • "numMonthsAfterSubscriptionExpiryReminder": 0,
  • "numMonthsBeforeSubscriptionExpiryReminder": 0,
  • "numPageLinks": 10,
  • "numWeeksAfterSubscriptionExpiryReminder": 0,
  • "numWeeksBeforeSubscriptionExpiryReminder": 0,
  • "numWeeksPerResponse": 4,
  • "numWeeksPerReview": 4,
  • "onlineIssn": "string",
  • "openAccessPolicy": {
    },
  • "pageFooter": {
    },
  • "pageHeaderLogoImage": {
    },
  • "paymentPluginName": "string",
  • "paymentsEnabled": true,
  • "primaryLocale": "string",
  • "printIssn": "string",
  • "privacyStatement": {
    },
  • "publicationFee": 0,
  • "publicationFeeDescription": {
    },
  • "publicationFeeName": {
    },
  • "publisherInstitution": "string",
  • "publisherUrl": "string",
  • "publishingMode": 0,
  • "purchaseArticleFee": 0,
  • "purchaseArticleFeeDescription": {
    },
  • "purchaseArticleFeeEnabled": true,
  • "purchaseArticleFeeName": {
    },
  • "purchaseIssueFee": 0,
  • "purchaseIssueFeeEnabled": true,
  • "rateReviewerOnQuality": true,
  • "readerInformation": {
    },
  • "registrationAgency": "",
  • "requireAuthorCompetingInterests": true,
  • "restrictArticleAccess": true,
  • "restrictOnlyPdf": true,
  • "restrictReviewerFileAccess": true,
  • "restrictSiteAccess": true,
  • "reviewGuidelines": {
    },
  • "reviewHelp": {
    },
  • "reviewerAccessKeysEnabled": true,
  • "rights": "0",
  • "searchDescription": {
    },
  • "seq": 0,
  • "showEnsuringLink": true,
  • "sidebar": [
    ],
  • "source": "0",
  • "styleSheet": {
    },
  • "subjects": "0",
  • "submissionAcknowledgement": "",
  • "submissionChecklist": {
    },
  • "submissionFee": 0,
  • "submissionFeeDescription": {
    },
  • "submissionFeeName": {
    },
  • "submitWithCategories": false,
  • "subscriptionAdditionalInformation": {
    },
  • "subscriptionEmail": "string",
  • "subscriptionExpiryPartial": true,
  • "subscriptionMailingAddress": "string",
  • "subscriptionName": "string",
  • "subscriptionPhone": "string",
  • "supportEmail": "string",
  • "supportName": "string",
  • "supportPhone": "string",
  • "supportedFormLocales": [
    ],
  • "supportedLocales": [
    ],
  • "supportedSubmissionLocales": [
    ],
  • "themePluginPath": "default",
  • "timeFormat": {
    },
  • "type": "0",
  • "uploadFilesHelp": {
    },
  • "url": "string",
  • "urlPath": "string"
}

Get a context.

path Parameters
contextId
required
integer

Context ID

Responses

Response samples

Content type
application/json
{
  • "_href": "http://example.com",
  • "abbreviation": {
    },
  • "about": {
    },
  • "acronym": {
    },
  • "additionalHomeContent": {
    },
  • "agencies": "0",
  • "announcementsIntroduction": {
    },
  • "authorGuidelines": {
    },
  • "authorInformation": {
    },
  • "automaticDoiDeposit": true,
  • "beginSubmissionHelp": {
    },
  • "citations": "0",
  • "clockssLicense": {
    },
  • "competingInterests": {
    },
  • "contactAffiliation": {
    },
  • "contactEmail": "string",
  • "contactName": "string",
  • "contactPhone": "string",
  • "contributorsHelp": {
    },
  • "copySubmissionAckAddress": "",
  • "copySubmissionAckPrimaryContact": false,
  • "copyrightHolderOther": {
    },
  • "copyrightHolderType": "author",
  • "copyrightNotice": {
    },
  • "copyrightYearBasis": "issue",
  • "country": "string",
  • "coverage": "0",
  • "currency": "string",
  • "currentIssueId": 0,
  • "customHeaders": {
    },
  • "dataAvailability": "0",
  • "dateFormatLong": {
    },
  • "dateFormatShort": {
    },
  • "datetimeFormatLong": {
    },
  • "datetimeFormatShort": {
    },
  • "defaultMetricType": "string",
  • "defaultReviewMode": 1,
  • "delayedOpenAccessDuration": 0,
  • "delayedOpenAccessPolicy": {
    },
  • "description": {
    },
  • "detailsHelp": {
    },
  • "disableBulkEmailUserGroups": [
    ],
  • "disableSubmissions": false,
  • "disableUserReg": true,
  • "disciplines": "0",
  • "doiCreationTime": "copyEditCreationTime",
  • "doiIssueSuffixPattern": "string",
  • "doiPrefix": "string",
  • "doiPublicationSuffixPattern": "string",
  • "doiRepresentationSuffixPattern": "string",
  • "doiSuffixType": "default",
  • "doiVersioning": false,
  • "editorialStatsEmail": true,
  • "editorialTeam": {
    },
  • "emailSignature": "string",
  • "enableAnnouncements": true,
  • "enableClockss": true,
  • "enableDois": true,
  • "enableGeoUsageStats": "disabled",
  • "enableInstitutionUsageStats": false,
  • "enableLockss": true,
  • "enableOai": 1,
  • "enableOpenAccessNotification": true,
  • "enablePublisherId": [
    ],
  • "enableSubscriptionOnlinePaymentNotificationPurchaseIndividual": true,
  • "enableSubscriptionOnlinePaymentNotificationPurchaseInstitutional": true,
  • "enableSubscriptionOnlinePaymentNotificationRenewIndividual": true,
  • "enableSubscriptionOnlinePaymentNotificationRenewInstitutional": true,
  • "enabled": true,
  • "enabledDoiTypes": [
    ],
  • "envelopeSender": "string",
  • "favicon": {
    },
  • "forTheEditorsHelp": {
    },
  • "homepageImage": {
    },
  • "id": 0,
  • "isSushiApiPublic": true,
  • "itemsPerPage": 25,
  • "journalThumbnail": {
    },
  • "keywords": "0",
  • "languages": "0",
  • "librarianInformation": {
    },
  • "licenseTerms": {
    },
  • "licenseUrl": "string",
  • "lockssLicense": {
    },
  • "mailingAddress": "string",
  • "membershipFee": 0,
  • "membershipFeeDescription": {
    },
  • "membershipFeeName": {
    },
  • "name": {
    },
  • "notifyAllAuthors": true,
  • "numAnnouncementsHomepage": 0,
  • "numDaysBeforeInviteReminder": 0,
  • "numDaysBeforeSubmitReminder": 0,
  • "numMonthsAfterSubscriptionExpiryReminder": 0,
  • "numMonthsBeforeSubscriptionExpiryReminder": 0,
  • "numPageLinks": 10,
  • "numWeeksAfterSubscriptionExpiryReminder": 0,
  • "numWeeksBeforeSubscriptionExpiryReminder": 0,
  • "numWeeksPerResponse": 4,
  • "numWeeksPerReview": 4,
  • "onlineIssn": "string",
  • "openAccessPolicy": {
    },
  • "pageFooter": {
    },
  • "pageHeaderLogoImage": {
    },
  • "paymentPluginName": "string",
  • "paymentsEnabled": true,
  • "primaryLocale": "string",
  • "printIssn": "string",
  • "privacyStatement": {
    },
  • "publicationFee": 0,
  • "publicationFeeDescription": {
    },
  • "publicationFeeName": {
    },
  • "publisherInstitution": "string",
  • "publishingMode": 0,
  • "purchaseArticleFee": 0,
  • "purchaseArticleFeeDescription": {
    },
  • "purchaseArticleFeeEnabled": true,
  • "purchaseArticleFeeName": {
    },
  • "purchaseIssueFee": 0,
  • "purchaseIssueFeeEnabled": true,
  • "rateReviewerOnQuality": true,
  • "readerInformation": {
    },
  • "registrationAgency": "",
  • "restrictArticleAccess": true,
  • "restrictOnlyPdf": true,
  • "restrictReviewerFileAccess": true,
  • "restrictSiteAccess": true,
  • "reviewGuidelines": {
    },
  • "reviewHelp": {
    },
  • "reviewerAccessKeysEnabled": true,
  • "rights": "0",
  • "searchDescription": {
    },
  • "seq": 0,
  • "showEnsuringLink": true,
  • "sidebar": [
    ],
  • "source": "0",
  • "styleSheet": {
    },
  • "subjects": "0",
  • "submissionAcknowledgement": "",
  • "submissionChecklist": {
    },
  • "submissionFee": 0,
  • "submissionFeeDescription": {
    },
  • "submissionFeeName": {
    },
  • "submitWithCategories": false,
  • "subscriptionAdditionalInformation": {
    },
  • "subscriptionEmail": "string",
  • "subscriptionExpiryPartial": true,
  • "subscriptionMailingAddress": "string",
  • "subscriptionName": "string",
  • "subscriptionPhone": "string",
  • "supportEmail": "string",
  • "supportName": "string",
  • "supportPhone": "string",
  • "supportedFormLocales": [
    ],
  • "supportedLocales": [
    ],
  • "supportedSubmissionLocales": [
    ],
  • "themePluginPath": "default",
  • "timeFormat": {
    },
  • "type": "0",
  • "uploadFilesHelp": {
    },
  • "url": "string",
  • "urlPath": "string"
}

Edit a context.

Edit a journal (OJS), press (OMP) or preprint server (OPS).

+

Response samples

Content type
application/json
{
  • "_href": "http://example.com",
  • "abbreviation": {
    },
  • "about": {
    },
  • "acronym": {
    },
  • "additionalHomeContent": {
    },
  • "agencies": "0",
  • "announcementsIntroduction": {
    },
  • "authorGuidelines": {
    },
  • "authorInformation": {
    },
  • "automaticDoiDeposit": true,
  • "beginSubmissionHelp": {
    },
  • "citations": "0",
  • "clockssLicense": {
    },
  • "competingInterests": {
    },
  • "contactAffiliation": {
    },
  • "contactEmail": "string",
  • "contactName": "string",
  • "contactPhone": "string",
  • "contributorsHelp": {
    },
  • "copySubmissionAckAddress": "",
  • "copySubmissionAckPrimaryContact": false,
  • "copyrightHolderOther": {
    },
  • "copyrightHolderType": "author",
  • "copyrightNotice": {
    },
  • "copyrightYearBasis": "issue",
  • "country": "string",
  • "coverage": "0",
  • "currency": "string",
  • "currentIssueId": 0,
  • "customHeaders": {
    },
  • "dataAvailability": "0",
  • "dateFormatLong": {
    },
  • "dateFormatShort": {
    },
  • "datetimeFormatLong": {
    },
  • "datetimeFormatShort": {
    },
  • "defaultMetricType": "string",
  • "defaultReviewMode": 1,
  • "delayedOpenAccessDuration": 0,
  • "delayedOpenAccessPolicy": {
    },
  • "description": {
    },
  • "detailsHelp": {
    },
  • "disableBulkEmailUserGroups": [
    ],
  • "disableSubmissions": false,
  • "disableUserReg": true,
  • "disciplines": "0",
  • "doiCreationTime": "copyEditCreationTime",
  • "doiIssueSuffixPattern": "string",
  • "doiPrefix": "string",
  • "doiPublicationSuffixPattern": "string",
  • "doiRepresentationSuffixPattern": "string",
  • "doiSuffixType": "default",
  • "doiVersioning": false,
  • "editorialStatsEmail": true,
  • "editorialTeam": {
    },
  • "emailSignature": "string",
  • "enableAnnouncements": true,
  • "enableClockss": true,
  • "enableDois": true,
  • "enableGeoUsageStats": "disabled",
  • "enableInstitutionUsageStats": false,
  • "enableLockss": true,
  • "enableOai": 1,
  • "enableOpenAccessNotification": true,
  • "enablePublisherId": [
    ],
  • "enableSubscriptionOnlinePaymentNotificationPurchaseIndividual": true,
  • "enableSubscriptionOnlinePaymentNotificationPurchaseInstitutional": true,
  • "enableSubscriptionOnlinePaymentNotificationRenewIndividual": true,
  • "enableSubscriptionOnlinePaymentNotificationRenewInstitutional": true,
  • "enabled": true,
  • "enabledDoiTypes": [
    ],
  • "envelopeSender": "string",
  • "favicon": {
    },
  • "forTheEditorsHelp": {
    },
  • "homepageImage": {
    },
  • "id": 0,
  • "isSushiApiPublic": true,
  • "itemsPerPage": 25,
  • "journalThumbnail": {
    },
  • "keywords": "0",
  • "languages": "0",
  • "librarianInformation": {
    },
  • "licenseTerms": {
    },
  • "licenseUrl": "string",
  • "lockssLicense": {
    },
  • "mailingAddress": "string",
  • "membershipFee": 0,
  • "membershipFeeDescription": {
    },
  • "membershipFeeName": {
    },
  • "name": {
    },
  • "notifyAllAuthors": true,
  • "numAnnouncementsHomepage": 0,
  • "numDaysBeforeInviteReminder": 0,
  • "numDaysBeforeSubmitReminder": 0,
  • "numMonthsAfterSubscriptionExpiryReminder": 0,
  • "numMonthsBeforeSubscriptionExpiryReminder": 0,
  • "numPageLinks": 10,
  • "numWeeksAfterSubscriptionExpiryReminder": 0,
  • "numWeeksBeforeSubscriptionExpiryReminder": 0,
  • "numWeeksPerResponse": 4,
  • "numWeeksPerReview": 4,
  • "onlineIssn": "string",
  • "openAccessPolicy": {
    },
  • "pageFooter": {
    },
  • "pageHeaderLogoImage": {
    },
  • "paymentPluginName": "string",
  • "paymentsEnabled": true,
  • "primaryLocale": "string",
  • "printIssn": "string",
  • "privacyStatement": {
    },
  • "publicationFee": 0,
  • "publicationFeeDescription": {
    },
  • "publicationFeeName": {
    },
  • "publisherInstitution": "string",
  • "publisherUrl": "string",
  • "publishingMode": 0,
  • "purchaseArticleFee": 0,
  • "purchaseArticleFeeDescription": {
    },
  • "purchaseArticleFeeEnabled": true,
  • "purchaseArticleFeeName": {
    },
  • "purchaseIssueFee": 0,
  • "purchaseIssueFeeEnabled": true,
  • "rateReviewerOnQuality": true,
  • "readerInformation": {
    },
  • "registrationAgency": "",
  • "requireAuthorCompetingInterests": true,
  • "restrictArticleAccess": true,
  • "restrictOnlyPdf": true,
  • "restrictReviewerFileAccess": true,
  • "restrictSiteAccess": true,
  • "reviewGuidelines": {
    },
  • "reviewHelp": {
    },
  • "reviewerAccessKeysEnabled": true,
  • "rights": "0",
  • "searchDescription": {
    },
  • "seq": 0,
  • "showEnsuringLink": true,
  • "sidebar": [
    ],
  • "source": "0",
  • "styleSheet": {
    },
  • "subjects": "0",
  • "submissionAcknowledgement": "",
  • "submissionChecklist": {
    },
  • "submissionFee": 0,
  • "submissionFeeDescription": {
    },
  • "submissionFeeName": {
    },
  • "submitWithCategories": false,
  • "subscriptionAdditionalInformation": {
    },
  • "subscriptionEmail": "string",
  • "subscriptionExpiryPartial": true,
  • "subscriptionMailingAddress": "string",
  • "subscriptionName": "string",
  • "subscriptionPhone": "string",
  • "supportEmail": "string",
  • "supportName": "string",
  • "supportPhone": "string",
  • "supportedFormLocales": [
    ],
  • "supportedLocales": [
    ],
  • "supportedSubmissionLocales": [
    ],
  • "themePluginPath": "default",
  • "timeFormat": {
    },
  • "type": "0",
  • "uploadFilesHelp": {
    },
  • "url": "string",
  • "urlPath": "string"
}

Edit a context.

Edit a journal (OJS), press (OMP) or preprint server (OPS).

path Parameters
contextId
required
integer

Context ID

Request Body schema: application/json

The details about a context that you want to edit. All params are optional. When a param is omitted, the existing value of that param will not be modified.

abbreviation
object (LocaleObject)

Key/value pairs containing data stored by locale key.

@@ -2813,7 +2816,7 @@
contactEmail
string
contactName
string
contactPhone
string
contributorsHelp
object (LocaleObject)

Key/value pairs containing data stored by locale key.

copyrightHolderOther
object (LocaleObject)

Key/value pairs containing data stored by locale key.

copyrightHolderType
string
Enum: "author" "context" "other"
copyrightNotice
object (LocaleObject)

Key/value pairs containing data stored by locale key.

-
copyrightYearBasis
string
Default: "issue"
Enum: "issue" "submission"
copySubmissionAckAddress
string
Default: ""

A copy of the submission acknowledgement email will be sent to any of the email addresses entered here. Separate multiple email addresses with a comma. Example: one@example.com,two@example.com

+
copyrightYearBasis
string
Default: "issue"
Enum: "issue" "submission"
copySubmissionAckAddress
string
Default: ""

A copy of the submission acknowledgement email will be sent to any of the email addresses entered here. Separate multiple email addresses with a comma. Example: one@example.com,two@example.com

copySubmissionAckPrimaryContact
boolean
Default: false

A copy of the submission acknowledgement email will be sent to this context's primary contact when true.

country
string
coverage
string
Enum: "0" "enable" "request" "require"

Enable coverage metadata. 0 is disabled. enable will make it available in the workflow. request will allow an author to enter a value during submission. require will require that the author enter a value during submission.

currency
string
currentIssueId
integer
customHeaders
object (LocaleObject)

Key/value pairs containing data stored by locale key.

@@ -2848,10 +2851,10 @@
object
paymentPluginName
string
paymentsEnabled
boolean
primaryLocale
string
printIssn
string
privacyStatement
object (LocaleObject)

Key/value pairs containing data stored by locale key.

publicationFee
number
Default: 0
publicationFeeDescription
object (LocaleObject)

Key/value pairs containing data stored by locale key.

publicationFeeName
object (LocaleObject)

Key/value pairs containing data stored by locale key.

-
publisherInstitution
string
publishingMode
integer
Enum: 0 1 2
purchaseArticleFee
number
Default: 0
purchaseArticleFeeDescription
object (LocaleObject)

Key/value pairs containing data stored by locale key.

+
publisherInstitution
string
publisherUrl
string
publishingMode
integer
Enum: 0 1 2
purchaseArticleFee
number
Default: 0
purchaseArticleFeeDescription
object (LocaleObject)

Key/value pairs containing data stored by locale key.

purchaseArticleFeeEnabled
boolean
purchaseArticleFeeName
object (LocaleObject)

Key/value pairs containing data stored by locale key.

purchaseIssueFee
number
purchaseIssueFeeEnabled
boolean
rateReviewerOnQuality
boolean
readerInformation
object (LocaleObject)

Key/value pairs containing data stored by locale key.

-
registrationAgency
string
Default: ""
restrictArticleAccess
boolean
restrictOnlyPdf
boolean
restrictReviewerFileAccess
boolean
restrictSiteAccess
boolean
reviewerAccessKeysEnabled
boolean
reviewGuidelines
object (LocaleObject)

Key/value pairs containing data stored by locale key.

+
registrationAgency
string
Default: ""
requireAuthorCompetingInterests
boolean
restrictArticleAccess
boolean
restrictOnlyPdf
boolean
restrictReviewerFileAccess
boolean
restrictSiteAccess
boolean
reviewerAccessKeysEnabled
boolean
reviewGuidelines
object (LocaleObject)

Key/value pairs containing data stored by locale key.

reviewHelp
object (LocaleObject)

Key/value pairs containing data stored by locale key.

rights
string
Enum: "0" "enable" "request" "require"

Enable rights metadata. 0 is disabled. enable will make it available in the workflow. request will allow an author to enter a value during submission. require will require that the author enter a value during submission.

searchDescription
object (LocaleObject)

Key/value pairs containing data stored by locale key.

@@ -2870,12 +2873,12 @@

Request samples

Content type
application/json
{
  • "abbreviation": {
    },
  • "about": {
    },
  • "acronym": {
    },
  • "additionalHomeContent": {
    },
  • "agencies": "0",
  • "announcementsIntroduction": {
    },
  • "authorGuidelines": {
    },
  • "authorInformation": {
    },
  • "automaticDoiDeposit": true,
  • "beginSubmissionHelp": {
    },
  • "citations": "0",
  • "clockssLicense": {
    },
  • "competingInterests": {
    },
  • "contactAffiliation": {
    },
  • "contactEmail": "string",
  • "contactName": "string",
  • "contactPhone": "string",
  • "contributorsHelp": {
    },
  • "copySubmissionAckAddress": "",
  • "copySubmissionAckPrimaryContact": false,
  • "copyrightHolderOther": {
    },
  • "copyrightHolderType": "author",
  • "copyrightNotice": {
    },
  • "copyrightYearBasis": "issue",
  • "country": "string",
  • "coverage": "0",
  • "currency": "string",
  • "currentIssueId": 0,
  • "customHeaders": {
    },
  • "dataAvailability": "0",
  • "dateFormatLong": {
    },
  • "dateFormatShort": {
    },
  • "datetimeFormatLong": {
    },
  • "datetimeFormatShort": {
    },
  • "defaultMetricType": "string",
  • "defaultReviewMode": 1,
  • "delayedOpenAccessDuration": 0,
  • "delayedOpenAccessPolicy": {
    },
  • "description": {
    },
  • "detailsHelp": {
    },
  • "disableBulkEmailUserGroups": [
    ],
  • "disableSubmissions": false,
  • "disableUserReg": true,
  • "disciplines": "0",
  • "doiCreationTime": "copyEditCreationTime",
  • "doiIssueSuffixPattern": "string",
  • "doiPrefix": "string",
  • "doiPublicationSuffixPattern": "string",
  • "doiRepresentationSuffixPattern": "string",
  • "doiSuffixType": "default",
  • "doiVersioning": false,
  • "editorialStatsEmail": true,
  • "editorialTeam": {
    },
  • "emailSignature": "string",
  • "enableAnnouncements": true,
  • "enableClockss": true,
  • "enableDois": true,
  • "enableGeoUsageStats": "disabled",
  • "enableInstitutionUsageStats": false,
  • "enableLockss": true,
  • "enableOai": 1,
  • "enableOpenAccessNotification": true,
  • "enablePublisherId": [
    ],
  • "enableSubscriptionOnlinePaymentNotificationPurchaseIndividual": true,
  • "enableSubscriptionOnlinePaymentNotificationPurchaseInstitutional": true,
  • "enableSubscriptionOnlinePaymentNotificationRenewIndividual": true,
  • "enableSubscriptionOnlinePaymentNotificationRenewInstitutional": true,
  • "enabled": true,
  • "enabledDoiTypes": [
    ],
  • "envelopeSender": "string",
  • "favicon": {
    },
  • "forTheEditorsHelp": {
    },
  • "homepageImage": {
    },
  • "isSushiApiPublic": true,
  • "itemsPerPage": 25,
  • "journalThumbnail": {
    },
  • "keywords": "0",
  • "languages": "0",
  • "librarianInformation": {
    },
  • "licenseTerms": {
    },
  • "licenseUrl": "string",
  • "lockssLicense": {
    },
  • "mailingAddress": "string",
  • "membershipFee": 0,
  • "membershipFeeDescription": {
    },
  • "membershipFeeName": {
    },
  • "name": {
    },
  • "notifyAllAuthors": true,
  • "numAnnouncementsHomepage": 0,
  • "numDaysBeforeInviteReminder": 0,
  • "numDaysBeforeSubmitReminder": 0,
  • "numMonthsAfterSubscriptionExpiryReminder": 0,
  • "numMonthsBeforeSubscriptionExpiryReminder": 0,
  • "numPageLinks": 10,
  • "numWeeksAfterSubscriptionExpiryReminder": 0,
  • "numWeeksBeforeSubscriptionExpiryReminder": 0,
  • "numWeeksPerResponse": 4,
  • "numWeeksPerReview": 4,
  • "onlineIssn": "string",
  • "openAccessPolicy": {
    },
  • "pageFooter": {
    },
  • "pageHeaderLogoImage": {
    },
  • "paymentPluginName": "string",
  • "paymentsEnabled": true,
  • "primaryLocale": "string",
  • "printIssn": "string",
  • "privacyStatement": {
    },
  • "publicationFee": 0,
  • "publicationFeeDescription": {
    },
  • "publicationFeeName": {
    },
  • "publisherInstitution": "string",
  • "publishingMode": 0,
  • "purchaseArticleFee": 0,
  • "purchaseArticleFeeDescription": {
    },
  • "purchaseArticleFeeEnabled": true,
  • "purchaseArticleFeeName": {
    },
  • "purchaseIssueFee": 0,
  • "purchaseIssueFeeEnabled": true,
  • "rateReviewerOnQuality": true,
  • "readerInformation": {
    },
  • "registrationAgency": "",
  • "restrictArticleAccess": true,
  • "restrictOnlyPdf": true,
  • "restrictReviewerFileAccess": true,
  • "restrictSiteAccess": true,
  • "reviewGuidelines": {
    },
  • "reviewHelp": {
    },
  • "reviewerAccessKeysEnabled": true,
  • "rights": "0",
  • "searchDescription": {
    },
  • "seq": 0,
  • "showEnsuringLink": true,
  • "sidebar": [
    ],
  • "source": "0",
  • "styleSheet": {
    },
  • "subjects": "0",
  • "submissionAcknowledgement": "",
  • "submissionChecklist": {
    },
  • "submissionFee": 0,
  • "submissionFeeDescription": {
    },
  • "submissionFeeName": {
    },
  • "submitWithCategories": false,
  • "subscriptionAdditionalInformation": {
    },
  • "subscriptionEmail": "string",
  • "subscriptionExpiryPartial": true,
  • "subscriptionMailingAddress": "string",
  • "subscriptionName": "string",
  • "subscriptionPhone": "string",
  • "supportEmail": "string",
  • "supportName": "string",
  • "supportPhone": "string",
  • "supportedFormLocales": [
    ],
  • "supportedLocales": [
    ],
  • "supportedSubmissionLocales": [
    ],
  • "themePluginPath": "default",
  • "timeFormat": {
    },
  • "type": "0",
  • "uploadFilesHelp": {
    },
  • "urlPath": "string"
}

Response samples

Content type
application/json
{
  • "_href": "http://example.com",
  • "abbreviation": {
    },
  • "about": {
    },
  • "acronym": {
    },
  • "additionalHomeContent": {
    },
  • "agencies": "0",
  • "announcementsIntroduction": {
    },
  • "authorGuidelines": {
    },
  • "authorInformation": {
    },
  • "automaticDoiDeposit": true,
  • "beginSubmissionHelp": {
    },
  • "citations": "0",
  • "clockssLicense": {
    },
  • "competingInterests": {
    },
  • "contactAffiliation": {
    },
  • "contactEmail": "string",
  • "contactName": "string",
  • "contactPhone": "string",
  • "contributorsHelp": {
    },
  • "copySubmissionAckAddress": "",
  • "copySubmissionAckPrimaryContact": false,
  • "copyrightHolderOther": {
    },
  • "copyrightHolderType": "author",
  • "copyrightNotice": {
    },
  • "copyrightYearBasis": "issue",
  • "country": "string",
  • "coverage": "0",
  • "currency": "string",
  • "currentIssueId": 0,
  • "customHeaders": {
    },
  • "dataAvailability": "0",
  • "dateFormatLong": {
    },
  • "dateFormatShort": {
    },
  • "datetimeFormatLong": {
    },
  • "datetimeFormatShort": {
    },
  • "defaultMetricType": "string",
  • "defaultReviewMode": 1,
  • "delayedOpenAccessDuration": 0,
  • "delayedOpenAccessPolicy": {
    },
  • "description": {
    },
  • "detailsHelp": {
    },
  • "disableBulkEmailUserGroups": [
    ],
  • "disableSubmissions": false,
  • "disableUserReg": true,
  • "disciplines": "0",
  • "doiCreationTime": "copyEditCreationTime",
  • "doiIssueSuffixPattern": "string",
  • "doiPrefix": "string",
  • "doiPublicationSuffixPattern": "string",
  • "doiRepresentationSuffixPattern": "string",
  • "doiSuffixType": "default",
  • "doiVersioning": false,
  • "editorialStatsEmail": true,
  • "editorialTeam": {
    },
  • "emailSignature": "string",
  • "enableAnnouncements": true,
  • "enableClockss": true,
  • "enableDois": true,
  • "enableGeoUsageStats": "disabled",
  • "enableInstitutionUsageStats": false,
  • "enableLockss": true,
  • "enableOai": 1,
  • "enableOpenAccessNotification": true,
  • "enablePublisherId": [
    ],
  • "enableSubscriptionOnlinePaymentNotificationPurchaseIndividual": true,
  • "enableSubscriptionOnlinePaymentNotificationPurchaseInstitutional": true,
  • "enableSubscriptionOnlinePaymentNotificationRenewIndividual": true,
  • "enableSubscriptionOnlinePaymentNotificationRenewInstitutional": true,
  • "enabled": true,
  • "enabledDoiTypes": [
    ],
  • "envelopeSender": "string",
  • "favicon": {
    },
  • "forTheEditorsHelp": {
    },
  • "homepageImage": {
    },
  • "id": 0,
  • "isSushiApiPublic": true,
  • "itemsPerPage": 25,
  • "journalThumbnail": {
    },
  • "keywords": "0",
  • "languages": "0",
  • "librarianInformation": {
    },
  • "licenseTerms": {
    },
  • "licenseUrl": "string",
  • "lockssLicense": {
    },
  • "mailingAddress": "string",
  • "membershipFee": 0,
  • "membershipFeeDescription": {
    },
  • "membershipFeeName": {
    },
  • "name": {
    },
  • "notifyAllAuthors": true,
  • "numAnnouncementsHomepage": 0,
  • "numDaysBeforeInviteReminder": 0,
  • "numDaysBeforeSubmitReminder": 0,
  • "numMonthsAfterSubscriptionExpiryReminder": 0,
  • "numMonthsBeforeSubscriptionExpiryReminder": 0,
  • "numPageLinks": 10,
  • "numWeeksAfterSubscriptionExpiryReminder": 0,
  • "numWeeksBeforeSubscriptionExpiryReminder": 0,
  • "numWeeksPerResponse": 4,
  • "numWeeksPerReview": 4,
  • "onlineIssn": "string",
  • "openAccessPolicy": {
    },
  • "pageFooter": {
    },
  • "pageHeaderLogoImage": {
    },
  • "paymentPluginName": "string",
  • "paymentsEnabled": true,
  • "primaryLocale": "string",
  • "printIssn": "string",
  • "privacyStatement": {
    },
  • "publicationFee": 0,
  • "publicationFeeDescription": {
    },
  • "publicationFeeName": {
    },
  • "publisherInstitution": "string",
  • "publishingMode": 0,
  • "purchaseArticleFee": 0,
  • "purchaseArticleFeeDescription": {
    },
  • "purchaseArticleFeeEnabled": true,
  • "purchaseArticleFeeName": {
    },
  • "purchaseIssueFee": 0,
  • "purchaseIssueFeeEnabled": true,
  • "rateReviewerOnQuality": true,
  • "readerInformation": {
    },
  • "registrationAgency": "",
  • "restrictArticleAccess": true,
  • "restrictOnlyPdf": true,
  • "restrictReviewerFileAccess": true,
  • "restrictSiteAccess": true,
  • "reviewGuidelines": {
    },
  • "reviewHelp": {
    },
  • "reviewerAccessKeysEnabled": true,
  • "rights": "0",
  • "searchDescription": {
    },
  • "seq": 0,
  • "showEnsuringLink": true,
  • "sidebar": [
    ],
  • "source": "0",
  • "styleSheet": {
    },
  • "subjects": "0",
  • "submissionAcknowledgement": "",
  • "submissionChecklist": {
    },
  • "submissionFee": 0,
  • "submissionFeeDescription": {
    },
  • "submissionFeeName": {
    },
  • "submitWithCategories": false,
  • "subscriptionAdditionalInformation": {
    },
  • "subscriptionEmail": "string",
  • "subscriptionExpiryPartial": true,
  • "subscriptionMailingAddress": "string",
  • "subscriptionName": "string",
  • "subscriptionPhone": "string",
  • "supportEmail": "string",
  • "supportName": "string",
  • "supportPhone": "string",
  • "supportedFormLocales": [
    ],
  • "supportedLocales": [
    ],
  • "supportedSubmissionLocales": [
    ],
  • "themePluginPath": "default",
  • "timeFormat": {
    },
  • "type": "0",
  • "uploadFilesHelp": {
    },
  • "url": "string",
  • "urlPath": "string"
}

Delete a context.

Delete a journal (OJS), press (OMP) or preprint server (OPS).

+

Request samples

Content type
application/json
{
  • "abbreviation": {
    },
  • "about": {
    },
  • "acronym": {
    },
  • "additionalHomeContent": {
    },
  • "agencies": "0",
  • "announcementsIntroduction": {
    },
  • "authorGuidelines": {
    },
  • "authorInformation": {
    },
  • "automaticDoiDeposit": true,
  • "beginSubmissionHelp": {
    },
  • "citations": "0",
  • "clockssLicense": {
    },
  • "competingInterests": {
    },
  • "contactAffiliation": {
    },
  • "contactEmail": "string",
  • "contactName": "string",
  • "contactPhone": "string",
  • "contributorsHelp": {
    },
  • "copySubmissionAckAddress": "",
  • "copySubmissionAckPrimaryContact": false,
  • "copyrightHolderOther": {
    },
  • "copyrightHolderType": "author",
  • "copyrightNotice": {
    },
  • "copyrightYearBasis": "issue",
  • "country": "string",
  • "coverage": "0",
  • "currency": "string",
  • "currentIssueId": 0,
  • "customHeaders": {
    },
  • "dataAvailability": "0",
  • "dateFormatLong": {
    },
  • "dateFormatShort": {
    },
  • "datetimeFormatLong": {
    },
  • "datetimeFormatShort": {
    },
  • "defaultMetricType": "string",
  • "defaultReviewMode": 1,
  • "delayedOpenAccessDuration": 0,
  • "delayedOpenAccessPolicy": {
    },
  • "description": {
    },
  • "detailsHelp": {
    },
  • "disableBulkEmailUserGroups": [
    ],
  • "disableSubmissions": false,
  • "disableUserReg": true,
  • "disciplines": "0",
  • "doiCreationTime": "copyEditCreationTime",
  • "doiIssueSuffixPattern": "string",
  • "doiPrefix": "string",
  • "doiPublicationSuffixPattern": "string",
  • "doiRepresentationSuffixPattern": "string",
  • "doiSuffixType": "default",
  • "doiVersioning": false,
  • "editorialStatsEmail": true,
  • "editorialTeam": {
    },
  • "emailSignature": "string",
  • "enableAnnouncements": true,
  • "enableClockss": true,
  • "enableDois": true,
  • "enableGeoUsageStats": "disabled",
  • "enableInstitutionUsageStats": false,
  • "enableLockss": true,
  • "enableOai": 1,
  • "enableOpenAccessNotification": true,
  • "enablePublisherId": [
    ],
  • "enableSubscriptionOnlinePaymentNotificationPurchaseIndividual": true,
  • "enableSubscriptionOnlinePaymentNotificationPurchaseInstitutional": true,
  • "enableSubscriptionOnlinePaymentNotificationRenewIndividual": true,
  • "enableSubscriptionOnlinePaymentNotificationRenewInstitutional": true,
  • "enabled": true,
  • "enabledDoiTypes": [
    ],
  • "envelopeSender": "string",
  • "favicon": {
    },
  • "forTheEditorsHelp": {
    },
  • "homepageImage": {
    },
  • "isSushiApiPublic": true,
  • "itemsPerPage": 25,
  • "journalThumbnail": {
    },
  • "keywords": "0",
  • "languages": "0",
  • "librarianInformation": {
    },
  • "licenseTerms": {
    },
  • "licenseUrl": "string",
  • "lockssLicense": {
    },
  • "mailingAddress": "string",
  • "membershipFee": 0,
  • "membershipFeeDescription": {
    },
  • "membershipFeeName": {
    },
  • "name": {
    },
  • "notifyAllAuthors": true,
  • "numAnnouncementsHomepage": 0,
  • "numDaysBeforeInviteReminder": 0,
  • "numDaysBeforeSubmitReminder": 0,
  • "numMonthsAfterSubscriptionExpiryReminder": 0,
  • "numMonthsBeforeSubscriptionExpiryReminder": 0,
  • "numPageLinks": 10,
  • "numWeeksAfterSubscriptionExpiryReminder": 0,
  • "numWeeksBeforeSubscriptionExpiryReminder": 0,
  • "numWeeksPerResponse": 4,
  • "numWeeksPerReview": 4,
  • "onlineIssn": "string",
  • "openAccessPolicy": {
    },
  • "pageFooter": {
    },
  • "pageHeaderLogoImage": {
    },
  • "paymentPluginName": "string",
  • "paymentsEnabled": true,
  • "primaryLocale": "string",
  • "printIssn": "string",
  • "privacyStatement": {
    },
  • "publicationFee": 0,
  • "publicationFeeDescription": {
    },
  • "publicationFeeName": {
    },
  • "publisherInstitution": "string",
  • "publisherUrl": "string",
  • "publishingMode": 0,
  • "purchaseArticleFee": 0,
  • "purchaseArticleFeeDescription": {
    },
  • "purchaseArticleFeeEnabled": true,
  • "purchaseArticleFeeName": {
    },
  • "purchaseIssueFee": 0,
  • "purchaseIssueFeeEnabled": true,
  • "rateReviewerOnQuality": true,
  • "readerInformation": {
    },
  • "registrationAgency": "",
  • "requireAuthorCompetingInterests": true,
  • "restrictArticleAccess": true,
  • "restrictOnlyPdf": true,
  • "restrictReviewerFileAccess": true,
  • "restrictSiteAccess": true,
  • "reviewGuidelines": {
    },
  • "reviewHelp": {
    },
  • "reviewerAccessKeysEnabled": true,
  • "rights": "0",
  • "searchDescription": {
    },
  • "seq": 0,
  • "showEnsuringLink": true,
  • "sidebar": [
    ],
  • "source": "0",
  • "styleSheet": {
    },
  • "subjects": "0",
  • "submissionAcknowledgement": "",
  • "submissionChecklist": {
    },
  • "submissionFee": 0,
  • "submissionFeeDescription": {
    },
  • "submissionFeeName": {
    },
  • "submitWithCategories": false,
  • "subscriptionAdditionalInformation": {
    },
  • "subscriptionEmail": "string",
  • "subscriptionExpiryPartial": true,
  • "subscriptionMailingAddress": "string",
  • "subscriptionName": "string",
  • "subscriptionPhone": "string",
  • "supportEmail": "string",
  • "supportName": "string",
  • "supportPhone": "string",
  • "supportedFormLocales": [
    ],
  • "supportedLocales": [
    ],
  • "supportedSubmissionLocales": [
    ],
  • "themePluginPath": "default",
  • "timeFormat": {
    },
  • "type": "0",
  • "uploadFilesHelp": {
    },
  • "urlPath": "string"
}

Response samples

Content type
application/json
{
  • "_href": "http://example.com",
  • "abbreviation": {
    },
  • "about": {
    },
  • "acronym": {
    },
  • "additionalHomeContent": {
    },
  • "agencies": "0",
  • "announcementsIntroduction": {
    },
  • "authorGuidelines": {
    },
  • "authorInformation": {
    },
  • "automaticDoiDeposit": true,
  • "beginSubmissionHelp": {
    },
  • "citations": "0",
  • "clockssLicense": {
    },
  • "competingInterests": {
    },
  • "contactAffiliation": {
    },
  • "contactEmail": "string",
  • "contactName": "string",
  • "contactPhone": "string",
  • "contributorsHelp": {
    },
  • "copySubmissionAckAddress": "",
  • "copySubmissionAckPrimaryContact": false,
  • "copyrightHolderOther": {
    },
  • "copyrightHolderType": "author",
  • "copyrightNotice": {
    },
  • "copyrightYearBasis": "issue",
  • "country": "string",
  • "coverage": "0",
  • "currency": "string",
  • "currentIssueId": 0,
  • "customHeaders": {
    },
  • "dataAvailability": "0",
  • "dateFormatLong": {
    },
  • "dateFormatShort": {
    },
  • "datetimeFormatLong": {
    },
  • "datetimeFormatShort": {
    },
  • "defaultMetricType": "string",
  • "defaultReviewMode": 1,
  • "delayedOpenAccessDuration": 0,
  • "delayedOpenAccessPolicy": {
    },
  • "description": {
    },
  • "detailsHelp": {
    },
  • "disableBulkEmailUserGroups": [
    ],
  • "disableSubmissions": false,
  • "disableUserReg": true,
  • "disciplines": "0",
  • "doiCreationTime": "copyEditCreationTime",
  • "doiIssueSuffixPattern": "string",
  • "doiPrefix": "string",
  • "doiPublicationSuffixPattern": "string",
  • "doiRepresentationSuffixPattern": "string",
  • "doiSuffixType": "default",
  • "doiVersioning": false,
  • "editorialStatsEmail": true,
  • "editorialTeam": {
    },
  • "emailSignature": "string",
  • "enableAnnouncements": true,
  • "enableClockss": true,
  • "enableDois": true,
  • "enableGeoUsageStats": "disabled",
  • "enableInstitutionUsageStats": false,
  • "enableLockss": true,
  • "enableOai": 1,
  • "enableOpenAccessNotification": true,
  • "enablePublisherId": [
    ],
  • "enableSubscriptionOnlinePaymentNotificationPurchaseIndividual": true,
  • "enableSubscriptionOnlinePaymentNotificationPurchaseInstitutional": true,
  • "enableSubscriptionOnlinePaymentNotificationRenewIndividual": true,
  • "enableSubscriptionOnlinePaymentNotificationRenewInstitutional": true,
  • "enabled": true,
  • "enabledDoiTypes": [
    ],
  • "envelopeSender": "string",
  • "favicon": {
    },
  • "forTheEditorsHelp": {
    },
  • "homepageImage": {
    },
  • "id": 0,
  • "isSushiApiPublic": true,
  • "itemsPerPage": 25,
  • "journalThumbnail": {
    },
  • "keywords": "0",
  • "languages": "0",
  • "librarianInformation": {
    },
  • "licenseTerms": {
    },
  • "licenseUrl": "string",
  • "lockssLicense": {
    },
  • "mailingAddress": "string",
  • "membershipFee": 0,
  • "membershipFeeDescription": {
    },
  • "membershipFeeName": {
    },
  • "name": {
    },
  • "notifyAllAuthors": true,
  • "numAnnouncementsHomepage": 0,
  • "numDaysBeforeInviteReminder": 0,
  • "numDaysBeforeSubmitReminder": 0,
  • "numMonthsAfterSubscriptionExpiryReminder": 0,
  • "numMonthsBeforeSubscriptionExpiryReminder": 0,
  • "numPageLinks": 10,
  • "numWeeksAfterSubscriptionExpiryReminder": 0,
  • "numWeeksBeforeSubscriptionExpiryReminder": 0,
  • "numWeeksPerResponse": 4,
  • "numWeeksPerReview": 4,
  • "onlineIssn": "string",
  • "openAccessPolicy": {
    },
  • "pageFooter": {
    },
  • "pageHeaderLogoImage": {
    },
  • "paymentPluginName": "string",
  • "paymentsEnabled": true,
  • "primaryLocale": "string",
  • "printIssn": "string",
  • "privacyStatement": {
    },
  • "publicationFee": 0,
  • "publicationFeeDescription": {
    },
  • "publicationFeeName": {
    },
  • "publisherInstitution": "string",
  • "publisherUrl": "string",
  • "publishingMode": 0,
  • "purchaseArticleFee": 0,
  • "purchaseArticleFeeDescription": {
    },
  • "purchaseArticleFeeEnabled": true,
  • "purchaseArticleFeeName": {
    },
  • "purchaseIssueFee": 0,
  • "purchaseIssueFeeEnabled": true,
  • "rateReviewerOnQuality": true,
  • "readerInformation": {
    },
  • "registrationAgency": "",
  • "requireAuthorCompetingInterests": true,
  • "restrictArticleAccess": true,
  • "restrictOnlyPdf": true,
  • "restrictReviewerFileAccess": true,
  • "restrictSiteAccess": true,
  • "reviewGuidelines": {
    },
  • "reviewHelp": {
    },
  • "reviewerAccessKeysEnabled": true,
  • "rights": "0",
  • "searchDescription": {
    },
  • "seq": 0,
  • "showEnsuringLink": true,
  • "sidebar": [
    ],
  • "source": "0",
  • "styleSheet": {
    },
  • "subjects": "0",
  • "submissionAcknowledgement": "",
  • "submissionChecklist": {
    },
  • "submissionFee": 0,
  • "submissionFeeDescription": {
    },
  • "submissionFeeName": {
    },
  • "submitWithCategories": false,
  • "subscriptionAdditionalInformation": {
    },
  • "subscriptionEmail": "string",
  • "subscriptionExpiryPartial": true,
  • "subscriptionMailingAddress": "string",
  • "subscriptionName": "string",
  • "subscriptionPhone": "string",
  • "supportEmail": "string",
  • "supportName": "string",
  • "supportPhone": "string",
  • "supportedFormLocales": [
    ],
  • "supportedLocales": [
    ],
  • "supportedSubmissionLocales": [
    ],
  • "themePluginPath": "default",
  • "timeFormat": {
    },
  • "type": "0",
  • "uploadFilesHelp": {
    },
  • "url": "string",
  • "urlPath": "string"
}

Delete a context.

Delete a journal (OJS), press (OMP) or preprint server (OPS).

path Parameters
contextId
required
integer

Context ID

Responses

Response samples

Content type
application/json
{
  • "_href": "http://example.com",
  • "abbreviation": {
    },
  • "about": {
    },
  • "acronym": {
    },
  • "additionalHomeContent": {
    },
  • "agencies": "0",
  • "announcementsIntroduction": {
    },
  • "authorGuidelines": {
    },
  • "authorInformation": {
    },
  • "automaticDoiDeposit": true,
  • "beginSubmissionHelp": {
    },
  • "citations": "0",
  • "clockssLicense": {
    },
  • "competingInterests": {
    },
  • "contactAffiliation": {
    },
  • "contactEmail": "string",
  • "contactName": "string",
  • "contactPhone": "string",
  • "contributorsHelp": {
    },
  • "copySubmissionAckAddress": "",
  • "copySubmissionAckPrimaryContact": false,
  • "copyrightHolderOther": {
    },
  • "copyrightHolderType": "author",
  • "copyrightNotice": {
    },
  • "copyrightYearBasis": "issue",
  • "country": "string",
  • "coverage": "0",
  • "currency": "string",
  • "currentIssueId": 0,
  • "customHeaders": {
    },
  • "dataAvailability": "0",
  • "dateFormatLong": {
    },
  • "dateFormatShort": {
    },
  • "datetimeFormatLong": {
    },
  • "datetimeFormatShort": {
    },
  • "defaultMetricType": "string",
  • "defaultReviewMode": 1,
  • "delayedOpenAccessDuration": 0,
  • "delayedOpenAccessPolicy": {
    },
  • "description": {
    },
  • "detailsHelp": {
    },
  • "disableBulkEmailUserGroups": [
    ],
  • "disableSubmissions": false,
  • "disableUserReg": true,
  • "disciplines": "0",
  • "doiCreationTime": "copyEditCreationTime",
  • "doiIssueSuffixPattern": "string",
  • "doiPrefix": "string",
  • "doiPublicationSuffixPattern": "string",
  • "doiRepresentationSuffixPattern": "string",
  • "doiSuffixType": "default",
  • "doiVersioning": false,
  • "editorialStatsEmail": true,
  • "editorialTeam": {
    },
  • "emailSignature": "string",
  • "enableAnnouncements": true,
  • "enableClockss": true,
  • "enableDois": true,
  • "enableGeoUsageStats": "disabled",
  • "enableInstitutionUsageStats": false,
  • "enableLockss": true,
  • "enableOai": 1,
  • "enableOpenAccessNotification": true,
  • "enablePublisherId": [
    ],
  • "enableSubscriptionOnlinePaymentNotificationPurchaseIndividual": true,
  • "enableSubscriptionOnlinePaymentNotificationPurchaseInstitutional": true,
  • "enableSubscriptionOnlinePaymentNotificationRenewIndividual": true,
  • "enableSubscriptionOnlinePaymentNotificationRenewInstitutional": true,
  • "enabled": true,
  • "enabledDoiTypes": [
    ],
  • "envelopeSender": "string",
  • "favicon": {
    },
  • "forTheEditorsHelp": {
    },
  • "homepageImage": {
    },
  • "id": 0,
  • "isSushiApiPublic": true,
  • "itemsPerPage": 25,
  • "journalThumbnail": {
    },
  • "keywords": "0",
  • "languages": "0",
  • "librarianInformation": {
    },
  • "licenseTerms": {
    },
  • "licenseUrl": "string",
  • "lockssLicense": {
    },
  • "mailingAddress": "string",
  • "membershipFee": 0,
  • "membershipFeeDescription": {
    },
  • "membershipFeeName": {
    },
  • "name": {
    },
  • "notifyAllAuthors": true,
  • "numAnnouncementsHomepage": 0,
  • "numDaysBeforeInviteReminder": 0,
  • "numDaysBeforeSubmitReminder": 0,
  • "numMonthsAfterSubscriptionExpiryReminder": 0,
  • "numMonthsBeforeSubscriptionExpiryReminder": 0,
  • "numPageLinks": 10,
  • "numWeeksAfterSubscriptionExpiryReminder": 0,
  • "numWeeksBeforeSubscriptionExpiryReminder": 0,
  • "numWeeksPerResponse": 4,
  • "numWeeksPerReview": 4,
  • "onlineIssn": "string",
  • "openAccessPolicy": {
    },
  • "pageFooter": {
    },
  • "pageHeaderLogoImage": {
    },
  • "paymentPluginName": "string",
  • "paymentsEnabled": true,
  • "primaryLocale": "string",
  • "printIssn": "string",
  • "privacyStatement": {
    },
  • "publicationFee": 0,
  • "publicationFeeDescription": {
    },
  • "publicationFeeName": {
    },
  • "publisherInstitution": "string",
  • "publishingMode": 0,
  • "purchaseArticleFee": 0,
  • "purchaseArticleFeeDescription": {
    },
  • "purchaseArticleFeeEnabled": true,
  • "purchaseArticleFeeName": {
    },
  • "purchaseIssueFee": 0,
  • "purchaseIssueFeeEnabled": true,
  • "rateReviewerOnQuality": true,
  • "readerInformation": {
    },
  • "registrationAgency": "",
  • "restrictArticleAccess": true,
  • "restrictOnlyPdf": true,
  • "restrictReviewerFileAccess": true,
  • "restrictSiteAccess": true,
  • "reviewGuidelines": {
    },
  • "reviewHelp": {
    },
  • "reviewerAccessKeysEnabled": true,
  • "rights": "0",
  • "searchDescription": {
    },
  • "seq": 0,
  • "showEnsuringLink": true,
  • "sidebar": [
    ],
  • "source": "0",
  • "styleSheet": {
    },
  • "subjects": "0",
  • "submissionAcknowledgement": "",
  • "submissionChecklist": {
    },
  • "submissionFee": 0,
  • "submissionFeeDescription": {
    },
  • "submissionFeeName": {
    },
  • "submitWithCategories": false,
  • "subscriptionAdditionalInformation": {
    },
  • "subscriptionEmail": "string",
  • "subscriptionExpiryPartial": true,
  • "subscriptionMailingAddress": "string",
  • "subscriptionName": "string",
  • "subscriptionPhone": "string",
  • "supportEmail": "string",
  • "supportName": "string",
  • "supportPhone": "string",
  • "supportedFormLocales": [
    ],
  • "supportedLocales": [
    ],
  • "supportedSubmissionLocales": [
    ],
  • "themePluginPath": "default",
  • "timeFormat": {
    },
  • "type": "0",
  • "uploadFilesHelp": {
    },
  • "url": "string",
  • "urlPath": "string"
}

Get the active theme.

Get the active theme and theme options for any journal (OJS), press (OMP) or preprint server (OPS).

+

Response samples

Content type
application/json
{
  • "_href": "http://example.com",
  • "abbreviation": {
    },
  • "about": {
    },
  • "acronym": {
    },
  • "additionalHomeContent": {
    },
  • "agencies": "0",
  • "announcementsIntroduction": {
    },
  • "authorGuidelines": {
    },
  • "authorInformation": {
    },
  • "automaticDoiDeposit": true,
  • "beginSubmissionHelp": {
    },
  • "citations": "0",
  • "clockssLicense": {
    },
  • "competingInterests": {
    },
  • "contactAffiliation": {
    },
  • "contactEmail": "string",
  • "contactName": "string",
  • "contactPhone": "string",
  • "contributorsHelp": {
    },
  • "copySubmissionAckAddress": "",
  • "copySubmissionAckPrimaryContact": false,
  • "copyrightHolderOther": {
    },
  • "copyrightHolderType": "author",
  • "copyrightNotice": {
    },
  • "copyrightYearBasis": "issue",
  • "country": "string",
  • "coverage": "0",
  • "currency": "string",
  • "currentIssueId": 0,
  • "customHeaders": {
    },
  • "dataAvailability": "0",
  • "dateFormatLong": {
    },
  • "dateFormatShort": {
    },
  • "datetimeFormatLong": {
    },
  • "datetimeFormatShort": {
    },
  • "defaultMetricType": "string",
  • "defaultReviewMode": 1,
  • "delayedOpenAccessDuration": 0,
  • "delayedOpenAccessPolicy": {
    },
  • "description": {
    },
  • "detailsHelp": {
    },
  • "disableBulkEmailUserGroups": [
    ],
  • "disableSubmissions": false,
  • "disableUserReg": true,
  • "disciplines": "0",
  • "doiCreationTime": "copyEditCreationTime",
  • "doiIssueSuffixPattern": "string",
  • "doiPrefix": "string",
  • "doiPublicationSuffixPattern": "string",
  • "doiRepresentationSuffixPattern": "string",
  • "doiSuffixType": "default",
  • "doiVersioning": false,
  • "editorialStatsEmail": true,
  • "editorialTeam": {
    },
  • "emailSignature": "string",
  • "enableAnnouncements": true,
  • "enableClockss": true,
  • "enableDois": true,
  • "enableGeoUsageStats": "disabled",
  • "enableInstitutionUsageStats": false,
  • "enableLockss": true,
  • "enableOai": 1,
  • "enableOpenAccessNotification": true,
  • "enablePublisherId": [
    ],
  • "enableSubscriptionOnlinePaymentNotificationPurchaseIndividual": true,
  • "enableSubscriptionOnlinePaymentNotificationPurchaseInstitutional": true,
  • "enableSubscriptionOnlinePaymentNotificationRenewIndividual": true,
  • "enableSubscriptionOnlinePaymentNotificationRenewInstitutional": true,
  • "enabled": true,
  • "enabledDoiTypes": [
    ],
  • "envelopeSender": "string",
  • "favicon": {
    },
  • "forTheEditorsHelp": {
    },
  • "homepageImage": {
    },
  • "id": 0,
  • "isSushiApiPublic": true,
  • "itemsPerPage": 25,
  • "journalThumbnail": {
    },
  • "keywords": "0",
  • "languages": "0",
  • "librarianInformation": {
    },
  • "licenseTerms": {
    },
  • "licenseUrl": "string",
  • "lockssLicense": {
    },
  • "mailingAddress": "string",
  • "membershipFee": 0,
  • "membershipFeeDescription": {
    },
  • "membershipFeeName": {
    },
  • "name": {
    },
  • "notifyAllAuthors": true,
  • "numAnnouncementsHomepage": 0,
  • "numDaysBeforeInviteReminder": 0,
  • "numDaysBeforeSubmitReminder": 0,
  • "numMonthsAfterSubscriptionExpiryReminder": 0,
  • "numMonthsBeforeSubscriptionExpiryReminder": 0,
  • "numPageLinks": 10,
  • "numWeeksAfterSubscriptionExpiryReminder": 0,
  • "numWeeksBeforeSubscriptionExpiryReminder": 0,
  • "numWeeksPerResponse": 4,
  • "numWeeksPerReview": 4,
  • "onlineIssn": "string",
  • "openAccessPolicy": {
    },
  • "pageFooter": {
    },
  • "pageHeaderLogoImage": {
    },
  • "paymentPluginName": "string",
  • "paymentsEnabled": true,
  • "primaryLocale": "string",
  • "printIssn": "string",
  • "privacyStatement": {
    },
  • "publicationFee": 0,
  • "publicationFeeDescription": {
    },
  • "publicationFeeName": {
    },
  • "publisherInstitution": "string",
  • "publisherUrl": "string",
  • "publishingMode": 0,
  • "purchaseArticleFee": 0,
  • "purchaseArticleFeeDescription": {
    },
  • "purchaseArticleFeeEnabled": true,
  • "purchaseArticleFeeName": {
    },
  • "purchaseIssueFee": 0,
  • "purchaseIssueFeeEnabled": true,
  • "rateReviewerOnQuality": true,
  • "readerInformation": {
    },
  • "registrationAgency": "",
  • "requireAuthorCompetingInterests": true,
  • "restrictArticleAccess": true,
  • "restrictOnlyPdf": true,
  • "restrictReviewerFileAccess": true,
  • "restrictSiteAccess": true,
  • "reviewGuidelines": {
    },
  • "reviewHelp": {
    },
  • "reviewerAccessKeysEnabled": true,
  • "rights": "0",
  • "searchDescription": {
    },
  • "seq": 0,
  • "showEnsuringLink": true,
  • "sidebar": [
    ],
  • "source": "0",
  • "styleSheet": {
    },
  • "subjects": "0",
  • "submissionAcknowledgement": "",
  • "submissionChecklist": {
    },
  • "submissionFee": 0,
  • "submissionFeeDescription": {
    },
  • "submissionFeeName": {
    },
  • "submitWithCategories": false,
  • "subscriptionAdditionalInformation": {
    },
  • "subscriptionEmail": "string",
  • "subscriptionExpiryPartial": true,
  • "subscriptionMailingAddress": "string",
  • "subscriptionName": "string",
  • "subscriptionPhone": "string",
  • "supportEmail": "string",
  • "supportName": "string",
  • "supportPhone": "string",
  • "supportedFormLocales": [
    ],
  • "supportedLocales": [
    ],
  • "supportedSubmissionLocales": [
    ],
  • "themePluginPath": "default",
  • "timeFormat": {
    },
  • "type": "0",
  • "uploadFilesHelp": {
    },
  • "url": "string",
  • "urlPath": "string"
}

Get the active theme.

Get the active theme and theme options for any journal (OJS), press (OMP) or preprint server (OPS).

path Parameters
contextId
required
integer

Context ID

Responses

Request samples

Content type
application/json
{
  • "themePluginPath": "string",
  • "...": "string"
}

Response samples

Content type
application/json
{
  • "themePluginPath": "string",
  • "...": "string"
}

Site

Only admins can access these endpoints, which should be accessed using _ instead of the journal path.

Get the site.

Responses

Response samples

Content type
application/json
{
  • "about": {
    },
  • "compressStatsLogs": false,
  • "contactEmail": {
    },
  • "contactName": {
    },
  • "counterR5StartDate": "string",
  • "enableBulkEmails": [
    ],
  • "enableGeoUsageStats": "disabled",
  • "enableInstitutionUsageStats": false,
  • "installedLocales": [
    ],
  • "isSiteSushiPlatform": false,
  • "isSushiApiPublic": true,
  • "keepDailyUsageStats": false,
  • "minPasswordLength": 0,
  • "pageFooter": {
    },
  • "pageHeaderTitleImage": {
    },
  • "primaryLocale": "string",
  • "privacyStatement": {
    },
  • "redirect": 0,
  • "sidebar": [
    ],
  • "styleSheet": {
    },
  • "supportedLocales": [
    ],
  • "sushiPlatformID": "string",
  • "themePluginPath": "default",
  • "title": {
    }
}

Edit the site.

Request Body schema: application/json

The details about the site that you want to edit. All params are optional. When a param is omitted, the existing value of that param will not be modified.

+

Response samples

Content type
application/json
{
  • "about": {
    },
  • "announcementsIntroduction": {
    },
  • "compressStatsLogs": false,
  • "contactEmail": {
    },
  • "contactName": {
    },
  • "counterR5StartDate": "string",
  • "disableSharedReviewerStatistics": false,
  • "enableAnnouncements": true,
  • "enableBulkEmails": [
    ],
  • "enableGeoUsageStats": "disabled",
  • "enableInstitutionUsageStats": false,
  • "installedLocales": [
    ],
  • "isSiteSushiPlatform": false,
  • "isSushiApiPublic": true,
  • "keepDailyUsageStats": false,
  • "minPasswordLength": 0,
  • "numAnnouncementsHomepage": 0,
  • "pageFooter": {
    },
  • "pageHeaderTitleImage": {
    },
  • "primaryLocale": "string",
  • "privacyStatement": {
    },
  • "redirect": 0,
  • "sidebar": [
    ],
  • "styleSheet": {
    },
  • "supportedLocales": [
    ],
  • "sushiPlatformID": "string",
  • "themePluginPath": "default",
  • "title": {
    },
  • "uniqueSiteId": "string"
}

Edit the site.

Request Body schema: application/json

The details about the site that you want to edit. All params are optional. When a param is omitted, the existing value of that param will not be modified.

about
object (LocaleObject)

Key/value pairs containing data stored by locale key.

+
announcementsIntroduction
object (LocaleObject)

Key/value pairs containing data stored by locale key.

compressStatsLogs
boolean
Default: false

Whether or not to compress usage statistics log files after they have been processed and archived.

contactEmail
object (LocaleObject)

Key/value pairs containing data stored by locale key.

contactName
object (LocaleObject)

Key/value pairs containing data stored by locale key.

-
counterR5StartDate
string
enableBulkEmails
Array of integers

Which hosted journals, presses or preprint servers are allowed to send bulk emails.

+
counterR5StartDate
string
disableSharedReviewerStatistics
boolean
Default: false

Specify whether reviewer statistics can be shared with other contexts of the installation.

+
enableAnnouncements
boolean
enableBulkEmails
Array of integers

Which hosted journals, presses or preprint servers are allowed to send bulk emails.

enableGeoUsageStats
string
Default: "disabled"
Enum: "disabled" "country" "country+region" "country+region+city"

Whether to track usage statistics by location, and whether to track at the country, region or city level.

enableInstitutionUsageStats
boolean
Default: false

Whether to track usage statistics by institutions. Requires institutional IP ranges to be configured.

installedLocales
Array of strings
isSiteSushiPlatform
boolean
Default: false

Whether or not to designate the site as the platform in COUNTER SUSHI statistics. Set this to true when all of the contexts (journals, presses or servers) of this site are published, owned or operated by the same provider.

isSushiApiPublic
boolean
Default: true

Whether or not the access to the COUNTER SUSHI statistics API is public. If false, only users with admin or manager roles can access the API.

keepDailyUsageStats
boolean
Default: false

Whether to retain daily usage stats or consolidate monthly stats. Daily stats can quickly result in millions of database rows for large installs with lots of submissions.

-
minPasswordLength
integer
pageFooter
object (LocaleObject)

Key/value pairs containing data stored by locale key.

+
minPasswordLength
integer
numAnnouncementsHomepage
integer
pageFooter
object (LocaleObject)

Key/value pairs containing data stored by locale key.

object
primaryLocale
string
privacyStatement
object (LocaleObject)

Key/value pairs containing data stored by locale key.

redirect
integer
sidebar
Array of strings
object
supportedLocales
Array of strings
sushiPlatformID
string

The platform ID for COUNTER SUSHI statistics. Required when isSiteSushiPlatform is true.

-
themePluginPath
string
Default: "default"
title
object (LocaleObject)

Key/value pairs containing data stored by locale key.

-

Responses

themePluginPath
string
Default: "default"
title
object (LocaleObject)

Key/value pairs containing data stored by locale key.

+
uniqueSiteId
string

Responses

Request samples

Content type
application/json
{
  • "about": {
    },
  • "compressStatsLogs": false,
  • "contactEmail": {
    },
  • "contactName": {
    },
  • "counterR5StartDate": "string",
  • "enableBulkEmails": [
    ],
  • "enableGeoUsageStats": "disabled",
  • "enableInstitutionUsageStats": false,
  • "installedLocales": [
    ],
  • "isSiteSushiPlatform": false,
  • "isSushiApiPublic": true,
  • "keepDailyUsageStats": false,
  • "minPasswordLength": 0,
  • "pageFooter": {
    },
  • "pageHeaderTitleImage": {
    },
  • "primaryLocale": "string",
  • "privacyStatement": {
    },
  • "redirect": 0,
  • "sidebar": [
    ],
  • "styleSheet": {
    },
  • "supportedLocales": [
    ],
  • "sushiPlatformID": "string",
  • "themePluginPath": "default",
  • "title": {
    }
}

Response samples

Content type
application/json
{
  • "about": {
    },
  • "compressStatsLogs": false,
  • "contactEmail": {
    },
  • "contactName": {
    },
  • "counterR5StartDate": "string",
  • "enableBulkEmails": [
    ],
  • "enableGeoUsageStats": "disabled",
  • "enableInstitutionUsageStats": false,
  • "installedLocales": [
    ],
  • "isSiteSushiPlatform": false,
  • "isSushiApiPublic": true,
  • "keepDailyUsageStats": false,
  • "minPasswordLength": 0,
  • "pageFooter": {
    },
  • "pageHeaderTitleImage": {
    },
  • "primaryLocale": "string",
  • "privacyStatement": {
    },
  • "redirect": 0,
  • "sidebar": [
    ],
  • "styleSheet": {
    },
  • "supportedLocales": [
    ],
  • "sushiPlatformID": "string",
  • "themePluginPath": "default",
  • "title": {
    }
}

Get the theme.

Get the active theme and theme options for the site.

+

Request samples

Content type
application/json
{
  • "about": {
    },
  • "announcementsIntroduction": {
    },
  • "compressStatsLogs": false,
  • "contactEmail": {
    },
  • "contactName": {
    },
  • "counterR5StartDate": "string",
  • "disableSharedReviewerStatistics": false,
  • "enableAnnouncements": true,
  • "enableBulkEmails": [
    ],
  • "enableGeoUsageStats": "disabled",
  • "enableInstitutionUsageStats": false,
  • "installedLocales": [
    ],
  • "isSiteSushiPlatform": false,
  • "isSushiApiPublic": true,
  • "keepDailyUsageStats": false,
  • "minPasswordLength": 0,
  • "numAnnouncementsHomepage": 0,
  • "pageFooter": {
    },
  • "pageHeaderTitleImage": {
    },
  • "primaryLocale": "string",
  • "privacyStatement": {
    },
  • "redirect": 0,
  • "sidebar": [
    ],
  • "styleSheet": {
    },
  • "supportedLocales": [
    ],
  • "sushiPlatformID": "string",
  • "themePluginPath": "default",
  • "title": {
    },
  • "uniqueSiteId": "string"
}

Response samples

Content type
application/json
{
  • "about": {
    },
  • "announcementsIntroduction": {
    },
  • "compressStatsLogs": false,
  • "contactEmail": {
    },
  • "contactName": {
    },
  • "counterR5StartDate": "string",
  • "disableSharedReviewerStatistics": false,
  • "enableAnnouncements": true,
  • "enableBulkEmails": [
    ],
  • "enableGeoUsageStats": "disabled",
  • "enableInstitutionUsageStats": false,
  • "installedLocales": [
    ],
  • "isSiteSushiPlatform": false,
  • "isSushiApiPublic": true,
  • "keepDailyUsageStats": false,
  • "minPasswordLength": 0,
  • "numAnnouncementsHomepage": 0,
  • "pageFooter": {
    },
  • "pageHeaderTitleImage": {
    },
  • "primaryLocale": "string",
  • "privacyStatement": {
    },
  • "redirect": 0,
  • "sidebar": [
    ],
  • "styleSheet": {
    },
  • "supportedLocales": [
    ],
  • "sushiPlatformID": "string",
  • "themePluginPath": "default",
  • "title": {
    },
  • "uniqueSiteId": "string"
}

Get the theme.

Get the active theme and theme options for the site.

Responses

Response samples

Content type
application/json
{
  • "themePluginPath": "string",
  • "...": "string"
}

Edit the theme.

Get the active theme and theme options for the site.

@@ -2920,41 +2925,43 @@
typeIds
Array of integers

Filter results by announcements of these announcement types.

Responses

Response samples

Content type
application/json
{
  • "itemsMax": 0,
  • "items": [
    ]
}

Create a new announcement.

Create and publish a new announcement in this context.

+

Response samples

Content type
application/json
{
  • "itemsMax": 0,
  • "items": [
    ]
}

Create a new announcement.

Create and publish a new announcement in this context.

Request Body schema: application/json

Details about the announcement that should be created.

-
assocId
integer

The journal, press or preprint server ID.

+
assocId
integer

The journal, press or preprint server ID. Null for site-level announcements.

assocType
integer

The assoc object. This should always be ASSOC_TYPE_JOURNAL (OJS), ASSOC_TYPE_PRESS (OMP) or ASSOC_TYPE_SERVER (OPS).

dateExpire
string

(Optional) The date that this announcement expires, if one is set. This is typically used to express closing dates for calls for papers.

description
object (LocaleObject)

Key/value pairs containing data stored by locale key.

descriptionShort
object (LocaleObject)

Key/value pairs containing data stored by locale key.

+
object

The image to show with this announcement.

title
object (LocaleObject)

Key/value pairs containing data stored by locale key.

typeId
integer

(Optional) One of the announcement type ids.

Responses

Request samples

Content type
application/json
{
  • "assocId": 0,
  • "assocType": 0,
  • "dateExpire": "string",
  • "description": {
    },
  • "descriptionShort": {
    },
  • "title": {
    },
  • "typeId": 0
}

Response samples

Content type
application/json
{
  • "_href": "http://example.com",
  • "assocId": 0,
  • "assocType": 0,
  • "dateExpire": "string",
  • "datePosted": "string",
  • "description": {
    },
  • "descriptionShort": {
    },
  • "id": 0,
  • "title": {
    },
  • "typeId": 0,
  • "url": "http://example.com"
}

Get an announcement.

path Parameters
announcementId
required
integer

Announcement ID

+

Request samples

Content type
application/json
{
  • "assocId": 0,
  • "assocType": 0,
  • "dateExpire": "string",
  • "description": {
    },
  • "descriptionShort": {
    },
  • "image": {
    },
  • "title": {
    },
  • "typeId": 0
}

Response samples

Content type
application/json
{
  • "_href": "http://example.com",
  • "assocId": 0,
  • "assocType": 0,
  • "dateExpire": "string",
  • "datePosted": "string",
  • "description": {
    },
  • "descriptionShort": {
    },
  • "id": 0,
  • "image": {
    },
  • "title": {
    },
  • "typeId": 0,
  • "url": "http://example.com"
}

Get an announcement.

path Parameters
announcementId
required
integer

Announcement ID

Responses

Response samples

Content type
application/json
{
  • "_href": "http://example.com",
  • "assocId": 0,
  • "assocType": 0,
  • "dateExpire": "string",
  • "datePosted": "string",
  • "description": {
    },
  • "descriptionShort": {
    },
  • "id": 0,
  • "title": {
    },
  • "typeId": 0,
  • "url": "http://example.com"
}

Edit an announcement.

Edit an announcement.

+

Response samples

Content type
application/json
{
  • "_href": "http://example.com",
  • "assocId": 0,
  • "assocType": 0,
  • "dateExpire": "string",
  • "datePosted": "string",
  • "description": {
    },
  • "descriptionShort": {
    },
  • "id": 0,
  • "image": {
    },
  • "title": {
    },
  • "typeId": 0,
  • "url": "http://example.com"
}

Edit an announcement.

Edit an announcement.

path Parameters
announcementId
required
integer

Announcement ID

Request Body schema: application/json

The details about the announcement that you want to edit. All params are optional. When a param is omitted, the existing value of that param will not be modified.

-
assocId
integer

The journal, press or preprint server ID.

+
assocId
integer

The journal, press or preprint server ID. Null for site-level announcements.

assocType
integer

The assoc object. This should always be ASSOC_TYPE_JOURNAL (OJS), ASSOC_TYPE_PRESS (OMP) or ASSOC_TYPE_SERVER (OPS).

dateExpire
string

(Optional) The date that this announcement expires, if one is set. This is typically used to express closing dates for calls for papers.

description
object (LocaleObject)

Key/value pairs containing data stored by locale key.

descriptionShort
object (LocaleObject)

Key/value pairs containing data stored by locale key.

+
object

The image to show with this announcement.

title
object (LocaleObject)

Key/value pairs containing data stored by locale key.

typeId
integer

(Optional) One of the announcement type ids.

Responses

Request samples

Content type
application/json
{
  • "assocId": 0,
  • "assocType": 0,
  • "dateExpire": "string",
  • "description": {
    },
  • "descriptionShort": {
    },
  • "title": {
    },
  • "typeId": 0
}

Response samples

Content type
application/json
{
  • "_href": "http://example.com",
  • "assocId": 0,
  • "assocType": 0,
  • "dateExpire": "string",
  • "datePosted": "string",
  • "description": {
    },
  • "descriptionShort": {
    },
  • "id": 0,
  • "title": {
    },
  • "typeId": 0,
  • "url": "http://example.com"
}

Delete an announcement.

Delete an announcement.

+

Request samples

Content type
application/json
{
  • "assocId": 0,
  • "assocType": 0,
  • "dateExpire": "string",
  • "description": {
    },
  • "descriptionShort": {
    },
  • "image": {
    },
  • "title": {
    },
  • "typeId": 0
}

Response samples

Content type
application/json
{
  • "_href": "http://example.com",
  • "assocId": 0,
  • "assocType": 0,
  • "dateExpire": "string",
  • "datePosted": "string",
  • "description": {
    },
  • "descriptionShort": {
    },
  • "id": 0,
  • "image": {
    },
  • "title": {
    },
  • "typeId": 0,
  • "url": "http://example.com"
}

Delete an announcement.

Delete an announcement.

path Parameters
announcementId
required
integer

Announcement ID

Responses

Response samples

Content type
application/json
{
  • "_href": "http://example.com",
  • "assocId": 0,
  • "assocType": 0,
  • "dateExpire": "string",
  • "datePosted": "string",
  • "description": {
    },
  • "descriptionShort": {
    },
  • "id": 0,
  • "title": {
    },
  • "typeId": 0,
  • "url": "http://example.com"
}

DOIs

Only admins and journal managers can access these endpoints.

+

Response samples

Content type
application/json
{
  • "_href": "http://example.com",
  • "assocId": 0,
  • "assocType": 0,
  • "dateExpire": "string",
  • "datePosted": "string",
  • "description": {
    },
  • "descriptionShort": {
    },
  • "id": 0,
  • "image": {
    },
  • "title": {
    },
  • "typeId": 0,
  • "url": "http://example.com"
}

DOIs

Only admins and journal managers can access these endpoints.

Get a list of DOIs.

query Parameters
count
integer
Default: 30

How many results to return in a single request. Max is 100.

offset
integer

Offset the results returned. Use this to receive subsequent pages of requests. A count of 10 and offset of 15 will return results 15 to 25.

status
Array of integers
Items Enum: 1 2 3 4 5

Filter results by one or more DOI statuses. Must match the value of one of the Doi::STATUS_UNREGISTERED, Doi::STATUS_SUBMITTED, Doi::STATUS_REGISTERED, Doi::STATUS_ERROR, Doi::STATUS_STALE constants.

@@ -3386,7 +3393,7 @@

Request samples

Content type
application/json
{
  • "enabledRegistrationAgency": "string",
  • "automaticDeposit": true
}

Response samples

Content type
application/json
{
  • "enabledRegistrationAgency": "string",
  • "automaticDeposit": true
}