Get Policy Service

The Get Policy service is a DISQ service used to retrieve a single policy's fixed and dynamic policy fields, as well as fixed and dynamic fields for several other policy-related entities. DISQ services in general allow an external application to access data in the OIPA system by using requests, which utilize a formal XML schema that is both easy to understand and flexible in its application.

Policy is one of several entities supported in the DISQ model. The Policy entity is a child entity with respect to the Plan entity, and is a parent entity to the Policy Roles, Segment, Allocations, Withholding and Benefit Split entities. Segments are in turn parent entities to Segment Roles entities.

Using the Get Policy DISQ request, the user can retrieve a single policy's data stored in the following database tables:

Field names used in DISQ requests are case sensitive, and any field included in the request must be configured in OIPA at the context where the request is being sent.

Get Policy Elements/Attributes

Element/Tag Definition Attribute Element/Attribute Value and Description
<DisqRequest>

Required element:

The parent element of a DISQ request.

   

<Header>

Optional element:

Container element for the <Message ID> and <TimeStamp> elements.

 

 

<MessageId>

Optional element:

Designates a message ID for the DISQ request.

  Literal string value.
<TimeStamp>

Optional element:

Designates a timestamp for the DISQ request.

  Literal string value representing a timestamp.
<Context> Optional element:

The Context is the DISQ means of identifying the resource of an entity. Since Context is tied to the Action being requested, it is essential that the Context uniquely identifies a single resource.

For the Get Policy service, <Context> is optional. But, if <Context> is not specified, <PolicyGuid> must be present in the <Get> Action element.

Note: If both the <Context> and <PolicyGuid> elements are omitted from the request, an exception will be returned.

   
<Company>

Required element:

Establishes the resource from which the policy is found.

   
<CompanyName>

Required element:

Holds the name of the subsidiary company to which a policy belongs.

  The name of a subsidiary company to which a policy belongs.
<Plan>

Optional element:

Plan is the parent entity of policy. A plan is unique within a subsidiary company, but may not be unique across multiple subsidiary companies. The combination of company and plan should be used to uniquely identify a single resource from which the policy will be found.

   
<PlanName>

Required element:

Holds the name of the plan to which a policy belongs.

  The name of a plan to which a policy belongs.
<Get>

Required element:

The parent element of the Get action. Get is a data retrieval action that can retrieve resources for a single, unique entity in the system. From the policy context, the Get action retrieves the resources of a single, unique policy.

   
<Policy>

Required element:

Holds child elements that specify the policy whose data is to be retrieved.

Note: Dynamic fields are not supported for the Get action. Only fixed fields can be used to identify the entity.

Note: Only one <Policy> element is processed. If multiple <Policy> elements are provided, only the first will be processed.

   
<PolicyGuid> Optional element:

Holds the GUID for the policy whose information is being requested. If a policy GUID is provided, the individual policy is directly identified, and no other identifying criteria will be recognized.

Note: If the <Context> element is omitted, then the <PolicyGuid> element must be present within the <Get> element in order to identify the specific policy.

  A policy's GUID.
<[Policy fixed field]>

Optional, repeatable element:

The name of each of these elements should be the name of a policy fixed field, such as PolicyNumber or PolicyName. These elements and their values are used to uniquely identify the policy.

When multiple policy fixed field elements are used within the <Get> action, the request will only retrieve policies that satisfy all of the specified policy criteria.

 

The value to search for. See the Policy Fixed Fields section below for a complete list of policy fixed fields that can be used in a DISQ request.

 

For example:

<StatusCode>01</StatusCode>

<PolicyName>TestPolicy</PolicyName>

<[Entities]>

Optional, repeatable element:

This element contains a number of entities related to the policy entity. It is used when the user wants to further filter the policy based on values in one more of the entities.

The name of this element should be the plural name of an entity related to the policy entity. The entity names that can be used for this element are Allocations, Roles, Segments, Withholdings and BenefitSplits.

Multiple entities may be provided by a request. If there are multiple elements referencing the same entity, the request will retrieve polices associated to the entities that satisfy all of the criteria.

   
<[Entity]>

Optional, repeatable element:

The name of this element should be the name an entity that is related to the policy entity. The entity names that can be used for this element are Allocation, Role, Segment, Withholding and BenefitSplit.

The element’s name must be the singular form of the containing entities name.

When more than one entity element is present, only the first will be recognized.

   
<[Entity fixed field]>

Required, repeatable element:

The name of each of these elements should be the name of a fixed field that belongs to the specified entity. If one or more policies have data that satisfy the criteria specified within these elements, the policies will be returned from the service.

When multiple entity fixed field elements are used within the <Get> action, the request will only retrieve policies that satisfy all of the specified criteria.

 

The value to search for. See the entity fixed fields listed below for a complete list of entity fixed fields that can be used in a DISQ request.

 

For example:

<RoleCode>01</RoleCode>

<StatusCode>01</StatusCode>

<ResponseFormat> Optional element:

The <ResponseFormat> section allows the requestor to specify what should be included in the response from the DISQ request. The responses returned from a Get Policy service can contain fixed and dynamic field data for both policies, roles, segments, allocations, benefit splits and withholdings.

Note: If <ResponseFormat> is omitted, then only policy fixed fields are returned, as that is the default response type.

   
<ResponseType>

Optional element:

This element specifies whether only policy fixed fields should be returned from the request, or if other field data should be returned as well.

 

 

Default: Only policy fixed fields will be returned from the request.

Custom: The user can specify policy dynamic fields, as well as fixed or dynamic fields for other entity types, to be returned from the request.

<Policy> Required element:

This element allows policy dynamic fields to be returned when valid child elements are present.

   
<Fields>

Optional element:

This is the container element for the policy dynamic field data that should be returned from the request.

If this element is empty, data for all policy dynamic fields will be returned.

   
<[Policy dynamic field]>

Optional, repeatable element:

The name of each of these elements should be the name of a policy dynamic field. Data will be returned for each policy dynamic field specified.

If the same dynamic field is referenced in multiple elements, the output will contain one instance of the field’s data.

 

 

<[Entities]> Optional, repeatable element:

The presence of this element indicates that entity resources should be filtered or entity data should be returned. Its child elements specify whether all or certain entity fixed field information should be returned.

If there are multiple elements referencing the same entity, only the last element is recognized

   
<[Entity]>

Optional element:

This is the container element for the entity dynamic field data that should be returned from the request.

The element’s name must be the singular form of the containing entities element. If multiple entity elements exist, entity resources that satisfy any one of the <[entity]> criteria set will be returned.

If this element is empty, data for all of the entity's dynamic fields will be returned.

   
<[Entity fixed field]>

Optional, repeatable element:

The name of each of these elements should be the name of an entity fixed field, such as <RoleCode> or <StatusCode>. These elements provide the criteria that filter the data returned in the response.

Multiple fields may be referenced. Entity resources are returned where they satisfy all criteria. If there are multiple elements referencing the same fixed field, only the last is recognized.

 

The value to search for. See the entity fixed fields listed below for a complete list of entity fixed fields that can be used in a DISQ request.

 

For example:

<RoleCode>01</RoleCode>

<StatusCode>01</StatusCode>

<Fields>

Optional element:

This is the container element for the address dynamic field data that should be returned from the request.

If this element is empty, data for all address dynamic fields will be returned.

If there are multiple elements, only the last element is recognized.

   
<[Entity dynamic field]>

Optional, repeatable element:

The name of each of these elements should be the name of an entity dynamic field. Data will be returned for each entity dynamic field specified.

Multiple dynamic fields may be specified. If a dynamic field is repeated by multiple elements, the response will contain only one instance of the field’s data.

 

 

The following elements are only applicable as sub-elements of the <Segment> element.

<Roles>

Optional element:

This element indicates that segment role data should be returned from the request. Its child elements, if present, may filter the segment roles that are returned.

Note: If this element is empty, the request will return all segment role resources and their fixed field data. If multiple <Roles> elements are provided, only the last will be recognized.

   
<Role>

Optional, repeatable element:

This is the container element for the segment role dynamic field data that should be returned from the request.

If this element is repeated, role resources that satisfy any one of the criteria sets are returned in the response.

If this element is empty, only segment role fixed fields will be returned.

   
<[Role fixed Field]>

Optional, repeatable element:

The name of each of these elements should be the name of a segment role field. These elements provide criteria that filter the segment role resources returned in the response.

If multiple role fixed field elements are provided, only segment roles that satisfy all of the specified criteria will be returned.

If multiple elements reference the same field, only the last is recognized.

 

The value to search for. See the Role Fixed Fields listed below for a complete list of entity fixed fields that can be used in a DISQ request.

 

For example:

<RoleCode>01</RoleCode>

<StatusCode>01</StatusCode>

<Fields>

Optional element:

This element indicates which of the segment role's dynamic fields to add to the response. If this element is empty, all the dynamic field data for segment roles are returned.

If this element is repeated, only the last element is recognized.

   
<[Role dynamic field]>

Optional, repeatable element:

The name of each of these elements should be the name of a segment role dynamic field. These elements specify the segment role data that should be returned for the resource.

Multiple fields may be referenced in multiple elements. If multiple elements reference the same field, the response will contain one instance of the field’s data.

 

 

 

Policy Fixed Fields

  • CompanyGuid
  • PlanDate
  • PolicyName
  • UpdatedGmt
  • CreationDate
  • PlanGuid
  • PolicyNumber
  • IssueStateCode
  • PolicyGuid
  • StatusCode

Segment Fixed Fields

  • EffectiveDate
  • SegmentGuid
  • StatusCode
  • ParentSegmentGuid
  • SegmentName
  • XmlData
  • PolicyGuid
  • SegmentNameGuid

Role Fixed Fields

  • ClientGuid
  • PercentDollarCode
  • RoleCode
  • SegmentGuid
  • CompanyGuid
  • PolicyGuid
  • RoleGuid
  • StateCode
  • ExternalClientGuid
  • RoleAmount
  • RolePercent
  • StatusCode

Allocation Fixed Fields

  • AllocationAmount
  • AllocationPercent
  • EffectiveDate
  • PercentInAllocation
  • AllocationGuid
  • AllocationUnits
  • TypeCode
  • FundGuid
  • RelatedGuid
  • AllocationMethodCode
  • CurrencyCode
  • GroupGuid
  • SubAllocationTypeCode

Benefit Split Fixed Fields

  • ActiveFromDate
  • BenefitPercent
  • CurrencyCode
  • GroupGuid
  • StatusCode
  • ActivityGuid
  • BenefitSplitGuid
  • EffectiveDate
  • RelatedGuid
  • TypeCode
  • BenefitAmount
  • BenefitUnits
  • FundGuid
  • ShadowActivityGuid

Withholding Fixed Fields

  • TypeCode
  • WithholdingGuid

XML Schema

<DisqRequest>
<Header>
<MessageId>[message id]</MessageId>
<TimeStamp>[time stamp]</TimeStamp>
</Header>
<Context>
<Company>
<CompanyName>[company name]</CompanyName>
<Plan>
<PlanName>[plan name]</PlanName>
</Plan>
</Company>
</Context>
<Get>
<Policy>
<PolicyGuid>[PolicyGUID]</PolicyGuid>
<policy_fixed_field_1>[value to search]</policy_fixed_field_1>
<policy_fixed_field_n>[value to search]</policy_fixed_field_n>
<entities_1>
<entity_1>
<entity_fixed_field_1>[value to search]</entity_fixed_field_1>
<entity_fixed_field_n>[value to search]</entity_fixed_field_n>
</entity_1>
<entity_1>. . . .</entity_1>
</entities_1>
<entities_n>
<entity_n>. . . .</entity_n>
<entity_n>. . . .</entity_n>
</entities_n>
</Policy>
</Get>
<ResponseFormat>
<ResponseType>[Default | Custom]</ResponseType>
<Policy>
<Fields>
<policy_dynamic_field_1></policy_dynamic_field_1>
<policy_dynamic_field_n></policy_dynamic_field_n>
</Fields>
<entities_1>
<entity_1>
<entity_fixed_field_1>[value to search]</entity_fixed_field_1>
<entity_fixed_field_n>[value to search]</entity_fixed_field_n>
<Fields>
<entity_dynamic_field_1></entity_dynamic_field_1>
<entity_dynamic_field_n></entity_dynamic_field_n>
</Fields>

The configuration below only applies to the segment entity.

<Roles>
<Role>
<Role_fixed_field_1>[value to search]</Role_fixed_field_1>
<Role_fixed_field_n>[value to search]</Role_fixed_field_n>
<Fields>
<Role_dynamic_field_1></Role_dynamic_field_1>
<Role_dynamic_field_n></Role_dynamic_field_n>
</Fields>
</Role>
<Role>. . . .</Role>
</Roles>

This marks the end of the segment-only configuration.

</entity_1>
<entity_1>. . . .</entity_1>
</entities_1>
<entities_n>. . . .</entities_n>
</Policy>
</ResponseFormat>
</DisqRequest>

 

 

 

 

 

Oracle Insurance Logo Copyright © 2017, Oracle and/or its affiliates. All rights reserved. About Oracle Insurance | Contact Us