PCI Endorsement workflow: Request Endorsement

Properties

@context

The @context must include:

• https://www.w3.org/ns/activitystreams
• https://purl.org/coar/notify

actor

The author of the preprint. The author is identified by their email (in URI form) so that PCI can contact them out of band of the Notify protocol.

• id: "mailto:[email protected]"
• name: "Josiah Carberry"
• type: "Person"

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.

object

The object describes the resource which is the main focus of this notification.

In this particular example:

• 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.
• An ietf:item containing the details of the actual content resource. The ietf:item 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 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

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

type

The activity has a type which should include Offer & coar-notify:EndorsementAction

Example JSON-LD Payload

{
  "@context": [
    "https://www.w3.org/ns/activitystreams",
    "https://purl.org/coar/notify"
  ],
  "actor": {
    "id": "mailto:[email protected]",
    "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",
    "ietf:item": {
      "id": "https://research-organisation.org/repository/preprint/201203/421/content.pdf",
      "mediaType": "application/pdf",
      "type": [
        "Article",
        "sorg:ScholarlyArticle"
      ]
    },
    "type": "sorg:AboutPage"
  },
  "origin": {
    "id": "https://research-organisation.org/repository",
    "inbox": "https://research-organisation.org/inbox/",
    "type": "Service"
  },
  "target": {
    "id": "https://https://peercommunityin.org",
    "inbox": "https://peercommunityin.org/inbox/",
    "type": "Service"
  },
  "type": [
    "Offer",
    "coar-notify:EndorsementAction"
  ]
}

Get raw JSON-LD