openactive-test-suite

< Return to Summary File Generated: Fri Oct 01 2021 08:18:16 GMT+0000 (Coordinated Universal Time)

additional-details-capture » additional-details-required-and-supplied (OpenBookingApprovalFlow » FacilityUseSlot)

Booking Flow: OpenBookingApprovalFlow

Opportunity Type: FacilityUseSlot

Feature: Details Capture / Additional Details capture (Implemented)

Test: Booking opportunity with additional details supplied

Should pass

Running only this test

npm start -- --runInBand test/features/details-capture/additional-details-capture/implemented/additional-details-required-and-supplied-test.js

⚠️ 9 passed with 0 failures, 92 warnings and 10 suggestions


Fetch Opportunities

Booking System Test Interface for OrderItem 0 Request

POST https://localhost:5001/api/openbooking/test-interface/datasets/uat-ci/opportunities

{
  "@type": "Slot",
  "facilityUse": {
    "@type": "FacilityUse",
    "provider": {
      "@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#TestOpportunityBookableAdditionalDetails",
  "test:testOpenBookingFlow": "https://openactive.io/test-interface#OpenBookingApprovalFlow",
  "test:testOpportunityDataShapeExpression": [
    {
      "@type": "test:TripleConstraint",
      "predicate": "https://openactive.io/remainingUses",
      "valueExpr": {
        "@type": "NumericNodeConstraint",
        "mininclusive": 2
      }
    },
    {
      "@type": "test:TripleConstraint",
      "predicate": "https://openactive.io/isOpenBookingAllowed",
      "valueExpr": {
        "@type": "test:BooleanNodeConstraint",
        "value": true
      }
    },
    {
      "@type": "test:TripleConstraint",
      "predicate": "https://schema.org/startDate",
      "valueExpr": {
        "@type": "test:DateRangeNodeConstraint",
        "minDate": "2021-10-01T09:55:12.486+00:00"
      }
    },
    {
      "@type": "test:TripleConstraint",
      "predicate": "https://schema.org/eventStatus",
      "valueExpr": {
        "@type": "test:OptionNodeConstraint",
        "datatype": "schema:EventStatusType",
        "blocklist": [
          "https://schema.org/EventCancelled",
          "https://schema.org/EventPostponed"
        ]
      }
    }
  ],
  "test:testOfferDataShapeExpression": [
    {
      "@type": "test:TripleConstraint",
      "predicate": "https://openactive.io/openBookingFlowRequirement",
      "valueExpr": {
        "@type": "test:ArrayConstraint",
        "datatype": "oa:OpenBookingFlowRequirement",
        "includesAll": [
          "https://openactive.io/OpenBookingIntakeForm",
          "https://openactive.io/OpenBookingApproval"
        ],
        "excludesAll": [
          "https://openactive.io/OpenBookingAttendeeDetails"
        ]
      }
    },
    {
      "@type": "test:TripleConstraint",
      "predicate": "https://openactive.io/validFromBeforeStartDate",
      "valueExpr": {
        "@type": "test:DateRangeNodeConstraint",
        "maxDate": "2021-10-01T07:55:12.486+00:00",
        "allowNull": true
      }
    },
    {
      "@type": "test:TripleConstraint",
      "predicate": "https://openactive.io/openBookingInAdvance",
      "valueExpr": {
        "@type": "test:OptionNodeConstraint",
        "datatype": "oa:RequiredStatusType",
        "blocklist": [
          "https://openactive.io/Unavailable"
        ]
      }
    }
  ]
}

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

{
  "@context": "https://openactive.io/",
  "@type": "Slot",
  "@id": "https://localhost:5001/api/identifiers/facility-uses/2513/facility-use-slots/20513"
}

Opportunity Feed extract for OrderItem 0 Request

GET http://localhost:3000/opportunity/https%3A%2F%2Flocalhost%3A5001%2Fapi%2Fidentifiers%2Ffacility-uses%2F2513%2Ffacility-use-slots%2F20513?useCacheIfAvailable=true


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

{
  "state": "updated",
  "id": "https://localhost:5001/api/identifiers/facility-uses/2513/facility-use-slots/20513",
  "modified": 1633076334643,
  "data": {
    "@context": [
      "https://openactive.io/"
    ],
    "@type": "Slot",
    "@id": "https://localhost:5001/api/identifiers/facility-uses/2513/facility-use-slots/20513",
    "identifier": 20513,
    "duration": "PT1H",
    "facilityUse": {
      "@type": "FacilityUse",
      "@id": "https://localhost:5001/api/identifiers/facility-uses/2513",
      "name": "[OPEN BOOKING API TEST INTERFACE] Bookable Paid Facility That Requires Additional Details",
      "activity": [
        {
          "@type": "Concept",
          "@id": "https://openactive.io/activity-list#c07d63a0-8eb9-4602-8bcc-23be6deb8f83",
          "inScheme": "https://openactive.io/activity-list",
          "prefLabel": "Jet Skiing"
        }
      ],
      "location": {
        "@type": "Place",
        "name": "Fake Pond",
        "address": {
          "@type": "PostalAddress",
          "addressCountry": "GB",
          "addressLocality": "Another town",
          "addressRegion": "Oxfordshire",
          "postalCode": "OX1 1AA",
          "streetAddress": "1 Fake Park"
        },
        "geo": {
          "@type": "GeoCoordinates",
          "latitude": 0.1,
          "longitude": 0.1
        }
      },
      "provider": {
        "@type": "Organization",
        "@id": "https://localhost:5001/api/identifiers/sellers/1",
        "name": "Acme Fitness Ltd",
        "isOpenBookingAllowed": true,
        "taxMode": "https://openactive.io/TaxGross",
        "termsOfService": [
          {
            "@type": "PrivacyPolicy",
            "name": "Privacy Policy",
            "requiresExplicitConsent": false,
            "url": "https://example.com/privacy.html"
          }
        ]
      },
      "url": "https://www.example.com/a-session-age"
    },
    "maximumUses": 10,
    "offers": [
      {
        "@type": "Offer",
        "@id": "https://localhost:5001/api/identifiers/facility-uses/2513/facility-use-slots/20513#/offers/0",
        "allowCustomerCancellationFullRefund": true,
        "openBookingFlowRequirement": [
          "https://openactive.io/OpenBookingApproval",
          "https://openactive.io/OpenBookingIntakeForm"
        ],
        "price": 10,
        "priceCurrency": "GBP"
      }
    ],
    "remainingUses": 10,
    "startDate": "2021-10-02T08:18:52+00:00",
    "endDate": "2021-10-02T09:18:52+00:00"
  }
}

Specs

Fetch Opportunities » validation of Opportunity Feed extract for OrderItem 0

Specs

Validations

C1

C1 Request

PUT https://localhost:5001/api/openbooking/order-quote-templates/ab22a5cf-26a6-4963-8c03-5082f059e45f

{
  "@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/facility-uses/2513/facility-use-slots/20513#/offers/0",
      "orderedItem": "https://localhost:5001/api/identifiers/facility-uses/2513/facility-use-slots/20513"
    }
  ],
  "payment": {
    "@type": "Payment",
    "name": "AcmeBroker Points",
    "accountId": "SN1593",
    "paymentProviderId": "STRIPE"
  }
}

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

