Request Attributes

The following attributes will define the kind of data that can be archived and retrieved and will be included in the post request:

Table - Request Attributes

Attribute	Mandatory/Optional	Description
taskName	Mandatory	Its value needs to be ARCHIVAL.
effectiveTo	Mandatory	A date parameter should be passed and be inclusive. All the archived activities whose effective date is before or on the date passed in the parameter will be archived.
statusCodes	Optional	All the activities with the status codes mentioned in the request body will be archived. By default, the system indicator is Y. Active = 1 Shadow = 12 Pending Shadow = 34 Note: Using any other code will return status 400. By default, activities with code value 01 will be archived.
batchSize	Optional	This parameter will define number of entities (Policy, Client etc.,) that will be grouped together to be processed by a single batch, the default value is 100.
activityLevels	Mandatory	This parameter will define the level of activity for archival, the possible values are POLICY/CLIENT. At least one value needs to be passed with this parameter for the request to be processed. When you provide an invalid activity level in the request, the system will respond with 400 status code with an error message: "Supported activity levels are POLICY AND CLIENT"
entityType	Mandatory	The Entity Type (activity) applicable for the archival request will be passed through the URI.

Table - Retrieval Attributes

Attribute	Mandatory/Optional	Description
taskName	Mandatory	Its value needs to be Retrieval
effectiveTo	Optional	A date parameter should be passed and the date mentioned in the request body will be inclusive. All the archived activities whose effective date is before or on the date passed in the parameter will be retrieved.
policyNumbers	Optional	An array of policy numbers for which archived activities will be retrieved.
policyGuids	Optional	An array of policy GUIDs, (IDs) for which archived activities will be retrieved.
clientGuids	Optional	It is an array of client GUIDS. All archived activities for the clients with the client GUIDs mentioned in the request will be retrieved and combined with effectiveTo parameter. Note: The user has to provide at least one of the parameters among policyNumbers, policyGuids, clientGuids for the request to process. Status 400 is returned when no parameters are passed.
entityType	Mandatory	EntityType (activity) applicable for the retrieval request will be passed through the URI.