< Return to Summary | File Generated: Tue Apr 16 2024 11:58:54 GMT+0000 (Coordinated Universal Time)

agent-broker >> customer-included (OpenBookingSimpleFlow >> ScheduledSession)

Booking Flow: OpenBookingSimpleFlow

Opportunity Type: ScheduledSession

Feature: Core / AgentBroker mode (Implemented)

Test: Successful request when customer is included in Order in AgentBroker mode

Successful request when customer is included in Order in AgentBroker mode

Running only this test

npm start -- --runInBand test/features/core/agent-broker/implemented/customer-included-test.js

Is this test failing?

The OpenActive Reference Implementation test result for this test can be used as a reference to help with debugging.

⚠️ 13 passed with 0 failures, 73 warnings and 42 suggestions

✅ Fetch Opportunities

Local Microservice Test Interface for OrderItem 0 Request

POST http://localhost:3000/test-interface/datasets/uat-ci/opportunities

{
  "@type": "ScheduledSession",
  "superEvent": {
    "@type": "SessionSeries",
    "organizer": {
      "@type": "Organization",
      "@id": "https://localhost:5001/api/identifiers/sellers/1"
    }
  },
  "@context": [
    "https://openactive.io/",
    "https://openactive.io/test-interface"
  ],
  "test:testOpportunityCriteria": "https://openactive.io/test-interface#TestOpportunityBookable",
  "test:testOpenBookingFlow": "https://openactive.io/test-interface#OpenBookingSimpleFlow"
}

Response status code: 200 OK. Responded in 44.748959ms.

{
  "@context": "https://openactive.io/",
  "@type": "ScheduledSession",
  "@id": "https://localhost:5001/api/identifiers/scheduled-sessions/136/events/1355"
}

Opportunity Feed extract for OrderItem 0 Request

GET http://localhost:3000/opportunity/https%3A%2F%2Flocalhost%3A5001%2Fapi%2Fidentifiers%2Fscheduled-sessions%2F136%2Fevents%2F1355?useCacheIfAvailable=true

Response status code: 200 OK. Responded in 7.290966ms.

{
  "data": {
    "@context": [
      "https://openactive.io/"
    ],
    "@type": "ScheduledSession",
    "@id": "https://localhost:5001/api/identifiers/scheduled-sessions/136/events/1355",
    "startDate": "2024-04-25T05:36:46+00:00",
    "endDate": "2024-04-25T06:11:46+00:00",
    "superEvent": {
      "@type": "SessionSeries",
      "@id": "https://localhost:5001/api/identifiers/session-series/136",
      "identifier": 136,
      "name": "GOLDEN: Cotton Zumba",
      "activity": [
        {
          "@type": "Concept",
          "@id": "https://openactive.io/activity-list#78503fa2-ed24-4a80-a224-e2e94581d8a8",
          "inScheme": "https://openactive.io/activity-list",
          "prefLabel": "Zumba®"
        }
      ],
      "eventAttendanceMode": "https://schema.org/OnlineEventAttendanceMode",
      "offers": [
        {
          "@type": "Offer",
          "@id": "https://localhost:5001/api/identifiers/session-series/136#/offers/0",
          "name": "Adult",
          "acceptedPaymentMethod": [
            "http://purl.org/goodrelations/v1#Cash",
            "http://purl.org/goodrelations/v1#PaymentMethodCreditCard"
          ],
          "ageRestriction": {
            "@type": "QuantitativeValue",
            "name": "Adult",
            "maxValue": 59,
            "minValue": 18
          },
          "allowCustomerCancellationFullRefund": false,
          "openBookingPrepayment": "https://openactive.io/Required",
          "price": 4.47,
          "priceCurrency": "GBP"
        },
        {
          "@type": "Offer",
          "@id": "https://localhost:5001/api/identifiers/session-series/136#/offers/0",
          "name": "Junior",
          "acceptedPaymentMethod": [
            "http://purl.org/goodrelations/v1#Cash",
            "http://purl.org/goodrelations/v1#PaymentMethodCreditCard"
          ],
          "ageRestriction": {
            "@type": "QuantitativeValue",
            "name": "Junior",
            "maxValue": 17
          },
          "allowCustomerCancellationFullRefund": false,
          "openBookingPrepayment": "https://openactive.io/Required",
          "price": 4.47,
          "priceCurrency": "GBP"
        },
        {
          "@type": "Offer",
          "@id": "https://localhost:5001/api/identifiers/session-series/136#/offers/0",
          "name": "Senior",
          "acceptedPaymentMethod": [
            "http://purl.org/goodrelations/v1#Cash",
            "http://purl.org/goodrelations/v1#PaymentMethodCreditCard"
          ],
          "ageRestriction": {
            "@type": "QuantitativeValue",
            "name": "Senior",
            "minValue": 60
          },
          "allowCustomerCancellationFullRefund": false,
          "openBookingPrepayment": "https://openactive.io/Required",
          "price": 4.47,
          "priceCurrency": "GBP"
        },
        {
          "@type": "Offer",
          "@id": "https://localhost:5001/api/identifiers/session-series/136#/offers/0",
          "name": "Adult (off-peak)",
          "acceptedPaymentMethod": [
            "http://purl.org/goodrelations/v1#Cash",
            "http://purl.org/goodrelations/v1#PaymentMethodCreditCard"
          ],
          "ageRestriction": {
            "@type": "QuantitativeValue",
            "name": "Adult (off-peak)",
            "maxValue": 59,
            "minValue": 18
          },
          "allowCustomerCancellationFullRefund": false,
          "openBookingPrepayment": "https://openactive.io/Required",
          "price": 4.47,
          "priceCurrency": "GBP"
        }
      ],
      "organizer": {
        "@type": "Organization",
        "@id": "https://localhost:5001/api/identifiers/sellers/1",
        "name": "Acme Fitness Ltd",
        "isOpenBookingAllowed": true,
        "sameAs": [
          "https://socialmedia.com/AcmeFitnessLtd"
        ],
        "taxMode": "https://openactive.io/TaxGross",
        "telephone": "06486 844612",
        "termsOfService": [
          {
            "@type": "PrivacyPolicy",
            "name": "Privacy Policy",
            "requiresExplicitConsent": false,
            "url": "https://example.com/privacy.html"
          }
        ],
        "url": "https://richmond.name"
      },
      "url": "https://www.example.com/sessions/136"
    },
    "duration": "PT35M",
    "maximumAttendeeCapacity": 2,
    "remainingAttendeeCapacity": 2
  }
}

Specs

✅ should return 200 on success for request relevant to OrderItem 0

✅ Fetch Opportunities >> validation of Opportunity Feed extract for OrderItem 0

Specs

✅ passes validation checks
✅ matches the criteria 'TestOpportunityBookable' required for this test

Validations

⚠️ $.eventStatus: Recommended property eventStatus is missing from ScheduledSession.
⚠️ $.leader: Recommended property leader is missing from ScheduledSession.
⚠️ $.url: Recommended property url is missing from ScheduledSession.
⚠️ $.superEvent.description: Recommended property description is missing from SessionSeries.
⚠️ $.superEvent.image: Recommended property image is missing from SessionSeries.
⚠️ $.superEvent.ageRange: Recommended property ageRange is missing from SessionSeries.
⚠️ $.superEvent.genderRestriction: Recommended property genderRestriction is missing from SessionSeries.
⚠️ $.superEvent.leader: Recommended property leader is missing from SessionSeries.
⚠️ $.superEvent.level: Recommended property level is missing from SessionSeries.
📝 $.genderRestriction: Data consumers will assume that there is no gender restriction when no valid genderRestriction is supplied on a ScheduledSession.
📝 $.ageRange: Data consumers will assume that the ageRange is 18+ when not specified.
📝 $.eventStatus: Data consumers will assume the eventStatus is scheduled if not specified or invalid.
📝 $.superEvent.genderRestriction: Data consumers will assume that there is no gender restriction when no valid genderRestriction is supplied on a SessionSeries.
📝 $.superEvent.ageRange: Data consumers will assume that the ageRange is 18+ when not specified.
📝 $.superEvent.eventStatus: Data consumers will assume the eventStatus is scheduled if not specified or invalid.
❔ $.superEvent.offers[0].ageRestriction.name: schema:name is declared in schema.org but this validator is not yet capable of checking whether they have the right format or values. You should refer to the schema.org documentation for schema:name for additional guidance.
❔ $.superEvent.offers[1].ageRestriction.name: schema:name is declared in schema.org but this validator is not yet capable of checking whether they have the right format or values. You should refer to the schema.org documentation for schema:name for additional guidance.
❔ $.superEvent.offers[2].ageRestriction.name: schema:name is declared in schema.org but this validator is not yet capable of checking whether they have the right format or values. You should refer to the schema.org documentation for schema:name for additional guidance.
❔ $.superEvent.offers[3].ageRestriction.name: schema:name is declared in schema.org but this validator is not yet capable of checking whether they have the right format or values. You should refer to the schema.org documentation for schema:name for additional guidance.