{
  "@context": "https://openactive.io/",
  "@type": "OrderQuote",
  "@id": "https://localhost:5001/api/openbooking/order-quotes/ab22a5cf-26a6-4963-8c03-5082f059e45f",
  "lease": {
    "@type": "Lease",
    "leaseExpires": "2021-10-01T08:23:54+00:00"
  },
  "orderRequiresApproval": true,
  "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/facility-uses/2513/facility-use-slots/20513#/offers/0",
        "allowCustomerCancellationFullRefund": true,
        "price": 10,
        "priceCurrency": "GBP"
      },
      "orderedItem": {
        "@type": "Slot",
        "@id": "https://localhost:5001/api/identifiers/facility-uses/2513/facility-use-slots/20513",
        "facilityUse": {
          "@type": "FacilityUse",
          "@id": "https://localhost:5001/api/identifiers/facility-uses/2513",
          "name": "[OPEN BOOKING API TEST INTERFACE] Bookable Paid Facility That Requires Additional Details",
          "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",
            "name": "Fake fitness studio",
            "geo": {
              "@type": "GeoCoordinates",
              "latitude": 0.1,
              "longitude": 0.1
            }
          },
          "url": "https://example.com/events/2513"
        },
        "maximumUses": 10,
        "remainingUses": 10,
        "startDate": "2021-10-02T08:18:52+00:00",
        "endDate": "2021-10-02T09:18:52+00:00"
      },
      "orderItemIntakeForm": [
        {
          "@type": "BooleanFormFieldSpecification",
          "@id": "https://example.com/photoconsent",
          "name": "Photo Consent",
          "description": "Are you happy for us to include photos of you in our marketing materials?"
        }
      ],
      "position": 0,
      "unitTaxSpecification": [
        {
          "@type": "TaxChargeSpecification",
          "name": "VAT at 20%",
          "price": 2,
          "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": 10,
    "priceCurrency": "GBP"
  },
  "totalPaymentTax": [
    {
      "@type": "TaxChargeSpecification",
      "name": "VAT at 20%",
      "price": 2,
      "priceCurrency": "GBP",
      "rate": 0.2
    }
  ]
}

