Navigation

Purpose

This method navigates through interaction resources, which are mapped into steps (that is, objectStepID). The Interaction Server Agent navigates through the interaction resource via this function.

URI Syntax and Example

http://[host:port]Application Name/version/[version]/account/[accountID]/[object]/[Object-Id]/[Object-Instance-Id]/[operation]

http://api.Interact.jacada.com/version/1/account/12345678/interaction/ABC1234567/1337088343163-840/navigation

HTTP Method

POST

Response

HTTP_OK 200

tog_minusBody Response Parameters

The Interaction Instance Navigation example body parameters are as follows:

Field Name

Data Type

Description

navigationType

String

The actual navigation action:

PREVIOUS, NEXT, CURRENT, FINISH, SAVE_UNFINISHED, TERMINATED_BY_USER, and INTERRUPTED.

Param

param[]

Each parameter represents an object inside the current Interaction Page.

{paramName – id of object , paramValue – value of object}

reason

String

Text to describe the reason for Jacada Interaction Server to request this navigation. This field is non-mandatory.

Parameter Element Scheme

    <xs:complexType>

      <xs:sequence>

        <xs:element name="paramName" type="xs:string"/>

        <xs:element name="paramValue" type="xs:string"/>

      </xs:sequence>

    </xs:complexType>
tog_minusBody Response Example

An Interaction Instance Navigation body example is as follows:

{

 "param":[

 {

         "paramValue"        :        "1335508398047-3373243601debcb0728d14627ca1136f253a125-5098",

         "paramName"                :        "1335508322167-9109243601debcb0728d14627ca1136f253a125-3fee"

 }],

 "navigationType":"NEXT",

 "reason":"INCOMING CALL"

}
tog_minusResponse Example
The Interaction Instance Navigation response scheme is as follows:

  <xs:sequence>

      <xs:element ref="tns:clientActions" minOccurs="0" maxOccurs="unbounded"/>

      <xs:element name="page" type="tns:page" minOccurs="0" maxOccurs="1"/>

    </xs:sequence>

An Interaction Instance Navigation response example is as follows:

"clientActions": [{

         "action": "local://playSound?type=Ding.mp3",

         "delayMillisecond": "1000"}],

"page" : {

      "pageNavigation" : {

        "navigationTitle" : "First Question",

        "navigationRight" : {

          "buttonState" : "NORMAL",

          "buttonVisible" : false,

          "buttonAction" : "server://navigationType?type=NEXT&shouldSendFormData=true"

        },

        "navigationLeft" : {

          "buttonState" : "NORMAL",

          "buttonVisible" : true,

          "buttonLabel" : "Back",

          "buttonAction" : "local://navigationType?type=BACK_TO_COVER_APP"

        }

      },

      "pageContent" : {

        "contentHeader" : {

          "id" : "1335508322167-9109243601debcb0728d14627ca1136f253a125-3fee",

          "innerHtml" : "<p>Please select one of the options below.</p>"

        },

        "contentSections" : [ {

          "id" : "1335508322167-9109243601debcb0728d14627ca1136f253a125-3fee",

          "sectionLabel" : "This is a long example of question's prompt:",

          "sectionGroupType" : "SINGLE",

          "sectionChoices" : [ {

            "id" : "1335508398047-3373243601debcb0728d14627ca1136f253a125-5098",

            "choiceValue" : "0",

            "clickToContinue" : {

              "id" : "1335508398047-3373243601debcb0728d14627ca1136f253a125-5098",

              "buttonVisible" : true,

              "buttonLabel" : "Choice Description 1"

            }

          }]

        } ],

        "allowVerticalScroll" : true,

        "allowHorizonalScroll" : false

      },

      "pageMenu" : {

        "menuVisible" : true,

        "menuButtons" : [ {

          "buttonState" : "NORMAL",

          "buttonVisible" : true,

          "buttonLabel" : "Help",

          "buttonAction" : "server://navigationType?type=HELP&shouldSendFormData=false",

          "buttonImageName" : "icon_help.png"

        }]

      }

      "pageTheme": "pageTheme1"

}