Draft Marked for review

Offer of a resource to a service

This pattern is used to make an offer, where one system offers one of its resources for some activity to be conducted by a second system.

Properties

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 which should include at least the value Offer 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

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

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

Example JSON-LD Payload

(Get raw JSON-LD)
{
  "@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://some-organisation.org/resource/0021",
    "ietf:cite-as": "https://doi.org/10.4598/12123487",
    "type": "Document"
  },
  "origin": {
    "id": "https://some-organisation.org/system",
    "inbox": "https://some-organisation.org/system/inbox/",
    "type": "Service"
  },
  "target": {
    "id": "https://generic-service.com/system",
    "inbox": "https://generic-service.com/system/inbox/",
    "type": "Service"
  },
  "type": "Offer"
}