Specs

C1 » validation of C1

Specs

Validations

C2

C2 Request

PUT https://localhost:5001/api/openbooking/order-quotes/ab22a5cf-26a6-4963-8c03-5082f059e45f

{
  "@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]",
    "telephone": "418-608-1729 x422",
    "givenName": "Boyle",
    "familyName": "Glennie",
    "identifier": "c7a24744-43fd-4078-8241-90dc02af125a"
  },
  "orderedItem": [
    {
      "@type": "OrderItem",
      "position": 0,
      "acceptedOffer": "https://localhost:5001/api/identifiers/facility-uses/2513/facility-use-slots/20513#/offers/0",
      "orderedItem": "https://localhost:5001/api/identifiers/facility-uses/2513/facility-use-slots/20513",
      "orderItemIntakeFormResponse": [
        {
          "@type": "PropertyValue",
          "propertyID": "https://example.com/photoconsent",
          "value": true
        }
      ]
    }
  ],
  "payment": {
    "@type": "Payment",
    "name": "AcmeBroker Points",
    "accountId": "SN1593",
    "paymentProviderId": "STRIPE"
  }
}

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

{
  "@context": "https://openactive.io/",
  "@type": "OrderQuote",
  "@id": "https://localhost:5001/api/openbooking/order-quotes/ab22a5cf-26a6-4963-8c03-5082f059e45f",
  "lease": {
    "@type": "Lease",
    "leaseExpires": "2021-10-01T08:23:54+00:00"
  },
  "orderRequiresApproval": true,
  "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",
    "identifier": "c7a24744-43fd-4078-8241-90dc02af125a",
    "email": "[email protected]",
    "familyName": "Glennie",
    "givenName": "Boyle",
    "telephone": "418-608-1729 x422"
  },
  "orderedItem": [
    {
      "@type": "OrderItem",
      "acceptedOffer": {
        "@type": "Offer",
        "@id": "https://localhost:5001/api/identifiers/facility-uses/2513/facility-use-slots/20513#/offers/0",
        "allowCustomerCancellationFullRefund": true,
        "price": 10,
        "priceCurrency": "GBP"
      },
      "orderedItem": {
        "@type": "Slot",
        "@id": "https://localhost:5001/api/identifiers/facility-uses/2513/facility-use-slots/20513",
        "facilityUse": {
          "@type": "FacilityUse",
          "@id": "https://localhost:5001/api/identifiers/facility-uses/2513",
          "name": "[OPEN BOOKING API TEST INTERFACE] Bookable Paid Facility That Requires Additional Details",
          "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",
            "name": "Fake fitness studio",
            "geo": {
              "@type": "GeoCoordinates",
              "latitude": 0.1,
              "longitude": 0.1
            }
          },
          "url": "https://example.com/events/2513"
        },
        "maximumUses": 10,
        "remainingUses": 10,
        "startDate": "2021-10-02T08:18:52+00:00",
        "endDate": "2021-10-02T09:18:52+00:00"
      },
      "orderItemIntakeForm": [
        {
          "@type": "BooleanFormFieldSpecification",
          "@id": "https://example.com/photoconsent",
          "name": "Photo Consent",
          "description": "Are you happy for us to include photos of you in our marketing materials?"
        }
      ],
      "orderItemIntakeFormResponse": [
        {
          "@type": "PropertyValue",
          "propertyID": "https://example.com/photoconsent",
          "value": true
        }
      ],
      "position": 0,
      "unitTaxSpecification": [
        {
          "@type": "TaxChargeSpecification",
          "name": "VAT at 20%",
          "price": 2,
          "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": 10,
    "priceCurrency": "GBP"
  },
  "totalPaymentTax": [
    {
      "@type": "TaxChargeSpecification",
      "name": "VAT at 20%",
      "price": 2,
      "priceCurrency": "GBP",
      "rate": 0.2
    }
  ]
}

Specs

C2 » validation of C2

Specs

Validations

P

P Request

PUT https://localhost:5001/api/openbooking/order-proposals/ab22a5cf-26a6-4963-8c03-5082f059e45f

{
  "@context": "https://openactive.io/",
  "@type": "OrderProposal",
  "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]",
    "telephone": "418-608-1729 x422",
    "givenName": "Boyle",
    "familyName": "Glennie",
    "identifier": "c7a24744-43fd-4078-8241-90dc02af125a"
  },
  "orderedItem": [
    {
      "@type": "OrderItem",
      "position": 0,
      "acceptedOffer": "https://localhost:5001/api/identifiers/facility-uses/2513/facility-use-slots/20513#/offers/0",
      "orderedItem": "https://localhost:5001/api/identifiers/facility-uses/2513/facility-use-slots/20513",
      "orderItemIntakeFormResponse": [
        {
          "@type": "PropertyValue",
          "propertyID": "https://example.com/photoconsent",
          "value": true
        }
      ]
    }
  ],
  "totalPaymentDue": {
    "@type": "PriceSpecification",
    "price": 10,
    "priceCurrency": "GBP"
  },
  "payment": {
    "@type": "Payment",
    "identifier": "g2N88T2mf",
    "name": "AcmeBroker Points",
    "accountId": "SN1593",
    "paymentProviderId": "STRIPE"
  }
}

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

{
  "@context": "https://openactive.io/",
  "@type": "OrderProposal",
  "@id": "https://localhost:5001/api/openbooking/order-proposals/ab22a5cf-26a6-4963-8c03-5082f059e45f",
  "orderProposalStatus": "https://openactive.io/AwaitingSellerConfirmation",
  "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",
    "identifier": "c7a24744-43fd-4078-8241-90dc02af125a",
    "email": "[email protected]",
    "familyName": "Glennie",
    "givenName": "Boyle",
    "telephone": "418-608-1729 x422"
  },
  "orderedItem": [
    {
      "@type": "OrderItem",
      "@id": "https://localhost:5001/api/openbooking/orders/ab22a5cf-26a6-4963-8c03-5082f059e45f#/orderedItems/2878",
      "acceptedOffer": {
        "@type": "Offer",
        "@id": "https://localhost:5001/api/identifiers/facility-uses/2513/facility-use-slots/20513#/offers/0",
        "allowCustomerCancellationFullRefund": true,
        "price": 10,
        "priceCurrency": "GBP"
      },
      "orderedItem": {
        "@type": "Slot",
        "@id": "https://localhost:5001/api/identifiers/facility-uses/2513/facility-use-slots/20513",
        "facilityUse": {
          "@type": "FacilityUse",
          "@id": "https://localhost:5001/api/identifiers/facility-uses/2513",
          "name": "[OPEN BOOKING API TEST INTERFACE] Bookable Paid Facility That Requires Additional Details",
          "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",
            "name": "Fake fitness studio",
            "geo": {
              "@type": "GeoCoordinates",
              "latitude": 0.1,
              "longitude": 0.1
            }
          },
          "url": "https://example.com/events/2513"
        },
        "maximumUses": 10,
        "remainingUses": 10,
        "startDate": "2021-10-02T08:18:52+00:00",
        "endDate": "2021-10-02T09:18:52+00:00"
      },
      "orderItemIntakeForm": [
        {
          "@type": "BooleanFormFieldSpecification",
          "@id": "https://example.com/photoconsent",
          "name": "Photo Consent",
          "description": "Are you happy for us to include photos of you in our marketing materials?"
        }
      ],
      "orderItemIntakeFormResponse": [
        {
          "@type": "PropertyValue",
          "propertyID": "https://example.com/photoconsent",
          "value": true
        }
      ],
      "position": 0,
      "unitTaxSpecification": [
        {
          "@type": "TaxChargeSpecification",
          "name": "VAT at 20%",
          "price": 2,
          "priceCurrency": "GBP",
          "rate": 0.2
        }
      ]
    }
  ],
  "orderProposalVersion": "https://localhost:5001/api/openbooking/order-proposals/ab22a5cf-26a6-4963-8c03-5082f059e45f/versions/447a7f9d-f7d1-4c6b-a578-3eb353f84c02",
  "payment": {
    "@type": "Payment",
    "identifier": "g2N88T2mf",
    "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": 10,
    "priceCurrency": "GBP"
  },
  "totalPaymentTax": [
    {
      "@type": "TaxChargeSpecification",
      "name": "VAT at 20%",
      "price": 2,
      "priceCurrency": "GBP",
      "rate": 0.2
    }
  ]
}