✅ C1

C1 Request

PUT https://localhost:5001/api/openbooking/order-quote-templates/2bab2a4e-dbe6-4b62-8812-284fd52500c5

Content-Type: "application/vnd.openactive.booking+json; version=1"
Authorization: "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6IkIwNEY3QjkxREUzQjk0NzhDNjE4MzNGQjI0QUE1Q0RCIiwidHlwIjoiYXQrand0In0.eyJuYmYiOjE3MTMyNjcyMzMsImV4cCI6MTcxMzI3MDgzMywiaXNzIjoiaHR0cHM6Ly9sb2NhbGhvc3Q6NTAwMyIsImF1ZCI6Im9wZW5ib29raW5nIiwiY2xpZW50X2lkIjoiNTk5OGNkN2EtNTBiYy00NTFjLThiYmYtNzA5MDFjZmQ5ZGU2IiwiaHR0cHM6Ly9vcGVuYWN0aXZlLmlvL2NsaWVudElkIjoiNTk5OGNkN2EtNTBiYy00NTFjLThiYmYtNzA5MDFjZmQ5ZGU2Iiwic3ViIjoiMTAwIiwiYXV0aF90aW1lIjoxNzEzMjY3MjMyLCJpZHAiOiJsb2NhbCIsImh0dHBzOi8vb3BlbmFjdGl2ZS5pby9zZWxsZXJJZCI6Imh0dHBzOi8vbG9jYWxob3N0OjUwMDEvYXBpL2lkZW50aWZpZXJzL3NlbGxlcnMvMSIsImp0aSI6IjkxRDk5MjFFNjQ1RkRFRDNGRjk1MDlGMDgxNDdEODczIiwic2lkIjoiODIzNDcwMEQ5OURBQTlBMTAxNTc2RkREMkQ3RDUxNDAiLCJpYXQiOjE3MTMyNjcyMzMsInNjb3BlIjpbIm9wZW5pZCIsIm9wZW5hY3RpdmUtb3BlbmJvb2tpbmciLCJvcGVuYWN0aXZlLWlkZW50aXR5Iiwib2ZmbGluZV9hY2Nlc3MiXSwiYW1yIjpbInB3ZCJdfQ.R83BB6ONQqCqUiTUTCHCnodiyuj8osyvoGL-grmmNeV04TCjnMdcUVHKPNmvtdkTAK0WNzyJ02P4fIR4FW86bIL1xOYQxZrqLX-8cyzkznh028-qze_te3PV4dfuIRnyVSqjT_WCLi7CO31qt6ATtxNg6Mfa6extC5epc9I8Wi5EvPhDpKOIKfRu5DPIOI9ugiWwRBQ06QdRYz3Y1tLLxCjbL8KQ9kPCHuQwlYIqk8CDZsx46lrE8sm1WHxq_Y_yEQJLGwfpuR2AsChECWSWe6EHJxyIDN140uSczmv6gta3hL43P2SeqGVpe_SU01VR55dAc-tkcXHih67vxnGkVQ"

{
  "@context": "https://openactive.io/",
  "@type": "OrderQuote",
  "brokerRole": "https://openactive.io/AgentBroker",
  "broker": {
    "@type": "Organization",
    "name": "MyFitnessApp",
    "url": "https://myfitnessapp.example.com",
    "description": "A fitness app for all the community",
    "logo": {
      "@type": "ImageObject",
      "url": "http://data.myfitnessapp.org.uk/images/logo.png"
    },
    "address": {
      "@type": "PostalAddress",
      "streetAddress": "Alan Peacock Way",
      "addressLocality": "Village East",
      "addressRegion": "Middlesbrough",
      "postalCode": "TS4 3AE",
      "addressCountry": "GB"
    }
  },
  "seller": "https://localhost:5001/api/identifiers/sellers/1",
  "orderedItem": [
    {
      "@type": "OrderItem",
      "position": 0,
      "acceptedOffer": "https://localhost:5001/api/identifiers/session-series/136#/offers/0",
      "orderedItem": "https://localhost:5001/api/identifiers/scheduled-sessions/136/events/1355"
    }
  ],
  "payment": {
    "@type": "Payment",
    "name": "AcmeBroker Points",
    "accountId": "SN1593",
    "paymentProviderId": "STRIPE"
  }
}

Response status code: 200 OK. Responded in 432.103899ms.

{
  "@context": "https://openactive.io/",
  "@type": "OrderQuote",
  "@id": "https://localhost:5001/api/openbooking/order-quotes/2bab2a4e-dbe6-4b62-8812-284fd52500c5",
  "lease": {
    "@type": "Lease",
    "leaseExpires": "2024-04-16T12:03:57+00:00"
  },
  "orderRequiresApproval": false,
  "bookingService": {
    "@type": "BookingService",
    "name": "Acme booking system",
    "termsOfService": [
      {
        "@type": "PrivacyPolicy",
        "name": "Privacy Policy",
        "requiresExplicitConsent": false,
        "url": "https://example.com/privacy.html"
      }
    ],
    "url": "https://example.com"
  },
  "broker": {
    "@type": "Organization",
    "name": "MyFitnessApp",
    "url": "https://myfitnessapp.example.com"
  },
  "brokerRole": "https://openactive.io/AgentBroker",
  "orderedItem": [
    {
      "@type": "OrderItem",
      "acceptedOffer": {
        "@type": "Offer",
        "@id": "https://localhost:5001/api/identifiers/session-series/136#/offers/0",
        "allowCustomerCancellationFullRefund": false,
        "openBookingPrepayment": "https://openactive.io/Required",
        "price": 4.47,
        "priceCurrency": "GBP"
      },
      "orderedItem": {
        "@type": "ScheduledSession",
        "@id": "https://localhost:5001/api/identifiers/scheduled-sessions/136/events/1355",
        "startDate": "2024-04-25T05:36:46+00:00",
        "endDate": "2024-04-25T06:11:46+00:00",
        "superEvent": {
          "@type": "SessionSeries",
          "@id": "https://localhost:5001/api/identifiers/session-series/136",
          "name": "Cotton Zumba",
          "activity": [
            {
              "@type": "Concept",
              "@id": "https://openactive.io/activity-list#6bdea630-ad22-4e58-98a3-bca26ee3f1da",
              "inScheme": "https://openactive.io/activity-list",
              "prefLabel": "Rave Fitness"
            }
          ],
          "location": {
            "@type": "Place",
            "@id": "https://example.com/place/3",
            "identifier": 3,
            "name": "Stroll & Stretch",
            "description": "Casual Calisthenics in the Heart of Commerce. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
            "address": {
              "@type": "PostalAddress",
              "addressCountry": "GB",
              "addressLocality": "Oxford",
              "addressRegion": "Oxfordshire",
              "postalCode": "OX1 1UU",
              "streetAddress": "Norfolk Street"
            },
            "geo": {
              "@type": "GeoCoordinates",
              "latitude": 51.749826,
              "longitude": -1.261492
            },
            "image": [
              {
                "@type": "ImageObject",
                "url": "https://upload.wikimedia.org/wikipedia/commons/2/28/Westfield_Garden_State_Plaza_-_panoramio.jpg"
              }
            ],
            "openingHoursSpecification": [
              {
                "@type": "OpeningHoursSpecification",
                "closes": "17:30",
                "dayOfWeek": [
                  "https://schema.org/Sunday"
                ],
                "opens": "09:00"
              },
              {
                "@type": "OpeningHoursSpecification",
                "closes": "21:30",
                "dayOfWeek": [
                  "https://schema.org/Monday"
                ],
                "opens": "06:30"
              },
              {
                "@type": "OpeningHoursSpecification",
                "closes": "21:30",
                "dayOfWeek": [
                  "https://schema.org/Tuesday"
                ],
                "opens": "06:30"
              },
              {
                "@type": "OpeningHoursSpecification",
                "closes": "21:30",
                "dayOfWeek": [
                  "https://schema.org/Wednesday"
                ],
                "opens": "06:30"
              },
              {
                "@type": "OpeningHoursSpecification",
                "closes": "21:30",
                "dayOfWeek": [
                  "https://schema.org/Thursday"
                ],
                "opens": "06:30"
              },
              {
                "@type": "OpeningHoursSpecification",
                "closes": "21:30",
                "dayOfWeek": [
                  "https://schema.org/Friday"
                ],
                "opens": "06:30"
              },
              {
                "@type": "OpeningHoursSpecification",
                "closes": "17:30",
                "dayOfWeek": [
                  "https://schema.org/Saturday"
                ],
                "opens": "09:00"
              }
            ],
            "telephone": "01865 000003",
            "url": "https://en.wikipedia.org/wiki/Shopping_center"
          },
          "url": "https://example.com/events/136"
        },
        "maximumAttendeeCapacity": 2,
        "remainingAttendeeCapacity": 2
      },
      "position": 0,
      "unitTaxSpecification": [
        {
          "@type": "TaxChargeSpecification",
          "name": "VAT at 20%",
          "price": 0.894,
          "priceCurrency": "GBP",
          "rate": 0.2
        }
      ]
    }
  ],
  "payment": {
    "@type": "Payment",
    "name": "AcmeBroker Points",
    "accountId": "SN1593",
    "paymentProviderId": "STRIPE"
  },
  "seller": {
    "@type": "Organization",
    "@id": "https://localhost:5001/api/identifiers/sellers/1",
    "name": "Acme Fitness Ltd",
    "address": {
      "@type": "PostalAddress",
      "addressCountry": "GB",
      "addressLocality": "Another town",
      "addressRegion": "Oxfordshire",
      "postalCode": "OX1 1AA",
      "streetAddress": "1 Hidden Gem"
    },
    "isOpenBookingAllowed": true,
    "legalName": "Acme Fitness Ltd",
    "taxMode": "https://openactive.io/TaxGross",
    "termsOfService": [
      {
        "@type": "PrivacyPolicy",
        "name": "Privacy Policy",
        "requiresExplicitConsent": false,
        "url": "https://example.com/privacy.html"
      }
    ]
  },
  "totalPaymentDue": {
    "@type": "PriceSpecification",
    "openBookingPrepayment": "https://openactive.io/Required",
    "price": 4.47,
    "priceCurrency": "GBP"
  },
  "totalPaymentTax": [
    {
      "@type": "TaxChargeSpecification",
      "name": "VAT at 20%",
      "price": 0.894,
      "priceCurrency": "GBP",
      "rate": 0.2
    }
  ]
}

