Announcement (in response to offer)

This pattern is used to announce the outcome of an activity, sometimes (but not always) linking an original resource (referenced in context) to a new, related resource (referenced in object), in response to an offer made in a previous notification.

• Announce Endorsement from scenario 2: Author requests review with possible endorsement (via repository)
• Announce Ingest from scenario 6: Author submits to overlay journal using repository to host resource and reviews
• Announce Review from scenario 2: Author requests review with possible endorsement (via repository)
• Announce Review from scenario 5: Repository requests review (on behalf of corresponding author)
• Announce Review from scenario 9: Author requests reviews from review service, via repository
• Announce Review from scenario 9: Author requests reviews from review service, via repository

Properties

The @context must include:

• Activity Streams 2.0
• Notify

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 which should include at least the value Announce from AS 2.0.

actor

The activity should have an actor describing the party responsible for initiating this activity. The actor:

• has an id which must be an HTTP URI.
• has a type which should be one of: Application, Group, Organization, Person or Service from AS 2.0.
• may have a name

context

This activity has a context. The context has:

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

inReplyTo

inReplyTo is specified because 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.

object

This activity has an object.

origin

The activity has an origin describing the system which has sent the notification. The origin has:

• An id which is an HTTP URI identifying the generic-service.
• 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 generic-service

target

The activity has a target describing the system which is intended to receive the notification. The target has:

• An id which is an HTTP URI identifying the generic-organisation.
• 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 generic-organisation

Example JSON-LD Payload

{
  "@context": [
    "https://www.w3.org/ns/activitystreams",
    "https://purl.org/coar/notify"
  ],
  "actor": {
    "id": "https://generic-service.com",
    "name": "Generic Service",
    "type": "Service"
  },
  "context": {
    "id": "https://some-organisation.org/resource/0021",
    "ietf:cite-as": "https://doi.org/10.4598/12123487",
    "type": "Document"
  },
  "id": "urn:uuid:94ecae35-dcfd-4182-8550-22c7164fe23f",
  "inReplyTo": "urn:uuid:0370c0fb-bb78-4a9b-87f5-bed307a509dd",
  "object": {
    "id": "https://generic-service.com/resource/1234",
    "ietf:cite-as": "https://doi.org/10.9357/123003",
    "type": "Document"
  },
  "origin": {
    "id": "https://generic-service.com/system",
    "inbox": "https://generic-service.com/system/inbox/",
    "type": "Service"
  },
  "target": {
    "id": "https://some-organisation.org/system",
    "inbox": "https://some-organisation.org/system/inbox/",
    "type": "Service"
  },
  "type": "Announce"
}