Specs

P » validation of P

Specs

Validations

Simulate Seller Approval (Test Interface Action)

Orders (order-proposals) Feed listen for 'ab22a5cf-26a6-4963-8c03-5082f059e45f' change (auth: primary) Request

POST http://localhost:3000/order-listeners/order-proposals/primary/ab22a5cf-26a6-4963-8c03-5082f059e45f


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

{
  "headers": {
    "Accept": "application/json, application/vnd.openactive.booking+json; version=1",
    "Cache-Control": "max-age=0",
    "Authorization": "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6IkIwNEY3QjkxREUzQjk0NzhDNjE4MzNGQjI0QUE1Q0RCIiwidHlwIjoiYXQrand0In0.eyJuYmYiOjE2MzMwNzQ5MTUsImV4cCI6MTYzMzA3ODUxNSwiaXNzIjoiaHR0cHM6Ly9sb2NhbGhvc3Q6NTAwMyIsImF1ZCI6Im9wZW5ib29raW5nIiwiY2xpZW50X2lkIjoiNWQ0ZGYyZjgtOThkOC00ODg4LWEzNGMtY2FjN2E3YTljNDkxIiwiaHR0cHM6Ly9vcGVuYWN0aXZlLmlvL2NsaWVudElkIjoiNWQ0ZGYyZjgtOThkOC00ODg4LWEzNGMtY2FjN2E3YTljNDkxIiwianRpIjoiNjM2RjA1OUI5QzQ3RUUxQThCNzRFNzA2NUMyMTcyRTciLCJpYXQiOjE2MzMwNzQ5MTUsInNjb3BlIjpbIm9wZW5hY3RpdmUtb3JkZXJzZmVlZCJdfQ.FJM6kZdzrEr3NolFnNEjSps40rjuG4DyrsneYWqxM4nCxzBNygpItBSzPN5PQ6KdF86tHVWjMpf7fYucSHK5Vgc54fMTQ0aWzyclj1iKIxHsqPlegqwrj8HaoU0fS5x6gRNs3DqpvvXNoP_dHY40dUxa99BpbzDu7c1mPLn7Y3ZOrDqTi_SovM8zj9gjyzO4Q9krQFOi5lUq_djDB1lRWBnsqhp6WkBnMmflAE7D0-F08v3qU2PRI5WaWCdCDZGU6KhOwSHvKzf1S0d3F6cU1IWWPvEa6Fg-Ojrugham1bdjVzPllJUWip_jO72L8qbkOGU042x3ZQuIJndB0f9tFg"
  },
  "startingFeedPage": "https://localhost:5001/api/openbooking/order-proposals-rpde?afterTimestamp=637686731327377300&afterId=a1a766c4-e180-4aa4-bbaa-7ed6881a180e",
  "message": "Listening for UUID: 'ab22a5cf-26a6-4963-8c03-5082f059e45f' in feed: order-proposals, for Booking Partner: primary from startingFeedPage using headers"
}

