Interview Service - Investigate Operation

Interview Service - Investigate Operation

Used to investigate a specified goal (or flow).

Question screen data that has been updated by the user can be passed in with the request. The interview session will be updated using this data.

The response contains the next question screen in the investigation, or the summary screen if the investigation is complete.

Inputs
Outputs
Errors and warnings

As mentioned above, if errors or warnings were raised when processing the submitted screen,the submitted screen will be returned, with the details of any errors or warnings added. If an error or warning is associated with a specific control, it will be listed with that control. Otherwise, it will be listed at the top of the screen definition.

Warnings listed for a specific control appear in "invalid-value-change" tags. These special warnings indicate that the value submitted for the control was discarded for reasons described in the supplied message.

If errors are raised, the screen data must be modified to resolve the errors then re-submitted in order to continue the investigation. If warnings are raised, it is not mandatory to modify the screen data unless this is desired. The investigation can be continued by resubmitting the unmodified screen data.

Goal state

The goal state passed to the investigate operation identifies the goal that is being investigated. When a flow is being investigated, the goal state also contains information about the current position in the flow.

When beginning a new investigation (that is, making the first request to the investigation operation), the initial goal state will be the goal id for the desired goal, as returned by the List Goals operation.

The response to an investigate request includes the updated goal state. This updated goal state needs to be extracted from the response and used when making the next request.

Request with no errors or warnings

Example: 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:typ="http://oracle.com/determinations/server/interview/10.4/InterviewServiceTest/types">
   <soapenv:Header/>
   <soapenv:Body>
      <typ:investigate-request>
         <typ:interview-session-id>79878fa7-3038-43e5-a270-71a866442b45</typ:interview-session-id>
         <typ:goal-state>Attribute~person_eligible~global~global</typ:goal-state>
         <typ:screen id="qs$s2@Interviews_Screens_xint$global$global" name="s2@Interviews_Screens_xint" title="Input person's details" context-entity-id="global" context-instance-id="global" type="question" is-automatic="false">
            <typ:currency-control is-visible="true" caption="What is the person's annual salary?" caption-style="" is-html="false" css-class="" css-style="" attribute-id="person_salary" is-mandatory="true" is-read-only="false" selection-style="">
               <typ:current-value>
                  <typ:number-val>50000</typ:number-val>
               </typ:current-value>
               <typ:default-value>
                  <typ:unknown-val/>
               </typ:default-value>
            </typ:currency-control>
            <typ:text-control is-visible="true" caption="What is the person's nickname?" caption-style="" is-html="false" css-class="" css-style="" attribute-id="person_nickname" is-mandatory="true" is-read-only="false" selection-style="">
               <typ:current-value>
                  <typ:text-val>JohnB</typ:text-val>
               </typ:current-value>
               <typ:default-value>
                  <typ:unknown-val/>
               </typ:default-value>
            </typ:text-control>
         </typ:screen>
      </typ:investigate-request>
   </soapenv:Body>
</soapenv:Envelope>

Response with no errors or warnings

Example: 
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:i18n="http://www.w3.org/2005/09/ws-i18n" xmlns:typ="http://oracle.com/determinations/server/interview/10.4/InterviewServiceTest/types">
   <SOAP-ENV:Header>
      <i18n:international>
         <i18n:locale>en_US</i18n:locale>
         <i18n:tz>GMT+0800</i18n:tz>
      </i18n:international>
   </SOAP-ENV:Header>
   <SOAP-ENV:Body>
      <typ:investigate-response>
         <typ:interview-session-id>79878fa7-3038-43e5-a270-71a866442b45</typ:interview-session-id>
         <typ:goal-state>Attribute~person_eligible~global~global</typ:goal-state>
         <typ:progress>0.2857142857142857</typ:progress>
         <typ:screen id="qs$s3@Interviews_Screens_xint$global$global" name="s3@Interviews_Screens_xint" title="Collect the children" context-entity-id="global" context-instance-id="global" type="question" is-automatic="false">
            <typ:containment-relationship-control is-visible="true" caption-style="" is-html="false" css-class="" css-style="" relationship-id="children" source-entity-id="global" source-instance-id="global" target-entity-id="child" relationship-type="OneToMany" display-style="Portrait">
               <typ:entity-instance-control is-visible="true" caption-style="" is-html="false" css-class="" css-style="" entity-id="child" instance-id="--BLANK--">
                  <typ:date-control is-visible="true" caption="What is the child's date of birth?" caption-style="" is-html="false" css-class="" css-style="" attribute-id="child_dob" is-mandatory="true" is-read-only="false" selection-style="default" input-style="d">
                     <typ:current-value>
                        <typ:unknown-val/>
                     </typ:current-value>
                     <typ:default-value>
                        <typ:unknown-val/>
                     </typ:default-value>
                     <typ:properties>
                        <typ:property key="CustomControlProperty"/>
                     </typ:properties>
                  </typ:date-control>
                  <typ:properties>
                     <typ:property key="CustomControlProperty"/>
                  </typ:properties>
               </typ:entity-instance-control>
               <typ:properties>
                  <typ:property key="CustomControlProperty"/>
               </typ:properties>
            </typ:containment-relationship-control>
            <typ:properties>
               <typ:property key="CustomScreenProperty"/>
            </typ:properties>
         </typ:screen>
      </typ:investigate-response>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Request with errors and warnings for specific controls

