@openactive/data-models
Version:
Data models used to drive that OpenActive validator, developer documentation, and model libraries
42 lines (41 loc) • 2.09 kB
JSON
{
"type": "OpportunityCapacityIsReservedByLeaseError",
"subClassOf": "#OpenBookingError",
"description": {
"sections": [
{
"title": "Error Use Case",
"paragraphs": [
"The available capacity required to book a specific Opportunity is reserved by a lease held by another Customer. If the `OrderItem` is repeated (for multiple attendees) this error MUST only be included in the API response against the `OrderItem`s which are in excess of the capacity but which are reserved by the lease of another Customer - for example in an Opportunity with a `remainingAttendeeCapacity` of 3, with 1 additional space held by another lease, then for an `OrderQuote` with 9 `OrderItem`s related to it, this error would only be emitted against 1 of the `OrderItem`s, with `OpportunityHasInsufficientCapacityError` emitted against the other 5 of the `OrderItem`s. This helps a Customer to know whether they should try again."
]
}
]
},
"fields": {
"type": {
"fieldName": "type",
"requiredContent": "OpportunityCapacityIsReservedByLeaseError",
"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": "The available capacity required to book a specific Opportunity is reserved by a lease held by another Customer.",
"defaultContent": "The available capacity required to book a specific Opportunity is reserved by a lease held by another Customer.",
"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": 409,
"defaultContent": 409,
"description": [
"An integer representing the HTTP status code."
]
}
}
}