Draft Marked for review

Scenario 9: Author requests reviews from review service, via repository

Initiated by the corresponding author, a repository requests reviews for one of its resources from a trusted review service. More than one review may be made - the offer is not tim-limited.

Repository

Notifications

Review Service

1 Initiate Request for Review
The corresponding author initiates a request for reviews of their resource in the repository
2 Request Review

The repository offers the resource for review by the review service.

The @context must include:

id

Notify notifications must describe an AS 2.0 activity. The activity has an id which must be a URI, and the use of URN:UUID is recommended. An HTTP URI may be used instead, but in such cases the URI should resolve to a useful resource.

type

The activity has a type array which should be an array including Offer from AS 2.0 and coar-notify:ReviewRequest from Notify.

actor

The activity MUST have an actor describing the author. The actor:

  • has an id which must be an HTTP URI identifying the author.
  • has a type which should be an array and, in any case, must include [Person] from AS 2.0.
  • may have an ldp:inbox which must be an HTTP URI
  • may have a name

object

This offer activity has an object representing the preprint. The object has:

  • An id which is the HTTP URI of the "landing page" for the resource.
  • A type which should be an array containing the value AboutPage from schema.org.
  • An ietf:cite-as which contains the persistent HTTP URI (sometimes called the "PID") which is to be used to cite or link to the resource.
  • A url containing the details of the actual content resource. The url has:
    • An id containing the HTTP URI of the content file for the resource.
    • A type describing the content file.
    • A mediaType which contains the MIME Type of the content file.

origin

The activity has an origin describing the system which has initiated the activity. The origin has:

  • An id which is an HTTP URI identifying the repository.
  • A type which should be an array including the value [Service] from AS 2.0.
  • An ldp:inbox which is the HTTP URI of the LDN inbox for the repository

target

The activity has a target describing the system which has initiated the activity. The target has:

  • An id which is an HTTP URI identifying the review-service.
  • A type which should be an array including the value [Service] from AS 2.0.
  • An ldp:inbox which is the HTTP URI of the LDN inbox for the review-service

{
  "@context": [
    "https://www.w3.org/ns/activitystreams",
    "http://purl.org/coar/notify"
  ],
  "actor": {
    "id": "https://orcid.org/0000-0002-1825-0097",
    "inbox": "https://josiahcarberry.com/ldn/inbox",
    "name": "Josiah Carberry",
    "type": [
      "Person"
    ]
  },
  "id": "urn:uuid:0370c0fb-bb78-4a9b-87f5-bed307a509dd",
  "object": {
    "id": "https://repository.org/preprint/201203/421/",
    "ietf:cite-as": "https://doi.org/10.5555/12345680",
    "type": [
      "sorg:AboutPage"
    ],
    "url": {
      "id": "https://repository.org/preprint/201203/421/content.pdf",
      "media-type": "application/pdf",
      "type": [
        "Article",
        "sorg:ScholarlyArticle"
      ]
    }
  },
  "origin": {
    "id": "https://repository.org",
    "inbox": "https://repository.org/inbox/",
    "type": [
      "Service"
    ]
  },
  "target": {
    "id": "https://reviewservice.org",
    "inbox": "https://reviewservice.org/requests/inbox/",
    "type": [
      "Service"
    ]
  },
  "type": [
    "Offer",
    "coar-notify:ReviewRequest"
  ]
}
3 Invite reviews
The review service displays a link to the resource, indicating that the author has requested reviews.
4 Review
A review is made
5 Announce Review

The review service notifies the repository of a new review

The @context must include:

id

Notify notifications must describe an AS 2.0 activity. The activity has an id which must be a URI, and the use of URN:UUID is recommended. An HTTP URI may be used instead, but in such cases the URI should resolve to a useful resource.

type

The activity has a type array which should be an array including Announce from AS 2.0 and coar-notify:ReviewSuccess from Notify.

actor

