Assess Service - ListGoals Operation

(please note that content in this topic will be subject to change for the V10.2 final release)

Description

The ListGoals service returns a list of goal attributes for a rulebase. The request and response for ListGoals is the same for the Specific and Generic service.

For an attribute to be identified as a goal attribute in a rulebase, it must:

 

A goal attribute can then be used in the outcome set of an Assess operation.

The input for the ListGoals operation is a string containing the name of the rulebase whose goals are to be listed .

Request

The Call is a simple SOAP Request with no parameters:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:typ="http://oracle.com/determinations/server/9.3/rulebase/types">
  <soapenv:Body>
    <typ:list-goals-request/>
  </soapenv:Body>
</soapenv:Envelope>

Response

The response is a complex XML type structured as:

"list-goals-response"
The response element containing all the goals

"entity” (optional, recurring element)
The entity that has at least one top level attribute. It has the following attributes:

"entity-type” - The name of the entity.

“attribute” (mandatory, recurring element)
at least one per entity, one for each goal attribute available.  It has the following attributes:

"text” - This XML attribute specifies the question form of the text of the goal attribute.

"id” - This XML attribute specifies the rulebase attribute ID used to uniquely identify the goal attribute.

"type” - The type of value of the attribute. Can be "text-val", "number-val", "currency-val", "date-val" or "boolean-val" .

 

Example Response:

In this example, there are two Goals. One is a global goal, "MyGlobalGoal" which is a Boolean value (true or false). The other is a goal for the "applicant" entity, "benefit" which is a currency (money) value.

<SOAP-ENV:Envelope
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:typ="http://oracle.com/determinations/server/9.3/cwg/types">
  <SOAP-ENV:Header/>
  <SOAP-ENV:Body>
    <typ:list-goals-response>
      <typ:entity name="global">
        <typ:attribute id="MyGlobalGoal"
          text="Is MyGlobal Goal True?" type="boolean-val"/>
      </typ:entity>
      <typ:entity name="applicant">
        <typ:attribute id="benefit"
          text="How much benefit will the applicant get?"
          type="currency-val"/>
      </typ:entity>
    </typ:list-goals-response>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>