Specs

✅ should return 200 on success
✅ Should have the same number of OrderItems as criteria
✅ OrderItem at position 0 - capacities should not have changed from their initial values after C1/C2 (regardless of leasing)

✅ C1 >> validation of C1

Specs

✅ passes validation checks

Validations

⚠️ $.orderedItem[0].acceptedOffer.name: Recommended property name is missing from Offer.
⚠️ $.orderedItem[0].acceptedOffer.ageRestriction: Recommended property ageRestriction is missing from Offer.
⚠️ $.orderedItem[0].orderedItem.eventStatus: Recommended property eventStatus is missing from ScheduledSession.
⚠️ $.orderedItem[0].orderedItem.superEvent.ageRange: Recommended property ageRange is missing from SessionSeries.
⚠️ $.orderedItem[0].orderedItem.superEvent.genderRestriction: Recommended property genderRestriction is missing from SessionSeries.
⚠️ $.orderedItem[0].orderedItem.superEvent.eventStatus: Recommended property eventStatus is missing from SessionSeries.
⚠️ $.orderedItem[0].orderedItem.superEvent.location.amenityFeature: Recommended property amenityFeature is missing from Place.
⚠️ $.seller.email: Recommended property email is missing from Organization.
⚠️ $.seller.url: Recommended property url is missing from Organization.
⚠️ $.seller.logo: Recommended property logo is missing from Organization.
⚠️ $.seller.vatID: Recommended property vatID is missing from Organization.
📝 $.orderedItem[0].orderedItem.genderRestriction: Data consumers will assume that there is no gender restriction when no valid genderRestriction is supplied on a ScheduledSession.
📝 $.orderedItem[0].orderedItem.ageRange: Data consumers will assume that the ageRange is 18+ when not specified.
📝 $.orderedItem[0].orderedItem.eventStatus: Data consumers will assume the eventStatus is scheduled if not specified or invalid.
📝 $.orderedItem[0].orderedItem.superEvent.genderRestriction: Data consumers will assume that there is no gender restriction when no valid genderRestriction is supplied on a SessionSeries.
📝 $.orderedItem[0].orderedItem.superEvent.ageRange: Data consumers will assume that the ageRange is 18+ when not specified.
📝 $.orderedItem[0].orderedItem.superEvent.eventStatus: Data consumers will assume the eventStatus is scheduled if not specified or invalid.

✅ Assert Opportunity Capacity (after C1)

Opportunity Feed extract for OrderItem 0 Request

GET http://localhost:3000/opportunity/https%3A%2F%2Flocalhost%3A5001%2Fapi%2Fidentifiers%2Fscheduled-sessions%2F136%2Fevents%2F1355?useCacheIfAvailable=true&expectedCapacity=1

Response status code: 200 OK. Responded in 462.884734ms.

{
  "state": "updated",
  "id": "https://localhost:5001/api/identifiers/scheduled-sessions/136/events/1355",
  "modified": "1713268739157",
  "data": {
    "@context": [
      "https://openactive.io/"
    ],
    "@type": "ScheduledSession",
    "@id": "https://localhost:5001/api/identifiers/scheduled-sessions/136/events/1355",
    "startDate": "2024-04-25T05:36:46+00:00",
    "endDate": "2024-04-25T06:11:46+00:00",
    "superEvent": {
      "@type": "SessionSeries",
      "@id": "https://localhost:5001/api/identifiers/session-series/136",
      "identifier": 136,
      "name": "GOLDEN: Cotton Zumba",
      "activity": [
        {
          "@type": "Concept",
          "@id": "https://openactive.io/activity-list#78503fa2-ed24-4a80-a224-e2e94581d8a8",
          "inScheme": "https://openactive.io/activity-list",
          "prefLabel": "Zumba®"
        }
      ],
      "eventAttendanceMode": "https://schema.org/OnlineEventAttendanceMode",
      "offers": [
        {
          "@type": "Offer",
          "@id": "https://localhost:5001/api/identifiers/session-series/136#/offers/0",
          "name": "Adult",
          "acceptedPaymentMethod": [
            "http://purl.org/goodrelations/v1#Cash",
            "http://purl.org/goodrelations/v1#PaymentMethodCreditCard"
          ],
          "ageRestriction": {
            "@type": "QuantitativeValue",
            "name": "Adult",
            "maxValue": 59,
            "minValue": 18
          },
          "allowCustomerCancellationFullRefund": false,
          "openBookingPrepayment": "https://openactive.io/Required",
          "price": 4.47,
          "priceCurrency": "GBP"
        },
        {
          "@type": "Offer",
          "@id": "https://localhost:5001/api/identifiers/session-series/136#/offers/0",
          "name": "Junior",
          "acceptedPaymentMethod": [
            "http://purl.org/goodrelations/v1#Cash",
            "http://purl.org/goodrelations/v1#PaymentMethodCreditCard"
          ],
          "ageRestriction": {
            "@type": "QuantitativeValue",
            "name": "Junior",
            "maxValue": 17
          },
          "allowCustomerCancellationFullRefund": false,
          "openBookingPrepayment": "https://openactive.io/Required",
          "price": 4.47,
          "priceCurrency": "GBP"
        },
        {
          "@type": "Offer",
          "@id": "https://localhost:5001/api/identifiers/session-series/136#/offers/0",
          "name": "Senior",
          "acceptedPaymentMethod": [
            "http://purl.org/goodrelations/v1#Cash",
            "http://purl.org/goodrelations/v1#PaymentMethodCreditCard"
          ],
          "ageRestriction": {
            "@type": "QuantitativeValue",
            "name": "Senior",
            "minValue": 60
          },
          "allowCustomerCancellationFullRefund": false,
          "openBookingPrepayment": "https://openactive.io/Required",
          "price": 4.47,
          "priceCurrency": "GBP"
        },
        {
          "@type": "Offer",
          "@id": "https://localhost:5001/api/identifiers/session-series/136#/offers/0",
          "name": "Adult (off-peak)",
          "acceptedPaymentMethod": [
            "http://purl.org/goodrelations/v1#Cash",
            "http://purl.org/goodrelations/v1#PaymentMethodCreditCard"
          ],
          "ageRestriction": {
            "@type": "QuantitativeValue",
            "name": "Adult (off-peak)",
            "maxValue": 59,
            "minValue": 18
          },
          "allowCustomerCancellationFullRefund": false,
          "openBookingPrepayment": "https://openactive.io/Required",
          "price": 4.47,
          "priceCurrency": "GBP"
        }
      ],
      "organizer": {
        "@type": "Organization",
        "@id": "https://localhost:5001/api/identifiers/sellers/1",
        "name": "Acme Fitness Ltd",
        "isOpenBookingAllowed": true,
        "sameAs": [
          "https://socialmedia.com/AcmeFitnessLtd"
        ],
        "taxMode": "https://openactive.io/TaxGross",
        "telephone": "06486 844612",
        "termsOfService": [
          {
            "@type": "PrivacyPolicy",
            "name": "Privacy Policy",
            "requiresExplicitConsent": false,
            "url": "https://example.com/privacy.html"
          }
        ],
        "url": "https://richmond.name"
      },
      "url": "https://www.example.com/sessions/136"
    },
    "duration": "PT35M",
    "maximumAttendeeCapacity": 2,
    "remainingAttendeeCapacity": 1
  }
}

