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

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

{
  "type": "PropertyValue",
  "derivedFrom": "https://schema.org/PropertyValue",
  "hasId": false,
  "validationMode": {
    "RPDEFeed": "all",
    "BookableRPDEFeed": "all",
    "DatasetSite": "all",
    "DataCatalog": "all",
    "C1Request": "all",
    "C1Response": "all",
    "C1ResponseOrderItemError": "all",
    "C2Request": "all",
    "C2Response": "all",
    "C2ResponseOrderItemError": "all",
    "PRequest": "all",
    "PResponse": "all",
    "PResponseOrderItemError": "all",
    "BRequest": "all",
    "BResponse": "all",
    "BResponseOrderItemError": "all",
    "OrderProposalPatch": "all",
    "OrderPatch": "all",
    "OrdersFeed": "all",
    "OrderProposalsFeed": "all",
    "OrderStatus": "all"
  },
  "imperativeConfigurationWithContext": {
    "all": {
      "accessCode": {
        "requiredFields": [
          "type",
          "name",
          "description"
        ],
        "shallNotInclude": [
          "value",
          "propertyID"
        ]
      },
      "additionalProperty": {
        "requiredFields": [
          "type",
          "name",
          "value"
        ],
        "shallNotInclude": [
          "description",
          "propertyID"
        ]
      },
      "orderItemIntakeFormResponse": {
        "requiredFields": [
          "type",
          "propertyID",
          "value"
        ],
        "shallNotInclude": [
          "name",
          "description"
        ]
      }
    }
  },
  "inSpec": [
    "type",
    "name",
    "propertyID",
    "value",
    "description"
  ],
  "fields": {
    "type": {
      "fieldName": "type",
      "requiredType": "https://schema.org/Text",
      "requiredContent": "PropertyValue"
    },
    "name": {
      "fieldName": "name",
      "sameAs": "https://schema.org/name",
      "requiredType": "https://schema.org/Text",
      "description": [
        "The name of this PropertyValue"
      ],
      "example": "Vendor ID"
    },
    "propertyID": {
      "fieldName": "propertyID",
      "sameAs": "https://schema.org/propertyID",
      "requiredType": "https://schema.org/URL",
      "alternativeTypes": [
        "https://schema.org/Text"
      ],
      "description": [
        "A commonly used identifier for the characteristic represented by the property"
      ],
      "example": "https://example.com/photoconsent"
    },
    "value": {
      "fieldName": "value",
      "sameAs": "https://schema.org/value",
      "requiredType": "https://schema.org/Text",
      "alternativeTypes": [
        "https://schema.org/Boolean",
        "https://schema.org/URL"
      ],
      "description": [
        "The actual value of this identifier"
      ],
      "example": "SB1234"
    },
    "description": {
      "fieldName": "description",
      "sameAs": "https://schema.org/description",
      "requiredType": "https://schema.org/Text",
      "description": [
        "Additional human-readable version of the value of the property."
      ]
    }
  }
}