Call TestInterface Action of type: test:SellerAcceptOrderProposalSimulateAction Request

POST https://localhost:5001/api/openbooking/test-interface/actions

{
  "@context": [
    "https://openactive.io/",
    "https://openactive.io/test-interface"
  ],
  "@type": "test:SellerAcceptOrderProposalSimulateAction",
  "object": {
    "@type": "OrderProposal",
    "@id": "https://localhost:5001/api/openbooking/order-proposals/ab22a5cf-26a6-4963-8c03-5082f059e45f"
  }
}

Response status code: 204 No Content. Responded in 94.584964ms.

Specs

OrderProposal Feed Update (after Simulate Seller Approval)

Orders (order-proposals) Feed collect for 'ab22a5cf-26a6-4963-8c03-5082f059e45f' change (auth: primary) Request

GET http://localhost:3000/order-listeners/order-proposals/primary/ab22a5cf-26a6-4963-8c03-5082f059e45f


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

{
  "state": "updated",
  "kind": "Order",
  "id": "ab22a5cf-26a6-4963-8c03-5082f059e45f",
  "modified": 637686731359792100,
  "data": {
    "@context": "https://openactive.io/",
    "@type": "OrderProposal",
    "@id": "https://localhost:5001/api/openbooking/order-proposals/ab22a5cf-26a6-4963-8c03-5082f059e45f",
    "identifier": "ab22a5cf-26a6-4963-8c03-5082f059e45f",
    "orderProposalStatus": "https://openactive.io/SellerAccepted",
    "orderedItem": [
      {
        "@type": "OrderItem",
        "@id": "https://localhost:5001/api/openbooking/orders/ab22a5cf-26a6-4963-8c03-5082f059e45f#/orderedItems/2878",
        "acceptedOffer": {
          "@type": "Offer",
          "@id": "https://localhost:5001/api/identifiers/facility-uses/2513/facility-use-slots/20513#/offers/0",
          "price": 10,
          "priceCurrency": "GBP"
        },
        "orderedItem": "https://localhost:5001/api/identifiers/facility-uses/2513/facility-use-slots/20513"
      }
    ],
    "orderProposalVersion": "https://localhost:5001/api/openbooking/order-proposals/ab22a5cf-26a6-4963-8c03-5082f059e45f/versions/447a7f9d-f7d1-4c6b-a578-3eb353f84c02",
    "totalPaymentDue": {
      "@type": "PriceSpecification",
      "openBookingPrepayment": "https://openactive.io/Required",
      "price": 10,
      "priceCurrency": "GBP"
    }
  }
}