Specs

✅ should return 200 on success for request relevant to OrderItem 0

✅ Assert Opportunity Capacity (after C1) >> validation of Opportunity Feed extract for OrderItem 0

Specs

✅ passes validation checks

Validations

⚠️ $.eventStatus: Recommended property eventStatus is missing from ScheduledSession.
⚠️ $.leader: Recommended property leader is missing from ScheduledSession.
⚠️ $.url: Recommended property url is missing from ScheduledSession.
⚠️ $.superEvent.description: Recommended property description is missing from SessionSeries.
⚠️ $.superEvent.image: Recommended property image is missing from SessionSeries.
⚠️ $.superEvent.ageRange: Recommended property ageRange is missing from SessionSeries.
⚠️ $.superEvent.genderRestriction: Recommended property genderRestriction is missing from SessionSeries.
⚠️ $.superEvent.leader: Recommended property leader is missing from SessionSeries.
⚠️ $.superEvent.level: Recommended property level is missing from SessionSeries.
📝 $.genderRestriction: Data consumers will assume that there is no gender restriction when no valid genderRestriction is supplied on a ScheduledSession.
📝 $.ageRange: Data consumers will assume that the ageRange is 18+ when not specified.
📝 $.eventStatus: Data consumers will assume the eventStatus is scheduled if not specified or invalid.
📝 $.superEvent.genderRestriction: Data consumers will assume that there is no gender restriction when no valid genderRestriction is supplied on a SessionSeries.
📝 $.superEvent.ageRange: Data consumers will assume that the ageRange is 18+ when not specified.
📝 $.superEvent.eventStatus: Data consumers will assume the eventStatus is scheduled if not specified or invalid.
❔ $.superEvent.offers[0].ageRestriction.name: schema:name is declared in schema.org but this validator is not yet capable of checking whether they have the right format or values. You should refer to the schema.org documentation for schema:name for additional guidance.
❔ $.superEvent.offers[1].ageRestriction.name: schema:name is declared in schema.org but this validator is not yet capable of checking whether they have the right format or values. You should refer to the schema.org documentation for schema:name for additional guidance.
❔ $.superEvent.offers[2].ageRestriction.name: schema:name is declared in schema.org but this validator is not yet capable of checking whether they have the right format or values. You should refer to the schema.org documentation for schema:name for additional guidance.
❔ $.superEvent.offers[3].ageRestriction.name: schema:name is declared in schema.org but this validator is not yet capable of checking whether they have the right format or values. You should refer to the schema.org documentation for schema:name for additional guidance.

✅ C2

C2 Request

PUT https://localhost:5001/api/openbooking/order-quotes/2bab2a4e-dbe6-4b62-8812-284fd52500c5

Content-Type: "application/vnd.openactive.booking+json; version=1"
Authorization: "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6IkIwNEY3QjkxREUzQjk0NzhDNjE4MzNGQjI0QUE1Q0RCIiwidHlwIjoiYXQrand0In0.eyJuYmYiOjE3MTMyNjcyMzMsImV4cCI6MTcxMzI3MDgzMywiaXNzIjoiaHR0cHM6Ly9sb2NhbGhvc3Q6NTAwMyIsImF1ZCI6Im9wZW5ib29raW5nIiwiY2xpZW50X2lkIjoiNTk5OGNkN2EtNTBiYy00NTFjLThiYmYtNzA5MDFjZmQ5ZGU2IiwiaHR0cHM6Ly9vcGVuYWN0aXZlLmlvL2NsaWVudElkIjoiNTk5OGNkN2EtNTBiYy00NTFjLThiYmYtNzA5MDFjZmQ5ZGU2Iiwic3ViIjoiMTAwIiwiYXV0aF90aW1lIjoxNzEzMjY3MjMyLCJpZHAiOiJsb2NhbCIsImh0dHBzOi8vb3BlbmFjdGl2ZS5pby9zZWxsZXJJZCI6Imh0dHBzOi8vbG9jYWxob3N0OjUwMDEvYXBpL2lkZW50aWZpZXJzL3NlbGxlcnMvMSIsImp0aSI6IjkxRDk5MjFFNjQ1RkRFRDNGRjk1MDlGMDgxNDdEODczIiwic2lkIjoiODIzNDcwMEQ5OURBQTlBMTAxNTc2RkREMkQ3RDUxNDAiLCJpYXQiOjE3MTMyNjcyMzMsInNjb3BlIjpbIm9wZW5pZCIsIm9wZW5hY3RpdmUtb3BlbmJvb2tpbmciLCJvcGVuYWN0aXZlLWlkZW50aXR5Iiwib2ZmbGluZV9hY2Nlc3MiXSwiYW1yIjpbInB3ZCJdfQ.R83BB6ONQqCqUiTUTCHCnodiyuj8osyvoGL-grmmNeV04TCjnMdcUVHKPNmvtdkTAK0WNzyJ02P4fIR4FW86bIL1xOYQxZrqLX-8cyzkznh028-qze_te3PV4dfuIRnyVSqjT_WCLi7CO31qt6ATtxNg6Mfa6extC5epc9I8Wi5EvPhDpKOIKfRu5DPIOI9ugiWwRBQ06QdRYz3Y1tLLxCjbL8KQ9kPCHuQwlYIqk8CDZsx46lrE8sm1WHxq_Y_yEQJLGwfpuR2AsChECWSWe6EHJxyIDN140uSczmv6gta3hL43P2SeqGVpe_SU01VR55dAc-tkcXHih67vxnGkVQ"

{
  "@context": "https://openactive.io/",
  "@type": "OrderQuote",
  "brokerRole": "https://openactive.io/AgentBroker",
  "broker": {
    "@type": "Organization",
    "name": "MyFitnessApp",
    "url": "https://myfitnessapp.example.com",
    "description": "A fitness app for all the community",
    "logo": {
      "@type": "ImageObject",
      "url": "http://data.myfitnessapp.org.uk/images/logo.png"
    },
    "address": {
      "@type": "PostalAddress",
      "streetAddress": "Alan Peacock Way",
      "addressLocality": "Village East",
      "addressRegion": "Middlesbrough",
      "postalCode": "TS4 3AE",
      "addressCountry": "GB"
    }
  },
  "seller": "https://localhost:5001/api/identifiers/sellers/1",
  "customer": {
    "@type": "Person",
    "email": "[email protected]",
    "givenName": "Steuber",
    "familyName": "Conrad"
  },
  "orderedItem": [
    {
      "@type": "OrderItem",
      "position": 0,
      "acceptedOffer": "https://localhost:5001/api/identifiers/session-series/136#/offers/0",
      "orderedItem": "https://localhost:5001/api/identifiers/scheduled-sessions/136/events/1355"
    }
  ],
  "payment": {
    "@type": "Payment",
    "name": "AcmeBroker Points",
    "accountId": "SN1593",
    "paymentProviderId": "STRIPE"
  }
}

Response status code: 200 OK. Responded in 558.499863ms.

