Download OpenAPI specification:Download
API to interact with Open Journal Systems 3.1.x.
OJS 3.1 Target:
/submissions/{submissionId}
.assignedTo | integer Filter results by those assigned to this user ID. All users except managers and admins are automatically restricted to assigned submissions and do not need to pass this parameter. |
count | integer How many results to return in a single request. Default is |
isIncomplete | boolean Filter the results by those for which the author has not yet completed the submission process. |
isOverdue | boolean Filter the results by those for which a reviewer has missed a deadline. |
offset | integer Offset the results returned. Use this to receive subsequent pages of requests. A |
orderBy | string Order the results returned. Must be one of |
orderDirection | string Return the results in ascending or descending order. Must be |
searchPhrase | string Filter the results by a search phrase matched against the title and authors. |
sectionIds | string Filter the results by those assigned to a section. |
status | string Filter results by submission status. Pass more than one status in a comma-separated list (eg - |
{- "itemsMax": 0,
- "items": [
- {
- "id": 0,
- "_href": "string",
- "issue": {
- "id": 0,
- "_href": "string",
- "title": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "description": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "identification": "string",
- "volume": 0,
- "number": 0,
- "year": 0,
- "doi": "string",
- "datePublished": "string",
- "publishedUrl": "string",
- "coverImageUrl": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "coverImageAltText": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "galleys": [
- {
- "id": 0,
- "_parent": "string",
- "locale": "string",
- "label": "string",
- "seq": 0,
- "urlRemote": "string",
- "urlPublished": "string"
}
]
}, - "section": {
- "id": 0,
- "abbrev": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "title": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "seq": 0
}, - "title": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "subtitle": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "fullTitle": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "prefix": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "authorString": "string",
- "shortAuthorString": "string",
- "authors": [
- {
- "id": 0,
- "seq": 0,
- "firstName": "string",
- "middleName": "string",
- "lastName": "string",
- "suffix": "string",
- "fullName": "string",
- "country": "string",
- "email": "string",
- "url": "string",
- "userGroupId": "string",
- "isBrowseable": true,
- "isPrimaryContact": true,
- "affiliation": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "biography": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "orcid": "string"
}
], - "abstract": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "coverImageUrl": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "coverImageAltText": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "discipline": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "subject": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "type": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "language": "string",
- "sponsor": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "pages": "string",
- "copyrightHolder": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "copyrightYear": "string",
- "licenseUrl": "string",
- "locale": "string",
- "dateSubmitted": "string",
- "dateStatusModified": "string",
- "lastModified": "string",
- "datePublished": "string",
- "status": {
- "id": 0,
- "label": "string"
}, - "submissionProgress": 0,
- "stages": [
- {
- "id": 0,
- "label": "string",
- "isActiveStage": true,
- "currentUserAssignedRoles": [
- 0
]
}
], - "reviewRounds": [
- {
- "id": 0,
- "round": 0,
- "stageId": 0,
- "statusId": 0,
- "status": "string"
}
], - "reviewAssignments": [
- {
- "id": 0,
- "assignedUserId": 0,
- "isCurrentUserAssigned": true,
- "statusId": 0,
- "status": "string",
- "due": "string",
- "responseDue": "string",
- "round": 0,
- "roundId": 0
}
], - "urlWorkflow": "string",
- "urlPublished": "string",
- "galleys": [
- {
- "id": 0,
- "_parent": "string",
- "locale": "string",
- "label": "string",
- "seq": 0,
- "urlRemote": "string",
- "urlPublished": "string",
- "file": {
- "id": 0,
- "revision": 0,
- "fileStage": 0,
- "fileName": "string",
- "genreId": 0,
- "metadata": {
- "description": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "creator": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "publisher": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "source": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "subject": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "sponsor": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "dateCreated": "string",
- "language": "string",
- "caption": "string",
- "credit": "string",
- "copyrightOwner": "string",
- "terms": "string",
- "width": "string",
- "height": "string",
- "physicalWidth": "string",
- "physicalHeight": "string"
}
}, - "dependentFiles": [
- {
- "id": 0,
- "revision": 0,
- "fileStage": 0,
- "fileName": "string",
- "genreId": 0,
- "metadata": {
- "description": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "creator": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "publisher": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "source": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "subject": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "sponsor": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "dateCreated": "string",
- "language": "string",
- "caption": "string",
- "credit": "string",
- "copyrightOwner": "string",
- "terms": "string",
- "width": "string",
- "height": "string",
- "physicalWidth": "string",
- "physicalHeight": "string"
}
}
]
}
], - "doi": "string"
}
]
}
OJS 3.1 Target:
stages
, reviewRounds
and reviewAssignments
Additional notes:
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]]
.submissionProgress
will be > 0 if the submission is incomplete.stages
, reviewRounds
and reviewAssignments
should only be returned for participants assigned to the submission.reviewAssignments
should only expose user-identifying information for editors and admins.submissionId required | integer Submission ID |
{- "id": 0,
- "_href": "string",
- "issue": {
- "id": 0,
- "_href": "string",
- "title": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "description": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "identification": "string",
- "volume": 0,
- "number": 0,
- "year": 0,
- "doi": "string",
- "datePublished": "string",
- "publishedUrl": "string",
- "coverImageUrl": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "coverImageAltText": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "galleys": [
- {
- "id": 0,
- "_parent": "string",
- "locale": "string",
- "label": "string",
- "seq": 0,
- "urlRemote": "string",
- "urlPublished": "string"
}
]
}, - "section": {
- "id": 0,
- "abbrev": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "title": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "seq": 0
}, - "title": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "subtitle": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "fullTitle": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "prefix": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "authorString": "string",
- "shortAuthorString": "string",
- "authors": [
- {
- "id": 0,
- "seq": 0,
- "firstName": "string",
- "middleName": "string",
- "lastName": "string",
- "suffix": "string",
- "fullName": "string",
- "country": "string",
- "email": "string",
- "url": "string",
- "userGroupId": "string",
- "isBrowseable": true,
- "isPrimaryContact": true,
- "affiliation": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "biography": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "orcid": "string"
}
], - "abstract": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "coverImageUrl": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "coverImageAltText": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "discipline": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "subject": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "type": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "language": "string",
- "sponsor": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "pages": "string",
- "copyrightHolder": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "copyrightYear": "string",
- "licenseUrl": "string",
- "locale": "string",
- "dateSubmitted": "string",
- "dateStatusModified": "string",
- "lastModified": "string",
- "datePublished": "string",
- "status": {
- "id": 0,
- "label": "string"
}, - "submissionProgress": 0,
- "stages": [
- {
- "id": 0,
- "label": "string",
- "isActiveStage": true,
- "currentUserAssignedRoles": [
- 0
]
}
], - "reviewRounds": [
- {
- "id": 0,
- "round": 0,
- "stageId": 0,
- "statusId": 0,
- "status": "string"
}
], - "reviewAssignments": [
- {
- "id": 0,
- "assignedUserId": 0,
- "isCurrentUserAssigned": true,
- "statusId": 0,
- "status": "string",
- "due": "string",
- "responseDue": "string",
- "round": 0,
- "roundId": 0
}
], - "urlWorkflow": "string",
- "urlPublished": "string",
- "galleys": [
- {
- "id": 0,
- "_parent": "string",
- "locale": "string",
- "label": "string",
- "seq": 0,
- "urlRemote": "string",
- "urlPublished": "string",
- "file": {
- "id": 0,
- "revision": 0,
- "fileStage": 0,
- "fileName": "string",
- "genreId": 0,
- "metadata": {
- "description": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "creator": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "publisher": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "source": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "subject": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "sponsor": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "dateCreated": "string",
- "language": "string",
- "caption": "string",
- "credit": "string",
- "copyrightOwner": "string",
- "terms": "string",
- "width": "string",
- "height": "string",
- "physicalWidth": "string",
- "physicalHeight": "string"
}
}, - "dependentFiles": [
- {
- "id": 0,
- "revision": 0,
- "fileStage": 0,
- "fileName": "string",
- "genreId": 0,
- "metadata": {
- "description": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "creator": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "publisher": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "source": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "subject": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "sponsor": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "dateCreated": "string",
- "language": "string",
- "caption": "string",
- "credit": "string",
- "copyrightOwner": "string",
- "terms": "string",
- "width": "string",
- "height": "string",
- "physicalWidth": "string",
- "physicalHeight": "string"
}
}
]
}
], - "doi": "string"
}
OJS 3.1 Target:
Additional Notes:
_parent
will return the API URL representing the associated submission.publishedUrl
will point to the frontend galley view (eg - /article/view/<submission-id>/<galley-id>
).submissionId required | integer Submission ID |
[- {
- "id": 0,
- "_parent": "string",
- "locale": "string",
- "label": "string",
- "seq": 0,
- "urlRemote": "string",
- "urlPublished": "string",
- "file": {
- "id": 0,
- "revision": 0,
- "fileStage": 0,
- "fileName": "string",
- "genreId": 0,
- "metadata": {
- "description": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "creator": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "publisher": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "source": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "subject": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "sponsor": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "dateCreated": "string",
- "language": "string",
- "caption": "string",
- "credit": "string",
- "copyrightOwner": "string",
- "terms": "string",
- "width": "string",
- "height": "string",
- "physicalWidth": "string",
- "physicalHeight": "string"
}
}, - "dependentFiles": [
- {
- "id": 0,
- "revision": 0,
- "fileStage": 0,
- "fileName": "string",
- "genreId": 0,
- "metadata": {
- "description": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "creator": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "publisher": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "source": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "subject": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "sponsor": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "dateCreated": "string",
- "language": "string",
- "caption": "string",
- "credit": "string",
- "copyrightOwner": "string",
- "terms": "string",
- "width": "string",
- "height": "string",
- "physicalWidth": "string",
- "physicalHeight": "string"
}
}
]
}
]
submissionId required | integer Submission ID |
[- {
- "id": 0,
- "_href": "string",
- "userName": "string",
- "email": "string",
- "fullName": "string",
- "orcid": "string",
- "groups": [
- {
- "id": 0,
- "name": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "abbrev": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "roleId": 0,
- "showTitle": true,
- "permitSelfRegistration": true,
- "recommendOnly": true
}
], - "disabled": true
}
]
stageId required | integer Stage ID |
submissionId required | integer Submission ID |
[- {
- "id": 0,
- "_href": "string",
- "userName": "string",
- "email": "string",
- "fullName": "string",
- "orcid": "string",
- "groups": [
- {
- "id": 0,
- "name": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "abbrev": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "roleId": 0,
- "showTitle": true,
- "permitSelfRegistration": true,
- "recommendOnly": true
}
], - "disabled": true
}
]
OJS 3.1 Target:
/issues/{issueId}
.volumes
, numbers
and years
parameters are supported.Additional Notes:
datePublished
, most recent first.Changes:
volume
, number
and year
were changed to volumes
, numbers
and years
in OJS 3.1.1. Multiple values can be passed as a comma-separated string (eg - 1,2,3
).count | integer How many results to return in a single request. Default is |
isPublished | boolean Filter returned issues by those that have been published. Pass a |
numbers | string Filter returned issues by those assigned a specific number. |
offset | integer Offset the results returned. Use this to receive subsequent pages of requests. A |
orderBy | string Order the results returned. Must be one of |
orderDirection | string Return the results in ascending or descending order. Must be |
volumes | string Filter returned issues by those in a specific volume. |
years | string Filter returned issues by those in a specific year. |
[- {
- "id": 0,
- "_href": "string",
- "title": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "description": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "identification": "string",
- "volume": 0,
- "number": 0,
- "year": 0,
- "doi": "string",
- "datePublished": "string",
- "publishedUrl": "string",
- "coverImageUrl": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "coverImageAltText": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "galleys": [
- {
- "id": 0,
- "_parent": "string",
- "locale": "string",
- "label": "string",
- "seq": 0,
- "urlRemote": "string",
- "urlPublished": "string"
}
]
}
]
{- "id": 0,
- "_href": "string",
- "title": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "description": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "identification": "string",
- "volume": 0,
- "number": "string",
- "year": 0,
- "isCurrent": true,
- "datePublished": "string",
- "dateNotified": "string",
- "lastModified": "string",
- "publishedUrl": "string",
- "doi": "string",
- "coverImageUrl": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "coverImageAltText": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "articles": [
- {
- "id": 0,
- "_href": "string",
- "issue": {
- "id": 0,
- "_href": "string",
- "title": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "description": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "identification": "string",
- "volume": 0,
- "number": 0,
- "year": 0,
- "doi": "string",
- "datePublished": "string",
- "publishedUrl": "string",
- "coverImageUrl": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "coverImageAltText": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "galleys": [
- {
- "id": 0,
- "_parent": "string",
- "locale": "string",
- "label": "string",
- "seq": 0,
- "urlRemote": "string",
- "urlPublished": "string"
}
]
}, - "section": {
- "id": 0,
- "abbrev": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "title": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "seq": 0
}, - "title": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "subtitle": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "fullTitle": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "prefix": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "authorString": "string",
- "shortAuthorString": "string",
- "authors": [
- {
- "id": 0,
- "seq": 0,
- "fullName": "string",
- "orcid": "string"
}
], - "abstract": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "coverImageUrl": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "coverImageAltText": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "language": "string",
- "pages": "string",
- "datePublished": "string",
- "status": {
- "id": 0,
- "label": "string"
}, - "submissionProgress": 0,
- "urlWorkflow": "string",
- "urlPublished": "string",
- "galleys": [
- {
- "id": 0,
- "_parent": "string",
- "locale": "string",
- "label": "string",
- "seq": 0,
- "urlRemote": "string",
- "urlPublished": "string"
}
], - "doi": "string"
}
], - "sections": [
- {
- "id": 0,
- "abbrev": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "title": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "seq": 0
}
], - "galleys": [
- {
- "id": 0,
- "_parent": "string",
- "locale": "string",
- "label": "string",
- "seq": 0,
- "urlRemote": "string",
- "urlPublished": "string",
- "file": {
- "id": 0,
- "revision": 0,
- "fileStage": 0,
- "fileName": "string",
- "genreId": 0,
- "metadata": {
- "description": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "creator": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "publisher": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "source": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "subject": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "sponsor": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "dateCreated": "string",
- "language": "string",
- "caption": "string",
- "credit": "string",
- "copyrightOwner": "string",
- "terms": "string",
- "width": "string",
- "height": "string",
- "physicalWidth": "string",
- "physicalHeight": "string"
}
}, - "dependentFiles": [
- {
- "id": 0,
- "revision": 0,
- "fileStage": 0,
- "fileName": "string",
- "genreId": 0,
- "metadata": {
- "description": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "creator": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "publisher": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "source": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "subject": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "sponsor": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "dateCreated": "string",
- "language": "string",
- "caption": "string",
- "credit": "string",
- "copyrightOwner": "string",
- "terms": "string",
- "width": "string",
- "height": "string",
- "physicalWidth": "string",
- "physicalHeight": "string"
}
}
]
}
]
}
OJS 3.1 Target:
Additional Notes:
description
will include HTMLseq
property of each SectionSummary
will reflect the sequence for that issue.issueId required | integer Issue ID |
{- "id": 0,
- "_href": "string",
- "title": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "description": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "identification": "string",
- "volume": 0,
- "number": "string",
- "year": 0,
- "isCurrent": true,
- "datePublished": "string",
- "dateNotified": "string",
- "lastModified": "string",
- "publishedUrl": "string",
- "doi": "string",
- "coverImageUrl": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "coverImageAltText": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "articles": [
- {
- "id": 0,
- "_href": "string",
- "issue": {
- "id": 0,
- "_href": "string",
- "title": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "description": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "identification": "string",
- "volume": 0,
- "number": 0,
- "year": 0,
- "doi": "string",
- "datePublished": "string",
- "publishedUrl": "string",
- "coverImageUrl": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "coverImageAltText": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "galleys": [
- {
- "id": 0,
- "_parent": "string",
- "locale": "string",
- "label": "string",
- "seq": 0,
- "urlRemote": "string",
- "urlPublished": "string"
}
]
}, - "section": {
- "id": 0,
- "abbrev": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "title": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "seq": 0
}, - "title": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "subtitle": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "fullTitle": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "prefix": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "authorString": "string",
- "shortAuthorString": "string",
- "authors": [
- {
- "id": 0,
- "seq": 0,
- "fullName": "string",
- "orcid": "string"
}
], - "abstract": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "coverImageUrl": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "coverImageAltText": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "language": "string",
- "pages": "string",
- "datePublished": "string",
- "status": {
- "id": 0,
- "label": "string"
}, - "submissionProgress": 0,
- "urlWorkflow": "string",
- "urlPublished": "string",
- "galleys": [
- {
- "id": 0,
- "_parent": "string",
- "locale": "string",
- "label": "string",
- "seq": 0,
- "urlRemote": "string",
- "urlPublished": "string"
}
], - "doi": "string"
}
], - "sections": [
- {
- "id": 0,
- "abbrev": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "title": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "seq": 0
}
], - "galleys": [
- {
- "id": 0,
- "_parent": "string",
- "locale": "string",
- "label": "string",
- "seq": 0,
- "urlRemote": "string",
- "urlPublished": "string",
- "file": {
- "id": 0,
- "revision": 0,
- "fileStage": 0,
- "fileName": "string",
- "genreId": 0,
- "metadata": {
- "description": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "creator": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "publisher": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "source": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "subject": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "sponsor": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "dateCreated": "string",
- "language": "string",
- "caption": "string",
- "credit": "string",
- "copyrightOwner": "string",
- "terms": "string",
- "width": "string",
- "height": "string",
- "physicalWidth": "string",
- "physicalHeight": "string"
}
}, - "dependentFiles": [
- {
- "id": 0,
- "revision": 0,
- "fileStage": 0,
- "fileName": "string",
- "genreId": 0,
- "metadata": {
- "description": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "creator": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "publisher": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "source": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "subject": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "sponsor": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "dateCreated": "string",
- "language": "string",
- "caption": "string",
- "credit": "string",
- "copyrightOwner": "string",
- "terms": "string",
- "width": "string",
- "height": "string",
- "physicalWidth": "string",
- "physicalHeight": "string"
}
}
]
}
]
}
In Progress.
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 |
count | integer How many results to return in a single request. Default is |
offset | integer Offset the results returned. Use this to receive subsequent pages of requests. A |
orderBy | string Order the results returned. Must be one of |
orderDirection | string Return the results in ascending or descending order. Must be |
roleIds | string Filter the results by those who have one of these user role IDs. |
searchPhrase | string Filter the results by a search phrase matched against the |
status | string Filter results by active/disabled users. Must be one of |
{- "itemsMax": 0,
- "items": [
- {
- "id": 0,
- "_href": "string",
- "userName": "string",
- "email": "string",
- "fullName": "string",
- "orcid": "string",
- "groups": [
- {
- "id": 0,
- "name": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "abbrev": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "roleId": 0,
- "showTitle": true,
- "permitSelfRegistration": true,
- "recommendOnly": true
}
], - "disabled": true
}
]
}
In progress.
userId required | integer User ID |
{- "id": 0,
- "userName": "string",
- "fullName": "string",
- "firstName": "string",
- "middleName": "string",
- "lastName": "string",
- "initials": "string",
- "salutation": "string",
- "suffix": "string",
- "affiliation": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "country": "string",
- "url": "string",
- "email": "string",
- "orcid": "string",
- "groups": [
- {
- "id": 0,
- "name": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "abbrev": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "roleId": 0,
- "showTitle": true,
- "permitSelfRegistration": true,
- "recommendOnly": true
}
], - "biography": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "signature": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "authId": 0,
- "authString": "string",
- "phone": "string",
- "mailingAddress": "string",
- "billingAddress": "string",
- "interests": [
- {
- "id": 0,
- "interest": "string"
}
], - "gossip": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "disabled": true,
- "disabledReason": "string",
- "dateRegistered": "string",
- "dateValidated": "string",
- "dateLastLogin": "string",
- "mustChangePassword": true
}
In Progress.
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 |
averageCompletion | integer Filter results by those who complete a review assignment within |
count | integer How many results to return in a single request. Default is |
daysSinceLastAssignment | integer Filter results by those who's last review was assigned at least |
offset | integer Offset the results returned. Use this to receive subsequent pages of requests. A |
orderBy | string Order the results returned. Must be one of |
orderDirection | string Return the results in ascending or descending order. Must be |
reviewerRating | integer Filter results by those who have an average review assignment rating of at least |
reviewsActive | integer Filter results by those who have |
reviewsCompleted | integer Filter results by those who have completed at least |
searchPhrase | string Filter the results by a search phrase matched against the |
status | string Filter results by active/disabled users. Must be one of |
{- "itemsMax": 0,
- "items": [
- {
- "id": 0,
- "_href": "string",
- "userName": "string",
- "fullName": "string",
- "affiliation": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "groups": [
- {
- "id": 0,
- "name": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "abbrev": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "roleId": 0,
- "showTitle": true,
- "permitSelfRegistration": true,
- "recommendOnly": true
}
], - "interests": [
- {
- "id": 0,
- "interest": "string"
}
], - "gossip": {
- "en_US": "Filename",
- "fr_CA": "Nom de fichier"
}, - "reviewsActive": 0,
- "reviewsCompleted": 0,
- "reviewsDeclined": 0,
- "averageReviewCompletionDays": 0,
- "dateLastReviewAssignment": "string",
- "disabled": true
}
]
}
Retrieve submission list
assignedTo | integer Assignee user ID |
count | integer How many results to return in a single request. Default is |
offset | integer Offset the results returned. Use this to receive subsequent pages of requests. A |
orderColumn | string Default: "id" Field to order by |
orderDirection | string Default: "DESC" Order direction |
searchPhrase | string Search phrase |
statuses | Array of integers Status list |