Content Type

application/json

HTTP Headers

NONE

Response Fields


action

expected values:

  • Success
    <Deprecated> - please use the LAUNCH action.
  • LAUNCH
    This action indicates that the Gateway Launch form should POST directly to the specified redirectURI.
  • RELAY
    This action indicates that Gateway should render the RELAY action for the resource type upon a successful lookup of a resource id.
  • BRANCH
    This action indicates that the Gateway Launch form should POST to the specified redirectURI and maintain the original Launch state to be replayed after the branch process is complete.
  • EXCEPTION
    Something is broke or borked


redirectURI

The URI provided by the Tool Provider to inject as the ACTION of the Launch form. In the case of RELAY or EXCEPTION this value should be NULL.


messageData

A container for Tool Provider specific string data to be passed back to Tool Provider during a launch. It will pass transparently through the Gateway and be returned to the Tool Provider as is.

Example LAUNCH:

RESPONSE:
 - BODY:
    {
        "action" = "LAUNCH",
        "redirectURI" = "http://tool-provider.com/doLaunch?tpSpecificParameter=SomeVal"
        "messageData" = "Some UI response message used by the Tool Provider."
    }

Example RELAY:

RESPONSE:
 - BODY:
    {
        "action" = "RELAY",
        "redirectURI" = null
        "messageData" = null
    }

Example BRANCH:

RESPONSE:
 - BODY:
    {
        "action" = "BRANCH",
        "redirectURI" = "http://tool-provider.com/doPaymentBranch?tpSpecificParameter=SomeVal"
        "messageData" = "Payment for book is needed"
    }