The activity may have an actor describing the reviewer. The actor:

  • has an id which must be an HTTP URI identifying the reviewer.
  • has a type which should be an array and, in any case, must include [Person] from AS 2.0.
  • may have an ldp:inbox which must be an HTTP URI
  • may have a name

inReplyTo

inReplyTo is specified because this is a response to a previous notification. inReplyTo has:

  • an id which must be the URI (URN:UUID or HTTP URI) which identifies the activity for which this is a response.
  • a type array which mirrors the type of the activity for which this is a response.

In this case inReplyTo also contains an object which represents the original object of the activity for which this is a response. This object has:

  • an id property which is the HTTP URI for the resource
  • an ietf:cite-as property which contains the persistent HTTP URI (sometimes called the "PID") which is to be used to cite or link to the resource.

object

The activity has an object representing the review. The objecthas:

  • An id which is the HTTP URI of the "landing page" for the resource.
  • A type which should be an array containing Document from AS 2.0.
  • An ietf:cite-as which contains the persistent HTTP URI (sometimes called the "PID") which is to be used to cite or link to the resource.
  • An coar-notify:reviews which contains the details of the resource which has been reviewed. The coar-notify:reviews property has:
    • An id containing the HTTP URI of the content file for the resource.
    • An ietf:cite-as which contains the persistent HTTP URI (sometimes called the "PID") which is to be used to cite or link to the resource.

origin

The activity has an origin describing the system which has initiated the activity. The origin has:

  • An id which is an HTTP URI identifying the review-service.
  • A type which should be an array including the value [Service] from AS 2.0.
  • An ldp:inbox which is the HTTP URI of the LDN inbox for the review-service

target

The activity has a target describing the system which has initiated the activity. The target has:

  • An id which is an HTTP URI identifying the repository.
  • A type which should be an array including the value [Service] from AS 2.0.
  • An ldp:inbox which is the HTTP URI of the LDN inbox for the repository

{
  "@context": [
    "https://www.w3.org/ns/activitystreams",
    "http://purl.org/coar/notify"
  ],
  "actor": {
    "id": "https://isni.org/isni/0000000122832703",
    "inbox": "https://hgwells.com/ldn/inbox",
    "name": "H G Wells",
    "type": [
      "Person"
    ]
  },
  "id": "urn:uuid:94ecae35-dcfd-4182-8550-22c7164fe23f",
  "inReplyTo": {
    "id": "urn:uuid:0370c0fb-bb78-4a9b-87f5-bed307a509dd",
    "object": {
      "id": "https://repository.org/preprint/201203/421/",
      "ietf:cite-as": "https://doi.org/10.5555/12345680"
    },
    "type": [
      "Offer",
      "coar-notify:ReviewRequest"
    ]
  },
  "object": {
    "coar-notify:reviews": {
      "id": "https://repository.org/preprint/201203/421/",
      "ietf:cite-as": "https://doi.org/10.5555/12345680"
    },
    "id": "https://reviewservice.org/review/geo/202103/0021",
    "ietf:cite-as": "https://doi.org/10.3214/987654",
    "type": [
      "Document",
      "sorg:Review"
    ]
  },
  "origin": {
    "id": "https://reviewservice.org",
    "inbox": "https://reviewservice.org/requests/inbox/",
    "type": [
      "Service"
    ]
  },
  "target": {
    "id": "https://repository.org",
    "inbox": "https://repository.org/inbox/",
    "type": [
      "Service"
    ]
  },
  "type": [
    "Announce",
    "coar-notify:ReviewSuccess"
  ]
}
6 Repository Links to Review
The repository creates a links to the review
7 Repository informs author of review
The repository informs the author that a review has been made and linked to their resource.
8 Review
The review service conducts a review
9 Announce Review

The review service notifies the repository of a new review

The @context must include:

id

Notify notifications must describe an AS 2.0 activity. The activity has an id which must be a URI, and the use of URN:UUID is recommended. An HTTP URI may be used instead, but in such cases the URI should resolve to a useful resource.