{
  "@context": "https://openactive.io/",
  "@type": "OrderQuote",
  "@id": "https://localhost:5001/api/openbooking/order-quotes/2bab2a4e-dbe6-4b62-8812-284fd52500c5",
  "lease": {
    "@type": "Lease",
    "leaseExpires": "2024-04-16T12:04:00+00:00"
  },
  "orderRequiresApproval": false,
  "bookingService": {
    "@type": "BookingService",
    "name": "Acme booking system",
    "termsOfService": [
      {
        "@type": "PrivacyPolicy",
        "name": "Privacy Policy",
        "requiresExplicitConsent": false,
        "url": "https://example.com/privacy.html"
      }
    ],
    "url": "https://example.com"
  },
  "broker": {
    "@type": "Organization",
    "name": "MyFitnessApp",
    "url": "https://myfitnessapp.example.com"
  },
  "brokerRole": "https://openactive.io/AgentBroker",
  "customer": {
    "@type": "Person",
    "email": "[email protected]",
    "familyName": "Conrad",
    "givenName": "Steuber"
  },
  "orderedItem": [
    {
      "@type": "OrderItem",
      "acceptedOffer": {
        "@type": "Offer",
        "@id": "https://localhost:5001/api/identifiers/session-series/136#/offers/0",
        "allowCustomerCancellationFullRefund": false,
        "openBookingPrepayment": "https://openactive.io/Required",
        "price": 4.47,
        "priceCurrency": "GBP"
      },
      "orderedItem": {
        "@type": "ScheduledSession",
        "@id": "https://localhost:5001/api/identifiers/scheduled-sessions/136/events/1355",
        "startDate": "2024-04-25T05:36:46+00:00",
        "endDate": "2024-04-25T06:11:46+00:00",
        "superEvent": {
          "@type": "SessionSeries",
          "@id": "https://localhost:5001/api/identifiers/session-series/136",
          "name": "Cotton Zumba",
          "activity": [
            {
              "@type": "Concept",
              "@id": "https://openactive.io/activity-list#6bdea630-ad22-4e58-98a3-bca26ee3f1da",
              "inScheme": "https://openactive.io/activity-list",
              "prefLabel": "Rave Fitness"
            }
          ],
          "location": {
            "@type": "Place",
            "@id": "https://example.com/place/3",
            "identifier": 3,
            "name": "Stroll & Stretch",
            "description": "Casual Calisthenics in the Heart of Commerce. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
            "address": {
              "@type": "PostalAddress",
              "addressCountry": "GB",
              "addressLocality": "Oxford",
              "addressRegion": "Oxfordshire",
              "postalCode": "OX1 1UU",
              "streetAddress": "Norfolk Street"
            },
            "geo": {
              "@type": "GeoCoordinates",
              "latitude": 51.749826,
              "longitude": -1.261492
            },
            "image": [
              {
                "@type": "ImageObject",
                "url": "https://upload.wikimedia.org/wikipedia/commons/2/28/Westfield_Garden_State_Plaza_-_panoramio.jpg"
              }
            ],
            "openingHoursSpecification": [
              {
                "@type": "OpeningHoursSpecification",
                "closes": "17:30",
                "dayOfWeek": [
                  "https://schema.org/Sunday"
                ],
                "opens": "09:00"
              },
              {
                "@type": "OpeningHoursSpecification",
                "closes": "21:30",
                "dayOfWeek": [
                  "https://schema.org/Monday"
                ],
                "opens": "06:30"
              },
              {
                "@type": "OpeningHoursSpecification",
                "closes": "21:30",
                "dayOfWeek": [
                  "https://schema.org/Tuesday"
                ],
                "opens": "06:30"
              },
              {
                "@type": "OpeningHoursSpecification",
                "closes": "21:30",
                "dayOfWeek": [
                  "https://schema.org/Wednesday"
                ],
                "opens": "06:30"
              },
              {
                "@type": "OpeningHoursSpecification",
                "closes": "21:30",
                "dayOfWeek": [
                  "https://schema.org/Thursday"
                ],
                "opens": "06:30"
              },
              {
                "@type": "OpeningHoursSpecification",
                "closes": "21:30",
                "dayOfWeek": [
                  "https://schema.org/Friday"
                ],
                "opens": "06:30"
              },
              {
                "@type": "OpeningHoursSpecification",
                "closes": "17:30",
                "dayOfWeek": [
                  "https://schema.org/Saturday"
                ],
                "opens": "09:00"
              }
            ],
            "telephone": "01865 000003",
            "url": "https://en.wikipedia.org/wiki/Shopping_center"
          },
          "url": "https://example.com/events/136"
        },
        "maximumAttendeeCapacity": 2,
        "remainingAttendeeCapacity": 2
      },
      "position": 0,
      "unitTaxSpecification": [
        {
          "@type": "TaxChargeSpecification",
          "name": "VAT at 20%",
          "price": 0.894,
          "priceCurrency": "GBP",
          "rate": 0.2
        }
      ]
    }
  ],
  "payment": {
    "@type": "Payment",
    "name": "AcmeBroker Points",
    "accountId": "SN1593",
    "paymentProviderId": "STRIPE"
  },
  "seller": {
    "@type": "Organization",
    "@id": "https://localhost:5001/api/identifiers/sellers/1",
    "name": "Acme Fitness Ltd",
    "address": {
      "@type": "PostalAddress",
      "addressCountry": "GB",
      "addressLocality": "Another town",
      "addressRegion": "Oxfordshire",
      "postalCode": "OX1 1AA",
      "streetAddress": "1 Hidden Gem"
    },
    "isOpenBookingAllowed": true,
    "legalName": "Acme Fitness Ltd",
    "taxMode": "https://openactive.io/TaxGross",
    "termsOfService": [
      {
        "@type": "PrivacyPolicy",
        "name": "Privacy Policy",
        "requiresExplicitConsent": false,
        "url": "https://example.com/privacy.html"
      }
    ]
  },
  "totalPaymentDue": {
    "@type": "PriceSpecification",
    "openBookingPrepayment": "https://openactive.io/Required",
    "price": 4.47,
    "priceCurrency": "GBP"
  },
  "totalPaymentTax": [
    {
      "@type": "TaxChargeSpecification",
      "name": "VAT at 20%",
      "price": 0.894,
      "priceCurrency": "GBP",
      "rate": 0.2
    }
  ]
}

Specs

✅ should return 200 on success
✅ Should have the same number of OrderItems as criteria
✅ OrderItem at position 0 - capacities should not have changed from their initial values after C1/C2 (regardless of leasing)

✅ C2 >> validation of C2

Specs

✅ passes validation checks

Validations

⚠️ $.orderedItem[0].acceptedOffer.name: Recommended property name is missing from Offer.
⚠️ $.orderedItem[0].acceptedOffer.ageRestriction: Recommended property ageRestriction is missing from Offer.
⚠️ $.orderedItem[0].orderedItem.eventStatus: Recommended property eventStatus is missing from ScheduledSession.
⚠️ $.orderedItem[0].orderedItem.superEvent.ageRange: Recommended property ageRange is missing from SessionSeries.
⚠️ $.orderedItem[0].orderedItem.superEvent.genderRestriction: Recommended property genderRestriction is missing from SessionSeries.
⚠️ $.orderedItem[0].orderedItem.superEvent.eventStatus: Recommended property eventStatus is missing from SessionSeries.
⚠️ $.orderedItem[0].orderedItem.superEvent.location.amenityFeature: Recommended property amenityFeature is missing from Place.
⚠️ $.seller.email: Recommended property email is missing from Organization.
⚠️ $.seller.url: Recommended property url is missing from Organization.
⚠️ $.seller.logo: Recommended property logo is missing from Organization.
⚠️ $.seller.vatID: Recommended property vatID is missing from Organization.
📝 $.orderedItem[0].orderedItem.genderRestriction: Data consumers will assume that there is no gender restriction when no valid genderRestriction is supplied on a ScheduledSession.
📝 $.orderedItem[0].orderedItem.ageRange: Data consumers will assume that the ageRange is 18+ when not specified.
📝 $.orderedItem[0].orderedItem.eventStatus: Data consumers will assume the eventStatus is scheduled if not specified or invalid.
📝 $.orderedItem[0].orderedItem.superEvent.genderRestriction: Data consumers will assume that there is no gender restriction when no valid genderRestriction is supplied on a SessionSeries.
📝 $.orderedItem[0].orderedItem.superEvent.ageRange: Data consumers will assume that the ageRange is 18+ when not specified.
📝 $.orderedItem[0].orderedItem.superEvent.eventStatus: Data consumers will assume the eventStatus is scheduled if not specified or invalid.

✅ Assert Opportunity Capacity (after C2)

Opportunity Feed extract for OrderItem 0 Request

GET http://localhost:3000/opportunity/https%3A%2F%2Flocalhost%3A5001%2Fapi%2Fidentifiers%2Fscheduled-sessions%2F136%2Fevents%2F1355?useCacheIfAvailable=true&expectedCapacity=1

Response status code: 200 OK. Responded in 5.774211ms.

