Where do properties such as potentialAction/termsOfService sit? Event vs Offer vs Service

[drchristhorpe]

Proposer

Nick/Leigh/Chris on W3C call

Use Case

potentialAction to book and termsOfService of the booking could sit either at the level of the service, event or offer. Where do they sit best?

Why is this needed?

To reduce the amount of data/to model the data best

Proposal

Discussion should be had around where things should sit

[nickevansuk]

As mentioned on the same call, suggest that these sit inside some type of object related to the Event or Organizer. This would also allow them to be provided as a separate endpoint if a data provider wanted to optimise transfer (by allowing the object to be separately retrieved).

For example, an offerTemplate could be supplied in the organizer and to the bookingService that is applied to all offers from that Organization.

In some cases the organizer will have T&Cs: https://bookwhen.com/bounce#focus=ev-swa3-20180905183000 (see PDF on this page)
In some cases the bookingService will also have T&Cs: https://bookwhen.com/terms

For situations where both are available, both may need to be displayed or referenced (e.g. as Google Reserve requires).

Proposal below:

{
  "@context": "https://openactive.io/",
  "type": "Event",
  "name": "Tai chi Class",
  "url": "http://www.example.org/events/1",
  "startDate": "2017-03-22T20:00:00Z",
  "activity": [
    {
      "type": "Concept",
      "id": "https://openactive.io/activity-list#72ddb2dc-7d75-424e-880a-d90eabe91381",
      "inScheme": "https://openactive.io/activity-list",
      "prefLabel": "Running"
    }
  ],
  "organizer": {
    "type": "Organization",
    "name": "Central Speedball Association",
    "url": "http://www.speedball-world.com",
    "termsOfService": { "type": "TermsOfService", "url": "url"},
    "offerTemplate": {
      "type": "Offer",
      "taxRate": 0.23,
      "acceptedPaymentMethod": [ "http://purl.org/goodrelations/v1#PaymentCash" ]
    }
  },
  "bookingService": {
    "type": "BookingService",
    "name": "Playwaze",
    "url": "http://www.playwaze.com",
    "termsOfService": { "type": "TermsOfService", "url": "url" },
    "offerTemplate": {
      "type": "Offer",
      "acceptedPaymentMethod": [ "http://purl.org/goodrelations/v1#PaymentMethodCreditCard" ],
      "potentialAction": [
        {
          "type": "ReserveAction",
          "name": "Book",
          "target": {
            "type": "EntryPoint",
            "urlTemplate": "https://example.com/orders",
            "encodingType": "application/vnd.openactive.v0.7+json",
            "httpMethod": "POST"
          }
        }
      ]
    }
  },
  "offers": [
    {
      "type": "Offer",
      "name": "30 minute hire",
      "price": "15",
      "priceCurrency": "GBP"
    }
  ],
  "location": {
    "type": "Place",
    "name": "ExampleCo Gym",
    "address": {
      "type": "PostalAddress",
      "streetAddress": "1 High Street",
      "addressLocality": "Bristol",
      "addressRegion": "England",
      "addressCountry": "GB",
      "postalCode": "BS1 4SD"
    }
  }
}

[nickevansuk]

Noting that organizer is now singular rather than an array (which fits with the above), and the proposal for this bookingService structure exists here: openactive/modelling-opportunity-data#147

[nickevansuk]

Also noting another usecase for wanting to specify property values that apply to all offers in an Event.

[nickevansuk]

The key requirement for “bookingService” T&C does not appear to have been addressed.

Suggest adding rationale remediation performed to issues for future reference, and addressing this requirement in this case.

[nickevansuk]

Create termsOfService in both bookingService and organizer

[nickevansuk]

In the current specification termsOfService may only be specified at the seller, broker or bookingService level within the Order, which avoids issues with it being in the Offer.

The simplified API discovery approach has also removed the need for potentialAction and hence anything like offerTemplate