HotspotNode

PUT /api/simulations/{simulationId}/nodes/{nodeId}/hotspot

Request

  • Base URL
    https://api.wearelearning.io (the document declares no server; this is the origin it was published from)
  • Auth
    OAuth 2
    Implicit: https://login.wearelearning.io/authorize?audience=https://api.wearelearning.io

Path parameters

simulationIdstring uuid required

A valid GUID

nodeIdstring uuid required

A valid GUID

Request body

showHotspotsboolean required
mandatoryCompletionboolean required
showVisitedHotspotsboolean required
showFullscreenboolean required
sequenceModeboolean required
autoContinueboolean required
popupPlacement'Relative' | 'Center' required
popupAnimation'Scale' | 'None' | 'Fade' | 'Pop' | 'Slide' | 'Bounce' | 'Flip' required
popupAnimationDirection'Up' | 'Down' | 'Left' | 'Right' required
popupAnimationSpeed'Normal' | 'Fast' | 'Slow' required
checkmarkSize'Small' | 'Medium' | 'Large'

Response

OK

nodeType'dialogue' | 'response' | 'poster' | 'event' | 'end' | 'open-response' | 'outcome' | 'no-match' | 'hotspot' | 'quiz' | 'page' | 'code' required
idstring required
simulationIdstring required

Changes

No recorded changes to this operation across all 1 revision of this API.