{
  "data": {
    "@context": [
      "https://openactive.io/"
    ],
    "@type": "ScheduledSession",
    "@id": "https://localhost:5001/api/identifiers/scheduled-sessions/136/events/1355",
    "startDate": "2024-04-25T05:36:46+00:00",
    "endDate": "2024-04-25T06:11:46+00:00",
    "superEvent": {
      "@type": "SessionSeries",
      "@id": "https://localhost:5001/api/identifiers/session-series/136",
      "identifier": 136,
      "name": "GOLDEN: Cotton Zumba",
      "activity": [
        {
          "@type": "Concept",
          "@id": "https://openactive.io/activity-list#78503fa2-ed24-4a80-a224-e2e94581d8a8",
          "inScheme": "https://openactive.io/activity-list",
          "prefLabel": "Zumba®"
        }
      ],
      "eventAttendanceMode": "https://schema.org/OnlineEventAttendanceMode",
      "offers": [
        {
          "@type": "Offer",
          "@id": "https://localhost:5001/api/identifiers/session-series/136#/offers/0",
          "name": "Adult",
          "acceptedPaymentMethod": [
            "http://purl.org/goodrelations/v1#Cash",
            "http://purl.org/goodrelations/v1#PaymentMethodCreditCard"
          ],
          "ageRestriction": {
            "@type": "QuantitativeValue",
            "name": "Adult",
            "maxValue": 59,
            "minValue": 18
          },
          "allowCustomerCancellationFullRefund": false,
          "openBookingPrepayment": "https://openactive.io/Required",
          "price": 4.47,
          "priceCurrency": "GBP"
        },
        {
          "@type": "Offer",
          "@id": "https://localhost:5001/api/identifiers/session-series/136#/offers/0",
          "name": "Junior",
          "acceptedPaymentMethod": [
            "http://purl.org/goodrelations/v1#Cash",
            "http://purl.org/goodrelations/v1#PaymentMethodCreditCard"
          ],
          "ageRestriction": {
            "@type": "QuantitativeValue",
            "name": "Junior",
            "maxValue": 17
          },
          "allowCustomerCancellationFullRefund": false,
          "openBookingPrepayment": "https://openactive.io/Required",
          "price": 4.47,
          "priceCurrency": "GBP"
        },
        {
          "@type": "Offer",
          "@id": "https://localhost:5001/api/identifiers/session-series/136#/offers/0",
          "name": "Senior",
          "acceptedPaymentMethod": [
            "http://purl.org/goodrelations/v1#Cash",
            "http://purl.org/goodrelations/v1#PaymentMethodCreditCard"
          ],
          "ageRestriction": {
            "@type": "QuantitativeValue",
            "name": "Senior",
            "minValue": 60
          },
          "allowCustomerCancellationFullRefund": false,
          "openBookingPrepayment": "https://openactive.io/Required",
          "price": 4.47,
          "priceCurrency": "GBP"
        },
        {
          "@type": "Offer",
          "@id": "https://localhost:5001/api/identifiers/session-series/136#/offers/0",
          "name": "Adult (off-peak)",
          "acceptedPaymentMethod": [
            "http://purl.org/goodrelations/v1#Cash",
            "http://purl.org/goodrelations/v1#PaymentMethodCreditCard"
          ],
          "ageRestriction": {
            "@type": "QuantitativeValue",
            "name": "Adult (off-peak)",
            "maxValue": 59,
            "minValue": 18
          },
          "allowCustomerCancellationFullRefund": false,
          "openBookingPrepayment": "https://openactive.io/Required",
          "price": 4.47,
          "priceCurrency": "GBP"
        }
      ],
      "organizer": {
        "@type": "Organization",
        "@id": "https://localhost:5001/api/identifiers/sellers/1",
        "name": "Acme Fitness Ltd",
        "isOpenBookingAllowed": true,
        "sameAs": [
          "https://socialmedia.com/AcmeFitnessLtd"
        ],
        "taxMode": "https://openactive.io/TaxGross",
        "telephone": "06486 844612",
        "termsOfService": [
          {
            "@type": "PrivacyPolicy",
            "name": "Privacy Policy",
            "requiresExplicitConsent": false,
            "url": "https://example.com/privacy.html"
          }
        ],
        "url": "https://richmond.name"
      },
      "url": "https://www.example.com/sessions/136"
    },
    "duration": "PT35M",
    "maximumAttendeeCapacity": 2,
    "remainingAttendeeCapacity": 1
  }
}

Specs

✅ should return 200 on success for request relevant to OrderItem 0

✅ Assert Opportunity Capacity (after C2) >> validation of Opportunity Feed extract for OrderItem 0

Specs

✅ passes validation checks

Validations

⚠️ $.eventStatus: Recommended property eventStatus is missing from ScheduledSession.
⚠️ $.leader: Recommended property leader is missing from ScheduledSession.
⚠️ $.url: Recommended property url is missing from ScheduledSession.
⚠️ $.superEvent.description: Recommended property description is missing from SessionSeries.
⚠️ $.superEvent.image: Recommended property image is missing from SessionSeries.
⚠️ $.superEvent.ageRange: Recommended property ageRange is missing from SessionSeries.
⚠️ $.superEvent.genderRestriction: Recommended property genderRestriction is missing from SessionSeries.
⚠️ $.superEvent.leader: Recommended property leader is missing from SessionSeries.
⚠️ $.superEvent.level: Recommended property level is missing from SessionSeries.
📝 $.genderRestriction: Data consumers will assume that there is no gender restriction when no valid genderRestriction is supplied on a ScheduledSession.
📝 $.ageRange: Data consumers will assume that the ageRange is 18+ when not specified.
📝 $.eventStatus: Data consumers will assume the eventStatus is scheduled if not specified or invalid.
📝 $.superEvent.genderRestriction: Data consumers will assume that there is no gender restriction when no valid genderRestriction is supplied on a SessionSeries.
📝 $.superEvent.ageRange: Data consumers will assume that the ageRange is 18+ when not specified.
📝 $.superEvent.eventStatus: Data consumers will assume the eventStatus is scheduled if not specified or invalid.
❔ $.superEvent.offers[0].ageRestriction.name: schema:name is declared in schema.org but this validator is not yet capable of checking whether they have the right format or values. You should refer to the schema.org documentation for schema:name for additional guidance.
❔ $.superEvent.offers[1].ageRestriction.name: schema:name is declared in schema.org but this validator is not yet capable of checking whether they have the right format or values. You should refer to the schema.org documentation for schema:name for additional guidance.
❔ $.superEvent.offers[2].ageRestriction.name: schema:name is declared in schema.org but this validator is not yet capable of checking whether they have the right format or values. You should refer to the schema.org documentation for schema:name for additional guidance.
❔ $.superEvent.offers[3].ageRestriction.name: schema:name is declared in schema.org but this validator is not yet capable of checking whether they have the right format or values. You should refer to the schema.org documentation for schema:name for additional guidance.

✅ B

B Request

PUT https://localhost:5001/api/openbooking/orders/2bab2a4e-dbe6-4b62-8812-284fd52500c5

Content-Type: "application/vnd.openactive.booking+json; version=1"
Authorization: "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6IkIwNEY3QjkxREUzQjk0NzhDNjE4MzNGQjI0QUE1Q0RCIiwidHlwIjoiYXQrand0In0.eyJuYmYiOjE3MTMyNjcyMzMsImV4cCI6MTcxMzI3MDgzMywiaXNzIjoiaHR0cHM6Ly9sb2NhbGhvc3Q6NTAwMyIsImF1ZCI6Im9wZW5ib29raW5nIiwiY2xpZW50X2lkIjoiNTk5OGNkN2EtNTBiYy00NTFjLThiYmYtNzA5MDFjZmQ5ZGU2IiwiaHR0cHM6Ly9vcGVuYWN0aXZlLmlvL2NsaWVudElkIjoiNTk5OGNkN2EtNTBiYy00NTFjLThiYmYtNzA5MDFjZmQ5ZGU2Iiwic3ViIjoiMTAwIiwiYXV0aF90aW1lIjoxNzEzMjY3MjMyLCJpZHAiOiJsb2NhbCIsImh0dHBzOi8vb3BlbmFjdGl2ZS5pby9zZWxsZXJJZCI6Imh0dHBzOi8vbG9jYWxob3N0OjUwMDEvYXBpL2lkZW50aWZpZXJzL3NlbGxlcnMvMSIsImp0aSI6IjkxRDk5MjFFNjQ1RkRFRDNGRjk1MDlGMDgxNDdEODczIiwic2lkIjoiODIzNDcwMEQ5OURBQTlBMTAxNTc2RkREMkQ3RDUxNDAiLCJpYXQiOjE3MTMyNjcyMzMsInNjb3BlIjpbIm9wZW5pZCIsIm9wZW5hY3RpdmUtb3BlbmJvb2tpbmciLCJvcGVuYWN0aXZlLWlkZW50aXR5Iiwib2ZmbGluZV9hY2Nlc3MiXSwiYW1yIjpbInB3ZCJdfQ.R83BB6ONQqCqUiTUTCHCnodiyuj8osyvoGL-grmmNeV04TCjnMdcUVHKPNmvtdkTAK0WNzyJ02P4fIR4FW86bIL1xOYQxZrqLX-8cyzkznh028-qze_te3PV4dfuIRnyVSqjT_WCLi7CO31qt6ATtxNg6Mfa6extC5epc9I8Wi5EvPhDpKOIKfRu5DPIOI9ugiWwRBQ06QdRYz3Y1tLLxCjbL8KQ9kPCHuQwlYIqk8CDZsx46lrE8sm1WHxq_Y_yEQJLGwfpuR2AsChECWSWe6EHJxyIDN140uSczmv6gta3hL43P2SeqGVpe_SU01VR55dAc-tkcXHih67vxnGkVQ"

