@openactive/data-models/versions/2.x/models/CancellationNotPermittedError.json

Data models used to drive that OpenActive validator, developer documentation, and model libraries

{
  "type": "CancellationNotPermittedError",
  "subClassOf": "#OpenBookingError",
  "description": {
    "sections": [
      {
        "title": "Error Use Case",
        "paragraphs": [
          "Cancellation is not permitted due to internal rules of the Booking System not otherwise exposed to the Broker.  The `description` property of the object MUST include a Customer-facing description of the reason that cancellation is not permitted."
        ]
      }
    ]
  },
  "fields": {
    "type": {
        "fieldName": "type",
        "requiredContent": "CancellationNotPermittedError",
        "requiredType": "https://schema.org/Text"
    },
    "name": {
      "description": [
          "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization."
      ],
      "example": "Cancellation is not permitted due to internal rules of the Booking System not otherwise exposed to the Broker.",
      "defaultContent": "Cancellation is not permitted due to internal rules of the Booking System not otherwise exposed to the Broker.",
      "fieldName": "name",
      "requiredType": "https://schema.org/Text",
      "sameAs": "https://schema.org/name"
    },
    "statusCode": {
      "fieldName": "statusCode",
      "sameAs": "https://openactive.io/statusCode",
      "requiredType": "https://schema.org/Integer",
      "requiredContent": 400,
      "defaultContent": 400,
      "description": [
        "An integer representing the HTTP status code."
      ]
    }
  }
}