Interview Service - List Screens Operation

Interview Service - List Screens Operation

Lists all of the available screens in an interview session. Filtering options can be applied to obtain all screens associated with a specified entity instance, or all screens on which a specified attribute or relationship can be set for a particular entity instance.

Inputs

 

All other inputs are optional:

 

To obtain all screens associated with a specified entity instance, supply Entity ID and Instance ID.

To obtain all screens on which a specified attribute can be set for an entity instance, supply Entity ID, Instance ID and Attribute ID.

To obtain all screens on which a specified relationship can be set for an entity instance, supply Entity ID, Instance ID and Relationship ID.

Outputs

A list of screens organized by entity and entity instance. The list of screens will be filtered according to the available filtering options described in the Inputs section.

Rulebase:

Can be found at examples\rulebases\compiled\InterviewServiceTest.zip in the Oracle Policy Automation Runtime package.

Requests

Example Request - no filtering: 
<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:list-screens-request>
         <typ:interview-session-id>b8bbf3ea-a6b7-49da-a16f-32747684d443</typ:interview-session-id>
      </typ:list-screens-request>
   </soapenv:Body>
</soapenv:Envelope>
Example Request - with filter for entity instance: 
<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:list-screens-request>
         <typ:interview-session-id>b8bbf3ea-a6b7-49da-a16f-32747684d443</typ:interview-session-id>
         <typ:entity-id>global</typ:entity-id>
         <typ:instance-id>global</typ:instance-id>
      </typ:list-screens-request>
   </soapenv:Body>
</soapenv:Envelope>
Example Request - with filter for entity instance and attribute: 
<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:list-screens-request>
         <typ:interview-session-id>93c74cec-9530-497a-a123-e44c5af1d479</typ:interview-session-id>
         <typ:entity-id>global</typ:entity-id>
         <typ:instance-id>global</typ:instance-id>
         <typ:attribute-id>person_salary</typ:attribute-id>
      </typ:list-screens-request>
   </soapenv:Body>
</soapenv:Envelope>
Example Request - with filter for entity instance and relationship: 
<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:list-screens-request>
         <typ:interview-session-id>93c74cec-9530-497a-a123-e44c5af1d479</typ:interview-session-id>
         <typ:entity-id>global</typ:entity-id>
         <typ:instance-id>global</typ:instance-id>
         <typ:relationship-id>children</typ:relationship-id>
      </typ:list-screens-request>
   </soapenv:Body>
</soapenv:Envelope>

Responses

Example Response - no filtering: 
<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:list-screens-response>
         <typ:interview-session-id>b8bbf3ea-a6b7-49da-a16f-32747684d443</typ:interview-session-id>
         <typ:entity id="global">
            <typ:instance id="global">
               <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: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:screen id="qs$s4@Interviews_Screens_xint$global$global" name="s4@Interviews_Screens_xint" title="Collect the schools" context-entity-id="global" context-instance-id="global" type="question" is-automatic="false"/>
               <typ:screen id="qs$summary$global$global" name="summary" title="Assessment Summary" context-entity-id="global" context-instance-id="global" type="summary" is-automatic="false"/>
               <typ:screen id="dr$DefaultScreenOrder$global$global" name="Default Data Review" title="Data Review" context-entity-id="global" context-instance-id="global" type="data-review" is-automatic="false"/>
            </typ:instance>
         </typ:entity>
      </typ:list-screens-response>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Example Response - with filter for entity instance: 
<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:list-screens-response>
         <typ:interview-session-id>b8bbf3ea-a6b7-49da-a16f-32747684d443</typ:interview-session-id>
         <typ:entity id="global">
            <typ:instance id="global">
               <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: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:screen id="qs$s4@Interviews_Screens_xint$global$global" name="s4@Interviews_Screens_xint" title="Collect the schools" context-entity-id="global" context-instance-id="global" type="question" is-automatic="false"/>
               <typ:screen id="qs$summary$global$global" name="summary" title="Assessment Summary" context-entity-id="global" context-instance-id="global" type="summary" is-automatic="false"/>
               <typ:screen id="dr$DefaultScreenOrder$global$global" name="Default Data Review" title="Data Review" context-entity-id="global" context-instance-id="global" type="data-review" is-automatic="false"/>
            </typ:instance>
         </typ:entity>
      </typ:list-screens-response>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Example Response - with filter for entity instance and attribute: 
<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+08:00</i18n:tz>
      </i18n:international>
   </SOAP-ENV:Header>
   <SOAP-ENV:Body>
      <typ:list-screens-response>
         <typ:interview-session-id>93c74cec-9530-497a-a123-e44c5af1d479</typ:interview-session-id>
         <typ:entity id="global">
            <typ:instance id="global">
               <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:instance>
         </typ:entity>
      </typ:list-screens-response>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Example Response - with filter for entity instance and relationship: 
<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+08:00</i18n:tz>
      </i18n:international>
   </SOAP-ENV:Header>
   <SOAP-ENV:Body>
      <typ:list-screens-response>
         <typ:interview-session-id>93c74cec-9530-497a-a123-e44c5af1d479</typ:interview-session-id>
         <typ:entity id="global">
            <typ:instance id="global">
               <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:instance>
         </typ:entity>
      </typ:list-screens-response>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>