COAR Notify: Un-processable Notification

This pattern is used to indicate that a previously received Notify notification was un-processable for some reason. The reason is given in the summary property.

Properties

@context

@context is REQUIRED. It takes an array of URIs which MUST include:

https://www.w3.org/ns/activitystreams

and MUST include ONE of the following:

https://coar-notify.net (preferred)
https://purl.org/coar/notify instead (deprecated)

actor

actor is RECOMMENDED. It describes the party responsible for this activity. It:

MUST have an id which MUST be a URI identifying the actor (HTTP URIs are RECOMMENDED, but any valid URI is permitted)
MUST have a type which MUST be one of: Application, Group, Organization, Person or Service from Activity Streams 2.0.
MAY have a name which is a string containing the name of the party responsible for this activity

The inclusion of actor is highly RECOMMENDED in order to facilitate the broadest possible interoperability beyond the immediate COAR Notify context. Some external systems which can usefully consume notifications based on Activity Streams 2.0 may require the presence of an actor to function correctly.

id

id is REQUIRED. It MUST identify an Activity Streams 2.0 activity. Its value MUST be a single URI, and the use of URN:UUID is RECOMMENDED. An HTTP URI MAY be used instead, and in such cases the URI SHOULD resolve to a useful resource.

inReplyTo

inReplyTo is REQUIRED. It MUST be specified because this is a response to a previous notification. It takes the URI which identifies the activity for which this is a response.

object

object is REQUIRED. The object refers to the previous activity that was not processable. It MUST contain an id.

origin

origin is REQUIRED. It describes the system which has sent the notification. It:

MUST have an id which MUST be an HTTP URI identifying the sending system
MUST have a type which SHOULD include the value Service from Activity Streams 2.0
SHOULD have an inbox which, when present, MUST have the HTTP URI of the LDN inbox for the origin.

summary

summary is REQUIRED. Describes the reason (in plain text) that the request could not be processed.

target

target is REQUIRED. It describes the system which is intended to receive the notification. It:

MUST have an id which MUST be an HTTP URI identifying the receiving system
MUST have a type which SHOULD include the value Service from Activity Streams 2.0
MUST have an inbox which MUST have the HTTP URI of the LDN inbox for the target.

type

type is REQUIRED. The type of this activity MUST include the values:

Flag
coar-notify:UnprocessableNotification

Example JSON-LD Payload

Get raw JSON

{
  "@context": [
    "https://www.w3.org/ns/activitystreams",
    "https://coar-notify.net"
  ],
  "actor": {
    "id": "https://generic-service-1.com",
    "name": "Generic Service",
    "type": "Service"
  },
  "id": "urn:uuid:49dae4d9-4a16-4dcf-8ae0-a0cef139254c",
  "inReplyTo": "urn:uuid:0370c0fb-bb78-4a9b-87f5-bed307a509dd",
  "object": {
    "id": "urn:uuid:0370c0fb-bb78-4a9b-87f5-bed307a509dd"
  },
  "origin": {
    "id": "https://some-organisation.org",
    "inbox": "https://some-organisation.org/inbox/",
    "type": "Service"
  },
  "summary": "Unable to process URL: http://www.example.com/broken-url - returns HTTP error 404",
  "target": {
    "id": "https://generic-service.com/system",
    "inbox": "https://generic-service.com/system/inbox/",
    "type": "Service"
  },
  "type": [
    "Flag",
    "coar-notify:UnprocessableNotification"
  ]
}

Pattern: Un-processable Notification