{
  "@context": "https://openactive.io/",
  "@type": "Order",
  "brokerRole": "https://openactive.io/AgentBroker",
  "broker": {
    "@type": "Organization",
    "name": "MyFitnessApp",
    "url": "https://myfitnessapp.example.com",
    "description": "A fitness app for all the community",
    "logo": {
      "@type": "ImageObject",
      "url": "http://data.myfitnessapp.org.uk/images/logo.png"
    },
    "address": {
      "@type": "PostalAddress",
      "streetAddress": "Alan Peacock Way",
      "addressLocality": "Village East",
      "addressRegion": "Middlesbrough",
      "postalCode": "TS4 3AE",
      "addressCountry": "GB"
    }
  },
  "seller": "https://localhost:5001/api/identifiers/sellers/1",
  "customer": {
    "@type": "Person",
    "email": "[email protected]",
    "givenName": "Steuber",
    "familyName": "Conrad"
  },
  "orderedItem": [
    {
      "@type": "OrderItem",
      "position": 0,
      "acceptedOffer": "https://localhost:5001/api/identifiers/session-series/136#/offers/0",
      "orderedItem": "https://localhost:5001/api/identifiers/scheduled-sessions/136/events/1355"
    }
  ],
  "totalPaymentDue": {
    "@type": "PriceSpecification",
    "price": 4.47,
    "priceCurrency": "GBP"
  },
  "payment": {
    "@type": "Payment",
    "identifier": "86NFK7stK",
    "name": "AcmeBroker Points",
    "accountId": "SN1593",
    "paymentProviderId": "STRIPE"
  }
}

Response status code: 201 Created. Responded in 219.795733ms.

{
  "@context": "https://openactive.io/",
  "@type": "Order",
  "@id": "https://localhost:5001/api/openbooking/orders/2bab2a4e-dbe6-4b62-8812-284fd52500c5",
  "bookingService": {
    "@type": "BookingService",
    "name": "Acme booking system",
    "termsOfService": [
      {
        "@type": "PrivacyPolicy",
        "name": "Privacy Policy",
        "requiresExplicitConsent": false,
        "url": "https://example.com/privacy.html"
      }
    ],
    "url": "https://example.com"
  },
  "broker": {
    "@type": "Organization",
    "name": "MyFitnessApp",
    "url": "https://myfitnessapp.example.com"
  },
  "brokerRole": "https://openactive.io/AgentBroker",
  "customer": {
    "@type": "Person",
    "email": "[email protected]",
    "familyName": "Conrad",
    "givenName": "Steuber"
  },
  "orderedItem": [
    {
      "@type": "OrderItem",
      "@id": "https://localhost:5001/api/openbooking/orders/2bab2a4e-dbe6-4b62-8812-284fd52500c5#/orderedItems/2559",
      "acceptedOffer": {
        "@type": "Offer",
        "@id": "https://localhost:5001/api/identifiers/session-series/136#/offers/0",
        "allowCustomerCancellationFullRefund": false,
        "openBookingPrepayment": "https://openactive.io/Required",
        "price": 4.47,
        "priceCurrency": "GBP"
      },
      "accessChannel": {
        "@type": "VirtualLocation",
        "name": "Zoom Video Chat",
        "description": "Please log into Zoom a few minutes before the event",
        "accessCode": "9091341913",
        "accessId": "0572030081"
      },
      "orderedItem": {
        "@type": "ScheduledSession",
        "@id": "https://localhost:5001/api/identifiers/scheduled-sessions/136/events/1355",
        "startDate": "2024-04-25T05:36:46+00:00",
        "endDate": "2024-04-25T06:11:46+00:00",
        "superEvent": {
          "@type": "SessionSeries",
          "@id": "https://localhost:5001/api/identifiers/session-series/136",
          "name": "Cotton Zumba",
          "activity": [
            {
              "@type": "Concept",
              "@id": "https://openactive.io/activity-list#6bdea630-ad22-4e58-98a3-bca26ee3f1da",
              "inScheme": "https://openactive.io/activity-list",
              "prefLabel": "Rave Fitness"
            }
          ],
          "location": {
            "@type": "Place",
            "@id": "https://example.com/place/3",
            "identifier": 3,
            "name": "Stroll & Stretch",
            "description": "Casual Calisthenics in the Heart of Commerce. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
            "address": {
              "@type": "PostalAddress",
              "addressCountry": "GB",
              "addressLocality": "Oxford",
              "addressRegion": "Oxfordshire",
              "postalCode": "OX1 1UU",
              "streetAddress": "Norfolk Street"
            },
            "geo": {
              "@type": "GeoCoordinates",
              "latitude": 51.749826,
              "longitude": -1.261492
            },
            "image": [
              {
                "@type": "ImageObject",
                "url": "https://upload.wikimedia.org/wikipedia/commons/2/28/Westfield_Garden_State_Plaza_-_panoramio.jpg"
              }
            ],
            "openingHoursSpecification": [
              {
                "@type": "OpeningHoursSpecification",
                "closes": "17:30",
                "dayOfWeek": [
                  "https://schema.org/Sunday"
                ],
                "opens": "09:00"
              },
              {
                "@type": "OpeningHoursSpecification",
                "closes": "21:30",
                "dayOfWeek": [
                  "https://schema.org/Monday"
                ],
                "opens": "06:30"
              },
              {
                "@type": "OpeningHoursSpecification",
                "closes": "21:30",
                "dayOfWeek": [
                  "https://schema.org/Tuesday"
                ],
                "opens": "06:30"
              },
              {
                "@type": "OpeningHoursSpecification",
                "closes": "21:30",
                "dayOfWeek": [
                  "https://schema.org/Wednesday"
                ],
                "opens": "06:30"
              },
              {
                "@type": "OpeningHoursSpecification",
                "closes": "21:30",
                "dayOfWeek": [
                  "https://schema.org/Thursday"
                ],
                "opens": "06:30"
              },
              {
                "@type": "OpeningHoursSpecification",
                "closes": "21:30",
                "dayOfWeek": [
                  "https://schema.org/Friday"
                ],
                "opens": "06:30"
              },
              {
                "@type": "OpeningHoursSpecification",
                "closes": "17:30",
                "dayOfWeek": [
                  "https://schema.org/Saturday"
                ],
                "opens": "09:00"
              }
            ],
            "telephone": "01865 000003",
            "url": "https://en.wikipedia.org/wiki/Shopping_center"
          },
          "url": "https://example.com/events/136"
        }
      },
      "orderItemStatus": "https://openactive.io/OrderItemConfirmed",
      "position": 0,
      "unitTaxSpecification": [
        {
          "@type": "TaxChargeSpecification",
          "name": "VAT at 20%",
          "price": 0.894,
          "priceCurrency": "GBP",
          "rate": 0.2
        }
      ]
    }
  ],
  "payment": {
    "@type": "Payment",
    "identifier": "86NFK7stK",
    "name": "AcmeBroker Points",
    "accountId": "SN1593",
    "paymentProviderId": "STRIPE"
  },
  "seller": {
    "@type": "Organization",
    "@id": "https://localhost:5001/api/identifiers/sellers/1",
    "name": "Acme Fitness Ltd",
    "address": {
      "@type": "PostalAddress",
      "addressCountry": "GB",
      "addressLocality": "Another town",
      "addressRegion": "Oxfordshire",
      "postalCode": "OX1 1AA",
      "streetAddress": "1 Hidden Gem"
    },
    "isOpenBookingAllowed": true,
    "legalName": "Acme Fitness Ltd",
    "taxMode": "https://openactive.io/TaxGross",
    "termsOfService": [
      {
        "@type": "PrivacyPolicy",
        "name": "Privacy Policy",
        "requiresExplicitConsent": false,
        "url": "https://example.com/privacy.html"
      }
    ]
  },
  "totalPaymentDue": {
    "@type": "PriceSpecification",
    "openBookingPrepayment": "https://openactive.io/Required",
    "price": 4.47,
    "priceCurrency": "GBP"
  },
  "totalPaymentTax": [
    {
      "@type": "TaxChargeSpecification",
      "name": "VAT at 20%",
      "price": 0.894,
      "priceCurrency": "GBP",
      "rate": 0.2
    }
  ]
}

Specs

✅ should return 201 on success

✅ B >> validation of B

Specs

✅ passes validation checks

Validations

