Documentation ¶
Index ¶
- type Abridged
- type Abstract
- type AcceptsReservations
- type AccessCode
- type AccessMode
- type AccessibilityAPI
- type AccessibilityControl
- type AccessibilityFeature
- type AccessibilityHazard
- type AccessibilitySummary
- type AccommodationCategory
- type AccountId
- type AcquireLicensePage
- type AcrissCode
- type ActionOption
- type ActionPlatform
- type ActionableFeedbackPolicy
- type ActiveIngredient
- type ActivityFrequency
- type AdditionalName
- type AdditionalNumberOfGuests
- type AdditionalType
- type AdditionalVariable
- type Address
- type AddressCountry
- type AddressLocality
- type AddressRegion
- type AdministrationRoute
- type AfterMedia
- type Aircraft
- type AlcoholWarning
- type Algorithm
- type AlignmentType
- type AlternateName
- type AlternativeHeadline
- type Amount
- type AmountOfThisGood
- type AnnualPercentageRate
- type AnswerCount
- type ApplicableCountry
- type ApplicationCategory
- type ApplicationDeadline
- type ApplicationStartDate
- type ApplicationSubCategory
- type ApplicationSuite
- type ArchivedAt
- type AreaServed
- type ArrivalGate
- type ArrivalPlatform
- type ArrivalTerminal
- type ArrivalTime
- type ArtEdition
- type ArtMedium
- type Artform
- type ArticleBody
- type ArticleSection
- type ArtworkSurface
- type Asin
- type Aspect
- type Assembly
- type AssemblyVersion
- type Assesses
- type AssociatedDisease
- type AssociatedPathophysiology
- type AudienceType
- type AvailabilityEnds
- type AvailabilityStarts
- type AvailableFrom
- type AvailableLanguage
- type AvailableOnDevice
- type AvailableThrough
- type Award
- type Awards
- type Backstory
- type BankAccountType
- type BaseSalary
- type Bed
- type BeforeMedia
- type BeneficiaryBank
- type Benefits
- type BenefitsSummaryUrl
- type BestRating
- type BillingDuration
- type BillingIncrement
- type BillingStart
- type BiomechnicalClass
- type BirthDate
- type Bitrate
- type BoardingGroup
- type BodyLocation
- type BodyType
- type BookEdition
- type BookingTime
- type Box
- type BranchCode
- type Breadcrumb
- type BreastfeedingWarning
- type BroadcastChannelId
- type BroadcastDisplayName
- type BroadcastFrequency
- type BroadcastFrequencyValue
- type BroadcastServiceTier
- type BroadcastSignalModulation
- type BroadcastSubChannel
- type BroadcastTimezone
- type BrowserRequirements
- type BusName
- type BusNumber
- type ByDay
- type ByMonth
- type ByMonthDay
- type ByMonthWeek
- type CallSign
- type Caption
- type CarrierRequirements
- type CashBack
- type CatalogNumber
- type Category
- type CharacterName
- type CheckinTime
- type CheckoutPageURLTemplate
- type CheckoutTime
- type ChemicalComposition
- type ChildMaxAge
- type ChildMinAge
- type ChildTaxon
- type Circle
- type Citation
- type ClaimReviewed
- type ClincalPharmacology
- type ClinicalPharmacology
- type ClipNumber
- type Closes
- type CodeRepository
- type CodeSampleType
- type CodeValue
- type CodingSystem
- type Colleague
- type CollectionSize
- type Color
- type CommentCount
- type CommentText
- type CommentTime
- type CompetencyRequired
- type ConditionsOfAccess
- type ConfirmationNumber
- type ConstraintProperty
- type ContactType
- type ContactlessPayment
- type ContentRating
- type ContentReferenceTime
- type ContentSize
- type ContentType
- type ContentUrl
- type Contraindication
- type CookingMethod
- type CopyrightNotice
- type CopyrightYear
- type Correction
- type CorrectionsPolicy
- type CostCurrency
- type CostOrigin
- type CostPerUnit
- type CountriesNotSupported
- type CountriesSupported
- type CountryOfAssembly
- type CountryOfLastProcessing
- type CourseCode
- type CourseMode
- type CoursePrerequisites
- type CourseWorkload
- type CoverageEndTime
- type CoverageStartTime
- type CreativeWorkStatus
- type CredentialCategory
- type CreditText
- type CssSelector
- type CurrenciesAccepted
- type Currency
- type CutoffTime
- type CvdCollectionDate
- type CvdFacilityCounty
- type CvdFacilityId
- type CvdNumBeds
- type CvdNumBedsOcc
- type CvdNumC19Died
- type CvdNumC19HOPats
- type CvdNumC19HospPats
- type CvdNumC19MechVentPats
- type CvdNumC19OFMechVentPats
- type CvdNumC19OverflowPats
- type CvdNumICUBeds
- type CvdNumICUBedsOcc
- type CvdNumTotBeds
- type CvdNumVent
- type CvdNumVentUse
- type DataFeedElement
- type DatasetTimeInterval
- type DateCreated
- type DateDeleted
- type DateIssued
- type DateModified
- type DatePosted
- type DatePublished
- type DateRead
- type DateReceived
- type DateSent
- type DateVehicleFirstRegistered
- type Dateline
- type DeathDate
- type DefaultValue
- type DepartureGate
- type DeparturePlatform
- type DepartureTerminal
- type DepartureTime
- type Dependencies
- type Description
- type Device
- type DietFeatures
- type DirectApply
- type DisambiguatingDescription
- type Discount
- type DiscountCode
- type DiscountCurrency
- type DiscussionUrl
- type DiseasePreventionInfo
- type DiseaseSpreadStatistics
- type DissolutionDate
- type DiversityPolicy
- type DiversityStaffingReport
- type Documentation
- type DoesNotShip
- type DomiciledMortgage
- type DoorTime
- type DosageForm
- type DoseUnit
- type DoseValue
- type DownPayment
- type DownloadUrl
- type DownvoteCount
- type DriveWheelConfiguration
- type DropoffTime
- type DrugUnit
- type Duns
- type DuringMedia
- type EditEIDR
- type EduQuestionType
- type EducationRequirements
- type EducationalCredentialAwarded
- type EducationalFramework
- type EducationalLevel
- type EducationalProgramMode
- type EducationalRole
- type EducationalUse
- type Elevation
- type EligibilityToWorkRequirement
- type EligibleRegion
- type Email
- type EmbedUrl
- type EmbeddedTextCaption
- type EmissionsCO2
- type EmployerOverview
- type EmploymentType
- type EncodingFormat
- type EncodingType
- type EndDate
- type EndOffset
- type EndTime
- type EngineType
- type Epidemiology
- type EpisodeNumber
- type EstimatedCost
- type EstimatedFlightDuration
- type EstimatedSalary
- type EthicsPolicy
- type EvidenceOrigin
- type ExceptDate
- type ExchangeRateSpread
- type ExecutableLibraryName
- type ExerciseType
- type ExifData
- type ExpectedArrivalFrom
- type ExpectedArrivalUntil
- type ExpectedPrognosis
- type ExperienceInPlaceOfEducation
- type ExperienceRequirements
- type ExpertConsiderations
- type Expires
- type FamilyName
- type FaxNumber
- type FeatureList
- type FeesAndCommissionsSpecification
- type FileFormat
- type FileSize
- type FinancialAidEligible
- type FlightDistance
- type FlightNumber
- type FloorLevel
- type Followup
- type FoodWarning
- type FoundingDate
- type Free
- type Frequency
- type FuelType
- type FunctionalClass
- type GameAvailabilityType
- type GameEdition
- type GameLocation
- type GamePlatform
- type Gender
- type Genre
- type GeoRadius
- type GettingTestedInfo
- type GivenName
- type GlobalLocationNumber
- type Gtin
- type Gtin12
- type Gtin13
- type Gtin14
- type Gtin8
- type GuidelineDate
- type HasBioPolymerSequence
- type HasDriveThroughService
- type HasMap
- type HasMenu
- type HasMolecularFunction
- type HasRepresentation
- type Headline
- type HealthPlanCoinsuranceOption
- type HealthPlanCoinsuranceRate
- type HealthPlanCopayOption
- type HealthPlanCostSharing
- type HealthPlanDrugOption
- type HealthPlanDrugTier
- type HealthPlanId
- type HealthPlanMarketingUrl
- type HealthPlanNetworkId
- type HealthPlanNetworkTier
- type HealthPlanPharmacyCategory
- type HighPrice
- type HonorificPrefix
- type HonorificSuffix
- type HowPerformed
- type HttpMethod
- type IataCode
- type IcaoCode
- type Identifier
- type Image
- type InChI
- type InChIKey
- type InCodeSet
- type InDefinedTermSet
- type InLanguage
- type InProductGroupWithID
- type InStoreReturnsOffered
- type InSupportOf
- type IncentiveCompensation
- type Incentives
- type Industry
- type IneligibleRegion
- type InfectiousAgent
- type Ingredients
- type InstallUrl
- type Intensity
- type InteractivityType
- type InterestRate
- type IsAcceptingNewPatients
- type IsAccessibleForFree
- type IsAvailableGenerically
- type IsBasedOn
- type IsBasedOnUrl
- type IsFamilyFriendly
- type IsGift
- type IsInvolvedInBiologicalProcess
- type IsLiveBroadcast
- type IsLocatedInSubcellularLocation
- type IsPartOf
- type IsProprietary
- type IsResizable
- type IsUnlabelledFallback
- type Isbn
- type IsicV4
- type Iso6523Code
- type IsrcCode
- type Issn
- type IssueNumber
- type IswcCode
- type ItemListElement
- type ItemListOrder
- type ItemLocation
- type IupacName
- type JobBenefits
- type JobImmediateStart
- type JobLocationType
- type JobStartDate
- type JobTitle
- type Jurisdiction
- type Keywords
- type KnownVehicleDamages
- type KnowsAbout
- type KnowsLanguage
- type LabelDetails
- type LastReviewed
- type Latitude
- type LayoutImage
- type LearningResourceType
- type LegalName
- type LegalStatus
- type LegislationDate
- type LegislationDateVersion
- type LegislationIdentifier
- type LegislationJurisdiction
- type LegislationType
- type LeiCode
- type License
- type Line
- type LinkRelationship
- type LoanPaymentFrequency
- type LoanType
- type Location
- type LodgingUnitDescription
- type LodgingUnitType
- type Logo
- type Longitude
- type LowPrice
- type MainEntityOfPage
- type Map
- type Maps
- type Masthead
- type Material
- type MaterialExtent
- type MathExpression
- type MaxPrice
- type MaxValue
- type MaximumAttendeeCapacity
- type MaximumEnrollment
- type MaximumPhysicalAttendeeCapacity
- type MaximumVirtualAttendeeCapacity
- type MealService
- type MeasurementMethod
- type MeasurementTechnique
- type MechanismOfAction
- type Median
- type MeetsEmissionStandard
- type MembershipNumber
- type MembershipPointsEarned
- type MemoryRequirements
- type Menu
- type MerchantReturnDays
- type MerchantReturnLink
- type MinPrice
- type MinValue
- type MissionCoveragePrioritiesPolicy
- type MobileUrl
- type Model
- type ModelDate
- type ModifiedTime
- type MolecularFormula
- type MolecularWeight
- type MonoisotopicMolecularWeight
- type MonthlyMinimumRepaymentAmount
- type MonthsOfExperience
- type Mpn
- type MultipleValues
- type MuscleAction
- type MusicCompositionForm
- type MusicalKey
- type Naics
- type Name
- type NamedPosition
- type NaturalProgression
- type NegativeNotes
- type NewsUpdatesAndGuidelines
- type NoBylinesPolicy
- type NonProprietaryName
- type NormalRange
- type Nsn
- type NumAdults
- type NumChildren
- type NumConstraints
- type NumTracks
- type NumberOfAirbags
- type NumberOfAxles
- type NumberOfBathroomsTotal
- type NumberOfBedrooms
- type NumberOfBeds
- type NumberOfCredits
- type NumberOfDoors
- type NumberOfEpisodes
- type NumberOfForwardGears
- type NumberOfFullBathrooms
- type NumberOfItems
- type NumberOfLoanPayments
- type NumberOfPages
- type NumberOfPartialBathrooms
- type NumberOfPreviousOwners
- type NumberOfRooms
- type NumberOfSeasons
- type NumberedPosition
- type ObservationDate
- type ObservationPeriod
- type OccupationalCategory
- type OccupationalCredentialAwarded
- type OfferCount
- type OffersPrescriptionByMail
- type OpeningHours
- type Opens
- type OperatingSystem
- type Option
- type OrderDate
- type OrderItemNumber
- type OrderNumber
- type OrderQuantity
- type OriginalMediaContextDescription
- type OriginalMediaLink
- type Overdosage
- type OwnedFrom
- type OwnedThrough
- type OwnershipFundingInfo
- type PageEnd
- type PageStart
- type Pagination
- type ParentTaxon
- type PartySize
- type PassengerPriorityStatus
- type PassengerSequenceNumber
- type Pathophysiology
- type Pattern
- type PaymentAccepted
- type PaymentDue
- type PaymentDueDate
- type PaymentMethodId
- type PaymentStatus
- type PaymentUrl
- type Percentile10
- type Percentile25
- type Percentile75
- type Percentile90
- type Permissions
- type PermittedUsage
- type PetsAllowed
- type PhoneticText
- type PhysicalRequirement
- type PhysiologicalBenefits
- type PickupTime
- type PlayerType
- type PlayersOnline
- type Polygon
- type Position
- type PositiveNotes
- type PossibleComplication
- type PostOfficeBoxNumber
- type PostOp
- type PostalCode
- type PostalCodeBegin
- type PostalCodeEnd
- type PostalCodePrefix
- type PreOp
- type PregnancyWarning
- type Preparation
- type PrescribingInfo
- type PrescriptionStatus
- type PreviousStartDate
- type Price
- type PriceCurrency
- type PriceRange
- type PriceType
- type PriceValidUntil
- type PrintColumn
- type PrintEdition
- type PrintPage
- type PrintSection
- type Procedure
- type ProcessorRequirements
- type ProductGroupID
- type ProductID
- type ProductReturnDays
- type ProductReturnLink
- type ProductSupported
- type ProductionDate
- type ProficiencyLevel
- type ProgramName
- type ProgramPrerequisites
- type ProgramType
- type ProgrammingLanguage
- type ProgrammingModel
- type PropertyID
- type ProprietaryName
- type ProviderMobility
- type PublicAccess
- type PublicTransportClosuresInfo
- type PublicationType
- type PublishingPrinciples
- type PurchaseDate
- type Qualifications
- type QuarantineGuidelines
- type Query
- type RatingCount
- type RatingExplanation
- type RatingValue
- type ReadonlyValue
- type RecipeCategory
- type RecipeCuisine
- type RecipeIngredient
- type RecipeInstructions
- type RecipeYield
- type RecommendationStrength
- type RecourseLoan
- type RelatedLink
- type ReleaseDate
- type ReleaseNotes
- type RemainingAttendeeCapacity
- type RenegotiableLoan
- type RepeatCount
- type RepeatFrequency
- type Repetitions
- type ReplyToUrl
- type ReportNumber
- type RepresentativeOfPage
- type RequiredCollateral
- type RequiredGender
- type RequiredMaxAge
- type RequiredMinAge
- type RequiredQuantity
- type Requirements
- type RequiresSubscription
- type ReservationId
- type Responsibilities
- type RestPeriods
- type RestockingFee
- type ReturnPolicyCountry
- type ReviewAspect
- type ReviewBody
- type ReviewCount
- type Risks
- type RoleName
- type Runtime
- type RuntimePlatform
- type Rxcui
- type SafetyConsideration
- type SalaryCurrency
- type SameAs
- type SampleType
- type ScheduleTimezone
- type ScheduledPaymentDate
- type ScheduledTime
- type SchemaVersion
- type SchoolClosuresInfo
- type ScreenCount
- type Screenshot
- type SdDatePublished
- type SdLicense
- type Season
- type SeasonNumber
- type SeatNumber
- type SeatRow
- type SeatSection
- type SeatingCapacity
- type SeatingType
- type SecurityClearanceRequirement
- type SecurityScreening
- type SensoryRequirement
- type SerialNumber
- type ServesCuisine
- type ServiceType
- type ServiceUrl
- type ServingSize
- type Sha256
- type ShippingLabel
- type ShippingSettingsLink
- type Significance
- type SignificantLink
- type SignificantLinks
- type Size
- type SizeGroup
- type SizeSystem
- type Skills
- type Sku
- type Slogan
- type Smiles
- type SmokingAllowed
- type SoftwareRequirements
- type SoftwareVersion
- type Speakable
- type SpecialCommitments
- type SpeechToTextMarkup
- type Sport
- type StageAsNumber
- type StartDate
- type StartOffset
- type StartTime
- type StatType
- type Status
- type Step
- type StepValue
- type Steps
- type StorageRequirements
- type StreetAddress
- type StrengthUnit
- type StrengthValue
- type StructuralClass
- type SubStageSuffix
- type SubtitleLanguage
- type SuggestedGender
- type SuggestedMaxAge
- type SuggestedMinAge
- type Supply
- type Surface
- type Target
- type TargetDescription
- type TargetName
- type TargetPlatform
- type TargetPopulation
- type TargetUrl
- type TaxID
- type TaxonRank
- type TaxonomicRange
- type Teaches
- type Telephone
- type Temporal
- type TemporalCoverage
- type TermCode
- type TermsOfService
- type TermsPerYear
- type Text
- type TextValue
- type ThumbnailUrl
- type TickerSymbol
- type TicketNumber
- type TicketToken
- type TimeOfDay
- type TissueSample
- type Title
- type TitleEIDR
- type Tool
- type TotalHistoricalEnrollment
- type TotalJobOpenings
- type TotalPrice
- type TourBookingPage
- type TouristType
- type TrackingNumber
- type TrackingUrl
- type TrainName
- type TrainNumber
- type Transcript
- type TransitTimeLabel
- type TransmissionMethod
- type TravelBans
- type TypeOfBed
- type TypicalAgeRange
- type TypicalCreditsPerTerm
- type UnitCode
- type UnitText
- type UnnamedSourcesPolicy
- type UploadDate
- type UpvoteCount
- type Url
- type UrlTemplate
- type UsageInfo
- type UserInteractionCount
- type UsesHealthPlanIdStandard
- type Utterances
- type ValidFrom
- type ValidThrough
- type ValidUntil
- type Value
- type ValueAddedTaxIncluded
- type ValueMaxLength
- type ValueMinLength
- type ValueName
- type ValuePattern
- type ValueReference
- type ValueRequired
- type VariableMeasured
- type VariablesMeasured
- type VariantCover
- type VariesBy
- type VatID
- type VehicleConfiguration
- type VehicleIdentificationNumber
- type VehicleInteriorColor
- type VehicleInteriorType
- type VehicleModelDate
- type VehicleSeatingCapacity
- type VehicleSpecialUsage
- type VehicleTransmission
- type VerificationFactCheckingPolicy
- type Version
- type VideoFormat
- type VideoFrameSize
- type VideoQuality
- type VolumeNumber
- type Warning
- type WebCheckinTime
- type WebFeed
- type WordCount
- type WorkHours
- type WorstRating
- type Xpath
- type YearBuilt
- type Yield
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Abridged ¶ added in v1.14.1
type Abridged bool
Abridged is https://schema.org/abridged
Indicates whether the book is an abridged edition.
type Abstract ¶
type Abstract string
Abstract is https://schema.org/abstract
An abstract is a short description that summarizes a [[CreativeWork]].
type AcceptsReservations ¶
type AcceptsReservations string
AcceptsReservations is https://schema.org/acceptsReservations
Indicates whether a FoodEstablishment accepts reservations. Values can be Boolean, an URL at which reservations can be made or (for backwards compatibility) the strings ```Yes``` or ```No```.
type AccessCode ¶
type AccessCode string
AccessCode is https://schema.org/accessCode
Password, PIN, or access code needed for delivery (e.g. from a locker).
type AccessMode ¶
type AccessMode string
AccessMode is https://schema.org/accessMode
The human sensory perceptual system or cognitive faculty through which a person may process or perceive information. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessMode-vocabulary).
type AccessibilityAPI ¶
type AccessibilityAPI string
AccessibilityAPI is https://schema.org/accessibilityAPI
Indicates that the resource is compatible with the referenced accessibility API. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityAPI-vocabulary).
type AccessibilityControl ¶
type AccessibilityControl string
AccessibilityControl is https://schema.org/accessibilityControl
Identifies input methods that are sufficient to fully control the described resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityControl-vocabulary).
type AccessibilityFeature ¶
type AccessibilityFeature string
AccessibilityFeature is https://schema.org/accessibilityFeature
Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityFeature-vocabulary).
type AccessibilityHazard ¶
type AccessibilityHazard string
AccessibilityHazard is https://schema.org/accessibilityHazard
A characteristic of the described resource that is physiologically dangerous to some users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityHazard-vocabulary).
type AccessibilitySummary ¶
type AccessibilitySummary string
AccessibilitySummary is https://schema.org/accessibilitySummary
A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as "short descriptions are present but long descriptions will be needed for non-visual users" or "short descriptions are present and no long descriptions are needed."
type AccommodationCategory ¶
type AccommodationCategory string
AccommodationCategory is https://schema.org/accommodationCategory
Category of an [[Accommodation]], following real estate conventions, e.g. RESO (see [PropertySubType](https://ddwiki.reso.org/display/DDW17/PropertySubType+Field), and [PropertyType](https://ddwiki.reso.org/display/DDW17/PropertyType+Field) fields for suggested values).
type AccountId ¶
type AccountId string
AccountId is https://schema.org/accountId
The identifier for the account the payment will be applied to.
type AcquireLicensePage ¶
type AcquireLicensePage string
AcquireLicensePage is https://schema.org/acquireLicensePage
Indicates a page documenting how licenses can be purchased or otherwise acquired, for the current item.
type AcrissCode ¶
type AcrissCode string
AcrissCode is https://schema.org/acrissCode
The ACRISS Car Classification Code is a code used by many car rental companies, for classifying vehicles. ACRISS stands for Association of Car Rental Industry Systems and Standards.
type ActionOption ¶
type ActionOption string
ActionOption is https://schema.org/actionOption
A sub property of object. The options subject to this action.
type ActionPlatform ¶
type ActionPlatform string
ActionPlatform is https://schema.org/actionPlatform
The high level platform(s) where the Action can be performed for the given URL. To specify a specific application or operating system instance, use actionApplication.
type ActionableFeedbackPolicy ¶
type ActionableFeedbackPolicy string
ActionableFeedbackPolicy is https://schema.org/actionableFeedbackPolicy
For a [[NewsMediaOrganization]] or other news-related [[Organization]], a statement about public engagement activities (for news media, the newsroom’s), including involving the public - digitally or otherwise -- in coverage decisions, reporting and activities after publication.
type ActiveIngredient ¶
type ActiveIngredient string
ActiveIngredient is https://schema.org/activeIngredient
An active ingredient, typically chemical compounds and/or biologic substances.
type ActivityFrequency ¶
type ActivityFrequency string
ActivityFrequency is https://schema.org/activityFrequency
How often one should engage in the activity.
type AdditionalName ¶
type AdditionalName string
AdditionalName is https://schema.org/additionalName
An additional name for a Person, can be used for a middle name.
type AdditionalNumberOfGuests ¶ added in v1.14.1
type AdditionalNumberOfGuests float64
AdditionalNumberOfGuests is https://schema.org/additionalNumberOfGuests
If responding yes, the number of guests who will attend in addition to the invitee.
type AdditionalType ¶
type AdditionalType string
AdditionalType is https://schema.org/additionalType
An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. Typically the value is a URI-identified RDF class, and in this case corresponds to the
use of rdf:type in RDF. Text values can be used sparingly, for cases where useful information can be added without their being an appropriate schema to reference. In the case of text values, the class label should follow the schema.org <a href="http://schema.org/docs/styleguide.html">style guide</a>
type AdditionalVariable ¶
type AdditionalVariable string
AdditionalVariable is https://schema.org/additionalVariable
Any additional component of the exercise prescription that may need to be articulated to the patient. This may include the order of exercises, the number of repetitions of movement, quantitative distance, progressions over time, etc.
type Address ¶
type Address string
Address is https://schema.org/address
Physical address of the item.
type AddressCountry ¶
type AddressCountry string
AddressCountry is https://schema.org/addressCountry
The country. For example, USA. You can also provide the two-letter [ISO 3166-1 alpha-2 country code](http://en.wikipedia.org/wiki/ISO_3166-1).
type AddressLocality ¶
type AddressLocality string
AddressLocality is https://schema.org/addressLocality
The locality in which the street address is, and which is in the region. For example, Mountain View.
type AddressRegion ¶
type AddressRegion string
AddressRegion is https://schema.org/addressRegion
The region in which the locality is, and which is in the country. For example, California or another appropriate first-level [Administrative division](https://en.wikipedia.org/wiki/List_of_administrative_divisions_by_country).
type AdministrationRoute ¶
type AdministrationRoute string
AdministrationRoute is https://schema.org/administrationRoute
A route by which this drug may be administered, e.g. 'oral'.
type AfterMedia ¶
type AfterMedia string
AfterMedia is https://schema.org/afterMedia
A media object representing the circumstances after performing this direction.
type Aircraft ¶
type Aircraft string
Aircraft is https://schema.org/aircraft
The kind of aircraft (e.g., "Boeing 747").
type AlcoholWarning ¶
type AlcoholWarning string
AlcoholWarning is https://schema.org/alcoholWarning
Any precaution, guidance, contraindication, etc. related to consumption of alcohol while taking this drug.
type Algorithm ¶
type Algorithm string
Algorithm is https://schema.org/algorithm
The algorithm or rules to follow to compute the score.
type AlignmentType ¶
type AlignmentType string
AlignmentType is https://schema.org/alignmentType
A category of alignment between the learning resource and the framework node. Recommended values include: 'requires', 'textComplexity', 'readingLevel', and 'educationalSubject'.
type AlternateName ¶
type AlternateName string
AlternateName is https://schema.org/alternateName
An alias for the item.
type AlternativeHeadline ¶
type AlternativeHeadline string
AlternativeHeadline is https://schema.org/alternativeHeadline
A secondary title of the CreativeWork.
type Amount ¶ added in v1.14.1
type Amount float64
Amount is https://schema.org/amount
The amount of money.
type AmountOfThisGood ¶ added in v1.14.1
type AmountOfThisGood float64
AmountOfThisGood is https://schema.org/amountOfThisGood
The quantity of the goods included in the offer.
type AnnualPercentageRate ¶ added in v1.14.1
type AnnualPercentageRate float64
AnnualPercentageRate is https://schema.org/annualPercentageRate
The annual rate that is charged for borrowing (or made by investing), expressed as a single percentage number that represents the actual yearly cost of funds over the term of a loan. This includes any fees or additional costs associated with the transaction.
type AnswerCount ¶ added in v1.14.1
type AnswerCount float64
AnswerCount is https://schema.org/answerCount
The number of answers this question has received.
type ApplicableCountry ¶ added in v1.14.0
type ApplicableCountry string
ApplicableCountry is https://schema.org/applicableCountry
A country where a particular merchant return policy applies to, for example the two-letter ISO 3166-1 alpha-2 country code.
type ApplicationCategory ¶
type ApplicationCategory string
ApplicationCategory is https://schema.org/applicationCategory
Type of software application, e.g. 'Game, Multimedia'.
type ApplicationDeadline ¶ added in v1.14.1
type ApplicationDeadline string
ApplicationDeadline is https://schema.org/applicationDeadline
The date at which the program stops collecting applications for the next enrollment cycle.
type ApplicationStartDate ¶ added in v1.14.1
type ApplicationStartDate string
ApplicationStartDate is https://schema.org/applicationStartDate
The date at which the program begins collecting applications for the next enrollment cycle.
type ApplicationSubCategory ¶
type ApplicationSubCategory string
ApplicationSubCategory is https://schema.org/applicationSubCategory
Subcategory of the application, e.g. 'Arcade Game'.
type ApplicationSuite ¶
type ApplicationSuite string
ApplicationSuite is https://schema.org/applicationSuite
The name of the application suite to which the application belongs (e.g. Excel belongs to Office).
type ArchivedAt ¶
type ArchivedAt string
ArchivedAt is https://schema.org/archivedAt
Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible, but be archived by archival, journalistic, activist, or law enforcement organizations. In such cases, the referenced page may not directly publish the content.
type AreaServed ¶
type AreaServed string
AreaServed is https://schema.org/areaServed
The geographic area where a service or offered item is provided.
type ArrivalGate ¶
type ArrivalGate string
ArrivalGate is https://schema.org/arrivalGate
Identifier of the flight's arrival gate.
type ArrivalPlatform ¶
type ArrivalPlatform string
ArrivalPlatform is https://schema.org/arrivalPlatform
The platform where the train arrives.
type ArrivalTerminal ¶
type ArrivalTerminal string
ArrivalTerminal is https://schema.org/arrivalTerminal
Identifier of the flight's arrival terminal.
type ArrivalTime ¶ added in v1.14.1
type ArrivalTime string
ArrivalTime is https://schema.org/arrivalTime
The expected arrival time.
type ArtEdition ¶ added in v1.14.1
type ArtEdition string
ArtEdition is https://schema.org/artEdition
The number of copies when multiple copies of a piece of artwork are produced - e.g. for a limited edition of 20 prints, 'artEdition' refers to the total number of copies (in this example "20").
type ArtMedium ¶
type ArtMedium string
ArtMedium is https://schema.org/artMedium
The material used. (E.g. Oil, Watercolour, Acrylic, Linoprint, Marble, Cyanotype, Digital, Lithograph, DryPoint, Intaglio, Pastel, Woodcut, Pencil, Mixed Media, etc.)
type Artform ¶
type Artform string
Artform is https://schema.org/artform
e.g. Painting, Drawing, Sculpture, Print, Photograph, Assemblage, Collage, etc.
type ArticleBody ¶
type ArticleBody string
ArticleBody is https://schema.org/articleBody
The actual body of the article.
type ArticleSection ¶
type ArticleSection string
ArticleSection is https://schema.org/articleSection
Articles may belong to one or more 'sections' in a magazine or newspaper, such as Sports, Lifestyle, etc.
type ArtworkSurface ¶
type ArtworkSurface string
ArtworkSurface is https://schema.org/artworkSurface
The supporting materials for the artwork, e.g. Canvas, Paper, Wood, Board, etc.
type Asin ¶ added in v1.22.0
type Asin string
Asin is https://schema.org/asin
An Amazon Standard Identification Number (ASIN) is a 10-character alphanumeric unique identifier assigned by Amazon.com and its partners for product identification within the Amazon organization (summary from [Wikipedia](https://en.wikipedia.org/wiki/Amazon_Standard_Identification_Number)'s article).
Note also that this is a definition for how to include ASINs in Schema.org data, and not a definition of ASINs in general - see documentation from Amazon for authoritative details. ASINs are most commonly encoded as text strings, but the [asin] property supports URL/URI as potential values too.
type Aspect ¶
type Aspect string
Aspect is https://schema.org/aspect
An aspect of medical practice that is considered on the page, such as 'diagnosis', 'treatment', 'causes', 'prognosis', 'etiology', 'epidemiology', etc.
type Assembly ¶
type Assembly string
Assembly is https://schema.org/assembly
Library file name, e.g., mscorlib.dll, system.web.dll.
type AssemblyVersion ¶
type AssemblyVersion string
AssemblyVersion is https://schema.org/assemblyVersion
Associated product/technology version. E.g., .NET Framework 4.5.
type Assesses ¶
type Assesses string
Assesses is https://schema.org/assesses
The item being described is intended to assess the competency or learning outcome defined by the referenced term.
type AssociatedDisease ¶
type AssociatedDisease string
AssociatedDisease is https://schema.org/associatedDisease
Disease associated to this BioChemEntity. Such disease can be a MedicalCondition or a URL. If you want to add an evidence supporting the association, please use PropertyValue.
type AssociatedPathophysiology ¶
type AssociatedPathophysiology string
AssociatedPathophysiology is https://schema.org/associatedPathophysiology
If applicable, a description of the pathophysiology associated with the anatomical system, including potential abnormal changes in the mechanical, physical, and biochemical functions of the system.
type AudienceType ¶
type AudienceType string
AudienceType is https://schema.org/audienceType
The target group associated with a given audience (e.g. veterans, car owners, musicians, etc.).
type AvailabilityEnds ¶ added in v1.14.1
type AvailabilityEnds string
AvailabilityEnds is https://schema.org/availabilityEnds
The end of the availability of the product or service included in the offer.
type AvailabilityStarts ¶ added in v1.14.1
type AvailabilityStarts string
AvailabilityStarts is https://schema.org/availabilityStarts
The beginning of the availability of the product or service included in the offer.
type AvailableFrom ¶ added in v1.14.1
type AvailableFrom string
AvailableFrom is https://schema.org/availableFrom
When the item is available for pickup from the store, locker, etc.
type AvailableLanguage ¶
type AvailableLanguage string
AvailableLanguage is https://schema.org/availableLanguage
A language someone may use with or at the item, service or place. Please use one of the language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also [[inLanguage]].
type AvailableOnDevice ¶
type AvailableOnDevice string
AvailableOnDevice is https://schema.org/availableOnDevice
Device required to run the application. Used in cases where a specific make/model is required to run the application.
type AvailableThrough ¶ added in v1.14.1
type AvailableThrough string
AvailableThrough is https://schema.org/availableThrough
After this date, the item will no longer be available for pickup.
type Awards ¶
type Awards string
Awards is https://schema.org/awards
Awards won by or for this item.
type Backstory ¶
type Backstory string
Backstory is https://schema.org/backstory
For an [[Article]], typically a [[NewsArticle]], the backstory property provides a textual summary giving a brief explanation of why and how an article was created. In a journalistic setting this could include information about reporting process, methods, interviews, data sources, etc.
type BankAccountType ¶
type BankAccountType string
BankAccountType is https://schema.org/bankAccountType
The type of a bank account.
type BaseSalary ¶ added in v1.14.1
type BaseSalary float64
BaseSalary is https://schema.org/baseSalary
The base salary of the job or of an employee in an EmployeeRole.
type Bed ¶
type Bed string
Bed is https://schema.org/bed
The type of bed or beds included in the accommodation. For the single case of just one bed of a certain type, you use bed directly with a text.
If you want to indicate the quantity of a certain kind of bed, use an instance of BedDetails. For more detailed information, use the amenityFeature property.
type BeforeMedia ¶
type BeforeMedia string
BeforeMedia is https://schema.org/beforeMedia
A media object representing the circumstances before performing this direction.
type BeneficiaryBank ¶
type BeneficiaryBank string
BeneficiaryBank is https://schema.org/beneficiaryBank
A bank or bank’s branch, financial institution or international financial institution operating the beneficiary’s bank account or releasing funds for the beneficiary.
type Benefits ¶
type Benefits string
Benefits is https://schema.org/benefits
Description of benefits associated with the job.
type BenefitsSummaryUrl ¶
type BenefitsSummaryUrl string
BenefitsSummaryUrl is https://schema.org/benefitsSummaryUrl
The URL that goes directly to the summary of benefits and coverage for the specific standard plan or plan variation.
type BestRating ¶ added in v1.14.0
type BestRating float64
BestRating is https://schema.org/bestRating
The highest value allowed in this rating system. If bestRating is omitted, 5 is assumed.
type BillingDuration ¶ added in v1.14.1
type BillingDuration float64
BillingDuration is https://schema.org/billingDuration
Specifies for how long this price (or price component) will be billed. Can be used, for example, to model the contractual duration of a subscription or payment plan. Type can be either a Duration or a Number (in which case the unit of measurement, for example month, is specified by the unitCode property).
type BillingIncrement ¶ added in v1.14.1
type BillingIncrement float64
BillingIncrement is https://schema.org/billingIncrement
This property specifies the minimal quantity and rounding increment that will be the basis for the billing. The unit of measurement is specified by the unitCode property.
type BillingStart ¶ added in v1.14.1
type BillingStart float64
BillingStart is https://schema.org/billingStart
Specifies after how much time this price (or price component) becomes valid and billing starts. Can be used, for example, to model a price increase after the first year of a subscription. The unit of measurement is specified by the unitCode property.
type BiomechnicalClass ¶
type BiomechnicalClass string
BiomechnicalClass is https://schema.org/biomechnicalClass
The biomechanical properties of the bone.
type BirthDate ¶ added in v1.14.1
type BirthDate string
BirthDate is https://schema.org/birthDate
Date of birth.
type Bitrate ¶
type Bitrate string
Bitrate is https://schema.org/bitrate
The bitrate of the media object.
type BoardingGroup ¶
type BoardingGroup string
BoardingGroup is https://schema.org/boardingGroup
The airline-specific indicator of boarding order / preference.
type BodyLocation ¶
type BodyLocation string
BodyLocation is https://schema.org/bodyLocation
Location in the body of the anatomical structure.
type BodyType ¶
type BodyType string
BodyType is https://schema.org/bodyType
Indicates the design and body style of the vehicle (e.g. station wagon, hatchback, etc.).
type BookEdition ¶
type BookEdition string
BookEdition is https://schema.org/bookEdition
The edition of the book.
type BookingTime ¶ added in v1.14.1
type BookingTime string
BookingTime is https://schema.org/bookingTime
The date and time the reservation was booked.
type Box ¶
type Box string
Box is https://schema.org/box
A box is the area enclosed by the rectangle formed by two points. The first point is the lower corner, the second point is the upper corner. A box is expressed as two points separated by a space character.
type BranchCode ¶
type BranchCode string
BranchCode is https://schema.org/branchCode
A short textual code (also called "store code") that uniquely identifies a place of business. The code is typically assigned by the parentOrganization and used in structured URLs.\n\nFor example, in the URL http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047" is a branchCode for a particular branch.
type Breadcrumb ¶
type Breadcrumb string
Breadcrumb is https://schema.org/breadcrumb
A set of links that can help a user understand and navigate a website hierarchy.
type BreastfeedingWarning ¶
type BreastfeedingWarning string
BreastfeedingWarning is https://schema.org/breastfeedingWarning
Any precaution, guidance, contraindication, etc. related to this drug's use by breastfeeding mothers.
type BroadcastChannelId ¶
type BroadcastChannelId string
BroadcastChannelId is https://schema.org/broadcastChannelId
The unique address by which the BroadcastService can be identified in a provider lineup. In US, this is typically a number.
type BroadcastDisplayName ¶
type BroadcastDisplayName string
BroadcastDisplayName is https://schema.org/broadcastDisplayName
The name displayed in the channel guide. For many US affiliates, it is the network name.
type BroadcastFrequency ¶
type BroadcastFrequency string
BroadcastFrequency is https://schema.org/broadcastFrequency
The frequency used for over-the-air broadcasts. Numeric values or simple ranges, e.g. 87-99. In addition a shortcut idiom is supported for frequences of AM and FM radio channels, e.g. "87 FM".
type BroadcastFrequencyValue ¶ added in v1.14.1
type BroadcastFrequencyValue float64
BroadcastFrequencyValue is https://schema.org/broadcastFrequencyValue
The frequency in MHz for a particular broadcast.
type BroadcastServiceTier ¶
type BroadcastServiceTier string
BroadcastServiceTier is https://schema.org/broadcastServiceTier
The type of service required to have access to the channel (e.g. Standard or Premium).
type BroadcastSignalModulation ¶
type BroadcastSignalModulation string
BroadcastSignalModulation is https://schema.org/broadcastSignalModulation
The modulation (e.g. FM, AM, etc) used by a particular broadcast service.
type BroadcastSubChannel ¶
type BroadcastSubChannel string
BroadcastSubChannel is https://schema.org/broadcastSubChannel
The subchannel used for the broadcast.
type BroadcastTimezone ¶
type BroadcastTimezone string
BroadcastTimezone is https://schema.org/broadcastTimezone
The timezone in [ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601) for which the service bases its broadcasts.
type BrowserRequirements ¶
type BrowserRequirements string
BrowserRequirements is https://schema.org/browserRequirements
Specifies browser requirements in human-readable text. For example, 'requires HTML5 support'.
type BusName ¶
type BusName string
BusName is https://schema.org/busName
The name of the bus (e.g. Bolt Express).
type BusNumber ¶
type BusNumber string
BusNumber is https://schema.org/busNumber
The unique identifier for the bus.
type ByDay ¶
type ByDay string
ByDay is https://schema.org/byDay
Defines the day(s) of the week on which a recurring [[Event]] takes place. May be specified using either [[DayOfWeek]], or alternatively [Text] conforming to iCal's syntax for byDay recurrence rules.
type ByMonth ¶ added in v1.14.1
type ByMonth float64
ByMonth is https://schema.org/byMonth
Defines the month(s) of the year on which a recurring [[Event]] takes place. Specified as an [[Integer]] between 1-12. January is 1.
type ByMonthDay ¶ added in v1.14.1
type ByMonthDay float64
ByMonthDay is https://schema.org/byMonthDay
Defines the day(s) of the month on which a recurring [[Event]] takes place. Specified as an [[Integer]] between 1-31.
type ByMonthWeek ¶ added in v1.14.1
type ByMonthWeek float64
ByMonthWeek is https://schema.org/byMonthWeek
Defines the week(s) of the month on which a recurring Event takes place. Specified as an Integer between 1-5. For clarity, byMonthWeek is best used in conjunction with byDay to indicate concepts like the first and third Mondays of a month.
type CallSign ¶
type CallSign string
CallSign is https://schema.org/callSign
A [callsign](https://en.wikipedia.org/wiki/Call_sign), as used in broadcasting and radio communications to identify people, radio and TV stations, or vehicles.
type Caption ¶
type Caption string
Caption is https://schema.org/caption
The caption for this object. For downloadable machine formats (closed caption, subtitles etc.) use MediaObject and indicate the [[encodingFormat]].
type CarrierRequirements ¶
type CarrierRequirements string
CarrierRequirements is https://schema.org/carrierRequirements
Specifies specific carrier(s) requirements for the application (e.g. an application may only work on a specific carrier network).
type CashBack ¶ added in v1.14.1
type CashBack float64
CashBack is https://schema.org/cashBack
A cardholder benefit that pays the cardholder a small percentage of their net expenditures.
type CatalogNumber ¶
type CatalogNumber string
CatalogNumber is https://schema.org/catalogNumber
The catalog number for the release.
type Category ¶
type Category string
Category is https://schema.org/category
A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy.
type CharacterName ¶
type CharacterName string
CharacterName is https://schema.org/characterName
The name of a character played in some acting or performing role, i.e. in a PerformanceRole.
type CheckinTime ¶ added in v1.14.1
type CheckinTime string
CheckinTime is https://schema.org/checkinTime
The earliest someone may check into a lodging establishment.
type CheckoutPageURLTemplate ¶ added in v1.22.0
type CheckoutPageURLTemplate string
CheckoutPageURLTemplate is https://schema.org/checkoutPageURLTemplate
A URL template (RFC 6570) for a checkout page for an offer. This approach allows merchants to specify a URL for online checkout of the offered product, by interpolating parameters such as the logged in user ID, product ID, quantity, discount code etc. Parameter naming and standardization are not specified here.
type CheckoutTime ¶ added in v1.14.1
type CheckoutTime string
CheckoutTime is https://schema.org/checkoutTime
The latest someone may check out of a lodging establishment.
type ChemicalComposition ¶
type ChemicalComposition string
ChemicalComposition is https://schema.org/chemicalComposition
The chemical composition describes the identity and relative ratio of the chemical elements that make up the substance.
type ChildMaxAge ¶ added in v1.14.1
type ChildMaxAge float64
ChildMaxAge is https://schema.org/childMaxAge
Maximal age of the child.
type ChildMinAge ¶ added in v1.14.1
type ChildMinAge float64
ChildMinAge is https://schema.org/childMinAge
Minimal age of the child.
type ChildTaxon ¶
type ChildTaxon string
ChildTaxon is https://schema.org/childTaxon
Closest child taxa of the taxon in question.
type Circle ¶
type Circle string
Circle is https://schema.org/circle
A circle is the circular region of a specified radius centered at a specified latitude and longitude. A circle is expressed as a pair followed by a radius in meters.
type Citation ¶
type Citation string
Citation is https://schema.org/citation
A citation or reference to another creative work, such as another publication, web page, scholarly article, etc.
type ClaimReviewed ¶
type ClaimReviewed string
ClaimReviewed is https://schema.org/claimReviewed
A short summary of the specific claims reviewed in a ClaimReview.
type ClincalPharmacology ¶
type ClincalPharmacology string
ClincalPharmacology is https://schema.org/clincalPharmacology
Description of the absorption and elimination of drugs, including their concentration (pharmacokinetics, pK) and biological effects (pharmacodynamics, pD).
type ClinicalPharmacology ¶
type ClinicalPharmacology string
ClinicalPharmacology is https://schema.org/clinicalPharmacology
Description of the absorption and elimination of drugs, including their concentration (pharmacokinetics, pK) and biological effects (pharmacodynamics, pD).
type ClipNumber ¶ added in v1.14.0
type ClipNumber string
ClipNumber is https://schema.org/clipNumber
Position of the clip within an ordered group of clips.
type Closes ¶ added in v1.14.1
type Closes string
Closes is https://schema.org/closes
The closing hour of the place or service on the given day(s) of the week.
type CodeRepository ¶
type CodeRepository string
CodeRepository is https://schema.org/codeRepository
Link to the repository where the un-compiled, human readable code and related code is located (SVN, GitHub, CodePlex).
type CodeSampleType ¶
type CodeSampleType string
CodeSampleType is https://schema.org/codeSampleType
What type of code sample: full (compile ready) solution, code snippet, inline code, scripts, template.
type CodeValue ¶
type CodeValue string
CodeValue is https://schema.org/codeValue
A short textual code that uniquely identifies the value.
type CodingSystem ¶
type CodingSystem string
CodingSystem is https://schema.org/codingSystem
The coding system, e.g. 'ICD-10'.
type Colleague ¶
type Colleague string
Colleague is https://schema.org/colleague
A colleague of the person.
type CollectionSize ¶ added in v1.14.1
type CollectionSize float64
CollectionSize is https://schema.org/collectionSize
The number of items in the [[Collection]].
type CommentCount ¶ added in v1.14.1
type CommentCount float64
CommentCount is https://schema.org/commentCount
The number of comments this CreativeWork (e.g. Article, Question or Answer) has received. This is most applicable to works published in Web sites with commenting system; additional comments may exist elsewhere.
type CommentText ¶
type CommentText string
CommentText is https://schema.org/commentText
The text of the UserComment.
type CommentTime ¶ added in v1.14.1
type CommentTime string
CommentTime is https://schema.org/commentTime
The time at which the UserComment was made.
type CompetencyRequired ¶
type CompetencyRequired string
CompetencyRequired is https://schema.org/competencyRequired
Knowledge, skill, ability or personal attribute that must be demonstrated by a person or other entity in order to do something such as earn an Educational Occupational Credential or understand a LearningResource.
type ConditionsOfAccess ¶
type ConditionsOfAccess string
ConditionsOfAccess is https://schema.org/conditionsOfAccess
Conditions that affect the availability of, or method(s) of access to, an item. Typically used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]. This property is not suitable for use as a general Web access control mechanism. It is expressed only in natural language.\n\nFor example "Available by appointment from the Reading Room" or "Accessible only from logged-in accounts ".
type ConfirmationNumber ¶
type ConfirmationNumber string
ConfirmationNumber is https://schema.org/confirmationNumber
A number that confirms the given order or payment has been received.
type ConstraintProperty ¶ added in v1.22.0
type ConstraintProperty string
ConstraintProperty is https://schema.org/constraintProperty
Indicates a property used as a constraint. For example, in the definition of a [[StatisticalVariable]]. The value is a property, either from within Schema.org or from other compatible (e.g. RDF) systems such as DataCommons.org or Wikidata.org.
type ContactType ¶
type ContactType string
ContactType is https://schema.org/contactType
A person or organization can have different contact points, for different purposes. For example, a sales contact point, a PR contact point and so on. This property is used to specify the kind of contact point.
type ContactlessPayment ¶ added in v1.14.1
type ContactlessPayment bool
ContactlessPayment is https://schema.org/contactlessPayment
A secure method for consumers to purchase products or services via debit, credit or smartcards by using RFID or NFC technology.
type ContentRating ¶
type ContentRating string
ContentRating is https://schema.org/contentRating
Official rating of a piece of content—for example, 'MPAA PG-13'.
type ContentReferenceTime ¶ added in v1.14.1
type ContentReferenceTime string
ContentReferenceTime is https://schema.org/contentReferenceTime
The specific time described by a creative work, for works (e.g. articles, video objects etc.) that emphasise a particular moment within an Event.
type ContentSize ¶
type ContentSize string
ContentSize is https://schema.org/contentSize
File size in (mega/kilo)bytes.
type ContentType ¶
type ContentType string
ContentType is https://schema.org/contentType
The supported content type(s) for an EntryPoint response.
type ContentUrl ¶
type ContentUrl string
ContentUrl is https://schema.org/contentUrl
Actual bytes of the media object, for example the image file or video file.
type Contraindication ¶
type Contraindication string
Contraindication is https://schema.org/contraindication
A contraindication for this therapy.
type CookingMethod ¶
type CookingMethod string
CookingMethod is https://schema.org/cookingMethod
The method of cooking, such as Frying, Steaming, ...
type CopyrightNotice ¶
type CopyrightNotice string
CopyrightNotice is https://schema.org/copyrightNotice
Text of a notice appropriate for describing the copyright aspects of this Creative Work, ideally indicating the owner of the copyright for the Work.
type CopyrightYear ¶ added in v1.14.1
type CopyrightYear float64
CopyrightYear is https://schema.org/copyrightYear
The year during which the claimed copyright for the CreativeWork was first asserted.
type Correction ¶
type Correction string
Correction is https://schema.org/correction
Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]], textually or in another document.
type CorrectionsPolicy ¶
type CorrectionsPolicy string
CorrectionsPolicy is https://schema.org/correctionsPolicy
For an [[Organization]] (e.g. [[NewsMediaOrganization]]), a statement describing (in news media, the newsroom’s) disclosure and correction policy for errors.
type CostCurrency ¶
type CostCurrency string
CostCurrency is https://schema.org/costCurrency
The currency (in 3-letter) of the drug cost. See: http://en.wikipedia.org/wiki/ISO_4217.
type CostOrigin ¶
type CostOrigin string
CostOrigin is https://schema.org/costOrigin
Additional details to capture the origin of the cost data. For example, 'Medicare Part B'.
type CostPerUnit ¶
type CostPerUnit float64
CostPerUnit is https://schema.org/costPerUnit
The cost per unit of the drug.
type CountriesNotSupported ¶
type CountriesNotSupported string
CountriesNotSupported is https://schema.org/countriesNotSupported
Countries for which the application is not supported. You can also provide the two-letter ISO 3166-1 alpha-2 country code.
type CountriesSupported ¶
type CountriesSupported string
CountriesSupported is https://schema.org/countriesSupported
Countries for which the application is supported. You can also provide the two-letter ISO 3166-1 alpha-2 country code.
type CountryOfAssembly ¶
type CountryOfAssembly string
CountryOfAssembly is https://schema.org/countryOfAssembly
The place where the product was assembled.
type CountryOfLastProcessing ¶
type CountryOfLastProcessing string
CountryOfLastProcessing is https://schema.org/countryOfLastProcessing
The place where the item (typically [[Product]]) was last processed and tested before importation.
type CourseCode ¶
type CourseCode string
CourseCode is https://schema.org/courseCode
The identifier for the [[Course]] used by the course [[provider]] (e.g. CS101 or 6.001).
type CourseMode ¶
type CourseMode string
CourseMode is https://schema.org/courseMode
The medium or means of delivery of the course instance or the mode of study, either as a text label (e.g. "online", "onsite" or "blended"; "synchronous" or "asynchronous"; "full-time" or "part-time") or as a URL reference to a term from a controlled vocabulary (e.g. https://ceds.ed.gov/element/001311#Asynchronous).
type CoursePrerequisites ¶
type CoursePrerequisites string
CoursePrerequisites is https://schema.org/coursePrerequisites
Requirements for taking the Course. May be completion of another [[Course]] or a textual description like "permission of instructor". Requirements may be a pre-requisite competency, referenced using [[AlignmentObject]].
type CourseWorkload ¶
type CourseWorkload string
CourseWorkload is https://schema.org/courseWorkload
The amount of work expected of students taking the course, often provided as a figure per week or per month, and may be broken down by type. For example, "2 hours of lectures, 1 hour of lab work and 3 hours of independent study per week".
type CoverageEndTime ¶ added in v1.14.1
type CoverageEndTime string
CoverageEndTime is https://schema.org/coverageEndTime
The time when the live blog will stop covering the Event. Note that coverage may continue after the Event concludes.
type CoverageStartTime ¶ added in v1.14.1
type CoverageStartTime string
CoverageStartTime is https://schema.org/coverageStartTime
The time when the live blog will begin covering the Event. Note that coverage may begin before the Event's start time. The LiveBlogPosting may also be created before coverage begins.
type CreativeWorkStatus ¶
type CreativeWorkStatus string
CreativeWorkStatus is https://schema.org/creativeWorkStatus
The status of a creative work in terms of its stage in a lifecycle. Example terms include Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for the stages of their publication lifecycle.
type CredentialCategory ¶
type CredentialCategory string
CredentialCategory is https://schema.org/credentialCategory
The category or type of credential being described, for example "degree”, “certificate”, “badge”, or more specific term.
type CreditText ¶
type CreditText string
CreditText is https://schema.org/creditText
Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work.
type CssSelector ¶
type CssSelector string
CssSelector is https://schema.org/cssSelector
A CSS selector, e.g. of a [[SpeakableSpecification]] or [[WebPageElement]]. In the latter case, multiple matches within a page can constitute a single conceptual "Web page element".
type CurrenciesAccepted ¶
type CurrenciesAccepted string
CurrenciesAccepted is https://schema.org/currenciesAccepted
The currency accepted.\n\nUse standard formats: [ISO 4217 currency format](http://en.wikipedia.org/wiki/ISO_4217), e.g. "USD"; [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for cryptocurrencies, e.g. "BTC"; well known names for [Local Exchange Trading Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) (LETS) and other currency types, e.g. "Ithaca HOUR".
type Currency ¶
type Currency string
Currency is https://schema.org/currency
The currency in which the monetary amount is expressed.\n\nUse standard formats: [ISO 4217 currency format](http://en.wikipedia.org/wiki/ISO_4217), e.g. "USD"; [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for cryptocurrencies, e.g. "BTC"; well known names for [Local Exchange Trading Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) (LETS) and other currency types, e.g. "Ithaca HOUR".
type CutoffTime ¶ added in v1.14.1
type CutoffTime string
CutoffTime is https://schema.org/cutoffTime
Order cutoff time allows merchants to describe the time after which they will no longer process orders received on that day. For orders processed after cutoff time, one day gets added to the delivery time estimate. This property is expected to be most typically used via the [[ShippingRateSettings]] publication pattern. The time is indicated using the ISO-8601 Time format, e.g. "23:30:00-05:00" would represent 6:30 pm Eastern Standard Time (EST) which is 5 hours behind Coordinated Universal Time (UTC).
type CvdCollectionDate ¶
type CvdCollectionDate string
CvdCollectionDate is https://schema.org/cvdCollectionDate
collectiondate - Date for which patient counts are reported.
type CvdFacilityCounty ¶
type CvdFacilityCounty string
CvdFacilityCounty is https://schema.org/cvdFacilityCounty
Name of the County of the NHSN facility that this data record applies to. Use [[cvdFacilityId]] to identify the facility. To provide other details, [[healthcareReportingData]] can be used on a [[Hospital]] entry.
type CvdFacilityId ¶
type CvdFacilityId string
CvdFacilityId is https://schema.org/cvdFacilityId
Identifier of the NHSN facility that this data record applies to. Use [[cvdFacilityCounty]] to indicate the county. To provide other details, [[healthcareReportingData]] can be used on a [[Hospital]] entry.
type CvdNumBeds ¶ added in v1.14.1
type CvdNumBeds float64
CvdNumBeds is https://schema.org/cvdNumBeds
numbeds - HOSPITAL INPATIENT BEDS: Inpatient beds, including all staffed, licensed, and overflow (surge) beds used for inpatients.
type CvdNumBedsOcc ¶ added in v1.14.1
type CvdNumBedsOcc float64
CvdNumBedsOcc is https://schema.org/cvdNumBedsOcc
numbedsocc - HOSPITAL INPATIENT BED OCCUPANCY: Total number of staffed inpatient beds that are occupied.
type CvdNumC19Died ¶ added in v1.14.1
type CvdNumC19Died float64
CvdNumC19Died is https://schema.org/cvdNumC19Died
numc19died - DEATHS: Patients with suspected or confirmed COVID-19 who died in the hospital, ED, or any overflow location.
type CvdNumC19HOPats ¶ added in v1.14.1
type CvdNumC19HOPats float64
CvdNumC19HOPats is https://schema.org/cvdNumC19HOPats
numc19hopats - HOSPITAL ONSET: Patients hospitalized in an NHSN inpatient care location with onset of suspected or confirmed COVID-19 14 or more days after hospitalization.
type CvdNumC19HospPats ¶ added in v1.14.1
type CvdNumC19HospPats float64
CvdNumC19HospPats is https://schema.org/cvdNumC19HospPats
numc19hosppats - HOSPITALIZED: Patients currently hospitalized in an inpatient care location who have suspected or confirmed COVID-19.
type CvdNumC19MechVentPats ¶ added in v1.14.1
type CvdNumC19MechVentPats float64
CvdNumC19MechVentPats is https://schema.org/cvdNumC19MechVentPats
numc19mechventpats - HOSPITALIZED and VENTILATED: Patients hospitalized in an NHSN inpatient care location who have suspected or confirmed COVID-19 and are on a mechanical ventilator.
type CvdNumC19OFMechVentPats ¶ added in v1.14.1
type CvdNumC19OFMechVentPats float64
CvdNumC19OFMechVentPats is https://schema.org/cvdNumC19OFMechVentPats
numc19ofmechventpats - ED/OVERFLOW and VENTILATED: Patients with suspected or confirmed COVID-19 who are in the ED or any overflow location awaiting an inpatient bed and on a mechanical ventilator.
type CvdNumC19OverflowPats ¶ added in v1.14.1
type CvdNumC19OverflowPats float64
CvdNumC19OverflowPats is https://schema.org/cvdNumC19OverflowPats
numc19overflowpats - ED/OVERFLOW: Patients with suspected or confirmed COVID-19 who are in the ED or any overflow location awaiting an inpatient bed.
type CvdNumICUBeds ¶ added in v1.14.1
type CvdNumICUBeds float64
CvdNumICUBeds is https://schema.org/cvdNumICUBeds
numicubeds - ICU BEDS: Total number of staffed inpatient intensive care unit (ICU) beds.
type CvdNumICUBedsOcc ¶ added in v1.14.1
type CvdNumICUBedsOcc float64
CvdNumICUBedsOcc is https://schema.org/cvdNumICUBedsOcc
numicubedsocc - ICU BED OCCUPANCY: Total number of staffed inpatient ICU beds that are occupied.
type CvdNumTotBeds ¶ added in v1.14.1
type CvdNumTotBeds float64
CvdNumTotBeds is https://schema.org/cvdNumTotBeds
numtotbeds - ALL HOSPITAL BEDS: Total number of all inpatient and outpatient beds, including all staffed, ICU, licensed, and overflow (surge) beds used for inpatients or outpatients.
type CvdNumVent ¶ added in v1.14.1
type CvdNumVent float64
CvdNumVent is https://schema.org/cvdNumVent
numvent - MECHANICAL VENTILATORS: Total number of ventilators available.
type CvdNumVentUse ¶ added in v1.14.1
type CvdNumVentUse float64
CvdNumVentUse is https://schema.org/cvdNumVentUse
numventuse - MECHANICAL VENTILATORS IN USE: Total number of ventilators in use.
type DataFeedElement ¶
type DataFeedElement string
DataFeedElement is https://schema.org/dataFeedElement
An item within a data feed. Data feeds may have many elements.
type DatasetTimeInterval ¶ added in v1.14.1
type DatasetTimeInterval string
DatasetTimeInterval is https://schema.org/datasetTimeInterval
The range of temporal applicability of a dataset, e.g. for a 2011 census dataset, the year 2011 (in ISO 8601 time interval format).
type DateCreated ¶ added in v1.14.1
type DateCreated string
DateCreated is https://schema.org/dateCreated
The date on which the CreativeWork was created or the item was added to a DataFeed.
type DateDeleted ¶ added in v1.14.1
type DateDeleted string
DateDeleted is https://schema.org/dateDeleted
The datetime the item was removed from the DataFeed.
type DateIssued ¶ added in v1.14.1
type DateIssued string
DateIssued is https://schema.org/dateIssued
The date the ticket was issued.
type DateModified ¶ added in v1.14.1
type DateModified string
DateModified is https://schema.org/dateModified
The date on which the CreativeWork was most recently modified or when the item's entry was modified within a DataFeed.
type DatePosted ¶ added in v1.14.1
type DatePosted string
DatePosted is https://schema.org/datePosted
Publication date of an online listing.
type DatePublished ¶ added in v1.14.1
type DatePublished string
DatePublished is https://schema.org/datePublished
Date of first broadcast/publication.
type DateRead ¶ added in v1.14.1
type DateRead string
DateRead is https://schema.org/dateRead
The date/time at which the message has been read by the recipient if a single recipient exists.
type DateReceived ¶ added in v1.14.1
type DateReceived string
DateReceived is https://schema.org/dateReceived
The date/time the message was received if a single recipient exists.
type DateSent ¶ added in v1.14.1
type DateSent string
DateSent is https://schema.org/dateSent
The date/time at which the message was sent.
type DateVehicleFirstRegistered ¶ added in v1.14.1
type DateVehicleFirstRegistered string
DateVehicleFirstRegistered is https://schema.org/dateVehicleFirstRegistered
The date of the first registration of the vehicle with the respective public authorities.
type Dateline ¶
type Dateline string
Dateline is https://schema.org/dateline
A [dateline](https://en.wikipedia.org/wiki/Dateline) is a brief piece of text included in news articles that describes where and when the story was written or filed though the date is often omitted. Sometimes only a placename is provided.
Structured representations of dateline-related information can also be expressed more explicitly using [[locationCreated]] (which represents where a work was created, e.g. where a news report was written). For location depicted or described in the content, use [[contentLocation]].
Dateline summaries are oriented more towards human readers than towards automated processing, and can vary substantially. Some examples: "BEIRUT, Lebanon, June 2.", "Paris, France", "December 19, 2017 11:43AM Reporting from Washington", "Beijing/Moscow", "QUEZON CITY, Philippines".
type DeathDate ¶ added in v1.14.1
type DeathDate string
DeathDate is https://schema.org/deathDate
Date of death.
type DefaultValue ¶
type DefaultValue string
DefaultValue is https://schema.org/defaultValue
The default value of the input. For properties that expect a literal, the default is a literal value, for properties that expect an object, it's an ID reference to one of the current values.
type DepartureGate ¶
type DepartureGate string
DepartureGate is https://schema.org/departureGate
Identifier of the flight's departure gate.
type DeparturePlatform ¶
type DeparturePlatform string
DeparturePlatform is https://schema.org/departurePlatform
The platform from which the train departs.
type DepartureTerminal ¶
type DepartureTerminal string
DepartureTerminal is https://schema.org/departureTerminal
Identifier of the flight's departure terminal.
type DepartureTime ¶ added in v1.14.1
type DepartureTime string
DepartureTime is https://schema.org/departureTime
The expected departure time.
type Dependencies ¶
type Dependencies string
Dependencies is https://schema.org/dependencies
Prerequisites needed to fulfill steps in article.
type Description ¶
type Description string
Description is https://schema.org/description
A description of the item.
type Device ¶
type Device string
Device is https://schema.org/device
Device required to run the application. Used in cases where a specific make/model is required to run the application.
type DietFeatures ¶
type DietFeatures string
DietFeatures is https://schema.org/dietFeatures
Nutritional information specific to the dietary plan. May include dietary recommendations on what foods to avoid, what foods to consume, and specific alterations/deviations from the USDA or other regulatory body's approved dietary guidelines.
type DirectApply ¶ added in v1.14.1
type DirectApply bool
DirectApply is https://schema.org/directApply
Indicates whether an [[url]] that is associated with a [[JobPosting]] enables direct application for the job, via the posting website. A job posting is considered to have directApply of [[True]] if an application process for the specified job can be directly initiated via the url(s) given (noting that e.g. multiple internet domains might nevertheless be involved at an implementation level). A value of [[False]] is appropriate if there is no clear path to applying directly online for the specified job, navigating directly from the JobPosting url(s) supplied.
type DisambiguatingDescription ¶
type DisambiguatingDescription string
DisambiguatingDescription is https://schema.org/disambiguatingDescription
A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
type Discount ¶ added in v1.14.0
type Discount float64
Discount is https://schema.org/discount
Any discount applied (to an Order).
type DiscountCode ¶
type DiscountCode string
DiscountCode is https://schema.org/discountCode
Code used to redeem a discount.
type DiscountCurrency ¶
type DiscountCurrency string
DiscountCurrency is https://schema.org/discountCurrency
The currency of the discount.\n\nUse standard formats: [ISO 4217 currency format](http://en.wikipedia.org/wiki/ISO_4217), e.g. "USD"; [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for cryptocurrencies, e.g. "BTC"; well known names for [Local Exchange Trading Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) (LETS) and other currency types, e.g. "Ithaca HOUR".
type DiscussionUrl ¶
type DiscussionUrl string
DiscussionUrl is https://schema.org/discussionUrl
A link to the page containing the comments of the CreativeWork.
type DiseasePreventionInfo ¶
type DiseasePreventionInfo string
DiseasePreventionInfo is https://schema.org/diseasePreventionInfo
Information about disease prevention.
type DiseaseSpreadStatistics ¶
type DiseaseSpreadStatistics string
DiseaseSpreadStatistics is https://schema.org/diseaseSpreadStatistics
Statistical information about the spread of a disease, either as [[WebContent]], or
described directly as a [[Dataset]], or the specific [[Observation]]s in the dataset. When a [[WebContent]] URL is provided, the page indicated might also contain more such markup.
type DissolutionDate ¶ added in v1.14.1
type DissolutionDate string
DissolutionDate is https://schema.org/dissolutionDate
The date that this organization was dissolved.
type DiversityPolicy ¶
type DiversityPolicy string
DiversityPolicy is https://schema.org/diversityPolicy
Statement on diversity policy by an [[Organization]] e.g. a [[NewsMediaOrganization]]. For a [[NewsMediaOrganization]], a statement describing the newsroom’s diversity policy on both staffing and sources, typically providing staffing data.
type DiversityStaffingReport ¶
type DiversityStaffingReport string
DiversityStaffingReport is https://schema.org/diversityStaffingReport
For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]), a report on staffing diversity issues. In a news context this might be for example ASNE or RTDNA (US) reports, or self-reported.
type Documentation ¶
type Documentation string
Documentation is https://schema.org/documentation
Further documentation describing the Web API in more detail.
type DoesNotShip ¶ added in v1.14.1
type DoesNotShip bool
DoesNotShip is https://schema.org/doesNotShip
Indicates when shipping to a particular [[shippingDestination]] is not available.
type DomiciledMortgage ¶ added in v1.14.1
type DomiciledMortgage bool
DomiciledMortgage is https://schema.org/domiciledMortgage
Whether borrower is a resident of the jurisdiction where the property is located.
type DoorTime ¶ added in v1.14.1
type DoorTime string
DoorTime is https://schema.org/doorTime
The time admission will commence.
type DosageForm ¶
type DosageForm string
DosageForm is https://schema.org/dosageForm
A dosage form in which this drug/supplement is available, e.g. 'tablet', 'suspension', 'injection'.
type DoseUnit ¶
type DoseUnit string
DoseUnit is https://schema.org/doseUnit
The unit of the dose, e.g. 'mg'.
type DoseValue ¶ added in v1.14.1
type DoseValue float64
DoseValue is https://schema.org/doseValue
The value of the dose, e.g. 500.
type DownPayment ¶ added in v1.14.1
type DownPayment float64
DownPayment is https://schema.org/downPayment
a type of payment made in cash during the onset of the purchase of an expensive good/service. The payment typically represents only a percentage of the full purchase price.
type DownloadUrl ¶
type DownloadUrl string
DownloadUrl is https://schema.org/downloadUrl
If the file can be downloaded, URL to download the binary.
type DownvoteCount ¶ added in v1.14.1
type DownvoteCount float64
DownvoteCount is https://schema.org/downvoteCount
The number of downvotes this question, answer or comment has received from the community.
type DriveWheelConfiguration ¶
type DriveWheelConfiguration string
DriveWheelConfiguration is https://schema.org/driveWheelConfiguration
The drive wheel configuration, i.e. which roadwheels will receive torque from the vehicle's engine via the drivetrain.
type DropoffTime ¶ added in v1.14.1
type DropoffTime string
DropoffTime is https://schema.org/dropoffTime
When a rental car can be dropped off.
type DrugUnit ¶
type DrugUnit string
DrugUnit is https://schema.org/drugUnit
The unit in which the drug is measured, e.g. '5 mg tablet'.
type Duns ¶
type Duns string
Duns is https://schema.org/duns
The Dun & Bradstreet DUNS number for identifying an organization or business person.
type DuringMedia ¶
type DuringMedia string
DuringMedia is https://schema.org/duringMedia
A media object representing the circumstances while performing this direction.
type EditEIDR ¶
type EditEIDR string
EditEIDR is https://schema.org/editEIDR
An [EIDR](https://eidr.org/) (Entertainment Identifier Registry) [[identifier]] representing a specific edit / edition for a work of film or television.
For example, the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J" has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3".
Since schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description), or alongside [[editEIDR]] for a more edit-specific description.
type EduQuestionType ¶
type EduQuestionType string
EduQuestionType is https://schema.org/eduQuestionType
For questions that are part of learning resources (e.g. Quiz), eduQuestionType indicates the format of question being given. Example: "Multiple choice", "Open ended", "Flashcard".
type EducationRequirements ¶
type EducationRequirements string
EducationRequirements is https://schema.org/educationRequirements
Educational background needed for the position or Occupation.
type EducationalCredentialAwarded ¶
type EducationalCredentialAwarded string
EducationalCredentialAwarded is https://schema.org/educationalCredentialAwarded
A description of the qualification, award, certificate, diploma or other educational credential awarded as a consequence of successful completion of this course or program.
type EducationalFramework ¶
type EducationalFramework string
EducationalFramework is https://schema.org/educationalFramework
The framework to which the resource being described is aligned.
type EducationalLevel ¶
type EducationalLevel string
EducationalLevel is https://schema.org/educationalLevel
The level in terms of progression through an educational or training context. Examples of educational levels include 'beginner', 'intermediate' or 'advanced', and formal sets of level indicators.
type EducationalProgramMode ¶
type EducationalProgramMode string
EducationalProgramMode is https://schema.org/educationalProgramMode
Similar to courseMode, the medium or means of delivery of the program as a whole. The value may either be a text label (e.g. "online", "onsite" or "blended"; "synchronous" or "asynchronous"; "full-time" or "part-time") or a URL reference to a term from a controlled vocabulary (e.g. https://ceds.ed.gov/element/001311#Asynchronous ).
type EducationalRole ¶
type EducationalRole string
EducationalRole is https://schema.org/educationalRole
An educationalRole of an EducationalAudience.
type EducationalUse ¶
type EducationalUse string
EducationalUse is https://schema.org/educationalUse
The purpose of a work in the context of education; for example, 'assignment', 'group work'.
type Elevation ¶ added in v1.14.0
type Elevation float64
Elevation is https://schema.org/elevation
The elevation of a location ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). Values may be of the form 'NUMBER UNIT\_OF\_MEASUREMENT' (e.g., '1,000 m', '3,200 ft') while numbers alone should be assumed to be a value in meters.
type EligibilityToWorkRequirement ¶
type EligibilityToWorkRequirement string
EligibilityToWorkRequirement is https://schema.org/eligibilityToWorkRequirement
The legal requirements such as citizenship, visa and other documentation required for an applicant to this job.
type EligibleRegion ¶
type EligibleRegion string
EligibleRegion is https://schema.org/eligibleRegion
The ISO 3166-1 (ISO 3166-1 alpha-2) or ISO 3166-2 code, the place, or the GeoShape for the geo-political region(s) for which the offer or delivery charge specification is valid.\n\nSee also [[ineligibleRegion]].
type EmbedUrl ¶
type EmbedUrl string
EmbedUrl is https://schema.org/embedUrl
A URL pointing to a player for a specific video. In general, this is the information in the ```src``` element of an ```embed``` tag and should not be the same as the content of the ```loc``` tag.
type EmbeddedTextCaption ¶
type EmbeddedTextCaption string
EmbeddedTextCaption is https://schema.org/embeddedTextCaption
Represents textual captioning from a [[MediaObject]], e.g. text of a 'meme'.
type EmissionsCO2 ¶ added in v1.14.1
type EmissionsCO2 float64
EmissionsCO2 is https://schema.org/emissionsCO2
The CO2 emissions in g/km. When used in combination with a QuantitativeValue, put "g/km" into the unitText property of that value, since there is no UN/CEFACT Common Code for "g/km".
type EmployerOverview ¶
type EmployerOverview string
EmployerOverview is https://schema.org/employerOverview
A description of the employer, career opportunities and work environment for this position.
type EmploymentType ¶
type EmploymentType string
EmploymentType is https://schema.org/employmentType
Type of employment (e.g. full-time, part-time, contract, temporary, seasonal, internship).
type EncodingFormat ¶
type EncodingFormat string
EncodingFormat is https://schema.org/encodingFormat
Media type typically expressed using a MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml) and [MDN reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)), e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.
In cases where a [[CreativeWork]] has several media type representations, [encoding] can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]] information.
Unregistered or niche encoding and file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.
type EncodingType ¶
type EncodingType string
EncodingType is https://schema.org/encodingType
The supported encoding type(s) for an EntryPoint request.
type EndDate ¶ added in v1.14.1
type EndDate string
EndDate is https://schema.org/endDate
The end date and time of the item (in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601)).
type EndOffset ¶ added in v1.14.1
type EndOffset float64
EndOffset is https://schema.org/endOffset
The end time of the clip expressed as the number of seconds from the beginning of the work.
type EndTime ¶ added in v1.14.1
type EndTime string
EndTime is https://schema.org/endTime
The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to end. For actions that span a period of time, when the action was performed. E.g. John wrote a book from January to *December*. For media, including audio and video, it's the time offset of the end of a clip within a larger file.\n\nNote that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.
type EngineType ¶
type EngineType string
EngineType is https://schema.org/engineType
The type of engine or engines powering the vehicle.
type Epidemiology ¶
type Epidemiology string
Epidemiology is https://schema.org/epidemiology
The characteristics of associated patients, such as age, gender, race etc.
type EpisodeNumber ¶
type EpisodeNumber string
EpisodeNumber is https://schema.org/episodeNumber
Position of the episode within an ordered group of episodes.
type EstimatedCost ¶
type EstimatedCost string
EstimatedCost is https://schema.org/estimatedCost
The estimated cost of the supply or supplies consumed when performing instructions.
type EstimatedFlightDuration ¶
type EstimatedFlightDuration string
EstimatedFlightDuration is https://schema.org/estimatedFlightDuration
The estimated time the flight will take.
type EstimatedSalary ¶ added in v1.14.1
type EstimatedSalary float64
EstimatedSalary is https://schema.org/estimatedSalary
An estimated salary for a job posting or occupation, based on a variety of variables including, but not limited to industry, job title, and location. Estimated salaries are often computed by outside organizations rather than the hiring organization, who may not have committed to the estimated value.
type EthicsPolicy ¶
type EthicsPolicy string
EthicsPolicy is https://schema.org/ethicsPolicy
Statement about ethics policy, e.g. of a [[NewsMediaOrganization]] regarding journalistic and publishing practices, or of a [[Restaurant]], a page describing food source policies. In the case of a [[NewsMediaOrganization]], an ethicsPolicy is typically a statement describing the personal, organizational, and corporate standards of behavior expected by the organization.
type EvidenceOrigin ¶
type EvidenceOrigin string
EvidenceOrigin is https://schema.org/evidenceOrigin
Source of the data used to formulate the guidance, e.g. RCT, consensus opinion, etc.
type ExceptDate ¶ added in v1.14.1
type ExceptDate string
ExceptDate is https://schema.org/exceptDate
Defines a [[Date]] or [[DateTime]] during which a scheduled [[Event]] will not take place. The property allows exceptions to
a [[Schedule]] to be specified. If an exception is specified as a [[DateTime]] then only the event that would have started at that specific date and time should be excluded from the schedule. If an exception is specified as a [[Date]] then any event that is scheduled for that 24 hour period should be excluded from the schedule. This allows a whole day to be excluded from the schedule without having to itemise every scheduled event.
type ExchangeRateSpread ¶ added in v1.14.1
type ExchangeRateSpread float64
ExchangeRateSpread is https://schema.org/exchangeRateSpread
The difference between the price at which a broker or other intermediary buys and sells foreign currency.
type ExecutableLibraryName ¶
type ExecutableLibraryName string
ExecutableLibraryName is https://schema.org/executableLibraryName
Library file name, e.g., mscorlib.dll, system.web.dll.
type ExerciseType ¶
type ExerciseType string
ExerciseType is https://schema.org/exerciseType
Type(s) of exercise or activity, such as strength training, flexibility training, aerobics, cardiac rehabilitation, etc.
type ExifData ¶
type ExifData string
ExifData is https://schema.org/exifData
exif data for this object.
type ExpectedArrivalFrom ¶ added in v1.14.1
type ExpectedArrivalFrom string
ExpectedArrivalFrom is https://schema.org/expectedArrivalFrom
The earliest date the package may arrive.
type ExpectedArrivalUntil ¶ added in v1.14.1
type ExpectedArrivalUntil string
ExpectedArrivalUntil is https://schema.org/expectedArrivalUntil
The latest date the package may arrive.
type ExpectedPrognosis ¶
type ExpectedPrognosis string
ExpectedPrognosis is https://schema.org/expectedPrognosis
The likely outcome in either the short term or long term of the medical condition.
type ExperienceInPlaceOfEducation ¶ added in v1.14.1
type ExperienceInPlaceOfEducation bool
ExperienceInPlaceOfEducation is https://schema.org/experienceInPlaceOfEducation
Indicates whether a [[JobPosting]] will accept experience (as indicated by [[OccupationalExperienceRequirements]]) in place of its formal educational qualifications (as indicated by [[educationRequirements]]). If true, indicates that satisfying one of these requirements is sufficient.
type ExperienceRequirements ¶
type ExperienceRequirements string
ExperienceRequirements is https://schema.org/experienceRequirements
Description of skills and experience needed for the position or Occupation.
type ExpertConsiderations ¶
type ExpertConsiderations string
ExpertConsiderations is https://schema.org/expertConsiderations
Medical expert advice related to the plan.
type Expires ¶ added in v1.14.1
type Expires string
Expires is https://schema.org/expires
Date the content expires and is no longer useful or available. For example a [[VideoObject]] or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]] fact check whose publisher wants to indicate that it may no longer be relevant (or helpful to highlight) after some date.
type FamilyName ¶
type FamilyName string
FamilyName is https://schema.org/familyName
Family name. In the U.S., the last name of a Person.
type FeatureList ¶
type FeatureList string
FeatureList is https://schema.org/featureList
Features or modules provided by this application (and possibly required by other applications).
type FeesAndCommissionsSpecification ¶
type FeesAndCommissionsSpecification string
FeesAndCommissionsSpecification is https://schema.org/feesAndCommissionsSpecification
Description of fees, commissions, and other terms applied either to a class of financial product, or by a financial service organization.
type FileFormat ¶
type FileFormat string
FileFormat is https://schema.org/fileFormat
Media type, typically MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of the content, e.g. application/zip of a SoftwareApplication binary. In cases where a CreativeWork has several media type representations, 'encoding' can be used to indicate each MediaObject alongside particular fileFormat information. Unregistered or niche file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia entry.
type FileSize ¶
type FileSize string
FileSize is https://schema.org/fileSize
Size of the application / package (e.g. 18MB). In the absence of a unit (MB, KB etc.), KB will be assumed.
type FinancialAidEligible ¶
type FinancialAidEligible string
FinancialAidEligible is https://schema.org/financialAidEligible
A financial aid type or program which students may use to pay for tuition or fees associated with the program.
type FlightDistance ¶
type FlightDistance string
FlightDistance is https://schema.org/flightDistance
The distance of the flight.
type FlightNumber ¶
type FlightNumber string
FlightNumber is https://schema.org/flightNumber
The unique identifier for a flight including the airline IATA code. For example, if describing United flight 110, where the IATA code for United is 'UA', the flightNumber is 'UA110'.
type FloorLevel ¶
type FloorLevel string
FloorLevel is https://schema.org/floorLevel
The floor level for an [[Accommodation]] in a multi-storey building. Since counting
systems [vary internationally](https://en.wikipedia.org/wiki/Storey#Consecutive_number_floor_designations), the local system should be used where possible.
type Followup ¶
type Followup string
Followup is https://schema.org/followup
Typical or recommended followup care after the procedure is performed.
type FoodWarning ¶
type FoodWarning string
FoodWarning is https://schema.org/foodWarning
Any precaution, guidance, contraindication, etc. related to consumption of specific foods while taking this drug.
type FoundingDate ¶ added in v1.14.1
type FoundingDate string
FoundingDate is https://schema.org/foundingDate
The date that this organization was founded.
type Free ¶ added in v1.14.1
type Free bool
Free is https://schema.org/free
A flag to signal that the item, event, or place is accessible for free.
type Frequency ¶
type Frequency string
Frequency is https://schema.org/frequency
How often the dose is taken, e.g. 'daily'.
type FuelType ¶
type FuelType string
FuelType is https://schema.org/fuelType
The type of fuel suitable for the engine or engines of the vehicle. If the vehicle has only one engine, this property can be attached directly to the vehicle.
type FunctionalClass ¶
type FunctionalClass string
FunctionalClass is https://schema.org/functionalClass
The degree of mobility the joint allows.
type GameAvailabilityType ¶ added in v1.14.0
type GameAvailabilityType string
GameAvailabilityType is https://schema.org/gameAvailabilityType
Indicates the availability type of the game content associated with this action, such as whether it is a full version or a demo.
type GameEdition ¶ added in v1.14.0
type GameEdition string
GameEdition is https://schema.org/gameEdition
The edition of a video game.
type GameLocation ¶
type GameLocation string
GameLocation is https://schema.org/gameLocation
Real or fictional location of the game (or part of game).
type GamePlatform ¶
type GamePlatform string
GamePlatform is https://schema.org/gamePlatform
The electronic systems used to play <a href="http://en.wikipedia.org/wiki/Category:Video_game_platforms">video games</a>.
type Gender ¶
type Gender string
Gender is https://schema.org/gender
Gender of something, typically a [[Person]], but possibly also fictional characters, animals, etc. While http://schema.org/Male and http://schema.org/Female may be used, text strings are also acceptable for people who do not identify as a binary gender. The [[gender]] property can also be used in an extended sense to cover e.g. the gender of sports teams. As with the gender of individuals, we do not try to enumerate all possibilities. A mixed-gender [[SportsTeam]] can be indicated with a text value of "Mixed".
type Genre ¶
type Genre string
Genre is https://schema.org/genre
Genre of the creative work, broadcast channel or group.
type GeoRadius ¶ added in v1.14.1
type GeoRadius float64
GeoRadius is https://schema.org/geoRadius
Indicates the approximate radius of a GeoCircle (metres unless indicated otherwise via Distance notation).
type GettingTestedInfo ¶
type GettingTestedInfo string
GettingTestedInfo is https://schema.org/gettingTestedInfo
Information about getting tested (for a [[MedicalCondition]]), e.g. in the context of a pandemic.
type GivenName ¶
type GivenName string
GivenName is https://schema.org/givenName
Given name. In the U.S., the first name of a Person.
type GlobalLocationNumber ¶
type GlobalLocationNumber string
GlobalLocationNumber is https://schema.org/globalLocationNumber
The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred to as International Location Number or ILN) of the respective organization, person, or place. The GLN is a 13-digit number used to identify parties and physical locations.
type Gtin ¶
type Gtin string
Gtin is https://schema.org/gtin
A Global Trade Item Number ([GTIN](https://www.gs1.org/standards/id-keys/gtin)). GTINs identify trade items, including products and services, using numeric identification codes.
The GS1 [digital link specifications](https://www.gs1.org/standards/Digital-Link/) express GTINs as URLs (URIs, IRIs, etc.). Details including regular expression examples can be found in, Section 6 of the GS1 URI Syntax specification; see also [schema.org tracking issue](https://github.com/schemaorg/schemaorg/issues/3156#issuecomment-1209522809) for schema.org-specific discussion. A correct [[gtin]] value should be a valid GTIN, which means that it should be an all-numeric string of either 8, 12, 13 or 14 digits, or a "GS1 Digital Link" URL based on such a string. The numeric component should also have a [valid GS1 check digit](https://www.gs1.org/services/check-digit-calculator) and meet the other rules for valid GTINs. See also [GS1's GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) and [Wikipedia](https://en.wikipedia.org/wiki/Global_Trade_Item_Number) for more details. Left-padding of the gtin values is not required or encouraged. The [[gtin]] property generalizes the earlier [[gtin8]], [[gtin12]], [[gtin13]], and [[gtin14]] properties.
Note also that this is a definition for how to include GTINs in Schema.org data, and not a definition of GTINs in general - see the GS1 documentation for authoritative details.
type Gtin12 ¶
type Gtin12 string
Gtin12 is https://schema.org/gtin12
The GTIN-12 code of the product, or the product to which the offer refers. The GTIN-12 is the 12-digit GS1 Identification Key composed of a U.P.C. Company Prefix, Item Reference, and Check Digit used to identify trade items. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.
type Gtin13 ¶
type Gtin13 string
Gtin13 is https://schema.org/gtin13
The GTIN-13 code of the product, or the product to which the offer refers. This is equivalent to 13-digit ISBN codes and EAN UCC-13. Former 12-digit UPC codes can be converted into a GTIN-13 code by simply adding a preceding zero. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.
type Gtin14 ¶
type Gtin14 string
Gtin14 is https://schema.org/gtin14
The GTIN-14 code of the product, or the product to which the offer refers. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.
type Gtin8 ¶
type Gtin8 string
Gtin8 is https://schema.org/gtin8
The GTIN-8 code of the product, or the product to which the offer refers. This code is also known as EAN/UCC-8 or 8-digit EAN. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.
type GuidelineDate ¶ added in v1.14.1
type GuidelineDate string
GuidelineDate is https://schema.org/guidelineDate
Date on which this guideline's recommendation was made.
type HasBioPolymerSequence ¶
type HasBioPolymerSequence string
HasBioPolymerSequence is https://schema.org/hasBioPolymerSequence
A symbolic representation of a BioChemEntity. For example, a nucleotide sequence of a Gene or an amino acid sequence of a Protein.
type HasDriveThroughService ¶ added in v1.14.1
type HasDriveThroughService bool
HasDriveThroughService is https://schema.org/hasDriveThroughService
Indicates whether some facility (e.g. [[FoodEstablishment]], [[CovidTestingFacility]]) offers a service that can be used by driving through in a car. In the case of [[CovidTestingFacility]] such facilities could potentially help with social distancing from other potentially-infected users.
type HasMenu ¶
type HasMenu string
HasMenu is https://schema.org/hasMenu
Either the actual menu as a structured representation, as text, or a URL of the menu.
type HasMolecularFunction ¶
type HasMolecularFunction string
HasMolecularFunction is https://schema.org/hasMolecularFunction
Molecular function performed by this BioChemEntity; please use PropertyValue if you want to include any evidence.
type HasRepresentation ¶
type HasRepresentation string
HasRepresentation is https://schema.org/hasRepresentation
A common representation such as a protein sequence or chemical structure for this entity. For images use schema.org/image.
type Headline ¶
type Headline string
Headline is https://schema.org/headline
Headline of the article.
type HealthPlanCoinsuranceOption ¶
type HealthPlanCoinsuranceOption string
HealthPlanCoinsuranceOption is https://schema.org/healthPlanCoinsuranceOption
Whether the coinsurance applies before or after deductible, etc. TODO: Is this a closed set?
type HealthPlanCoinsuranceRate ¶ added in v1.14.1
type HealthPlanCoinsuranceRate float64
HealthPlanCoinsuranceRate is https://schema.org/healthPlanCoinsuranceRate
The rate of coinsurance expressed as a number between 0.0 and 1.0.
type HealthPlanCopayOption ¶
type HealthPlanCopayOption string
HealthPlanCopayOption is https://schema.org/healthPlanCopayOption
Whether the copay is before or after deductible, etc. TODO: Is this a closed set?
type HealthPlanCostSharing ¶ added in v1.14.1
type HealthPlanCostSharing bool
HealthPlanCostSharing is https://schema.org/healthPlanCostSharing
The costs to the patient for services under this network or formulary.
type HealthPlanDrugOption ¶
type HealthPlanDrugOption string
HealthPlanDrugOption is https://schema.org/healthPlanDrugOption
TODO.
type HealthPlanDrugTier ¶
type HealthPlanDrugTier string
HealthPlanDrugTier is https://schema.org/healthPlanDrugTier
The tier(s) of drugs offered by this formulary or insurance plan.
type HealthPlanId ¶
type HealthPlanId string
HealthPlanId is https://schema.org/healthPlanId
The 14-character, HIOS-generated Plan ID number. (Plan IDs must be unique, even across different markets.)
type HealthPlanMarketingUrl ¶
type HealthPlanMarketingUrl string
HealthPlanMarketingUrl is https://schema.org/healthPlanMarketingUrl
The URL that goes directly to the plan brochure for the specific standard plan or plan variation.
type HealthPlanNetworkId ¶
type HealthPlanNetworkId string
HealthPlanNetworkId is https://schema.org/healthPlanNetworkId
Name or unique ID of network. (Networks are often reused across different insurance plans.)
type HealthPlanNetworkTier ¶
type HealthPlanNetworkTier string
HealthPlanNetworkTier is https://schema.org/healthPlanNetworkTier
The tier(s) for this network.
type HealthPlanPharmacyCategory ¶
type HealthPlanPharmacyCategory string
HealthPlanPharmacyCategory is https://schema.org/healthPlanPharmacyCategory
The category or type of pharmacy associated with this cost sharing.
type HighPrice ¶
type HighPrice float64
HighPrice is https://schema.org/highPrice
The highest price of all offers available.\n\nUsage guidelines:\n\n* Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similar Unicode symbols.\n* Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator.
type HonorificPrefix ¶
type HonorificPrefix string
HonorificPrefix is https://schema.org/honorificPrefix
An honorific prefix preceding a Person's name such as Dr/Mrs/Mr.
type HonorificSuffix ¶
type HonorificSuffix string
HonorificSuffix is https://schema.org/honorificSuffix
An honorific suffix following a Person's name such as M.D./PhD/MSCSW.
type HowPerformed ¶
type HowPerformed string
HowPerformed is https://schema.org/howPerformed
How the procedure is performed.
type HttpMethod ¶
type HttpMethod string
HttpMethod is https://schema.org/httpMethod
An HTTP method that specifies the appropriate HTTP method for a request to an HTTP EntryPoint. Values are capitalized strings as used in HTTP.
type IataCode ¶
type IataCode string
IataCode is https://schema.org/iataCode
IATA identifier for an airline or airport.
type IcaoCode ¶
type IcaoCode string
IcaoCode is https://schema.org/icaoCode
ICAO identifier for an airport.
type Identifier ¶
type Identifier string
Identifier is https://schema.org/identifier
The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
type Image ¶
type Image string
Image is https://schema.org/image
An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
type InChI ¶
type InChI string
InChI is https://schema.org/inChI
Non-proprietary identifier for molecular entity that can be used in printed and electronic data sources thus enabling easier linking of diverse data compilations.
type InChIKey ¶
type InChIKey string
InChIKey is https://schema.org/inChIKey
InChIKey is a hashed version of the full InChI (using the SHA-256 algorithm).
type InCodeSet ¶
type InCodeSet string
InCodeSet is https://schema.org/inCodeSet
A [[CategoryCodeSet]] that contains this category code.
type InDefinedTermSet ¶
type InDefinedTermSet string
InDefinedTermSet is https://schema.org/inDefinedTermSet
A [[DefinedTermSet]] that contains this term.
type InLanguage ¶
type InLanguage string
InLanguage is https://schema.org/inLanguage
The language of the content or performance or used in an action. Please use one of the language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also [[availableLanguage]].
type InProductGroupWithID ¶
type InProductGroupWithID string
InProductGroupWithID is https://schema.org/inProductGroupWithID
Indicates the [[productGroupID]] for a [[ProductGroup]] that this product [[isVariantOf]].
type InStoreReturnsOffered ¶ added in v1.14.1
type InStoreReturnsOffered bool
InStoreReturnsOffered is https://schema.org/inStoreReturnsOffered
Are in-store returns offered? (For more advanced return methods use the [[returnMethod]] property.)
type InSupportOf ¶
type InSupportOf string
InSupportOf is https://schema.org/inSupportOf
Qualification, candidature, degree, application that Thesis supports.
type IncentiveCompensation ¶
type IncentiveCompensation string
IncentiveCompensation is https://schema.org/incentiveCompensation
Description of bonus and commission compensation aspects of the job.
type Incentives ¶
type Incentives string
Incentives is https://schema.org/incentives
Description of bonus and commission compensation aspects of the job.
type Industry ¶
type Industry string
Industry is https://schema.org/industry
The industry associated with the job position.
type IneligibleRegion ¶
type IneligibleRegion string
IneligibleRegion is https://schema.org/ineligibleRegion
The ISO 3166-1 (ISO 3166-1 alpha-2) or ISO 3166-2 code, the place, or the GeoShape for the geo-political region(s) for which the offer or delivery charge specification is not valid, e.g. a region where the transaction is not allowed.\n\nSee also [[eligibleRegion]].
type InfectiousAgent ¶
type InfectiousAgent string
InfectiousAgent is https://schema.org/infectiousAgent
The actual infectious agent, such as a specific bacterium.
type Ingredients ¶
type Ingredients string
Ingredients is https://schema.org/ingredients
A single ingredient used in the recipe, e.g. sugar, flour or garlic.
type InstallUrl ¶
type InstallUrl string
InstallUrl is https://schema.org/installUrl
URL at which the app may be installed, if different from the URL of the item.
type Intensity ¶
type Intensity string
Intensity is https://schema.org/intensity
Quantitative measure gauging the degree of force involved in the exercise, for example, heartbeats per minute. May include the velocity of the movement.
type InteractivityType ¶
type InteractivityType string
InteractivityType is https://schema.org/interactivityType
The predominant mode of learning supported by the learning resource. Acceptable values are 'active', 'expositive', or 'mixed'.
type InterestRate ¶ added in v1.14.1
type InterestRate float64
InterestRate is https://schema.org/interestRate
The interest rate, charged or paid, applicable to the financial product. Note: This is different from the calculated annualPercentageRate.
type IsAcceptingNewPatients ¶ added in v1.14.1
type IsAcceptingNewPatients bool
IsAcceptingNewPatients is https://schema.org/isAcceptingNewPatients
Whether the provider is accepting new patients.
type IsAccessibleForFree ¶ added in v1.14.1
type IsAccessibleForFree bool
IsAccessibleForFree is https://schema.org/isAccessibleForFree
A flag to signal that the item, event, or place is accessible for free.
type IsAvailableGenerically ¶ added in v1.14.1
type IsAvailableGenerically bool
IsAvailableGenerically is https://schema.org/isAvailableGenerically
True if the drug is available in a generic form (regardless of name).
type IsBasedOn ¶
type IsBasedOn string
IsBasedOn is https://schema.org/isBasedOn
A resource from which this work is derived or from which it is a modification or adaptation.
type IsBasedOnUrl ¶
type IsBasedOnUrl string
IsBasedOnUrl is https://schema.org/isBasedOnUrl
A resource that was used in the creation of this resource. This term can be repeated for multiple sources. For example, http://example.com/great-multiplication-intro.html.
type IsFamilyFriendly ¶ added in v1.14.1
type IsFamilyFriendly bool
IsFamilyFriendly is https://schema.org/isFamilyFriendly
Indicates whether this content is family friendly.
type IsGift ¶ added in v1.14.1
type IsGift bool
IsGift is https://schema.org/isGift
Indicates whether the offer was accepted as a gift for someone other than the buyer.
type IsInvolvedInBiologicalProcess ¶
type IsInvolvedInBiologicalProcess string
IsInvolvedInBiologicalProcess is https://schema.org/isInvolvedInBiologicalProcess
Biological process this BioChemEntity is involved in; please use PropertyValue if you want to include any evidence.
type IsLiveBroadcast ¶ added in v1.14.1
type IsLiveBroadcast bool
IsLiveBroadcast is https://schema.org/isLiveBroadcast
True if the broadcast is of a live event.
type IsLocatedInSubcellularLocation ¶
type IsLocatedInSubcellularLocation string
IsLocatedInSubcellularLocation is https://schema.org/isLocatedInSubcellularLocation
Subcellular location where this BioChemEntity is located; please use PropertyValue if you want to include any evidence.
type IsPartOf ¶
type IsPartOf string
IsPartOf is https://schema.org/isPartOf
Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of.
type IsProprietary ¶ added in v1.14.1
type IsProprietary bool
IsProprietary is https://schema.org/isProprietary
True if this item's name is a proprietary/brand name (vs. generic name).
type IsResizable ¶ added in v1.14.1
type IsResizable bool
IsResizable is https://schema.org/isResizable
Whether the 3DModel allows resizing. For example, room layout applications often do not allow 3DModel elements to be resized to reflect reality.
type IsUnlabelledFallback ¶ added in v1.14.1
type IsUnlabelledFallback bool
IsUnlabelledFallback is https://schema.org/isUnlabelledFallback
This can be marked 'true' to indicate that some published [[DeliveryTimeSettings]] or [[ShippingRateSettings]] are intended to apply to all [[OfferShippingDetails]] published by the same merchant, when referenced by a [[shippingSettingsLink]] in those settings. It is not meaningful to use a 'true' value for this property alongside a transitTimeLabel (for [[DeliveryTimeSettings]]) or shippingLabel (for [[ShippingRateSettings]]), since this property is for use with unlabelled settings.
type IsicV4 ¶
type IsicV4 string
IsicV4 is https://schema.org/isicV4
The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place.
type Iso6523Code ¶ added in v1.14.0
type Iso6523Code string
Iso6523Code is https://schema.org/iso6523Code
An organization identifier as defined in ISO 6523(-1). Note that many existing organization identifiers such as [leiCode](http://schema.org/leiCode), [duns](http://schema.org/duns) and [vatID](http://schema.org/vatID) can be expressed as an ISO 6523 identifier by setting the ICD part of the ISO 6523 identifier accordingly.
type IsrcCode ¶
type IsrcCode string
IsrcCode is https://schema.org/isrcCode
The International Standard Recording Code for the recording.
type Issn ¶
type Issn string
Issn is https://schema.org/issn
The International Standard Serial Number (ISSN) that identifies this serial publication. You can repeat this property to identify different formats of, or the linking ISSN (ISSN-L) for, this serial publication.
type IssueNumber ¶
type IssueNumber string
IssueNumber is https://schema.org/issueNumber
Identifies the issue of publication; for example, "iii" or "2".
type IswcCode ¶
type IswcCode string
IswcCode is https://schema.org/iswcCode
The International Standard Musical Work Code for the composition.
type ItemListElement ¶
type ItemListElement string
ItemListElement is https://schema.org/itemListElement
For itemListElement values, you can use simple strings (e.g. "Peter", "Paul", "Mary"), existing entities, or use ListItem.\n\nText values are best if the elements in the list are plain strings. Existing entities are best for a simple, unordered list of existing things in your data. ListItem is used with ordered lists when you want to provide additional context about the element in that list or when the same item might be in different places in different lists.\n\nNote: The order of elements in your mark-up is not sufficient for indicating the order or elements. Use ListItem with a 'position' property in such cases.
type ItemListOrder ¶
type ItemListOrder string
ItemListOrder is https://schema.org/itemListOrder
Type of ordering (e.g. Ascending, Descending, Unordered).
type ItemLocation ¶
type ItemLocation string
ItemLocation is https://schema.org/itemLocation
Current location of the item.
type IupacName ¶
type IupacName string
IupacName is https://schema.org/iupacName
Systematic method of naming chemical compounds as recommended by the International Union of Pure and Applied Chemistry (IUPAC).
type JobBenefits ¶
type JobBenefits string
JobBenefits is https://schema.org/jobBenefits
Description of benefits associated with the job.
type JobImmediateStart ¶ added in v1.14.1
type JobImmediateStart bool
JobImmediateStart is https://schema.org/jobImmediateStart
An indicator as to whether a position is available for an immediate start.
type JobLocationType ¶
type JobLocationType string
JobLocationType is https://schema.org/jobLocationType
A description of the job location (e.g. TELECOMMUTE for telecommute jobs).
type JobStartDate ¶ added in v1.14.1
type JobStartDate string
JobStartDate is https://schema.org/jobStartDate
The date on which a successful applicant for this job would be expected to start work. Choose a specific date in the future or use the jobImmediateStart property to indicate the position is to be filled as soon as possible.
type JobTitle ¶
type JobTitle string
JobTitle is https://schema.org/jobTitle
The job title of the person (for example, Financial Manager).
type Jurisdiction ¶
type Jurisdiction string
Jurisdiction is https://schema.org/jurisdiction
Indicates a legal jurisdiction, e.g. of some legislation, or where some government service is based.
type Keywords ¶
type Keywords string
Keywords is https://schema.org/keywords
Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
type KnownVehicleDamages ¶
type KnownVehicleDamages string
KnownVehicleDamages is https://schema.org/knownVehicleDamages
A textual description of known damages, both repaired and unrepaired.
type KnowsAbout ¶
type KnowsAbout string
KnowsAbout is https://schema.org/knowsAbout
Of a [[Person]], and less typically of an [[Organization]], to indicate a topic that is known about - suggesting possible expertise but not implying it. We do not distinguish skill levels here, or relate this to educational content, events, objectives or [[JobPosting]] descriptions.
type KnowsLanguage ¶
type KnowsLanguage string
KnowsLanguage is https://schema.org/knowsLanguage
Of a [[Person]], and less typically of an [[Organization]], to indicate a known language. We do not distinguish skill levels or reading/writing/speaking/signing here. Use language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47).
type LabelDetails ¶
type LabelDetails string
LabelDetails is https://schema.org/labelDetails
Link to the drug's label details.
type LastReviewed ¶ added in v1.14.1
type LastReviewed string
LastReviewed is https://schema.org/lastReviewed
Date on which the content on this web page was last reviewed for accuracy and/or completeness.
type Latitude ¶
type Latitude float64
Latitude is https://schema.org/latitude
The latitude of a location. For example ```37.42242``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
type LayoutImage ¶
type LayoutImage string
LayoutImage is https://schema.org/layoutImage
A schematic image showing the floorplan layout.
type LearningResourceType ¶
type LearningResourceType string
LearningResourceType is https://schema.org/learningResourceType
The predominant type or kind characterizing the learning resource. For example, 'presentation', 'handout'.
type LegalName ¶
type LegalName string
LegalName is https://schema.org/legalName
The official name of the organization, e.g. the registered company name.
type LegalStatus ¶
type LegalStatus string
LegalStatus is https://schema.org/legalStatus
The drug or supplement's legal status, including any controlled substance schedules that apply.
type LegislationDate ¶ added in v1.14.1
type LegislationDate string
LegislationDate is https://schema.org/legislationDate
The date of adoption or signature of the legislation. This is the date at which the text is officially aknowledged to be a legislation, even though it might not even be published or in force.
type LegislationDateVersion ¶ added in v1.14.1
type LegislationDateVersion string
LegislationDateVersion is https://schema.org/legislationDateVersion
The point-in-time at which the provided description of the legislation is valid (e.g.: when looking at the law on the 2016-04-07 (= dateVersion), I get the consolidation of 2015-04-12 of the "National Insurance Contributions Act 2015")
type LegislationIdentifier ¶
type LegislationIdentifier string
LegislationIdentifier is https://schema.org/legislationIdentifier
An identifier for the legislation. This can be either a string-based identifier, like the CELEX at EU level or the NOR in France, or a web-based, URL/URI identifier, like an ELI (European Legislation Identifier) or an URN-Lex.
type LegislationJurisdiction ¶
type LegislationJurisdiction string
LegislationJurisdiction is https://schema.org/legislationJurisdiction
The jurisdiction from which the legislation originates.
type LegislationType ¶
type LegislationType string
LegislationType is https://schema.org/legislationType
The type of the legislation. Examples of values are "law", "act", "directive", "decree", "regulation", "statutory instrument", "loi organique", "règlement grand-ducal", etc., depending on the country.
type LeiCode ¶
type LeiCode string
LeiCode is https://schema.org/leiCode
An organization identifier that uniquely identifies a legal entity as defined in ISO 17442.
type License ¶
type License string
License is https://schema.org/license
A license document that applies to this content, typically indicated by URL.
type Line ¶
type Line string
Line is https://schema.org/line
A line is a point-to-point path consisting of two or more points. A line is expressed as a series of two or more point objects separated by space.
type LinkRelationship ¶
type LinkRelationship string
LinkRelationship is https://schema.org/linkRelationship
Indicates the relationship type of a Web link.
type LoanPaymentFrequency ¶ added in v1.14.1
type LoanPaymentFrequency float64
LoanPaymentFrequency is https://schema.org/loanPaymentFrequency
Frequency of payments due, i.e. number of months between payments. This is defined as a frequency, i.e. the reciprocal of a period of time.
type LoanType ¶
type LoanType string
LoanType is https://schema.org/loanType
The type of a loan or credit.
type Location ¶
type Location string
Location is https://schema.org/location
The location of, for example, where an event is happening, where an organization is located, or where an action takes place.
type LodgingUnitDescription ¶
type LodgingUnitDescription string
LodgingUnitDescription is https://schema.org/lodgingUnitDescription
A full description of the lodging unit.
type LodgingUnitType ¶
type LodgingUnitType string
LodgingUnitType is https://schema.org/lodgingUnitType
Textual description of the unit type (including suite vs. room, size of bed, etc.).
type Longitude ¶ added in v1.14.1
type Longitude float64
Longitude is https://schema.org/longitude
The longitude of a location. For example ```-122.08585``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
type LowPrice ¶
type LowPrice float64
LowPrice is https://schema.org/lowPrice
The lowest price of all offers available.\n\nUsage guidelines:\n\n* Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similar Unicode symbols.\n* Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator.
type MainEntityOfPage ¶
type MainEntityOfPage string
MainEntityOfPage is https://schema.org/mainEntityOfPage
Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
type Masthead ¶
type Masthead string
Masthead is https://schema.org/masthead
For a [[NewsMediaOrganization]], a link to the masthead page or a page listing top editorial management.
type Material ¶
type Material string
Material is https://schema.org/material
A material that something is made from, e.g. leather, wool, cotton, paper.
type MaterialExtent ¶
type MaterialExtent string
MaterialExtent is https://schema.org/materialExtent
The quantity of the materials being described or an expression of the physical space they occupy.
type MathExpression ¶
type MathExpression string
MathExpression is https://schema.org/mathExpression
A mathematical expression (e.g. 'x^2-3x=0') that may be solved for a specific variable, simplified, or transformed. This can take many formats, e.g. LaTeX, Ascii-Math, or math as you would write with a keyboard.
type MaxPrice ¶ added in v1.14.1
type MaxPrice float64
MaxPrice is https://schema.org/maxPrice
The highest price if the price is a range.
type MaxValue ¶ added in v1.14.1
type MaxValue float64
MaxValue is https://schema.org/maxValue
The upper value of some characteristic or property.
type MaximumAttendeeCapacity ¶ added in v1.14.1
type MaximumAttendeeCapacity float64
MaximumAttendeeCapacity is https://schema.org/maximumAttendeeCapacity
The total number of individuals that may attend an event or venue.
type MaximumEnrollment ¶ added in v1.14.1
type MaximumEnrollment float64
MaximumEnrollment is https://schema.org/maximumEnrollment
The maximum number of students who may be enrolled in the program.
type MaximumPhysicalAttendeeCapacity ¶ added in v1.14.1
type MaximumPhysicalAttendeeCapacity float64
MaximumPhysicalAttendeeCapacity is https://schema.org/maximumPhysicalAttendeeCapacity
The maximum physical attendee capacity of an [[Event]] whose [[eventAttendanceMode]] is [[OfflineEventAttendanceMode]] (or the offline aspects, in the case of a [[MixedEventAttendanceMode]]).
type MaximumVirtualAttendeeCapacity ¶ added in v1.14.1
type MaximumVirtualAttendeeCapacity float64
MaximumVirtualAttendeeCapacity is https://schema.org/maximumVirtualAttendeeCapacity
The maximum virtual attendee capacity of an [[Event]] whose [[eventAttendanceMode]] is [[OnlineEventAttendanceMode]] (or the online aspects, in the case of a [[MixedEventAttendanceMode]]).
type MealService ¶
type MealService string
MealService is https://schema.org/mealService
Description of the meals that will be provided or available for purchase.
type MeasurementMethod ¶ added in v1.22.0
type MeasurementMethod string
MeasurementMethod is https://schema.org/measurementMethod
A subproperty of [[measurementTechnique]] that can be used for specifying specific methods, in particular via [[MeasurementMethodEnum]].
type MeasurementTechnique ¶
type MeasurementTechnique string
MeasurementTechnique is https://schema.org/measurementTechnique
A technique, method or technology used in an [[Observation]], [[StatisticalVariable]] or [[Dataset]] (or [[DataDownload]], [[DataCatalog]]), corresponding to the method used for measuring the corresponding variable(s) (for datasets, described using [[variableMeasured]]; for [[Observation]], a [[StatisticalVariable]]). Often but not necessarily each [[variableMeasured]] will have an explicit representation as (or mapping to) an property such as those defined in Schema.org, or other RDF vocabularies and "knowledge graphs". In that case the subproperty of [[variableMeasured]] called [[measuredProperty]] is applicable.
The [[measurementTechnique]] property helps when extra clarification is needed about how a [[measuredProperty]] was measured. This is oriented towards scientific and scholarly dataset publication but may have broader applicability; it is not intended as a full representation of measurement, but can often serve as a high level summary for dataset discovery.
For example, if [[variableMeasured]] is: molecule concentration, [[measurementTechnique]] could be: "mass spectrometry" or "nmr spectroscopy" or "colorimetry" or "immunofluorescence". If the [[variableMeasured]] is "depression rating", the [[measurementTechnique]] could be "Zung Scale" or "HAM-D" or "Beck Depression Inventory".
If there are several [[variableMeasured]] properties recorded for some given data object, use a [[PropertyValue]] for each [[variableMeasured]] and attach the corresponding [[measurementTechnique]]. The value can also be from an enumeration, organized as a [[MeasurementMetholdEnumeration]].
type MechanismOfAction ¶
type MechanismOfAction string
MechanismOfAction is https://schema.org/mechanismOfAction
The specific biochemical interaction through which this drug or supplement produces its pharmacological effect.
type Median ¶ added in v1.14.1
type Median float64
Median is https://schema.org/median
The median value.
type MeetsEmissionStandard ¶
type MeetsEmissionStandard string
MeetsEmissionStandard is https://schema.org/meetsEmissionStandard
Indicates that the vehicle meets the respective emission standard.
type MembershipNumber ¶
type MembershipNumber string
MembershipNumber is https://schema.org/membershipNumber
A unique identifier for the membership.
type MembershipPointsEarned ¶ added in v1.14.1
type MembershipPointsEarned float64
MembershipPointsEarned is https://schema.org/membershipPointsEarned
The number of membership points earned by the member. If necessary, the unitText can be used to express the units the points are issued in. (E.g. stars, miles, etc.)
type MemoryRequirements ¶
type MemoryRequirements string
MemoryRequirements is https://schema.org/memoryRequirements
Minimum memory requirements.
type Menu ¶
type Menu string
Menu is https://schema.org/menu
Either the actual menu as a structured representation, as text, or a URL of the menu.
type MerchantReturnDays ¶ added in v1.14.1
type MerchantReturnDays string
MerchantReturnDays is https://schema.org/merchantReturnDays
Specifies either a fixed return date or the number of days (from the delivery date) that a product can be returned. Used when the [[returnPolicyCategory]] property is specified as [[MerchantReturnFiniteReturnWindow]].
type MerchantReturnLink ¶
type MerchantReturnLink string
MerchantReturnLink is https://schema.org/merchantReturnLink
Specifies a Web page or service by URL, for product returns.
type MinPrice ¶ added in v1.14.1
type MinPrice float64
MinPrice is https://schema.org/minPrice
The lowest price if the price is a range.
type MinValue ¶ added in v1.14.1
type MinValue float64
MinValue is https://schema.org/minValue
The lower value of some characteristic or property.
type MissionCoveragePrioritiesPolicy ¶
type MissionCoveragePrioritiesPolicy string
MissionCoveragePrioritiesPolicy is https://schema.org/missionCoveragePrioritiesPolicy
For a [[NewsMediaOrganization]], a statement on coverage priorities, including any public agenda or stance on issues.
type MobileUrl ¶ added in v1.22.0
type MobileUrl string
MobileUrl is https://schema.org/mobileUrl
The [[mobileUrl]] property is provided for specific situations in which data consumers need to determine whether one of several provided URLs is a dedicated 'mobile site'.
To discourage over-use, and reflecting intial usecases, the property is expected only on [[Product]] and [[Offer]], rather than [[Thing]]. The general trend in web technology is towards [responsive design](https://en.wikipedia.org/wiki/Responsive_web_design) in which content can be flexibly adapted to a wide range of browsing environments. Pages and sites referenced with the long-established [[url]] property should ideally also be usable on a wide variety of devices, including mobile phones. In most cases, it would be pointless and counter productive to attempt to update all [[url]] markup to use [[mobileUrl]] for more mobile-oriented pages. The property is intended for the case when items (primarily [[Product]] and [[Offer]]) have extra URLs hosted on an additional "mobile site" alongside the main one. It should not be taken as an endorsement of this publication style.
type Model ¶
type Model string
Model is https://schema.org/model
The model of the product. Use with the URL of a ProductModel or a textual representation of the model identifier. The URL of the ProductModel can be from an external source. It is recommended to additionally provide strong product identifiers via the gtin8/gtin13/gtin14 and mpn properties.
type ModelDate ¶ added in v1.14.1
type ModelDate string
ModelDate is https://schema.org/modelDate
The release date of a vehicle model (often used to differentiate versions of the same make and model).
type ModifiedTime ¶ added in v1.14.1
type ModifiedTime string
ModifiedTime is https://schema.org/modifiedTime
The date and time the reservation was modified.
type MolecularFormula ¶
type MolecularFormula string
MolecularFormula is https://schema.org/molecularFormula
The empirical formula is the simplest whole number ratio of all the atoms in a molecule.
type MolecularWeight ¶
type MolecularWeight string
MolecularWeight is https://schema.org/molecularWeight
This is the molecular weight of the entity being described, not of the parent. Units should be included in the form '<Number> <unit>', for example '12 amu' or as '<QuantitativeValue>.
type MonoisotopicMolecularWeight ¶
type MonoisotopicMolecularWeight string
MonoisotopicMolecularWeight is https://schema.org/monoisotopicMolecularWeight
The monoisotopic mass is the sum of the masses of the atoms in a molecule using the unbound, ground-state, rest mass of the principal (most abundant) isotope for each element instead of the isotopic average mass. Please include the units in the form '<Number> <unit>', for example '770.230488 g/mol' or as '<QuantitativeValue>.
type MonthlyMinimumRepaymentAmount ¶ added in v1.14.1
type MonthlyMinimumRepaymentAmount float64
MonthlyMinimumRepaymentAmount is https://schema.org/monthlyMinimumRepaymentAmount
The minimum payment is the lowest amount of money that one is required to pay on a credit card statement each month.
type MonthsOfExperience ¶ added in v1.14.1
type MonthsOfExperience float64
MonthsOfExperience is https://schema.org/monthsOfExperience
Indicates the minimal number of months of experience required for a position.
type Mpn ¶
type Mpn string
Mpn is https://schema.org/mpn
The Manufacturer Part Number (MPN) of the product, or the product to which the offer refers.
type MultipleValues ¶ added in v1.14.1
type MultipleValues bool
MultipleValues is https://schema.org/multipleValues
Whether multiple values are allowed for the property. Default is false.
type MuscleAction ¶
type MuscleAction string
MuscleAction is https://schema.org/muscleAction
The movement the muscle generates.
type MusicCompositionForm ¶
type MusicCompositionForm string
MusicCompositionForm is https://schema.org/musicCompositionForm
The type of composition (e.g. overture, sonata, symphony, etc.).
type MusicalKey ¶
type MusicalKey string
MusicalKey is https://schema.org/musicalKey
The key, mode, or scale this composition uses.
type Naics ¶
type Naics string
Naics is https://schema.org/naics
The North American Industry Classification System (NAICS) code for a particular organization or business person.
type NamedPosition ¶
type NamedPosition string
NamedPosition is https://schema.org/namedPosition
A position played, performed or filled by a person or organization, as part of an organization. For example, an athlete in a SportsTeam might play in the position named 'Quarterback'.
type NaturalProgression ¶
type NaturalProgression string
NaturalProgression is https://schema.org/naturalProgression
The expected progression of the condition if it is not treated and allowed to progress naturally.
type NegativeNotes ¶
type NegativeNotes string
NegativeNotes is https://schema.org/negativeNotes
Provides negative considerations regarding something, most typically in pro/con lists for reviews (alongside [[positiveNotes]]). For symmetry
In the case of a [[Review]], the property describes the [[itemReviewed]] from the perspective of the review; in the case of a [[Product]], the product itself is being described. Since product descriptions tend to emphasise positive claims, it may be relatively unusual to find [[negativeNotes]] used in this way. Nevertheless for the sake of symmetry, [[negativeNotes]] can be used on [[Product]].
The property values can be expressed either as unstructured text (repeated as necessary), or if ordered, as a list (in which case the most negative is at the beginning of the list).
type NewsUpdatesAndGuidelines ¶
type NewsUpdatesAndGuidelines string
NewsUpdatesAndGuidelines is https://schema.org/newsUpdatesAndGuidelines
Indicates a page with news updates and guidelines. This could often be (but is not required to be) the main page containing [[SpecialAnnouncement]] markup on a site.
type NoBylinesPolicy ¶
type NoBylinesPolicy string
NoBylinesPolicy is https://schema.org/noBylinesPolicy
For a [[NewsMediaOrganization]] or other news-related [[Organization]], a statement explaining when authors of articles are not named in bylines.
type NonProprietaryName ¶
type NonProprietaryName string
NonProprietaryName is https://schema.org/nonProprietaryName
The generic name of this drug or supplement.
type NormalRange ¶
type NormalRange string
NormalRange is https://schema.org/normalRange
Range of acceptable values for a typical patient, when applicable.
type Nsn ¶
type Nsn string
Nsn is https://schema.org/nsn
Indicates the [NATO stock number](https://en.wikipedia.org/wiki/NATO_Stock_Number) (nsn) of a [[Product]].
type NumAdults ¶ added in v1.14.1
type NumAdults float64
NumAdults is https://schema.org/numAdults
The number of adults staying in the unit.
type NumChildren ¶ added in v1.14.1
type NumChildren float64
NumChildren is https://schema.org/numChildren
The number of children staying in the unit.
type NumConstraints ¶ added in v1.14.1
type NumConstraints float64
NumConstraints is https://schema.org/numConstraints
Indicates the number of constraints property values defined for a particular [[ConstraintNode]] such as [[StatisticalVariable]]. This helps applications understand if they have access to a sufficiently complete description of a [[StatisticalVariable]] or other construct that is defined using properties on template-style nodes.
type NumTracks ¶ added in v1.14.1
type NumTracks float64
NumTracks is https://schema.org/numTracks
The number of tracks in this album or playlist.
type NumberOfAirbags ¶
type NumberOfAirbags float64
NumberOfAirbags is https://schema.org/numberOfAirbags
The number or type of airbags in the vehicle.
type NumberOfAxles ¶ added in v1.14.1
type NumberOfAxles float64
NumberOfAxles is https://schema.org/numberOfAxles
The number of axles.\n\nTypical unit code(s): C62
type NumberOfBathroomsTotal ¶ added in v1.14.1
type NumberOfBathroomsTotal float64
NumberOfBathroomsTotal is https://schema.org/numberOfBathroomsTotal
The total integer number of bathrooms in some [[Accommodation]], following real estate conventions as [documented in RESO](https://ddwiki.reso.org/display/DDW17/BathroomsTotalInteger+Field): "The simple sum of the number of bathrooms. For example for a property with two Full Bathrooms and one Half Bathroom, the Bathrooms Total Integer will be 3.". See also [[numberOfRooms]].
type NumberOfBedrooms ¶ added in v1.14.1
type NumberOfBedrooms float64
NumberOfBedrooms is https://schema.org/numberOfBedrooms
The total integer number of bedrooms in a some [[Accommodation]], [[ApartmentComplex]] or [[FloorPlan]].
type NumberOfBeds ¶ added in v1.14.1
type NumberOfBeds float64
NumberOfBeds is https://schema.org/numberOfBeds
The quantity of the given bed type available in the HotelRoom, Suite, House, or Apartment.
type NumberOfCredits ¶ added in v1.14.1
type NumberOfCredits float64
NumberOfCredits is https://schema.org/numberOfCredits
The number of credits or units awarded by a Course or required to complete an EducationalOccupationalProgram.
type NumberOfDoors ¶ added in v1.14.1
type NumberOfDoors float64
NumberOfDoors is https://schema.org/numberOfDoors
The number of doors.\n\nTypical unit code(s): C62
type NumberOfEpisodes ¶ added in v1.14.1
type NumberOfEpisodes float64
NumberOfEpisodes is https://schema.org/numberOfEpisodes
The number of episodes in this season or series.
type NumberOfForwardGears ¶ added in v1.14.1
type NumberOfForwardGears float64
NumberOfForwardGears is https://schema.org/numberOfForwardGears
The total number of forward gears available for the transmission system of the vehicle.\n\nTypical unit code(s): C62
type NumberOfFullBathrooms ¶ added in v1.14.1
type NumberOfFullBathrooms float64
NumberOfFullBathrooms is https://schema.org/numberOfFullBathrooms
Number of full bathrooms - The total number of full and ¾ bathrooms in an [[Accommodation]]. This corresponds to the [BathroomsFull field in RESO](https://ddwiki.reso.org/display/DDW17/BathroomsFull+Field).
type NumberOfItems ¶ added in v1.14.1
type NumberOfItems float64
NumberOfItems is https://schema.org/numberOfItems
The number of items in an ItemList. Note that some descriptions might not fully describe all items in a list (e.g., multi-page pagination); in such cases, the numberOfItems would be for the entire list.
type NumberOfLoanPayments ¶ added in v1.14.1
type NumberOfLoanPayments float64
NumberOfLoanPayments is https://schema.org/numberOfLoanPayments
The number of payments contractually required at origination to repay the loan. For monthly paying loans this is the number of months from the contractual first payment date to the maturity date.
type NumberOfPages ¶ added in v1.14.1
type NumberOfPages float64
NumberOfPages is https://schema.org/numberOfPages
The number of pages in the book.
type NumberOfPartialBathrooms ¶ added in v1.14.1
type NumberOfPartialBathrooms float64
NumberOfPartialBathrooms is https://schema.org/numberOfPartialBathrooms
Number of partial bathrooms - The total number of half and ¼ bathrooms in an [[Accommodation]]. This corresponds to the [BathroomsPartial field in RESO](https://ddwiki.reso.org/display/DDW17/BathroomsPartial+Field).
type NumberOfPreviousOwners ¶ added in v1.14.1
type NumberOfPreviousOwners float64
NumberOfPreviousOwners is https://schema.org/numberOfPreviousOwners
The number of owners of the vehicle, including the current one.\n\nTypical unit code(s): C62
type NumberOfRooms ¶ added in v1.14.1
type NumberOfRooms float64
NumberOfRooms is https://schema.org/numberOfRooms
The number of rooms (excluding bathrooms and closets) of the accommodation or lodging business. Typical unit code(s): ROM for room or C62 for no unit. The type of room can be put in the unitText property of the QuantitativeValue.
type NumberOfSeasons ¶ added in v1.14.1
type NumberOfSeasons float64
NumberOfSeasons is https://schema.org/numberOfSeasons
The number of seasons in this series.
type NumberedPosition ¶ added in v1.14.1
type NumberedPosition float64
NumberedPosition is https://schema.org/numberedPosition
A number associated with a role in an organization, for example, the number on an athlete's jersey.
type ObservationDate ¶ added in v1.14.1
type ObservationDate string
ObservationDate is https://schema.org/observationDate
The observationDate of an [[Observation]].
type ObservationPeriod ¶ added in v1.22.0
type ObservationPeriod string
ObservationPeriod is https://schema.org/observationPeriod
The length of time an Observation took place over. The format follows `P[0-9]*[Y|M|D|h|m|s]`. For example, P1Y is Period 1 Year, P3M is Period 3 Months, P3h is Period 3 hours.
type OccupationalCategory ¶
type OccupationalCategory string
OccupationalCategory is https://schema.org/occupationalCategory
A category describing the job, preferably using a term from a taxonomy such as [BLS O*NET-SOC](http://www.onetcenter.org/taxonomy.html), [ISCO-08](https://www.ilo.org/public/english/bureau/stat/isco/isco08/) or similar, with the property repeated for each applicable value. Ideally the taxonomy should be identified, and both the textual label and formal code for the category should be provided.\n Note: for historical reasons, any textual label and formal code provided as a literal may be assumed to be from O*NET-SOC.
type OccupationalCredentialAwarded ¶
type OccupationalCredentialAwarded string
OccupationalCredentialAwarded is https://schema.org/occupationalCredentialAwarded
A description of the qualification, award, certificate, diploma or other occupational credential awarded as a consequence of successful completion of this course or program.
type OfferCount ¶ added in v1.14.1
type OfferCount float64
OfferCount is https://schema.org/offerCount
The number of offers for the product.
type OffersPrescriptionByMail ¶ added in v1.14.1
type OffersPrescriptionByMail bool
OffersPrescriptionByMail is https://schema.org/offersPrescriptionByMail
Whether prescriptions can be delivered by mail.
type OpeningHours ¶
type OpeningHours string
OpeningHours is https://schema.org/openingHours
The general opening hours for a business. Opening hours can be specified as a weekly time range, starting with days, then times per day. Multiple days can be listed with commas ',' separating each day. Day or time ranges are specified using a hyphen '-'.\n\n* Days are specified using the following two-letter combinations: ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```.\n* Times are specified using 24:00 format. For example, 3pm is specified as ```15:00```, 10am as ```10:00```. \n* Here is an example: <code><time itemprop="openingHours" datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays 4-8pm</time></code>.\n* If a business is open 7 days a week, then it can be specified as <code><time itemprop="openingHours" datetime="Mo-Su">Monday through Sunday, all day</time></code>.
type Opens ¶ added in v1.14.1
type Opens string
Opens is https://schema.org/opens
The opening hour of the place or service on the given day(s) of the week.
type OperatingSystem ¶
type OperatingSystem string
OperatingSystem is https://schema.org/operatingSystem
Operating systems supported (Windows 7, OS X 10.6, Android 1.6).
type Option ¶
type Option string
Option is https://schema.org/option
A sub property of object. The options subject to this action.
type OrderDate ¶ added in v1.14.1
type OrderDate string
OrderDate is https://schema.org/orderDate
Date order was placed.
type OrderItemNumber ¶
type OrderItemNumber string
OrderItemNumber is https://schema.org/orderItemNumber
The identifier of the order item.
type OrderNumber ¶
type OrderNumber string
OrderNumber is https://schema.org/orderNumber
The identifier of the transaction.
type OrderQuantity ¶ added in v1.14.1
type OrderQuantity float64
OrderQuantity is https://schema.org/orderQuantity
The number of the item ordered. If the property is not set, assume the quantity is one.
type OriginalMediaContextDescription ¶
type OriginalMediaContextDescription string
OriginalMediaContextDescription is https://schema.org/originalMediaContextDescription
Describes, in a [[MediaReview]] when dealing with [[DecontextualizedContent]], background information that can contribute to better interpretation of the [[MediaObject]].
type OriginalMediaLink ¶
type OriginalMediaLink string
OriginalMediaLink is https://schema.org/originalMediaLink
Link to the page containing an original version of the content, or directly to an online copy of the original [[MediaObject]] content, e.g. video file.
type Overdosage ¶
type Overdosage string
Overdosage is https://schema.org/overdosage
Any information related to overdose on a drug, including signs or symptoms, treatments, contact information for emergency response.
type OwnedFrom ¶ added in v1.14.1
type OwnedFrom string
OwnedFrom is https://schema.org/ownedFrom
The date and time of obtaining the product.
type OwnedThrough ¶ added in v1.14.1
type OwnedThrough string
OwnedThrough is https://schema.org/ownedThrough
The date and time of giving up ownership on the product.
type OwnershipFundingInfo ¶
type OwnershipFundingInfo string
OwnershipFundingInfo is https://schema.org/ownershipFundingInfo
For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]), a description of organizational ownership structure; funding and grants. In a news/media setting, this is with particular reference to editorial independence. Note that the [[funder]] is also available and can be used to make basic funder information machine-readable.
type PageEnd ¶ added in v1.14.0
type PageEnd string
PageEnd is https://schema.org/pageEnd
The page on which the work ends; for example "138" or "xvi".
type PageStart ¶
type PageStart string
PageStart is https://schema.org/pageStart
The page on which the work starts; for example "135" or "xiii".
type Pagination ¶
type Pagination string
Pagination is https://schema.org/pagination
Any description of pages that is not separated into pageStart and pageEnd; for example, "1-6, 9, 55" or "10-12, 46-49".
type ParentTaxon ¶
type ParentTaxon string
ParentTaxon is https://schema.org/parentTaxon
Closest parent taxon of the taxon in question.
type PartySize ¶ added in v1.14.1
type PartySize float64
PartySize is https://schema.org/partySize
Number of people the reservation should accommodate.
type PassengerPriorityStatus ¶
type PassengerPriorityStatus string
PassengerPriorityStatus is https://schema.org/passengerPriorityStatus
The priority status assigned to a passenger for security or boarding (e.g. FastTrack or Priority).
type PassengerSequenceNumber ¶
type PassengerSequenceNumber string
PassengerSequenceNumber is https://schema.org/passengerSequenceNumber
The passenger's sequence number as assigned by the airline.
type Pathophysiology ¶
type Pathophysiology string
Pathophysiology is https://schema.org/pathophysiology
Changes in the normal mechanical, physical, and biochemical functions that are associated with this activity or condition.
type Pattern ¶
type Pattern string
Pattern is https://schema.org/pattern
A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'. Values are typically expressed as text, although links to controlled value schemes are also supported.
type PaymentAccepted ¶
type PaymentAccepted string
PaymentAccepted is https://schema.org/paymentAccepted
Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc.
type PaymentDue ¶ added in v1.14.1
type PaymentDue string
PaymentDue is https://schema.org/paymentDue
The date that payment is due.
type PaymentDueDate ¶ added in v1.14.1
type PaymentDueDate string
PaymentDueDate is https://schema.org/paymentDueDate
The date that payment is due.
type PaymentMethodId ¶
type PaymentMethodId string
PaymentMethodId is https://schema.org/paymentMethodId
An identifier for the method of payment used (e.g. the last 4 digits of the credit card).
type PaymentStatus ¶
type PaymentStatus string
PaymentStatus is https://schema.org/paymentStatus
The status of payment; whether the invoice has been paid or not.
type PaymentUrl ¶
type PaymentUrl string
PaymentUrl is https://schema.org/paymentUrl
The URL for sending a payment.
type Percentile10 ¶ added in v1.14.1
type Percentile10 float64
Percentile10 is https://schema.org/percentile10
The 10th percentile value.
type Percentile25 ¶ added in v1.14.1
type Percentile25 float64
Percentile25 is https://schema.org/percentile25
The 25th percentile value.
type Percentile75 ¶ added in v1.14.1
type Percentile75 float64
Percentile75 is https://schema.org/percentile75
The 75th percentile value.
type Percentile90 ¶ added in v1.14.1
type Percentile90 float64
Percentile90 is https://schema.org/percentile90
The 90th percentile value.
type Permissions ¶
type Permissions string
Permissions is https://schema.org/permissions
Permission(s) required to run the app (for example, a mobile app may require full internet access or may run only on wifi).
type PermittedUsage ¶
type PermittedUsage string
PermittedUsage is https://schema.org/permittedUsage
Indications regarding the permitted usage of the accommodation.
type PetsAllowed ¶ added in v1.14.0
type PetsAllowed string
PetsAllowed is https://schema.org/petsAllowed
Indicates whether pets are allowed to enter the accommodation or lodging business. More detailed information can be put in a text value.
type PhoneticText ¶
type PhoneticText string
PhoneticText is https://schema.org/phoneticText
Representation of a text [[textValue]] using the specified [[speechToTextMarkup]]. For example the city name of Houston in IPA: /ˈhjuːstən/.
type PhysicalRequirement ¶
type PhysicalRequirement string
PhysicalRequirement is https://schema.org/physicalRequirement
A description of the types of physical activity associated with the job. Defined terms such as those in O*net may be used, but note that there is no way to specify the level of ability as well as its nature when using a defined term.
type PhysiologicalBenefits ¶
type PhysiologicalBenefits string
PhysiologicalBenefits is https://schema.org/physiologicalBenefits
Specific physiologic benefits associated to the plan.
type PickupTime ¶ added in v1.14.1
type PickupTime string
PickupTime is https://schema.org/pickupTime
When a taxi will pick up a passenger or a rental car can be picked up.
type PlayerType ¶
type PlayerType string
PlayerType is https://schema.org/playerType
Player type required—for example, Flash or Silverlight.
type PlayersOnline ¶ added in v1.14.1
type PlayersOnline float64
PlayersOnline is https://schema.org/playersOnline
Number of players on the server.
type Polygon ¶
type Polygon string
Polygon is https://schema.org/polygon
A polygon is the area enclosed by a point-to-point path for which the starting and ending points are the same. A polygon is expressed as a series of four or more space delimited points where the first and final points are identical.
type Position ¶
type Position float64
Position is https://schema.org/position
The position of an item in a series or sequence of items.
type PositiveNotes ¶
type PositiveNotes string
PositiveNotes is https://schema.org/positiveNotes
Provides positive considerations regarding something, for example product highlights or (alongside [[negativeNotes]]) pro/con lists for reviews.
In the case of a [[Review]], the property describes the [[itemReviewed]] from the perspective of the review; in the case of a [[Product]], the product itself is being described.
The property values can be expressed either as unstructured text (repeated as necessary), or if ordered, as a list (in which case the most positive is at the beginning of the list).
type PossibleComplication ¶
type PossibleComplication string
PossibleComplication is https://schema.org/possibleComplication
A possible unexpected and unfavorable evolution of a medical condition. Complications may include worsening of the signs or symptoms of the disease, extension of the condition to other organ systems, etc.
type PostOfficeBoxNumber ¶
type PostOfficeBoxNumber string
PostOfficeBoxNumber is https://schema.org/postOfficeBoxNumber
The post office box number for PO box addresses.
type PostOp ¶
type PostOp string
PostOp is https://schema.org/postOp
A description of the postoperative procedures, care, and/or followups for this device.
type PostalCode ¶
type PostalCode string
PostalCode is https://schema.org/postalCode
The postal code. For example, 94043.
type PostalCodeBegin ¶
type PostalCodeBegin string
PostalCodeBegin is https://schema.org/postalCodeBegin
First postal code in a range (included).
type PostalCodeEnd ¶
type PostalCodeEnd string
PostalCodeEnd is https://schema.org/postalCodeEnd
Last postal code in the range (included). Needs to be after [[postalCodeBegin]].
type PostalCodePrefix ¶
type PostalCodePrefix string
PostalCodePrefix is https://schema.org/postalCodePrefix
A defined range of postal codes indicated by a common textual prefix. Used for non-numeric systems such as UK.
type PreOp ¶
type PreOp string
PreOp is https://schema.org/preOp
A description of the workup, testing, and other preparations required before implanting this device.
type PregnancyWarning ¶
type PregnancyWarning string
PregnancyWarning is https://schema.org/pregnancyWarning
Any precaution, guidance, contraindication, etc. related to this drug's use during pregnancy.
type Preparation ¶
type Preparation string
Preparation is https://schema.org/preparation
Typical preparation that a patient must undergo before having the procedure performed.
type PrescribingInfo ¶
type PrescribingInfo string
PrescribingInfo is https://schema.org/prescribingInfo
Link to prescribing information for the drug.
type PrescriptionStatus ¶
type PrescriptionStatus string
PrescriptionStatus is https://schema.org/prescriptionStatus
Indicates the status of drug prescription, e.g. local catalogs classifications or whether the drug is available by prescription or over-the-counter, etc.
type PreviousStartDate ¶ added in v1.14.1
type PreviousStartDate string
PreviousStartDate is https://schema.org/previousStartDate
Used in conjunction with eventStatus for rescheduled or cancelled events. This property contains the previously scheduled start date. For rescheduled events, the startDate property should be used for the newly scheduled start date. In the (rare) case of an event that has been postponed and rescheduled multiple times, this field may be repeated.
type Price ¶
type Price float64
Price is https://schema.org/price
The offer price of a product, or of a price component when attached to PriceSpecification and its subtypes.\n\nUsage guidelines:\n\n* Use the [[priceCurrency]] property (with standard formats: [ISO 4217 currency format](http://en.wikipedia.org/wiki/ISO_4217), e.g. "USD"; [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for cryptocurrencies, e.g. "BTC"; well known names for [Local Exchange Trading Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) (LETS) and other currency types, e.g. "Ithaca HOUR") instead of including [ambiguous symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) such as '$' in the value.\n* Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator.\n* Note that both [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) and Microdata syntax allow the use of a "content=" attribute for publishing simple machine-readable values alongside more human-friendly formatting.\n* Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similar Unicode symbols.
type PriceCurrency ¶
type PriceCurrency string
PriceCurrency is https://schema.org/priceCurrency
The currency of the price, or a price component when attached to [[PriceSpecification]] and its subtypes.\n\nUse standard formats: [ISO 4217 currency format](http://en.wikipedia.org/wiki/ISO_4217), e.g. "USD"; [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for cryptocurrencies, e.g. "BTC"; well known names for [Local Exchange Trading Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) (LETS) and other currency types, e.g. "Ithaca HOUR".
type PriceRange ¶
type PriceRange string
PriceRange is https://schema.org/priceRange
The price range of the business, for example ```$$$```.
type PriceType ¶
type PriceType string
PriceType is https://schema.org/priceType
Defines the type of a price specified for an offered product, for example a list price, a (temporary) sale price or a manufacturer suggested retail price. If multiple prices are specified for an offer the [[priceType]] property can be used to identify the type of each such specified price. The value of priceType can be specified as a value from enumeration PriceTypeEnumeration or as a free form text string for price types that are not already predefined in PriceTypeEnumeration.
type PriceValidUntil ¶ added in v1.14.1
type PriceValidUntil string
PriceValidUntil is https://schema.org/priceValidUntil
The date after which the price is no longer available.
type PrintColumn ¶
type PrintColumn string
PrintColumn is https://schema.org/printColumn
The number of the column in which the NewsArticle appears in the print edition.
type PrintEdition ¶
type PrintEdition string
PrintEdition is https://schema.org/printEdition
The edition of the print product in which the NewsArticle appears.
type PrintPage ¶
type PrintPage string
PrintPage is https://schema.org/printPage
If this NewsArticle appears in print, this field indicates the name of the page on which the article is found. Please note that this field is intended for the exact page name (e.g. A5, B18).
type PrintSection ¶
type PrintSection string
PrintSection is https://schema.org/printSection
If this NewsArticle appears in print, this field indicates the print section in which the article appeared.
type Procedure ¶
type Procedure string
Procedure is https://schema.org/procedure
A description of the procedure involved in setting up, using, and/or installing the device.
type ProcessorRequirements ¶
type ProcessorRequirements string
ProcessorRequirements is https://schema.org/processorRequirements
Processor architecture required to run the application (e.g. IA64).
type ProductGroupID ¶
type ProductGroupID string
ProductGroupID is https://schema.org/productGroupID
Indicates a textual identifier for a ProductGroup.
type ProductID ¶
type ProductID string
ProductID is https://schema.org/productID
The product identifier, such as ISBN. For example: ``` meta itemprop="productID" content="isbn:123-456-789" ```.
type ProductReturnDays ¶ added in v1.14.1
type ProductReturnDays float64
ProductReturnDays is https://schema.org/productReturnDays
The productReturnDays property indicates the number of days (from purchase) within which relevant product return policy is applicable.
type ProductReturnLink ¶
type ProductReturnLink string
ProductReturnLink is https://schema.org/productReturnLink
Indicates a Web page or service by URL, for product return.
type ProductSupported ¶
type ProductSupported string
ProductSupported is https://schema.org/productSupported
The product or service this support contact point is related to (such as product support for a particular product line). This can be a specific product or product line (e.g. "iPhone") or a general category of products or services (e.g. "smartphones").
type ProductionDate ¶ added in v1.14.1
type ProductionDate string
ProductionDate is https://schema.org/productionDate
The date of production of the item, e.g. vehicle.
type ProficiencyLevel ¶
type ProficiencyLevel string
ProficiencyLevel is https://schema.org/proficiencyLevel
Proficiency needed for this content; expected values: 'Beginner', 'Expert'.
type ProgramName ¶
type ProgramName string
ProgramName is https://schema.org/programName
The program providing the membership.
type ProgramPrerequisites ¶
type ProgramPrerequisites string
ProgramPrerequisites is https://schema.org/programPrerequisites
Prerequisites for enrolling in the program.
type ProgramType ¶
type ProgramType string
ProgramType is https://schema.org/programType
The type of educational or occupational program. For example, classroom, internship, alternance, etc.
type ProgrammingLanguage ¶
type ProgrammingLanguage string
ProgrammingLanguage is https://schema.org/programmingLanguage
The computer programming language.
type ProgrammingModel ¶
type ProgrammingModel string
ProgrammingModel is https://schema.org/programmingModel
Indicates whether API is managed or unmanaged.
type PropertyID ¶
type PropertyID string
PropertyID is https://schema.org/propertyID
A commonly used identifier for the characteristic represented by the property, e.g. a manufacturer or a standard code for a property. propertyID can be (1) a prefixed string, mainly meant to be used with standards for product properties; (2) a site-specific, non-prefixed string (e.g. the primary key of the property or the vendor-specific ID of the property), or (3) a URL indicating the type of the property, either pointing to an external vocabulary, or a Web resource that describes the property (e.g. a glossary entry). Standards bodies should promote a standard prefix for the identifiers of properties from their standards.
type ProprietaryName ¶
type ProprietaryName string
ProprietaryName is https://schema.org/proprietaryName
Proprietary name given to the diet plan, typically by its originator or creator.
type ProviderMobility ¶
type ProviderMobility string
ProviderMobility is https://schema.org/providerMobility
Indicates the mobility of a provided service (e.g. 'static', 'dynamic').
type PublicAccess ¶ added in v1.14.1
type PublicAccess bool
PublicAccess is https://schema.org/publicAccess
A flag to signal that the [[Place]] is open to public visitors. If this property is omitted there is no assumed default boolean value
type PublicTransportClosuresInfo ¶
type PublicTransportClosuresInfo string
PublicTransportClosuresInfo is https://schema.org/publicTransportClosuresInfo
Information about public transport closures.
type PublicationType ¶
type PublicationType string
PublicationType is https://schema.org/publicationType
The type of the medical article, taken from the US NLM MeSH publication type catalog. See also [MeSH documentation](http://www.nlm.nih.gov/mesh/pubtypes.html).
type PublishingPrinciples ¶
type PublishingPrinciples string
PublishingPrinciples is https://schema.org/publishingPrinciples
The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]].
While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.
type PurchaseDate ¶ added in v1.14.1
type PurchaseDate string
PurchaseDate is https://schema.org/purchaseDate
The date the item, e.g. vehicle, was purchased by the current owner.
type Qualifications ¶
type Qualifications string
Qualifications is https://schema.org/qualifications
Specific qualifications required for this role or Occupation.
type QuarantineGuidelines ¶
type QuarantineGuidelines string
QuarantineGuidelines is https://schema.org/quarantineGuidelines
Guidelines about quarantine rules, e.g. in the context of a pandemic.
type Query ¶
type Query string
Query is https://schema.org/query
A sub property of instrument. The query used on this action.
type RatingCount ¶ added in v1.14.1
type RatingCount float64
RatingCount is https://schema.org/ratingCount
The count of total number of ratings.
type RatingExplanation ¶
type RatingExplanation string
RatingExplanation is https://schema.org/ratingExplanation
A short explanation (e.g. one to two sentences) providing background context and other information that led to the conclusion expressed in the rating. This is particularly applicable to ratings associated with "fact check" markup using [[ClaimReview]].
type RatingValue ¶ added in v1.14.1
type RatingValue float64
RatingValue is https://schema.org/ratingValue
The rating for the content.\n\nUsage guidelines:\n\n* Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similar Unicode symbols.\n* Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator.
type ReadonlyValue ¶ added in v1.14.1
type ReadonlyValue bool
ReadonlyValue is https://schema.org/readonlyValue
Whether or not a property is mutable. Default is false. Specifying this for a property that also has a value makes it act similar to a "hidden" input in an HTML form.
type RecipeCategory ¶
type RecipeCategory string
RecipeCategory is https://schema.org/recipeCategory
The category of the recipe—for example, appetizer, entree, etc.
type RecipeCuisine ¶
type RecipeCuisine string
RecipeCuisine is https://schema.org/recipeCuisine
The cuisine of the recipe (for example, French or Ethiopian).
type RecipeIngredient ¶
type RecipeIngredient string
RecipeIngredient is https://schema.org/recipeIngredient
A single ingredient used in the recipe, e.g. sugar, flour or garlic.
type RecipeInstructions ¶
type RecipeInstructions string
RecipeInstructions is https://schema.org/recipeInstructions
A step in making the recipe, in the form of a single item (document, video, etc.) or an ordered list with HowToStep and/or HowToSection items.
type RecipeYield ¶
type RecipeYield string
RecipeYield is https://schema.org/recipeYield
The quantity produced by the recipe (for example, number of people served, number of servings, etc).
type RecommendationStrength ¶
type RecommendationStrength string
RecommendationStrength is https://schema.org/recommendationStrength
Strength of the guideline's recommendation (e.g. 'class I').
type RecourseLoan ¶ added in v1.14.1
type RecourseLoan bool
RecourseLoan is https://schema.org/recourseLoan
The only way you get the money back in the event of default is the security. Recourse is where you still have the opportunity to go back to the borrower for the rest of the money.
type RelatedLink ¶
type RelatedLink string
RelatedLink is https://schema.org/relatedLink
A link related to this web page, for example to other related web pages.
type ReleaseDate ¶ added in v1.14.1
type ReleaseDate string
ReleaseDate is https://schema.org/releaseDate
The release date of a product or product model. This can be used to distinguish the exact variant of a product.
type ReleaseNotes ¶
type ReleaseNotes string
ReleaseNotes is https://schema.org/releaseNotes
Description of what changed in this version.
type RemainingAttendeeCapacity ¶ added in v1.14.1
type RemainingAttendeeCapacity float64
RemainingAttendeeCapacity is https://schema.org/remainingAttendeeCapacity
The number of attendee places for an event that remain unallocated.
type RenegotiableLoan ¶ added in v1.14.1
type RenegotiableLoan bool
RenegotiableLoan is https://schema.org/renegotiableLoan
Whether the terms for payment of interest can be renegotiated during the life of the loan.
type RepeatCount ¶ added in v1.14.1
type RepeatCount float64
RepeatCount is https://schema.org/repeatCount
Defines the number of times a recurring [[Event]] will take place.
type RepeatFrequency ¶
type RepeatFrequency string
RepeatFrequency is https://schema.org/repeatFrequency
Defines the frequency at which [[Event]]s will occur according to a schedule [[Schedule]]. The intervals between
events should be defined as a [[Duration]] of time.
type Repetitions ¶ added in v1.14.1
type Repetitions float64
Repetitions is https://schema.org/repetitions
Number of times one should repeat the activity.
type ReplyToUrl ¶
type ReplyToUrl string
ReplyToUrl is https://schema.org/replyToUrl
The URL at which a reply may be posted to the specified UserComment.
type ReportNumber ¶
type ReportNumber string
ReportNumber is https://schema.org/reportNumber
The number or other unique designator assigned to a Report by the publishing organization.
type RepresentativeOfPage ¶ added in v1.14.1
type RepresentativeOfPage bool
RepresentativeOfPage is https://schema.org/representativeOfPage
Indicates whether this image is representative of the content of the page.
type RequiredCollateral ¶
type RequiredCollateral string
RequiredCollateral is https://schema.org/requiredCollateral
Assets required to secure loan or credit repayments. It may take form of third party pledge, goods, financial instruments (cash, securities, etc.)
type RequiredGender ¶
type RequiredGender string
RequiredGender is https://schema.org/requiredGender
Audiences defined by a person's gender.
type RequiredMaxAge ¶ added in v1.14.1
type RequiredMaxAge float64
RequiredMaxAge is https://schema.org/requiredMaxAge
Audiences defined by a person's maximum age.
type RequiredMinAge ¶ added in v1.14.1
type RequiredMinAge float64
RequiredMinAge is https://schema.org/requiredMinAge
Audiences defined by a person's minimum age.
type RequiredQuantity ¶ added in v1.14.1
type RequiredQuantity string
RequiredQuantity is https://schema.org/requiredQuantity
The required quantity of the item(s).
type Requirements ¶
type Requirements string
Requirements is https://schema.org/requirements
Component dependency requirements for application. This includes runtime environments and shared libraries that are not included in the application distribution package, but required to run the application (examples: DirectX, Java or .NET runtime).
type RequiresSubscription ¶ added in v1.14.1
type RequiresSubscription bool
RequiresSubscription is https://schema.org/requiresSubscription
Indicates if use of the media require a subscription (either paid or free). Allowed values are ```true``` or ```false``` (note that an earlier version had 'yes', 'no').
type ReservationId ¶
type ReservationId string
ReservationId is https://schema.org/reservationId
A unique identifier for the reservation.
type Responsibilities ¶
type Responsibilities string
Responsibilities is https://schema.org/responsibilities
Responsibilities associated with this role or Occupation.
type RestPeriods ¶
type RestPeriods string
RestPeriods is https://schema.org/restPeriods
How often one should break from the activity.
type RestockingFee ¶ added in v1.14.1
type RestockingFee float64
RestockingFee is https://schema.org/restockingFee
Use [[MonetaryAmount]] to specify a fixed restocking fee for product returns, or use [[Number]] to specify a percentage of the product price paid by the customer.
type ReturnPolicyCountry ¶
type ReturnPolicyCountry string
ReturnPolicyCountry is https://schema.org/returnPolicyCountry
The country where the product has to be sent to for returns, for example "Ireland" using the [[name]] property of [[Country]]. You can also provide the two-letter [ISO 3166-1 alpha-2 country code](http://en.wikipedia.org/wiki/ISO_3166-1). Note that this can be different from the country where the product was originally shipped from or sent to.
type ReviewAspect ¶
type ReviewAspect string
ReviewAspect is https://schema.org/reviewAspect
This Review or Rating is relevant to this part or facet of the itemReviewed.
type ReviewBody ¶
type ReviewBody string
ReviewBody is https://schema.org/reviewBody
The actual body of the review.
type ReviewCount ¶ added in v1.14.1
type ReviewCount float64
ReviewCount is https://schema.org/reviewCount
The count of total number of reviews.
type Risks ¶
type Risks string
Risks is https://schema.org/risks
Specific physiologic risks associated to the diet plan.
type RoleName ¶
type RoleName string
RoleName is https://schema.org/roleName
A role played, performed or filled by a person or organization. For example, the team of creators for a comic book might fill the roles named 'inker', 'penciller', and 'letterer'; or an athlete in a SportsTeam might play in the position named 'Quarterback'.
type Runtime ¶
type Runtime string
Runtime is https://schema.org/runtime
Runtime platform or script interpreter dependencies (example: Java v1, Python 2.3, .NET Framework 3.0).
type RuntimePlatform ¶
type RuntimePlatform string
RuntimePlatform is https://schema.org/runtimePlatform
Runtime platform or script interpreter dependencies (example: Java v1, Python 2.3, .NET Framework 3.0).
type Rxcui ¶
type Rxcui string
Rxcui is https://schema.org/rxcui
The RxCUI drug identifier from RXNORM.
type SafetyConsideration ¶
type SafetyConsideration string
SafetyConsideration is https://schema.org/safetyConsideration
Any potential safety concern associated with the supplement. May include interactions with other drugs and foods, pregnancy, breastfeeding, known adverse reactions, and documented efficacy of the supplement.
type SalaryCurrency ¶
type SalaryCurrency string
SalaryCurrency is https://schema.org/salaryCurrency
The currency (coded using [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217)) used for the main salary information in this job posting or for this employee.
type SameAs ¶
type SameAs string
SameAs is https://schema.org/sameAs
URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
type SampleType ¶
type SampleType string
SampleType is https://schema.org/sampleType
What type of code sample: full (compile ready) solution, code snippet, inline code, scripts, template.
type ScheduleTimezone ¶
type ScheduleTimezone string
ScheduleTimezone is https://schema.org/scheduleTimezone
Indicates the timezone for which the time(s) indicated in the [[Schedule]] are given. The value provided should be among those listed in the IANA Time Zone Database.
type ScheduledPaymentDate ¶ added in v1.14.1
type ScheduledPaymentDate string
ScheduledPaymentDate is https://schema.org/scheduledPaymentDate
The date the invoice is scheduled to be paid.
type ScheduledTime ¶ added in v1.14.1
type ScheduledTime string
ScheduledTime is https://schema.org/scheduledTime
The time the object is scheduled to.
type SchemaVersion ¶
type SchemaVersion string
SchemaVersion is https://schema.org/schemaVersion
Indicates (by URL or string) a particular version of a schema used in some CreativeWork. This property was created primarily to
indicate the use of a specific schema.org release, e.g. ```10.0``` as a simple string, or more explicitly via URL, ```http://schema.org/docs/releases.html#v10.0```. There may be situations in which other schemas might usefully be referenced this way, e.g. ```http://dublincore.org/specifications/dublin-core/dces/1999-07-02/``` but this has not been carefully explored in the community.
type SchoolClosuresInfo ¶
type SchoolClosuresInfo string
SchoolClosuresInfo is https://schema.org/schoolClosuresInfo
Information about school closures.
type ScreenCount ¶ added in v1.14.1
type ScreenCount float64
ScreenCount is https://schema.org/screenCount
The number of screens in the movie theater.
type Screenshot ¶
type Screenshot string
Screenshot is https://schema.org/screenshot
A link to a screenshot image of the app.
type SdDatePublished ¶ added in v1.14.1
type SdDatePublished string
SdDatePublished is https://schema.org/sdDatePublished
Indicates the date on which the current structured data was generated / published. Typically used alongside [[sdPublisher]]
type SdLicense ¶
type SdLicense string
SdLicense is https://schema.org/sdLicense
A license document that applies to this structured data, typically indicated by URL.
type SeasonNumber ¶
type SeasonNumber string
SeasonNumber is https://schema.org/seasonNumber
Position of the season within an ordered group of seasons.
type SeatNumber ¶
type SeatNumber string
SeatNumber is https://schema.org/seatNumber
The location of the reserved seat (e.g., 27).
type SeatRow ¶
type SeatRow string
SeatRow is https://schema.org/seatRow
The row location of the reserved seat (e.g., B).
type SeatSection ¶
type SeatSection string
SeatSection is https://schema.org/seatSection
The section location of the reserved seat (e.g. Orchestra).
type SeatingCapacity ¶ added in v1.14.1
type SeatingCapacity float64
SeatingCapacity is https://schema.org/seatingCapacity
The number of persons that can be seated (e.g. in a vehicle), both in terms of the physical space available, and in terms of limitations set by law.\n\nTypical unit code(s): C62 for persons
type SeatingType ¶
type SeatingType string
SeatingType is https://schema.org/seatingType
The type/class of the seat.
type SecurityClearanceRequirement ¶
type SecurityClearanceRequirement string
SecurityClearanceRequirement is https://schema.org/securityClearanceRequirement
A description of any security clearance requirements of the job.
type SecurityScreening ¶
type SecurityScreening string
SecurityScreening is https://schema.org/securityScreening
The type of security screening the passenger is subject to.
type SensoryRequirement ¶
type SensoryRequirement string
SensoryRequirement is https://schema.org/sensoryRequirement
A description of any sensory requirements and levels necessary to function on the job, including hearing and vision. Defined terms such as those in O*net may be used, but note that there is no way to specify the level of ability as well as its nature when using a defined term.
type SerialNumber ¶
type SerialNumber string
SerialNumber is https://schema.org/serialNumber
The serial number or any alphanumeric identifier of a particular product. When attached to an offer, it is a shortcut for the serial number of the product included in the offer.
type ServesCuisine ¶
type ServesCuisine string
ServesCuisine is https://schema.org/servesCuisine
The cuisine of the restaurant.
type ServiceType ¶
type ServiceType string
ServiceType is https://schema.org/serviceType
The type of service being offered, e.g. veterans' benefits, emergency relief, etc.
type ServiceUrl ¶
type ServiceUrl string
ServiceUrl is https://schema.org/serviceUrl
The website to access the service.
type ServingSize ¶
type ServingSize string
ServingSize is https://schema.org/servingSize
The serving size, in terms of the number of volume or mass.
type Sha256 ¶
type Sha256 string
Sha256 is https://schema.org/sha256
The [SHA-2](https://en.wikipedia.org/wiki/SHA-2) SHA256 hash of the content of the item. For example, a zero-length input has value 'e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855'
type ShippingLabel ¶
type ShippingLabel string
ShippingLabel is https://schema.org/shippingLabel
Label to match an [[OfferShippingDetails]] with a [[ShippingRateSettings]] (within the context of a [[shippingSettingsLink]] cross-reference).
type ShippingSettingsLink ¶
type ShippingSettingsLink string
ShippingSettingsLink is https://schema.org/shippingSettingsLink
Link to a page containing [[ShippingRateSettings]] and [[DeliveryTimeSettings]] details.
type Significance ¶
type Significance string
Significance is https://schema.org/significance
The significance associated with the superficial anatomy; as an example, how characteristics of the superficial anatomy can suggest underlying medical conditions or courses of treatment.
type SignificantLink ¶
type SignificantLink string
SignificantLink is https://schema.org/significantLink
One of the more significant URLs on the page. Typically, these are the non-navigation links that are clicked on the most.
type SignificantLinks ¶
type SignificantLinks string
SignificantLinks is https://schema.org/significantLinks
The most significant URLs on the page. Typically, these are the non-navigation links that are clicked on the most.
type Size ¶
type Size string
Size is https://schema.org/size
A standardized size of a product or creative work, specified either through a simple textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode, or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]], [[height]], [[depth]] and [[weight]] properties may be more applicable.
type SizeGroup ¶
type SizeGroup string
SizeGroup is https://schema.org/sizeGroup
The size group (also known as "size type") for a product's size. Size groups are common in the fashion industry to define size segments and suggested audiences for wearable products. Multiple values can be combined, for example "men's big and tall", "petite maternity" or "regular"
type SizeSystem ¶
type SizeSystem string
SizeSystem is https://schema.org/sizeSystem
The size system used to identify a product's size. Typically either a standard (for example, "GS1" or "ISO-EN13402"), country code (for example "US" or "JP"), or a measuring system (for example "Metric" or "Imperial").
type Skills ¶
type Skills string
Skills is https://schema.org/skills
A statement of knowledge, skill, ability, task or any other assertion expressing a competency that is desired or required to fulfill this role or to work in this occupation.
type Sku ¶
type Sku string
Sku is https://schema.org/sku
The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a product or service, or the product to which the offer refers.
type Slogan ¶
type Slogan string
Slogan is https://schema.org/slogan
A slogan or motto associated with the item.
type Smiles ¶
type Smiles string
Smiles is https://schema.org/smiles
A specification in form of a line notation for describing the structure of chemical species using short ASCII strings. Double bond stereochemistry \ indicators may need to be escaped in the string in formats where the backslash is an escape character.
type SmokingAllowed ¶ added in v1.14.1
type SmokingAllowed bool
SmokingAllowed is https://schema.org/smokingAllowed
Indicates whether it is allowed to smoke in the place, e.g. in the restaurant, hotel or hotel room.
type SoftwareRequirements ¶
type SoftwareRequirements string
SoftwareRequirements is https://schema.org/softwareRequirements
Component dependency requirements for application. This includes runtime environments and shared libraries that are not included in the application distribution package, but required to run the application (examples: DirectX, Java or .NET runtime).
type SoftwareVersion ¶
type SoftwareVersion string
SoftwareVersion is https://schema.org/softwareVersion
Version of the software instance.
type Speakable ¶
type Speakable string
Speakable is https://schema.org/speakable
Indicates sections of a Web page that are particularly 'speakable' in the sense of being highlighted as being especially appropriate for text-to-speech conversion. Other sections of a page may also be usefully spoken in particular circumstances; the 'speakable' property serves to indicate the parts most likely to be generally useful for speech.
The *speakable* property can be repeated an arbitrary number of times, with three kinds of possible 'content-locator' values:
1.) *id-value* URL references - uses *id-value* of an element in the page being annotated. The simplest use of *speakable* has (potentially relative) URL values, referencing identified sections of the document concerned.
2.) CSS Selectors - addresses content in the annotated page, e.g. via class attribute. Use the [[cssSelector]] property.
3.) XPaths - addresses content via XPaths (assuming an XML view of the content). Use the [[xpath]] property.
For more sophisticated markup of speakable sections beyond simple ID references, either CSS selectors or XPath expressions to pick out document section(s) as speakable. For this we define a supporting type, [[SpeakableSpecification]] which is defined to be a possible value of the *speakable* property.
type SpecialCommitments ¶
type SpecialCommitments string
SpecialCommitments is https://schema.org/specialCommitments
Any special commitments associated with this job posting. Valid entries include VeteranCommit, MilitarySpouseCommit, etc.
type SpeechToTextMarkup ¶
type SpeechToTextMarkup string
SpeechToTextMarkup is https://schema.org/speechToTextMarkup
Form of markup used. eg. [SSML](https://www.w3.org/TR/speech-synthesis11) or [IPA](https://www.wikidata.org/wiki/Property:P898).
type StageAsNumber ¶ added in v1.14.1
type StageAsNumber float64
StageAsNumber is https://schema.org/stageAsNumber
The stage represented as a number, e.g. 3.
type StartDate ¶ added in v1.14.1
type StartDate string
StartDate is https://schema.org/startDate
The start date and time of the item (in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601)).
type StartOffset ¶ added in v1.14.1
type StartOffset float64
StartOffset is https://schema.org/startOffset
The start time of the clip expressed as the number of seconds from the beginning of the work.
type StartTime ¶ added in v1.14.1
type StartTime string
StartTime is https://schema.org/startTime
The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to start. For actions that span a period of time, when the action was performed. E.g. John wrote a book from *January* to December. For media, including audio and video, it's the time offset of the start of a clip within a larger file.\n\nNote that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.
type StatType ¶ added in v1.22.0
type StatType string
StatType is https://schema.org/statType
Indicates the kind of statistic represented by a [[StatisticalVariable]], e.g. mean, count etc. The value of statType is a property, either from within Schema.org (e.g. [[count]], [[median]], [[marginOfError]], [[maxValue]], [[minValue]]) or from other compatible (e.g. RDF) systems such as DataCommons.org or Wikidata.org.
type Status ¶
type Status string
Status is https://schema.org/status
The status of the study (enumerated).
type Step ¶
type Step string
Step is https://schema.org/step
A single step item (as HowToStep, text, document, video, etc.) or a HowToSection.
type StepValue ¶ added in v1.14.1
type StepValue float64
StepValue is https://schema.org/stepValue
The stepValue attribute indicates the granularity that is expected (and required) of the value in a PropertyValueSpecification.
type Steps ¶
type Steps string
Steps is https://schema.org/steps
A single step item (as HowToStep, text, document, video, etc.) or a HowToSection (originally misnamed 'steps'; 'step' is preferred).
type StorageRequirements ¶
type StorageRequirements string
StorageRequirements is https://schema.org/storageRequirements
Storage requirements (free space required).
type StreetAddress ¶
type StreetAddress string
StreetAddress is https://schema.org/streetAddress
The street address. For example, 1600 Amphitheatre Pkwy.
type StrengthUnit ¶
type StrengthUnit string
StrengthUnit is https://schema.org/strengthUnit
The units of an active ingredient's strength, e.g. mg.
type StrengthValue ¶ added in v1.14.1
type StrengthValue float64
StrengthValue is https://schema.org/strengthValue
The value of an active ingredient's strength, e.g. 325.
type StructuralClass ¶
type StructuralClass string
StructuralClass is https://schema.org/structuralClass
The name given to how bone physically connects to each other.
type SubStageSuffix ¶
type SubStageSuffix string
SubStageSuffix is https://schema.org/subStageSuffix
The substage, e.g. 'a' for Stage IIIa.
type SubtitleLanguage ¶
type SubtitleLanguage string
SubtitleLanguage is https://schema.org/subtitleLanguage
Languages in which subtitles/captions are available, in [IETF BCP 47 standard format](http://tools.ietf.org/html/bcp47).
type SuggestedGender ¶
type SuggestedGender string
SuggestedGender is https://schema.org/suggestedGender
The suggested gender of the intended person or audience, for example "male", "female", or "unisex".
type SuggestedMaxAge ¶ added in v1.14.1
type SuggestedMaxAge float64
SuggestedMaxAge is https://schema.org/suggestedMaxAge
Maximum recommended age in years for the audience or user.
type SuggestedMinAge ¶ added in v1.14.1
type SuggestedMinAge float64
SuggestedMinAge is https://schema.org/suggestedMinAge
Minimum recommended age in years for the audience or user.
type Supply ¶
type Supply string
Supply is https://schema.org/supply
A sub-property of instrument. A supply consumed when performing instructions or a direction.
type Surface ¶
type Surface string
Surface is https://schema.org/surface
A material used as a surface in some artwork, e.g. Canvas, Paper, Wood, Board, etc.
type Target ¶ added in v1.22.0
type Target string
Target is https://schema.org/target
Indicates a target EntryPoint, or url, for an Action.
type TargetDescription ¶
type TargetDescription string
TargetDescription is https://schema.org/targetDescription
The description of a node in an established educational framework.
type TargetName ¶
type TargetName string
TargetName is https://schema.org/targetName
The name of a node in an established educational framework.
type TargetPlatform ¶
type TargetPlatform string
TargetPlatform is https://schema.org/targetPlatform
Type of app development: phone, Metro style, desktop, XBox, etc.
type TargetPopulation ¶
type TargetPopulation string
TargetPopulation is https://schema.org/targetPopulation
Characteristics of the population for which this is intended, or which typically uses it, e.g. 'adults'.
type TargetUrl ¶
type TargetUrl string
TargetUrl is https://schema.org/targetUrl
The URL of a node in an established educational framework.
type TaxID ¶
type TaxID string
TaxID is https://schema.org/taxID
The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US or the CIF/NIF in Spain.
type TaxonRank ¶
type TaxonRank string
TaxonRank is https://schema.org/taxonRank
The taxonomic rank of this taxon given preferably as a URI from a controlled vocabulary – typically the ranks from TDWG TaxonRank ontology or equivalent Wikidata URIs.
type TaxonomicRange ¶
type TaxonomicRange string
TaxonomicRange is https://schema.org/taxonomicRange
The taxonomic grouping of the organism that expresses, encodes, or in some way related to the BioChemEntity.
type Teaches ¶
type Teaches string
Teaches is https://schema.org/teaches
The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term.
type Telephone ¶
type Telephone string
Telephone is https://schema.org/telephone
The telephone number.
type Temporal ¶ added in v1.14.1
type Temporal string
Temporal is https://schema.org/temporal
The "temporal" property can be used in cases where more specific properties (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]]) are not known to be appropriate.
type TemporalCoverage ¶
type TemporalCoverage string
TemporalCoverage is https://schema.org/temporalCoverage
The temporalCoverage of a CreativeWork indicates the period that the content applies to, i.e. that it describes, either as a DateTime or as a textual string indicating a time period in [ISO 8601 time interval format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In
the case of a Dataset it will typically indicate the relevant time period in a precise notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012"). Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate their temporalCoverage in broader terms - textually or via well-known URL. Written works such as books may sometimes have precise temporal coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945".
Open-ended date ranges can be written with ".." in place of the end date. For example, "2015-11/.." indicates a range beginning in November 2015 and with no specified final date. This is tentative and might be updated in future when ISO 8601 is officially updated.
type TermCode ¶
type TermCode string
TermCode is https://schema.org/termCode
A code that identifies this [[DefinedTerm]] within a [[DefinedTermSet]]
type TermsOfService ¶
type TermsOfService string
TermsOfService is https://schema.org/termsOfService
Human-readable terms of service documentation.
type TermsPerYear ¶ added in v1.14.1
type TermsPerYear float64
TermsPerYear is https://schema.org/termsPerYear
The number of times terms of study are offered per year. Semesters and quarters are common units for term. For example, if the student can only take 2 semesters for the program in one year, then termsPerYear should be 2.
type Text ¶
type Text string
Text is https://schema.org/text
The textual content of this CreativeWork.
type TextValue ¶
type TextValue string
TextValue is https://schema.org/textValue
Text value being annotated.
type ThumbnailUrl ¶
type ThumbnailUrl string
ThumbnailUrl is https://schema.org/thumbnailUrl
A thumbnail image relevant to the Thing.
type TickerSymbol ¶
type TickerSymbol string
TickerSymbol is https://schema.org/tickerSymbol
The exchange traded instrument associated with a Corporation object. The tickerSymbol is expressed as an exchange and an instrument name separated by a space character. For the exchange component of the tickerSymbol attribute, we recommend using the controlled vocabulary of Market Identifier Codes (MIC) specified in ISO 15022.
type TicketNumber ¶
type TicketNumber string
TicketNumber is https://schema.org/ticketNumber
The unique identifier for the ticket.
type TicketToken ¶
type TicketToken string
TicketToken is https://schema.org/ticketToken
Reference to an asset (e.g., Barcode, QR code image or PDF) usable for entrance.
type TimeOfDay ¶
type TimeOfDay string
TimeOfDay is https://schema.org/timeOfDay
The time of day the program normally runs. For example, "evenings".
type TissueSample ¶
type TissueSample string
TissueSample is https://schema.org/tissueSample
The type of tissue sample required for the test.
type TitleEIDR ¶
type TitleEIDR string
TitleEIDR is https://schema.org/titleEIDR
An [EIDR](https://eidr.org/) (Entertainment Identifier Registry) [[identifier]] representing at the most general/abstract level, a work of film or television.
For example, the motion picture known as "Ghostbusters" has a titleEIDR of "10.5240/7EC7-228A-510A-053E-CBB8-J". This title (or work) may have several variants, which EIDR calls "edits". See [[editEIDR]].
Since schema.org types like [[Movie]], [[TVEpisode]], [[TVSeason]], and [[TVSeries]] can be used for both works and their multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description), or alongside [[editEIDR]] for a more edit-specific description.
type Tool ¶
type Tool string
Tool is https://schema.org/tool
A sub property of instrument. An object used (but not consumed) when performing instructions or a direction.
type TotalHistoricalEnrollment ¶ added in v1.22.0
type TotalHistoricalEnrollment float64
TotalHistoricalEnrollment is https://schema.org/totalHistoricalEnrollment
The total number of students that have enrolled in the history of the course.
type TotalJobOpenings ¶ added in v1.14.1
type TotalJobOpenings float64
TotalJobOpenings is https://schema.org/totalJobOpenings
The number of positions open for this job posting. Use a positive integer. Do not use if the number of positions is unclear or not known.
type TotalPrice ¶
type TotalPrice string
TotalPrice is https://schema.org/totalPrice
The total price for the reservation or ticket, including applicable taxes, shipping, etc.\n\nUsage guidelines:\n\n* Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similar Unicode symbols.\n* Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator.
type TourBookingPage ¶
type TourBookingPage string
TourBookingPage is https://schema.org/tourBookingPage
A page providing information on how to book a tour of some [[Place]], such as an [[Accommodation]] or [[ApartmentComplex]] in a real estate setting, as well as other kinds of tours as appropriate.
type TouristType ¶
type TouristType string
TouristType is https://schema.org/touristType
Attraction suitable for type(s) of tourist. E.g. children, visitors from a particular country, etc.
type TrackingNumber ¶
type TrackingNumber string
TrackingNumber is https://schema.org/trackingNumber
Shipper tracking number.
type TrackingUrl ¶
type TrackingUrl string
TrackingUrl is https://schema.org/trackingUrl
Tracking url for the parcel delivery.
type TrainName ¶
type TrainName string
TrainName is https://schema.org/trainName
The name of the train (e.g. The Orient Express).
type TrainNumber ¶
type TrainNumber string
TrainNumber is https://schema.org/trainNumber
The unique identifier for the train.
type Transcript ¶
type Transcript string
Transcript is https://schema.org/transcript
If this MediaObject is an AudioObject or VideoObject, the transcript of that object.
type TransitTimeLabel ¶
type TransitTimeLabel string
TransitTimeLabel is https://schema.org/transitTimeLabel
Label to match an [[OfferShippingDetails]] with a [[DeliveryTimeSettings]] (within the context of a [[shippingSettingsLink]] cross-reference).
type TransmissionMethod ¶
type TransmissionMethod string
TransmissionMethod is https://schema.org/transmissionMethod
How the disease spreads, either as a route or vector, for example 'direct contact', 'Aedes aegypti', etc.
type TravelBans ¶
type TravelBans string
TravelBans is https://schema.org/travelBans
Information about travel bans, e.g. in the context of a pandemic.
type TypeOfBed ¶
type TypeOfBed string
TypeOfBed is https://schema.org/typeOfBed
The type of bed to which the BedDetail refers, i.e. the type of bed available in the quantity indicated by quantity.
type TypicalAgeRange ¶
type TypicalAgeRange string
TypicalAgeRange is https://schema.org/typicalAgeRange
The typical expected age range, e.g. '7-9', '11-'.
type TypicalCreditsPerTerm ¶ added in v1.14.1
type TypicalCreditsPerTerm float64
TypicalCreditsPerTerm is https://schema.org/typicalCreditsPerTerm
The number of credits or units a full-time student would be expected to take in 1 term however 'term' is defined by the institution.
type UnitCode ¶
type UnitCode string
UnitCode is https://schema.org/unitCode
The unit of measurement given using the UN/CEFACT Common Code (3 characters) or a URL. Other codes than the UN/CEFACT Common Code may be used with a prefix followed by a colon.
type UnitText ¶
type UnitText string
UnitText is https://schema.org/unitText
A string or text indicating the unit of measurement. Useful if you cannot provide a standard unit code for <a href='unitCode'>unitCode</a>.
type UnnamedSourcesPolicy ¶
type UnnamedSourcesPolicy string
UnnamedSourcesPolicy is https://schema.org/unnamedSourcesPolicy
For an [[Organization]] (typically a [[NewsMediaOrganization]]), a statement about policy on use of unnamed sources and the decision process required.
type UploadDate ¶ added in v1.14.1
type UploadDate string
UploadDate is https://schema.org/uploadDate
Date when this media object was uploaded to this site.
type UpvoteCount ¶ added in v1.14.1
type UpvoteCount float64
UpvoteCount is https://schema.org/upvoteCount
The number of upvotes this question, answer or comment has received from the community.
type UrlTemplate ¶
type UrlTemplate string
UrlTemplate is https://schema.org/urlTemplate
An url template (RFC6570) that will be used to construct the target of the execution of the action.
type UsageInfo ¶
type UsageInfo string
UsageInfo is https://schema.org/usageInfo
The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]. This property is applicable both to works that are freely available and to those that require payment or other transactions. It can reference additional information, e.g. community expectations on preferred linking and citation conventions, as well as purchasing details. For something that can be commercially licensed, usageInfo can provide detailed, resource-specific information about licensing options.
This property can be used alongside the license property which indicates license(s) applicable to some piece of content. The usageInfo property can provide information about other licensing options, e.g. acquiring commercial usage rights for an image that is also available under non-commercial creative commons licenses.
type UserInteractionCount ¶ added in v1.14.1
type UserInteractionCount float64
UserInteractionCount is https://schema.org/userInteractionCount
The number of interactions for the CreativeWork using the WebSite or SoftwareApplication.
type UsesHealthPlanIdStandard ¶
type UsesHealthPlanIdStandard string
UsesHealthPlanIdStandard is https://schema.org/usesHealthPlanIdStandard
The standard for interpreting the Plan ID. The preferred is "HIOS". See the Centers for Medicare & Medicaid Services for more details.
type Utterances ¶
type Utterances string
Utterances is https://schema.org/utterances
Text of an utterances (spoken words, lyrics etc.) that occurs at a certain section of a media object, represented as a [[HyperTocEntry]].
type ValidFrom ¶ added in v1.14.1
type ValidFrom string
ValidFrom is https://schema.org/validFrom
The date when the item becomes valid.
type ValidThrough ¶ added in v1.14.1
type ValidThrough string
ValidThrough is https://schema.org/validThrough
The date after when the item is not valid. For example the end of an offer, salary period, or a period of opening hours.
type ValidUntil ¶ added in v1.14.1
type ValidUntil string
ValidUntil is https://schema.org/validUntil
The date when the item is no longer valid.
type Value ¶
type Value float64
Value is https://schema.org/value
The value of a [[QuantitativeValue]] (including [[Observation]]) or property value node.\n\n* For [[QuantitativeValue]] and [[MonetaryAmount]], the recommended type for values is 'Number'.\n* For [[PropertyValue]], it can be 'Text', 'Number', 'Boolean', or 'StructuredValue'.\n* Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similar Unicode symbols.\n* Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator.
type ValueAddedTaxIncluded ¶ added in v1.14.1
type ValueAddedTaxIncluded bool
ValueAddedTaxIncluded is https://schema.org/valueAddedTaxIncluded
Specifies whether the applicable value-added tax (VAT) is included in the price specification or not.
type ValueMaxLength ¶ added in v1.14.1
type ValueMaxLength float64
ValueMaxLength is https://schema.org/valueMaxLength
Specifies the allowed range for number of characters in a literal value.
type ValueMinLength ¶ added in v1.14.1
type ValueMinLength float64
ValueMinLength is https://schema.org/valueMinLength
Specifies the minimum allowed range for number of characters in a literal value.
type ValueName ¶
type ValueName string
ValueName is https://schema.org/valueName
Indicates the name of the PropertyValueSpecification to be used in URL templates and form encoding in a manner analogous to HTML's input@name.
type ValuePattern ¶
type ValuePattern string
ValuePattern is https://schema.org/valuePattern
Specifies a regular expression for testing literal values according to the HTML spec.
type ValueReference ¶
type ValueReference string
ValueReference is https://schema.org/valueReference
A secondary value that provides additional information on the original value, e.g. a reference temperature or a type of measurement.
type ValueRequired ¶ added in v1.14.1
type ValueRequired bool
ValueRequired is https://schema.org/valueRequired
Whether the property must be filled in to complete the action. Default is false.
type VariableMeasured ¶
type VariableMeasured string
VariableMeasured is https://schema.org/variableMeasured
The variableMeasured property can indicate (repeated as necessary) the variables that are measured in some dataset, either described as text or as pairs of identifier and description using PropertyValue, or more explicitly as a [[StatisticalVariable]].
type VariablesMeasured ¶
type VariablesMeasured string
VariablesMeasured is https://schema.org/variablesMeasured
Originally named [[variablesMeasured]], the [[variableMeasured]] property can indicate (repeated as necessary) the variables that are measured in some dataset, either described as text or as pairs of identifier and description using PropertyValue.
type VariantCover ¶
type VariantCover string
VariantCover is https://schema.org/variantCover
A description of the variant cover
for the issue, if the issue is a variant printing. For example, "Bryan Hitch Variant Cover" or "2nd Printing Variant".
type VariesBy ¶
type VariesBy string
VariesBy is https://schema.org/variesBy
Indicates the property or properties by which the variants in a [[ProductGroup]] vary, e.g. their size, color etc. Schema.org properties can be referenced by their short name e.g. "color"; terms defined elsewhere can be referenced with their URIs.
type VatID ¶
type VatID string
VatID is https://schema.org/vatID
The Value-added Tax ID of the organization or person.
type VehicleConfiguration ¶
type VehicleConfiguration string
VehicleConfiguration is https://schema.org/vehicleConfiguration
A short text indicating the configuration of the vehicle, e.g. '5dr hatchback ST 2.5 MT 225 hp' or 'limited edition'.
type VehicleIdentificationNumber ¶
type VehicleIdentificationNumber string
VehicleIdentificationNumber is https://schema.org/vehicleIdentificationNumber
The Vehicle Identification Number (VIN) is a unique serial number used by the automotive industry to identify individual motor vehicles.
type VehicleInteriorColor ¶
type VehicleInteriorColor string
VehicleInteriorColor is https://schema.org/vehicleInteriorColor
The color or color combination of the interior of the vehicle.
type VehicleInteriorType ¶
type VehicleInteriorType string
VehicleInteriorType is https://schema.org/vehicleInteriorType
The type or material of the interior of the vehicle (e.g. synthetic fabric, leather, wood, etc.). While most interior types are characterized by the material used, an interior type can also be based on vehicle usage or target audience.
type VehicleModelDate ¶ added in v1.14.1
type VehicleModelDate string
VehicleModelDate is https://schema.org/vehicleModelDate
The release date of a vehicle model (often used to differentiate versions of the same make and model).
type VehicleSeatingCapacity ¶ added in v1.14.1
type VehicleSeatingCapacity float64
VehicleSeatingCapacity is https://schema.org/vehicleSeatingCapacity
The number of passengers that can be seated in the vehicle, both in terms of the physical space available, and in terms of limitations set by law.\n\nTypical unit code(s): C62 for persons.
type VehicleSpecialUsage ¶
type VehicleSpecialUsage string
VehicleSpecialUsage is https://schema.org/vehicleSpecialUsage
Indicates whether the vehicle has been used for special purposes, like commercial rental, driving school, or as a taxi. The legislation in many countries requires this information to be revealed when offering a car for sale.
type VehicleTransmission ¶
type VehicleTransmission string
VehicleTransmission is https://schema.org/vehicleTransmission
The type of component used for transmitting the power from a rotating power source to the wheels or other relevant component(s) ("gearbox" for cars).
type VerificationFactCheckingPolicy ¶
type VerificationFactCheckingPolicy string
VerificationFactCheckingPolicy is https://schema.org/verificationFactCheckingPolicy
Disclosure about verification and fact-checking processes for a [[NewsMediaOrganization]] or other fact-checking [[Organization]].
type Version ¶
type Version float64
Version is https://schema.org/version
The version of the CreativeWork embodied by a specified resource.
type VideoFormat ¶
type VideoFormat string
VideoFormat is https://schema.org/videoFormat
The type of screening or video broadcast used (e.g. IMAX, 3D, SD, HD, etc.).
type VideoFrameSize ¶
type VideoFrameSize string
VideoFrameSize is https://schema.org/videoFrameSize
The frame size of the video.
type VideoQuality ¶
type VideoQuality string
VideoQuality is https://schema.org/videoQuality
The quality of the video.
type VolumeNumber ¶
type VolumeNumber string
VolumeNumber is https://schema.org/volumeNumber
Identifies the volume of publication or multi-part work; for example, "iii" or "2".
type Warning ¶
type Warning string
Warning is https://schema.org/warning
Any FDA or other warnings about the drug (text or URL).
type WebCheckinTime ¶ added in v1.14.1
type WebCheckinTime string
WebCheckinTime is https://schema.org/webCheckinTime
The time when a passenger can check into the flight online.
type WebFeed ¶
type WebFeed string
WebFeed is https://schema.org/webFeed
The URL for a feed, e.g. associated with a podcast series, blog, or series of date-stamped updates. This is usually RSS or Atom.
type WordCount ¶ added in v1.14.1
type WordCount float64
WordCount is https://schema.org/wordCount
The number of words in the text of the Article.
type WorkHours ¶
type WorkHours string
WorkHours is https://schema.org/workHours
The typical working hours for this job (e.g. 1st shift, night shift, 8am-5pm).
type WorstRating ¶
type WorstRating float64
WorstRating is https://schema.org/worstRating
The lowest value allowed in this rating system. If worstRating is omitted, 1 is assumed.
type Xpath ¶
type Xpath string
Xpath is https://schema.org/xpath
An XPath, e.g. of a [[SpeakableSpecification]] or [[WebPageElement]]. In the latter case, multiple matches within a page can constitute a single conceptual "Web page element".
type YearBuilt ¶ added in v1.14.1
type YearBuilt float64
YearBuilt is https://schema.org/yearBuilt
The year an [[Accommodation]] was constructed. This corresponds to the [YearBuilt field in RESO](https://ddwiki.reso.org/display/DDW17/YearBuilt+Field).
type Yield ¶
type Yield string
Yield is https://schema.org/yield
The quantity that results by performing instructions. For example, a paper airplane, 10 personalized candles.