type

The activity has a type array which should be an array including Announce from AS 2.0 and coar-notify:ReviewSuccess from Notify.

actor

The activity may have an actor describing the reviewer. The actor:

  • has an id which must be an HTTP URI identifying the reviewer.
  • has a type which should be an array and, in any case, must include [Person] from AS 2.0.
  • may have an ldp:inbox which must be an HTTP URI
  • may have a name

inReplyTo

inReplyTo is specified because this is a response to a previous notification. inReplyTo has:

  • an id which must be the URI (URN:UUID or HTTP URI) which identifies the activity for which this is a response.
  • a type array which mirrors the type of the activity for which this is a response.

In this case inReplyTo also contains an object which represents the original object of the activity for which this is a response. This object has:

  • an id property which is the HTTP URI for the resource
  • an ietf:cite-as property which contains the persistent HTTP URI (sometimes called the "PID") which is to be used to cite or link to the resource.

object

The activity has an object representing the review. The objecthas:

  • An id which is the HTTP URI of the "landing page" for the resource.
  • A type which should be an array containing Document from AS 2.0.
  • An ietf:cite-as which contains the persistent HTTP URI (sometimes called the "PID") which is to be used to cite or link to the resource.
  • An coar-notify:reviews which contains the details of the resource which has been reviewed. The coar-notify:reviews property has:
    • An id containing the HTTP URI of the content file for the resource.
    • An ietf:cite-as which contains the persistent HTTP URI (sometimes called the "PID") which is to be used to cite or link to the resource.

origin

The activity has an origin describing the system which has initiated the activity. The origin has:

  • An id which is an HTTP URI identifying the review-service.
  • A type which should be an array including the value [Service] from AS 2.0.
  • An ldp:inbox which is the HTTP URI of the LDN inbox for the review-service

target

The activity has a target describing the system which has initiated the activity. The target has:

  • An id which is an HTTP URI identifying the repository.
  • A type which should be an array including the value [Service] from AS 2.0.
  • An ldp:inbox which is the HTTP URI of the LDN inbox for the repository

{
  "@context": [
    "https://www.w3.org/ns/activitystreams",
    "http://purl.org/coar/notify"
  ],
  "actor": {
    "id": "https://isni.org/isni/0000000122832703",
    "inbox": "https://hgwells.com/ldn/inbox",
    "name": "H G Wells",
    "type": [
      "Person"
    ]
  },
  "id": "urn:uuid:94ecae35-dcfd-4182-8550-22c7164fe23f",
  "inReplyTo": {
    "id": "urn:uuid:0370c0fb-bb78-4a9b-87f5-bed307a509dd",
    "object": {
      "id": "https://repository.org/preprint/201203/421/",
      "ietf:cite-as": "https://doi.org/10.5555/12345680"
    },
    "type": [
      "Offer",
      "coar-notify:ReviewRequest"
    ]
  },
  "object": {
    "coar-notify:reviews": {
      "id": "https://repository.org/preprint/201203/421/",
      "ietf:cite-as": "https://doi.org/10.5555/12345680"
    },
    "id": "https://reviewservice.org/review/geo/202103/0021",
    "ietf:cite-as": "https://doi.org/10.3214/987654",
    "type": [
      "Document",
      "sorg:Review"
    ]
  },
  "origin": {
    "id": "https://reviewservice.org",
    "inbox": "https://reviewservice.org/requests/inbox/",
    "type": [
      "Service"
    ]
  },
  "target": {
    "id": "https://repository.org",
    "inbox": "https://repository.org/inbox/",
    "type": [
      "Service"
    ]
  },
  "type": [
    "Announce",
    "coar-notify:ReviewSuccess"
  ]
}
10 Repository Links to Review
The repository creates a links to the review
11 Repository Links to Review
The repository creates a links to the review