• Home
  • Notification Patterns
  • Notify Vocabulary
  • Use-cases
  • Example Scenarios
  • About
    • Example Scenario

    Author requests reviews from review service, via repository

    See these use-cases to understand this scenario in context: Peer-review

    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 time-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.

    @context

    The @context must include:

    id

    Notify payloads 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 which should include Offer & coar-notify:ReviewAction

    actor

    The actor describes the party responsible for this activity. The actor has:

    • An id which must be an HTTP URI identifying the actor
    • A type which should be one of: Application, Group, Organization, Person or Service from AS 2.0.
    • The actor may also have a name

    origin

    The origin describes the system which has sent the notification. The origin has:

    • An id which is an HTTP URI identifying the sending system
    • A type which should include the value Service from AS 2.0.
    • An inbox which is the HTTP URI of the LDN inbox for the origin

    object

    The object describes the resource which is the main focus of this notification. This particular example has the following properties:

    • An id which is the HTTP URI of the "landing page" for the resource.
    • A type which should include 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.

    target

    The target describes the system which is intended to receive the notification. The target has:

    • An id which is an HTTP URI identifying the receiving system
    • A type which should include the value Service from AS 2.0.
    • An inbox which is the HTTP URI of the LDN inbox for the target

    {
  "@context": [
    "https://www.w3.org/ns/activitystreams",
    "https://purl.org/coar/notify"
  ],
  "actor": {
    "id": "https://orcid.org/0000-0002-1825-0097",
    "name": "Josiah Carberry",
    "type": "Person"
  },
  "id": "urn:uuid:0370c0fb-bb78-4a9b-87f5-bed307a509dd",
  "object": {
    "id": "https://research-organisation.org/repository/preprint/201203/421/",
    "ietf:cite-as": "https://doi.org/10.5555/12345680",
    "type": "sorg:AboutPage",
    "url": {
      "id": "https://research-organisation.org/repository/preprint/201203/421/content.pdf",
      "media-type": "application/pdf",
      "type": [
        "Article",
        "sorg:ScholarlyArticle"
      ]
    }
  },
  "origin": {
    "id": "https://research-organisation.org/repository",
    "inbox": "https://research-organisation.org/inbox/",
    "type": "Service"
  },
  "target": {
    "id": "https://review-service.com/system",
    "inbox": "https://review-service.com/inbox/",
    "type": "Service"
  },
  "type": [
    "Offer",
    "coar-notify:ReviewAction"
  ]
}
    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

    @context

    The @context must include:

    id

    Notify payloads 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 which should include Announce & coar-notify:ReviewAction

    actor

    The actor describes the party responsible for this activity. The actor has:

    • An id which must be an HTTP URI identifying the actor
    • A type which should be one of: Application, Group, Organization, Person or Service from AS 2.0.
    • The actor may also have a name

    origin

    The origin describes the system which has sent the notification. The origin has:

    • An id which is an HTTP URI identifying the sending system
    • A type which should include the value Service from AS 2.0.
    • An inbox which is the HTTP URI of the LDN inbox for the origin

    inReplyTo

    This particular example has the following properties:

    inReplyTo may be specified if this is a response to a previous notification. inReplyTo takes the URI (URN:UUID or HTTP URI) which identifies the activity for which this is a response.

    context

    When the object describes the result of some service acting on a resource, the context may be used to refer to that second resource. This particular example has the following properties:

    • An id which is the HTTP URI of the "landing page" for the resource.
    • A type which should include 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.

    object

    The object describes the resource which is the main focus of this notification. This particular example has the following properties:

    • id is the HTTP URI of the "landing page" for the resource.
    • type should include the value Document from AS 2.0, and sorg:Review
    • ietf:cite-as contains the persistent HTTP URI (sometimes called the "PID") which is to be used to cite or link to the resource.

    target

    The target describes the system which is intended to receive the notification. The target has:

    • An id which is an HTTP URI identifying the receiving system
    • A type which should include the value Service from AS 2.0.
    • An inbox which is the HTTP URI of the LDN inbox for the target

    {
  "@context": [
    "https://www.w3.org/ns/activitystreams",
    "https://purl.org/coar/notify"
  ],
  "actor": {
    "id": "https://isni.org/isni/0000000122832703",
    "name": "H G Wells",
    "type": "Person"
  },
  "context": {
    "id": "https://research-organisation.org/repository/preprint/201203/421/",
    "ietf:cite-as": "https://doi.org/10.5555/12345680",
    "type": "sorg:AboutPage",
    "url": {
      "id": "https://research-organisation.org/repository/preprint/201203/421/content.pdf",
      "media-type": "application/pdf",
      "type": [
        "Article",
        "sorg:ScholarlyArticle"
      ]
    }
  },
  "id": "urn:uuid:94ecae35-dcfd-4182-8550-22c7164fe23f",
  "inReplyTo": "urn:uuid:0370c0fb-bb78-4a9b-87f5-bed307a509dd",
  "object": {
    "id": "https://review-service.com/review/geo/202103/0021",
    "ietf:cite-as": "https://doi.org/10.3214/987654",
    "type": [
      "Document",
      "sorg:Review"
    ]
  },
  "origin": {
    "id": "https://review-service.com/system",
    "inbox": "https://review-service.com/inbox/",
    "type": "Service"
  },
  "target": {
    "id": "https://research-organisation.org/repository",
    "inbox": "https://research-organisation.org/inbox/",
    "type": "Service"
  },
  "type": [
    "Announce",
    "coar-notify:ReviewAction"
  ]
}
    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

    @context

    The @context must include:

    id

    Notify payloads 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 which should include Announce & coar-notify:ReviewAction

    actor

    The actor describes the party responsible for this activity. The actor has:

    • An id which must be an HTTP URI identifying the actor
    • A type which should be one of: Application, Group, Organization, Person or Service from AS 2.0.
    • The actor may also have a name

    origin

    The origin describes the system which has sent the notification. The origin has:

    • An id which is an HTTP URI identifying the sending system
    • A type which should include the value Service from AS 2.0.
    • An inbox which is the HTTP URI of the LDN inbox for the origin

    inReplyTo

    This particular example has the following properties:

    inReplyTo may be specified if this is a response to a previous notification. inReplyTo takes the URI (URN:UUID or HTTP URI) which identifies the activity for which this is a response.

    context

    When the object describes the result of some service acting on a resource, the context may be used to refer to that second resource. This particular example has the following properties:

    • An id which is the HTTP URI of the "landing page" for the resource.
    • A type which should include 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.

    object

    The object describes the resource which is the main focus of this notification. This particular example has the following properties:

    • id is the HTTP URI of the "landing page" for the resource.
    • type should include the value Document from AS 2.0, and sorg:Review
    • ietf:cite-as contains the persistent HTTP URI (sometimes called the "PID") which is to be used to cite or link to the resource.

    target

    The target describes the system which is intended to receive the notification. The target has:

    • An id which is an HTTP URI identifying the receiving system
    • A type which should include the value Service from AS 2.0.
    • An inbox which is the HTTP URI of the LDN inbox for the target

    {
  "@context": [
    "https://www.w3.org/ns/activitystreams",
    "https://purl.org/coar/notify"
  ],
  "actor": {
    "id": "https://isni:org/isni/00000001214005623",
    "name": "Jules Verne",
    "type": "Person"
  },
  "context": {
    "id": "https://research-organisation.org/repository/preprint/201203/421/",
    "ietf:cite-as": "https://doi.org/10.5555/12345680",
    "type": "sorg:AboutPage",
    "url": {
      "id": "https://research-organisation.org/repository/preprint/201203/421/content.pdf",
      "media-type": "application/pdf",
      "type": [
        "Article",
        "sorg:ScholarlyArticle"
      ]
    }
  },
  "id": "urn:uuid:d4ed8e1d-d6ce-4160-9f84-2546a72376a1",
  "inReplyTo": "urn:uuid:0370c0fb-bb78-4a9b-87f5-bed307a509dd",
  "object": {
    "id": "https://review-service.com/review/geo/202103/0021",
    "ietf:cite-as": "https://doi.org/10.3214/987654",
    "type": [
      "Document",
      "sorg:Review"
    ]
  },
  "origin": {
    "id": "https://review-service.com/system",
    "inbox": "https://review-service.com/inbox/",
    "type": "Service"
  },
  "target": {
    "id": "https://research-organisation.org/repository",
    "inbox": "https://research-organisation.org/inbox/",
    "type": "Service"
  },
  "type": [
    "Announce",
    "coar-notify:ReviewAction"
  ]
}
    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