⚠️ $.orderedItem[0].accessCode: Recommended property accessCode is missing from OrderItem.
⚠️ $.orderedItem[0].accessPass: Recommended property accessPass is missing from OrderItem.
⚠️ $.orderedItem[0].acceptedOffer.name: Recommended property name is missing from Offer.
⚠️ $.orderedItem[0].acceptedOffer.ageRestriction: Recommended property ageRestriction is missing from Offer.
⚠️ $.orderedItem[0].orderedItem.eventStatus: Recommended property eventStatus is missing from ScheduledSession.
⚠️ $.orderedItem[0].orderedItem.maximumAttendeeCapacity: Recommended property maximumAttendeeCapacity is missing from ScheduledSession.
⚠️ $.orderedItem[0].orderedItem.remainingAttendeeCapacity: Recommended property remainingAttendeeCapacity is missing from ScheduledSession.
⚠️ $.orderedItem[0].orderedItem.superEvent.ageRange: Recommended property ageRange is missing from SessionSeries.
⚠️ $.orderedItem[0].orderedItem.superEvent.genderRestriction: Recommended property genderRestriction is missing from SessionSeries.
⚠️ $.orderedItem[0].orderedItem.superEvent.eventStatus: Recommended property eventStatus is missing from SessionSeries.
⚠️ $.orderedItem[0].orderedItem.superEvent.location.amenityFeature: Recommended property amenityFeature is missing from Place.
⚠️ $.seller.email: Recommended property email is missing from Organization.
⚠️ $.seller.url: Recommended property url is missing from Organization.
⚠️ $.seller.logo: Recommended property logo is missing from Organization.
⚠️ $.seller.vatID: Recommended property vatID is missing from Organization.
📝 $.orderedItem[0].orderedItem.genderRestriction: Data consumers will assume that there is no gender restriction when no valid genderRestriction is supplied on a ScheduledSession.
📝 $.orderedItem[0].orderedItem.ageRange: Data consumers will assume that the ageRange is 18+ when not specified.
📝 $.orderedItem[0].orderedItem.eventStatus: Data consumers will assume the eventStatus is scheduled if not specified or invalid.
📝 $.orderedItem[0].orderedItem.superEvent.genderRestriction: Data consumers will assume that there is no gender restriction when no valid genderRestriction is supplied on a SessionSeries.
📝 $.orderedItem[0].orderedItem.superEvent.ageRange: Data consumers will assume that the ageRange is 18+ when not specified.
📝 $.orderedItem[0].orderedItem.superEvent.eventStatus: Data consumers will assume the eventStatus is scheduled if not specified or invalid.

✅ Assert Opportunity Capacity (after B)

Opportunity Feed extract for OrderItem 0 Request

GET http://localhost:3000/opportunity/https%3A%2F%2Flocalhost%3A5001%2Fapi%2Fidentifiers%2Fscheduled-sessions%2F136%2Fevents%2F1355?useCacheIfAvailable=true&expectedCapacity=1

Response status code: 200 OK. Responded in 5.742643ms.

{
  "data": {
    "@context": [
      "https://openactive.io/"
    ],
    "@type": "ScheduledSession",
    "@id": "https://localhost:5001/api/identifiers/scheduled-sessions/136/events/1355",
    "startDate": "2024-04-25T05:36:46+00:00",
    "endDate": "2024-04-25T06:11:46+00:00",
    "superEvent": {
      "@type": "SessionSeries",
      "@id": "https://localhost:5001/api/identifiers/session-series/136",
      "identifier": 136,
      "name": "GOLDEN: Cotton Zumba",
      "activity": [
        {
          "@type": "Concept",
          "@id": "https://openactive.io/activity-list#78503fa2-ed24-4a80-a224-e2e94581d8a8",
          "inScheme": "https://openactive.io/activity-list",
          "prefLabel": "Zumba®"
        }
      ],
      "eventAttendanceMode": "https://schema.org/OnlineEventAttendanceMode",
      "offers": [
        {
          "@type": "Offer",
          "@id": "https://localhost:5001/api/identifiers/session-series/136#/offers/0",
          "name": "Adult",
          "acceptedPaymentMethod": [
            "http://purl.org/goodrelations/v1#Cash",
            "http://purl.org/goodrelations/v1#PaymentMethodCreditCard"
          ],
          "ageRestriction": {
            "@type": "QuantitativeValue",
            "name": "Adult",
            "maxValue": 59,
            "minValue": 18
          },
          "allowCustomerCancellationFullRefund": false,
          "openBookingPrepayment": "https://openactive.io/Required",
          "price": 4.47,
          "priceCurrency": "GBP"
        },
        {
          "@type": "Offer",
          "@id": "https://localhost:5001/api/identifiers/session-series/136#/offers/0",
          "name": "Junior",
          "acceptedPaymentMethod": [
            "http://purl.org/goodrelations/v1#Cash",
            "http://purl.org/goodrelations/v1#PaymentMethodCreditCard"
          ],
          "ageRestriction": {
            "@type": "QuantitativeValue",
            "name": "Junior",
            "maxValue": 17
          },
          "allowCustomerCancellationFullRefund": false,
          "openBookingPrepayment": "https://openactive.io/Required",
          "price": 4.47,
          "priceCurrency": "GBP"
        },
        {
          "@type": "Offer",
          "@id": "https://localhost:5001/api/identifiers/session-series/136#/offers/0",
          "name": "Senior",
          "acceptedPaymentMethod": [
            "http://purl.org/goodrelations/v1#Cash",
            "http://purl.org/goodrelations/v1#PaymentMethodCreditCard"
          ],
          "ageRestriction": {
            "@type": "QuantitativeValue",
            "name": "Senior",
            "minValue": 60
          },
          "allowCustomerCancellationFullRefund": false,
          "openBookingPrepayment": "https://openactive.io/Required",
          "price": 4.47,
          "priceCurrency": "GBP"
        },
        {
          "@type": "Offer",
          "@id": "https://localhost:5001/api/identifiers/session-series/136#/offers/0",
          "name": "Adult (off-peak)",
          "acceptedPaymentMethod": [
            "http://purl.org/goodrelations/v1#Cash",
            "http://purl.org/goodrelations/v1#PaymentMethodCreditCard"
          ],
          "ageRestriction": {
            "@type": "QuantitativeValue",
            "name": "Adult (off-peak)",
            "maxValue": 59,
            "minValue": 18
          },
          "allowCustomerCancellationFullRefund": false,
          "openBookingPrepayment": "https://openactive.io/Required",
          "price": 4.47,
          "priceCurrency": "GBP"
        }
      ],
      "organizer": {
        "@type": "Organization",
        "@id": "https://localhost:5001/api/identifiers/sellers/1",
        "name": "Acme Fitness Ltd",
        "isOpenBookingAllowed": true,
        "sameAs": [
          "https://socialmedia.com/AcmeFitnessLtd"
        ],
        "taxMode": "https://openactive.io/TaxGross",
        "telephone": "06486 844612",
        "termsOfService": [
          {
            "@type": "PrivacyPolicy",
            "name": "Privacy Policy",
            "requiresExplicitConsent": false,
            "url": "https://example.com/privacy.html"
          }
        ],
        "url": "https://richmond.name"
      },
      "url": "https://www.example.com/sessions/136"
    },
    "duration": "PT35M",
    "maximumAttendeeCapacity": 2,
    "remainingAttendeeCapacity": 1
  }
}

Specs

✅ should return 200 on success for request relevant to OrderItem 0

✅ Assert Opportunity Capacity (after B) >> validation of Opportunity Feed extract for OrderItem 0

Specs

✅ passes validation checks

Validations

⚠️ $.eventStatus: Recommended property eventStatus is missing from ScheduledSession.
⚠️ $.leader: Recommended property leader is missing from ScheduledSession.
⚠️ $.url: Recommended property url is missing from ScheduledSession.
⚠️ $.superEvent.description: Recommended property description is missing from SessionSeries.
⚠️ $.superEvent.image: Recommended property image is missing from SessionSeries.
⚠️ $.superEvent.ageRange: Recommended property ageRange is missing from SessionSeries.
⚠️ $.superEvent.genderRestriction: Recommended property genderRestriction is missing from SessionSeries.
⚠️ $.superEvent.leader: Recommended property leader is missing from SessionSeries.
⚠️ $.superEvent.level: Recommended property level is missing from SessionSeries.
📝 $.genderRestriction: Data consumers will assume that there is no gender restriction when no valid genderRestriction is supplied on a ScheduledSession.
📝 $.ageRange: Data consumers will assume that the ageRange is 18+ when not specified.
📝 $.eventStatus: Data consumers will assume the eventStatus is scheduled if not specified or invalid.
📝 $.superEvent.genderRestriction: Data consumers will assume that there is no gender restriction when no valid genderRestriction is supplied on a SessionSeries.
📝 $.superEvent.ageRange: Data consumers will assume that the ageRange is 18+ when not specified.
📝 $.superEvent.eventStatus: Data consumers will assume the eventStatus is scheduled if not specified or invalid.
❔ $.superEvent.offers[0].ageRestriction.name: schema:name is declared in schema.org but this validator is not yet capable of checking whether they have the right format or values. You should refer to the schema.org documentation for schema:name for additional guidance.
❔ $.superEvent.offers[1].ageRestriction.name: schema:name is declared in schema.org but this validator is not yet capable of checking whether they have the right format or values. You should refer to the schema.org documentation for schema:name for additional guidance.
❔ $.superEvent.offers[2].ageRestriction.name: schema:name is declared in schema.org but this validator is not yet capable of checking whether they have the right format or values. You should refer to the schema.org documentation for schema:name for additional guidance.
❔ $.superEvent.offers[3].ageRestriction.name: schema:name is declared in schema.org but this validator is not yet capable of checking whether they have the right format or values. You should refer to the schema.org documentation for schema:name for additional guidance.