Example: 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:typ="http://oracle.com/determinations/server/interview/10.4/ErrorTest/types">
   <soapenv:Header/>
   <soapenv:Body>
      <typ:investigate-request>
         <typ:interview-session-id>636272c7-053f-4c0c-856e-53e9914969d3</typ:interview-session-id>
         <typ:goal-state>Attribute~parent_happy~global~global</typ:goal-state>
         <typ:screen id="qs$parent_info$global$global" name="parent_info" title="Parent Info" context-entity-id="global" context-instance-id="global" type="question" is-automatic="false">
            <typ:currency-control is-visible="true" caption="What is the parent's salary?" caption-style="" is-html="false" css-class="" css-style="" attribute-id="parent_salary" is-mandatory="true" is-read-only="false" selection-style="">
               <typ:current-value>
                  <typ:number-val>50000</typ:number-val>
               </typ:current-value>
               <typ:default-value>
                  <typ:unknown-val/>
               </typ:default-value>
            </typ:currency-control>
            <typ:boolean-control is-visible="true" caption="Does the parent have a good paying job?" caption-style="" is-html="false" css-class="" css-style="" attribute-id="parent_good_job" is-mandatory="true" is-read-only="false" selection-style="">
               <typ:current-value>
                  <typ:boolean-val>true</typ:boolean-val>
               </typ:current-value>
               <typ:default-value>
                  <typ:unknown-val/>
               </typ:default-value>
            </typ:boolean-control>
         </typ:screen>
      </typ:investigate-request>
   </soapenv:Body>
</soapenv:Envelope>

Response with errors and warnings for specific controls

Example: 
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:i18n="http://www.w3.org/2005/09/ws-i18n" xmlns:typ="http://oracle.com/determinations/server/interview/10.4/ErrorTest/types">
   <SOAP-ENV:Header>
      <i18n:international>
         <i18n:locale>en_US</i18n:locale>
         <i18n:tz>GMT+0800</i18n:tz>
      </i18n:international>
   </SOAP-ENV:Header>
   <SOAP-ENV:Body>
      <typ:investigate-response>
         <typ:interview-session-id>636272c7-053f-4c0c-856e-53e9914969d3</typ:interview-session-id>
         <typ:goal-state>Attribute~parent_happy~global~global</typ:goal-state>
         <typ:progress>0.3333333333333333</typ:progress>
         <typ:screen id="qs$parent_info$global$global" name="parent_info" title="Parent Info" context-entity-id="global" context-instance-id="global" type="question" is-automatic="false">
            <typ:currency-control is-visible="true" caption="What is the parent's salary?" caption-style="" is-html="false" css-class="" css-style="" attribute-id="parent_salary" is-mandatory="true" is-read-only="false" selection-style="default">
               <typ:current-value>
                  <typ:number-val>50000.0</typ:number-val>
               </typ:current-value>
               <typ:default-value>
                  <typ:unknown-val/>
               </typ:default-value>
            </typ:currency-control>
            <typ:boolean-control is-visible="false" caption="Does the parent have a good paying job?" caption-style="" is-html="false" css-class="" css-style="" attribute-id="parent_good_job" is-mandatory="true" is-read-only="false" selection-style="default">
               <typ:invalid-value-change>There was an attempt to change the value of a control that is not visible. The submitted value for this control has been discarded.</typ:invalid-value-change>
               <typ:current-value>
                  <typ:unknown-val/>
               </typ:current-value>
               <typ:default-value>
                  <typ:unknown-val/>
               </typ:default-value>
            </typ:boolean-control>
         </typ:screen>
      </typ:investigate-response>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Request with errors and warnings listed at top of screen definition

