Policy In Patch Integration Point
This web service supports the creation and maintenance of Policies. It accepts either an online request for a single Policy or a data file for a set of Policies. To process a file with Policies, start by uploading the data file using the Data File Set web service.
The processing and request format is the same as for the regular Policy In Integration Point, with the following differences:
-
The Policy In Patch IP treats list items in the request differently. Just like in Policy In Integration Point, the system updates existing list items and creates new list items. However, this integration point never deletes existing list items.
-
There is no delete by omission. If an existing element is not included in a list, the element is not deleted. However, if you include an empty list explicitly, all items will be removed.
-
This behavior is applicable for sub-resources, dynamic records and dynamic fields.
-
The list behavior also applies to Person details.
-
Address matching is on address type and start date.
Use this integration point in situations where the payload does not contain all details of a Policy. Typical use cases are:
-
Details of the same Policy are in separate files. For example, one month file that includes only coverage details for the employee and a second-month file that includes only coverage details for dependents.
-
Only changes to an existing Policy are present in the payload. Examples are new enrollments (such as newborns) or address changes.
Online Request Message
The HTTP PUT request to: http://[hostName]:[portNumber]/[api-context-root]/policies enable external systems to create and update Policies.
Each request message contains the details of a single Policy.
Set the header parameter patch to true for invoking the Policy In Patch Integration Point.
An HTTP request without the header parameter starts the Policy In Integration Point.
File Request
Just like the Policy In integration Point, the Policy In Patch supports file based requests. This request enables the handling of multiple Policies in one go. Because this service supports requests with significant volume, it relies on the Data File Set web service to import the Policy payload into the application before it reads and processes the data. Refer to Data File Set Integration Point for more information about how to create a Data File Set.
The patch flag in the request body controls whether the Policy In Patch Integration Point, or the Policy In Integration Point is started.
Patch is true starts the Policy In Patch Integration Point.
The default value for the flag is false.
Each of the data files has <policies> as its root element.
This data file has the following structure:
<policies>
<policy
code=""
elementId=""
>
</policies>