Skip to content

Potential Action

It is available in schema.org/docs/actions.html. It is a shift from the static representation of an entity in the digital world, by providing an interactive possibility to take action on these entities.

Actions and Offers

Our infocenter contains different types of entities (objects), e.g. Events, Products, LodgingBusiness, SkiResorts, etc. Potential Action it is a property that represents the possibilities to make better use of an entity. In other words, the end-user can benefit more from the info related to the entity itself. Such as being able to buy tickets for the offered event, or to book a Ski pass from a specific ski resort.

Possible action types

  • OrderAction see below
  • RegisterAction Used for signup/registration flows
  • EventList vertex (place) has events that take place in this location.
  • LiveState vertex has a frequent update for the 'State' property.

Where it is used

  • Thing.PotentialAction (detail responses)
  • Search.IndexResponse.PotentialAction (search results)

Relevant Entities for 'OrderAction' type

  • Event buying ticket for a specific event
  • Product this product can be ordered
  • LodgingBusiness booking an accommodation (room)
  • FoodEstablishment booking a table
  • SkiResort buy a skipass

Possible target (EntryPoint) types

  • Web open the url in a web browser or pull the state in the case of LiveState
  • DsMarket discover.swiss marketplace service
  • DsInfocenter internal infocenter endpoints (e.g. EventList, LiveState)

Possible target (EntryPoint) additional types

Only relevant when target type is DsMarket:

  • Variants place on order directly by adding an orderitem with a variant
  • Offers get offers first and then cerate the order item with a selected offer
  • Availability availabilties are available (calender)
  • StayTravelerAddOn this product is used as well as an addon for a traveler

Examples

"PotentialAction": [
    {
        "AdditionalType": "OrderAction",
        "Target": [
            {
                "Type": "Web",
                "UrlTemplate": "[https://www.flimslaax.com/kulinarische-wanderung/winter](https://www.flimslaax.com/kulinarische-wanderung/winter)"
            }
        ],
        "Name": {}
    }
]

"PotentialAction": [
    {
        "AdditionalType": "LiveState",
        "Target": [
            {
                "Type": "DsInfocenter",
                "UrlTemplate": "[https://infocenter.discover.swiss/api/v1/skiresorts/ski_12345?select=state,stateTimestamp](https://infocenter.discover.swiss/api/v1/skiresorts/ski_12345?select=state,stateTimestamp)"
            }
        ]
    }
]

"PotentialAction": [
    {
        "AdditionalType": "OrderAction",
        "Target": [
            {
                "Type": "DsMarket",
                "AdditionalType": "Offers"
            },
            {
                "Type": "DsMarket",
                "AdditionalType": "Availability"
            }
        ]
    }
]