Specs

OrderProposal Feed Update (after Simulate Seller Approval) » validation of OrderFeed

Specs

Validations

B

Orders (order-proposals) Feed listen for 'ab22a5cf-26a6-4963-8c03-5082f059e45f' change (auth: primary) Request

POST http://localhost:3000/order-listeners/order-proposals/primary/ab22a5cf-26a6-4963-8c03-5082f059e45f


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

{
  "headers": {
    "Accept": "application/json, application/vnd.openactive.booking+json; version=1",
    "Cache-Control": "max-age=0",
    "Authorization": "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6IkIwNEY3QjkxREUzQjk0NzhDNjE4MzNGQjI0QUE1Q0RCIiwidHlwIjoiYXQrand0In0.eyJuYmYiOjE2MzMwNzQ5MTUsImV4cCI6MTYzMzA3ODUxNSwiaXNzIjoiaHR0cHM6Ly9sb2NhbGhvc3Q6NTAwMyIsImF1ZCI6Im9wZW5ib29raW5nIiwiY2xpZW50X2lkIjoiNWQ0ZGYyZjgtOThkOC00ODg4LWEzNGMtY2FjN2E3YTljNDkxIiwiaHR0cHM6Ly9vcGVuYWN0aXZlLmlvL2NsaWVudElkIjoiNWQ0ZGYyZjgtOThkOC00ODg4LWEzNGMtY2FjN2E3YTljNDkxIiwianRpIjoiNjM2RjA1OUI5QzQ3RUUxQThCNzRFNzA2NUMyMTcyRTciLCJpYXQiOjE2MzMwNzQ5MTUsInNjb3BlIjpbIm9wZW5hY3RpdmUtb3JkZXJzZmVlZCJdfQ.FJM6kZdzrEr3NolFnNEjSps40rjuG4DyrsneYWqxM4nCxzBNygpItBSzPN5PQ6KdF86tHVWjMpf7fYucSHK5Vgc54fMTQ0aWzyclj1iKIxHsqPlegqwrj8HaoU0fS5x6gRNs3DqpvvXNoP_dHY40dUxa99BpbzDu7c1mPLn7Y3ZOrDqTi_SovM8zj9gjyzO4Q9krQFOi5lUq_djDB1lRWBnsqhp6WkBnMmflAE7D0-F08v3qU2PRI5WaWCdCDZGU6KhOwSHvKzf1S0d3F6cU1IWWPvEa6Fg-Ojrugham1bdjVzPllJUWip_jO72L8qbkOGU042x3ZQuIJndB0f9tFg"
  },
  "startingFeedPage": "https://localhost:5001/api/openbooking/order-proposals-rpde?afterTimestamp=637686731359792088&afterId=ab22a5cf-26a6-4963-8c03-5082f059e45f",
  "message": "Listening for UUID: 'ab22a5cf-26a6-4963-8c03-5082f059e45f' in feed: order-proposals, for Booking Partner: primary from startingFeedPage using headers"
}

B Request

PUT https://localhost:5001/api/openbooking/orders/ab22a5cf-26a6-4963-8c03-5082f059e45f

{
  "@context": "https://openactive.io/",
  "@type": "Order",
  "orderProposalVersion": "https://localhost:5001/api/openbooking/order-proposals/ab22a5cf-26a6-4963-8c03-5082f059e45f/versions/447a7f9d-f7d1-4c6b-a578-3eb353f84c02",
  "payment": {
    "@type": "Payment",
    "identifier": "KjxRGfI9W",
    "name": "AcmeBroker Points",
    "accountId": "SN1593",
    "paymentProviderId": "STRIPE"
  }
}

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

{
  "@context": [
    "https://openactive.io/",
    "https://openactive.io/ns-beta"
  ],
  "@type": "Order",
  "@id": "https://localhost:5001/api/openbooking/orders/ab22a5cf-26a6-4963-8c03-5082f059e45f",
  "identifier": "ab22a5cf-26a6-4963-8c03-5082f059e45f",
  "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",
    "identifier": "c7a24744-43fd-4078-8241-90dc02af125a",
    "email": "[email protected]",
    "familyName": "Glennie",
    "givenName": "Boyle",
    "telephone": "418-608-1729 x422"
  },
  "orderedItem": [
    {
      "@type": "OrderItem",
      "@id": "https://localhost:5001/api/openbooking/orders/ab22a5cf-26a6-4963-8c03-5082f059e45f#/orderedItems/2878",
      "acceptedOffer": {
        "@type": "Offer",
        "@id": "https://localhost:5001/api/identifiers/facility-uses/2513/facility-use-slots/20513#/offers/0",
        "allowCustomerCancellationFullRefund": true,
        "price": 10,
        "priceCurrency": "GBP"
      },
      "accessCode": [
        {
          "@type": "PropertyValue",
          "name": "Pin Code",
          "description": "773183",
          "value": "defaultValue"
        }
      ],
      "accessPass": [
        {
          "@type": "ImageObject",
          "url": "https://via.placeholder.com/25x25/cccccc/9c9c9c.png"
        },
        {
          "@type": "Barcode",
          "text": "9329882066",
          "url": "https://via.placeholder.com/25x25/cccccc/9c9c9c.png",
          "beta:codeType": "code128"
        }
      ],
      "error": [
        {
          "@type": "IncompleteIntakeFormError",
          "name": "The 'orderItemIntakeFormResponse' is missing fields that are specified as 'valueRequired' within the 'orderItemIntakeForm'.",
          "statusCode": 409,
          "description": "Incomplete additional details supplied",
          "instance": "https://example.com/photoconsent"
        }
      ],
      "orderedItem": {
        "@type": "Slot",
        "@id": "https://localhost:5001/api/identifiers/facility-uses/2513/facility-use-slots/20513",
        "facilityUse": {
          "@type": "FacilityUse",
          "@id": "https://localhost:5001/api/identifiers/facility-uses/2513",
          "name": "[OPEN BOOKING API TEST INTERFACE] Bookable Paid Facility That Requires Additional Details",
          "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",
            "name": "Fake fitness studio",
            "geo": {
              "@type": "GeoCoordinates",
              "latitude": 0.1,
              "longitude": 0.1
            }
          },
          "url": "https://example.com/events/2513"
        },
        "maximumUses": 10,
        "remainingUses": 10,
        "startDate": "2021-10-02T08:18:52+00:00",
        "endDate": "2021-10-02T09:18:52+00:00"
      },
      "orderItemIntakeForm": [
        {
          "@type": "BooleanFormFieldSpecification",
          "@id": "https://example.com/photoconsent",
          "name": "Photo Consent",
          "description": "Are you happy for us to include photos of you in our marketing materials?"
        }
      ],
      "orderItemStatus": "https://openactive.io/OrderItemConfirmed",
      "unitTaxSpecification": [
        {
          "@type": "TaxChargeSpecification",
          "name": "VAT at 20%",
          "price": 2,
          "priceCurrency": "GBP",
          "rate": 0.2
        }
      ]
    }
  ],
  "payment": {
    "@type": "Payment",
    "identifier": "g2N88T2mf",
    "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": 0
  }
}

Specs

B » validation of B

Specs

Validations

OrderProposal Feed Deletion (after B)

Orders (order-proposals) Feed collect for 'ab22a5cf-26a6-4963-8c03-5082f059e45f' change (auth: primary) Request

GET http://localhost:3000/order-listeners/order-proposals/primary/ab22a5cf-26a6-4963-8c03-5082f059e45f


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

{
  "state": "deleted",
  "kind": "Order",
  "id": "ab22a5cf-26a6-4963-8c03-5082f059e45f",
  "modified": 637686731405442700
}

Specs

OrderProposal Feed Deletion (after B) » validation of OrderFeed

Specs

Validations