Example: 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:typ="http://oracle.com/determinations/server/interview/10.4/ErrorTest/types">
   <soapenv:Header/>
   <soapenv:Body>
      <typ:investigate-request>
         <typ:interview-session-id>636272c7-053f-4c0c-856e-53e9914969d3</typ:interview-session-id>
         <typ:goal-state>Attribute~parent_happy~global~global</typ:goal-state>
         <typ:screen id="qs$parent_info$global$global" name="parent_info" title="Parent Info" context-entity-id="global" context-instance-id="global" type="question" is-automatic="false">
            <typ:currency-control is-visible="true" caption="What is the parent's salary?" caption-style="" is-html="false" css-class="" css-style="" attribute-id="parent_salary" is-mandatory="true" is-read-only="false" selection-style="">
               <typ:current-value>
                  <typ:number-val>-50000</typ:number-val>
               </typ:current-value>
               <typ:default-value>
                  <typ:unknown-val/>
               </typ:default-value>
            </typ:currency-control>
            <typ:boolean-control is-visible="true" caption="Does the parent have a good paying job?" caption-style="" is-html="false" css-class="" css-style="" attribute-id="parent_good_job" is-mandatory="true" is-read-only="false" selection-style="">
               <typ:current-value>
                  <typ:unknown-val/>
               </typ:current-value>
               <typ:default-value>
                  <typ:unknown-val/>
               </typ:default-value>
            </typ:boolean-control>
         </typ:screen>
      </typ:investigate-request>
   </soapenv:Body>
</soapenv:Envelope>

Response with errors and warnings listed at top of screen definition

Example: 
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:i18n="http://www.w3.org/2005/09/ws-i18n" xmlns:typ="http://oracle.com/determinations/server/interview/10.4/ErrorTest/types">
   <SOAP-ENV:Header>
      <i18n:international>
         <i18n:locale>en_US</i18n:locale>
         <i18n:tz>GMT+0800</i18n:tz>
      </i18n:international>
   </SOAP-ENV:Header>
   <SOAP-ENV:Body>
      <typ:investigate-response>
         <typ:interview-session-id>636272c7-053f-4c0c-856e-53e9914969d3</typ:interview-session-id>
         <typ:goal-state>Attribute~parent_happy~global~global</typ:goal-state>
         <typ:progress>0.3333333333333333</typ:progress>
         <typ:screen id="qs$parent_info$global$global" name="parent_info" title="Parent Info" context-entity-id="global" context-instance-id="global" type="question" is-automatic="false">
            <typ:error-list>
               <typ:error>You have entered a negative salary value.</typ:error>
            </typ:error-list>
            <typ:currency-control is-visible="true" caption="What is the parent's salary?" caption-style="" is-html="false" css-class="" css-style="" attribute-id="parent_salary" is-mandatory="true" is-read-only="false" selection-style="default">
               <typ:current-value>
                  <typ:number-val>-50000.0</typ:number-val>
               </typ:current-value>
               <typ:default-value>
                  <typ:unknown-val/>
               </typ:default-value>
            </typ:currency-control>
            <typ:boolean-control is-visible="false" caption="Does the parent have a good paying job?" caption-style="" is-html="false" css-class="" css-style="" attribute-id="parent_good_job" is-mandatory="true" is-read-only="false" selection-style="default">
               <typ:current-value>
                  <typ:unknown-val/>
               </typ:current-value>
               <typ:default-value>
                  <typ:unknown-val/>
               </typ:default-value>
            </typ:boolean-control>
         </typ:screen>
      </typ:investigate-response>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>