SEO.JSONLD.Ticket (SEO v0.3.0-rc.0)

View Source

Used to describe a ticket to an event, a flight, a bus ride, etc.

Helper for building a Schema.org Ticket JSON-LD structure.

Summary

Types

attrs()
t()

A JSON-LD map ready to be nested or rendered. String-keyed, always includes "@type" set to "Ticket", plus any camelCased field keys the caller provided (see build/1). "@context" is added at render time by SEO.JSONLD.meta/1 on the top-level node only.

Functions

build(attrs)

Build a Ticket JSON-LD map.

Types

attrs()

@type attrs() ::
  %{
    optional(:date_issued) =>
      Date.t() | String.t() | DateTime.t() | NaiveDateTime.t(),
    optional(:issued_by) => SEO.JSONLD.Organization.t() | map(),
    optional(:price_currency) => String.t(),
    optional(:ticket_number) => String.t(),
    optional(:ticket_token) => String.t() | URI.t(),
    optional(:ticketed_seat) => SEO.JSONLD.Seat.t() | map(),
    optional(:total_price) =>
      SEO.JSONLD.PriceSpecification.t() | map() | String.t() | number(),
    optional(:under_name) =>
      SEO.JSONLD.Organization.t() | map() | SEO.JSONLD.Person.t(),
    optional(:additional_type) => String.t() | URI.t(),
    optional(:alternate_name) => String.t(),
    optional(:description) => SEO.JSONLD.TextObject.t() | map() | String.t(),
    optional(:disambiguating_description) => String.t(),
    optional(:identifier) =>
      String.t() | URI.t() | SEO.JSONLD.PropertyValue.t() | map(),
    optional(:image) =>
      URI.t() | String.t() | SEO.JSONLD.ImageObject.t() | map(),
    optional(:main_entity_of_page) =>
      SEO.JSONLD.CreativeWork.t() | map() | URI.t() | String.t(),
    optional(:name) => String.t(),
    optional(:owner) =>
      SEO.JSONLD.Organization.t() | map() | SEO.JSONLD.Person.t(),
    optional(:potential_action) => SEO.JSONLD.Action.t() | map(),
    optional(:same_as) => URI.t() | String.t(),
    optional(:subject_of) =>
      SEO.JSONLD.Event.t() | map() | SEO.JSONLD.CreativeWork.t(),
    optional(:url) => URI.t() | String.t()
  }
  | [
      date_issued: Date.t() | String.t() | DateTime.t() | NaiveDateTime.t(),
      issued_by: SEO.JSONLD.Organization.t() | map(),
      price_currency: String.t(),
      ticket_number: String.t(),
      ticket_token: String.t() | URI.t(),
      ticketed_seat: SEO.JSONLD.Seat.t() | map(),
      total_price:
        SEO.JSONLD.PriceSpecification.t() | map() | String.t() | number(),
      under_name: SEO.JSONLD.Organization.t() | map() | SEO.JSONLD.Person.t(),
      additional_type: String.t() | URI.t(),
      alternate_name: String.t(),
      description: SEO.JSONLD.TextObject.t() | map() | String.t(),
      disambiguating_description: String.t(),
      identifier: String.t() | URI.t() | SEO.JSONLD.PropertyValue.t() | map(),
      image: URI.t() | String.t() | SEO.JSONLD.ImageObject.t() | map(),
      main_entity_of_page:
        SEO.JSONLD.CreativeWork.t() | map() | URI.t() | String.t(),
      name: String.t(),
      owner: SEO.JSONLD.Organization.t() | map() | SEO.JSONLD.Person.t(),
      potential_action: SEO.JSONLD.Action.t() | map(),
      same_as: URI.t() | String.t(),
      subject_of: SEO.JSONLD.Event.t() | map() | SEO.JSONLD.CreativeWork.t(),
      url: URI.t() | String.t()
    ]

t()

@type t() :: %{required(String.t()) => term()}

A JSON-LD map ready to be nested or rendered. String-keyed, always includes "@type" set to "Ticket", plus any camelCased field keys the caller provided (see build/1). "@context" is added at render time by SEO.JSONLD.meta/1 on the top-level node only.

Functions

build(attrs)

@spec build(attrs()) :: t()

Build a Ticket JSON-LD map.

Fields

Use standard formats: ISO 4217 currency format, e.g. "USD"; Ticker symbol for cryptocurrencies, e.g. "BTC"; well known names for Local Exchange Trading Systems (LETS) and other currency types, e.g. "Ithaca HOUR".

  • :ticket_number - The unique identifier for the ticket.
  • :ticket_token - Reference to an asset (e.g., Barcode, QR code image or PDF) usable for entrance.
  • :ticketed_seat - The seat associated with the ticket.
  • :total_price - The total price for the reservation or ticket, including applicable taxes, shipping, etc.

Usage guidelines:

  • Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similar Unicode symbols.
  • Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator.
  • :under_name - The person or organization the reservation or ticket is for.

Inherited properties

Additional properties are available through the inheritance chain. See each ancestor's docs for its properties: