DFS v26.1
Loading
API docs by Redocly

DFS InsurProductConfigurationService API (latest)

Download OpenAPI specification:

Contains functionality around insurance product configuration.

For endpoints that support localization the language can be passed either as a query string parameter (using the name 'language') or in the 'accept-language' header.
If no language is passed to such endpoints then the default configured language will be used.

GlobalData

Retrieve all global reference values

Returns all available global reference values.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "referenceValues": [
    ]
}

Retrieve all global rules

Returns all available global rules.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "rules": [
    ]
}

Retrieves all global composite rules

Returns all available global composite rules.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "compositeRules": [
    ]
}

Retrieve all parameters

Retrieve all available global parameters.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "globalParameter": {
    }
}

Retrieve all composite parameters

Retrieve all available global composite parameters.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "globalParameter": {
    }
}

Retrieve all lookups

Retrieve all available lookups

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "lookups": [
    ]
}

Retrieve all global parameters merged with schema parameters

Retrieve all available global parameters merged with schema parameters

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "parameters": {
    }
}

Retrieve all global composite parameters merged with schema composite parameters

Retrieve all available global composite parameters merged with schema composite parameters

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "compositeParameters": {
    }
}

Retrieve all requested global data

Retrieve all available global data that is being requested.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

Defines data that should be returned

getCompositeParameters
boolean
getParameters
boolean
getReferenceValues
boolean
getRules
boolean
getCompositeRules
boolean
getLookups
boolean
getMergedParameters
boolean
getMergedCompositeParameters
boolean

Responses

Request samples

Content type
{
  • "getCompositeParameters": true,
  • "getParameters": true,
  • "getReferenceValues": true,
  • "getRules": true,
  • "getCompositeRules": true,
  • "getLookups": true,
  • "getMergedParameters": true,
  • "getMergedCompositeParameters": true
}

Response samples

Content type
application/json
{
  • "rules": [
    ],
  • "compositeRules": [
    ],
  • "referenceValues": [
    ],
  • "parametersSchema": {
    },
  • "compositeParametersSchema": {
    },
  • "lookups": [
    ],
  • "mergedParametersSchema": {
    },
  • "mergedCompositeParametersSchema": {
    },
  • "groupCode": "6ee5b9c2-cf46-4d2e-9610-3e18715a8502"
}

Retrieve all requested documents data

Retrieve all available documents data that is being requested

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

Defines data that should be returned

getCategories
boolean

Indicates should categories be retrieved

getDocuments
boolean

Indicates should documents be retrieved

getTemplates
boolean

Indicates should templates be retrieved

getTypes
boolean

Indicates should types be retrieved

isActive
boolean or null

Represents search criteria by IsActive property Relevant for categories retrieval, indirectly for documents retrieval

documentTypeId
integer or null <int32>

Represents search criteria by DocumentTypeId property Relevant for categories retrieval, indirectly for documents retrieval

documentMetadataName
string or null

Represent search criteria by DocumentMetadataName property Relevant for documents retrieval

language
string or null

Represent search criteria by Language property Relevant for categories retrieval, indirectly for documents retrieval

Responses

Request samples

Content type
{
  • "getCategories": true,
  • "getDocuments": true,
  • "getTemplates": true,
  • "getTypes": true,
  • "isActive": true,
  • "documentTypeId": 0,
  • "documentMetadataName": "string",
  • "language": "string"
}

Response samples

Content type
application/json
{
  • "categories": [
    ],
  • "documents": [
    ],
  • "templates": [
    ],
  • "types": [
    ]
}

Retrieve all requested notifications data

Retrieve all available

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
getTypes
boolean

Indicates should types be retrieved

getTypeChannels
boolean

Inidicates should type channels be retrieved

typeKeyPrefix
string or null

Represent search criteria for type key prefix

isActive
boolean or null

Represent search criteria for IsActive property

Responses

Request samples

Content type
{
  • "getTypes": true,
  • "getTypeChannels": true,
  • "typeKeyPrefix": "string",
  • "isActive": true
}

Response samples

Content type
application/json
{
  • "types": [
    ]
}

InsuranceProducts

Get all products

Gets all the products.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "products": [
    ]
}

Create product definition

Create new product definition

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
name
string or null
description
string or null
type
string or null
lineOfBusiness
string or null
insuranceCarrier
string or null
offerIdentifierFormat
string or null
policyIdentifierFormat
string or null
contractIdentifierFormat
string or null
insuranceHolderType
string (InsuranceHolderType)
Enum: "Person" "LegalEntity"
createdBy
integer <int32>
object (ProductBusinessStateMachine)
object (PolicyDuration)
Array of objects or null (Api.Products.Definition.Outputs.Documents.Document)
Array of objects or null (Notification)

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "type": "string",
  • "lineOfBusiness": "string",
  • "insuranceCarrier": "string",
  • "offerIdentifierFormat": "string",
  • "policyIdentifierFormat": "string",
  • "contractIdentifierFormat": "string",
  • "insuranceHolderType": "Person",
  • "createdBy": 0,
  • "businessStateMachine": {
    },
  • "policyDuration": {
    },
  • "documents": [
    ],
  • "notifications": [
    ]
}

Response samples

Content type
application/json
{
  • "code": "f5d62b05-370e-48be-a755-8675ca146431"
}

/v1.0/insuranceproducts/{code}

Authorizations:
Bearer
path Parameters
code
required
string <uuid>
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "productDefinition": {
    }
}

Update product details

Update product details.

Authorizations:
Bearer
path Parameters
code
required
string <uuid>

Product code

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

Patch product definition request

code
string <uuid>
name
string or null
description
string or null
type
string or null
lineOfBusiness
string or null
insuranceCarrier
string or null
offerIdentifierFormat
string or null
policyIdentifierFormat
string or null
contractIdentifierFormat
string or null
status
string (ProductDefinitionStatus)
Enum: "Unknown" "Draft" "Approved" "Rejected" "Obsolete"
insuranceHolderType
string (InsuranceHolderType)
Enum: "Person" "LegalEntity"
createdBy
integer <int32>
object (ProductBusinessStateMachine)
object (PolicyDuration)
Array of objects or null (Api.Products.Definition.Outputs.Documents.Document)
Array of objects or null (Notification)

Responses

Request samples

Content type
{
  • "code": "f5d62b05-370e-48be-a755-8675ca146431",
  • "name": "string",
  • "description": "string",
  • "type": "string",
  • "lineOfBusiness": "string",
  • "insuranceCarrier": "string",
  • "offerIdentifierFormat": "string",
  • "policyIdentifierFormat": "string",
  • "contractIdentifierFormat": "string",
  • "status": "Unknown",
  • "insuranceHolderType": "Person",
  • "createdBy": 0,
  • "businessStateMachine": {
    },
  • "policyDuration": {
    },
  • "documents": [
    ],
  • "notifications": [
    ]
}

Response samples

Content type
application/json
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

GetLatestProductVersion

Authorizations:
Bearer
path Parameters
code
required
string <uuid>
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "code": "f5d62b05-370e-48be-a755-8675ca146431",
  • "productDefinitionCode": "f891b4f7-a4b6-4471-9a82-78ceeece2e46",
  • "productDefinition": {
    },
  • "version": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "createdBy": 0,
  • "status": "Unknown",
  • "statusChangeDate": "2019-08-24T14:15:22Z",
  • "statusChangedBy": 0,
  • "riskParametersSchema": {
    },
  • "pricingOutputSchema": {
    },
  • "backOfficeDataSchema": {
    },
  • "systemDataSchema": {
    },
  • "rules": [
    ],
  • "uwRules": [
    ],
  • "referenceValues": [
    ],
  • "documents": [
    ],
  • "notifications": [
    ]
}

GetProductVersionByProductAndVersionCodes

Authorizations:
Bearer
path Parameters
productCode
required
string <uuid>
productVersion
required
string <uuid>
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "code": "f5d62b05-370e-48be-a755-8675ca146431",
  • "productDefinitionCode": "f891b4f7-a4b6-4471-9a82-78ceeece2e46",
  • "productDefinition": {
    },
  • "version": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "createdBy": 0,
  • "status": "Unknown",
  • "statusChangeDate": "2019-08-24T14:15:22Z",
  • "statusChangedBy": 0,
  • "riskParametersSchema": {
    },
  • "pricingOutputSchema": {
    },
  • "backOfficeDataSchema": {
    },
  • "systemDataSchema": {
    },
  • "rules": [
    ],
  • "uwRules": [
    ],
  • "referenceValues": [
    ],
  • "documents": [
    ],
  • "notifications": [
    ]
}

GetProductVersionByVersionCode

Authorizations:
Bearer
path Parameters
code
required
string <uuid>
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "code": "f5d62b05-370e-48be-a755-8675ca146431",
  • "productDefinitionCode": "f891b4f7-a4b6-4471-9a82-78ceeece2e46",
  • "productDefinition": {
    },
  • "version": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "createdBy": 0,
  • "status": "Unknown",
  • "statusChangeDate": "2019-08-24T14:15:22Z",
  • "statusChangedBy": 0,
  • "riskParametersSchema": {
    },
  • "pricingOutputSchema": {
    },
  • "backOfficeDataSchema": {
    },
  • "systemDataSchema": {
    },
  • "rules": [
    ],
  • "uwRules": [
    ],
  • "referenceValues": [
    ],
  • "documents": [
    ],
  • "notifications": [
    ]
}

Retrieve Compiled global parameters

Authorizations:
Bearer
path Parameters
code
required
string <uuid>
getParameters
required
boolean
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Update product version status

Authorizations:
Bearer
path Parameters
code
required
string <uuid>
versionCode
required
string <uuid>
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
status
string (ProductDefinitionStatus)
Enum: "Unknown" "Draft" "Approved" "Rejected" "Obsolete"

Responses

Request samples

Content type
{
  • "status": "Unknown"
}

Response samples

Content type
application/json
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Search products

Get all products based on search criteria.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
page
integer <int32>
pageSize
integer <int32>

Responses

Request samples

Content type
{
  • "page": 0,
  • "pageSize": 0
}

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "page": 0,
  • "pageSize": 0,
  • "pageCount": 0,
  • "totalCount": 0
}

Update product details

Update product details.

Authorizations:
Bearer
path Parameters
code
required
string <uuid>

Product code

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

Product version request

code
string <uuid>
version
string or null

Formed as x.y.z x -> schema changes y -> rules/reference values changes z -> Documents and notification changes

createdBy
integer <int32>
statusChangeDate
string or null <date-time>
statusChangedBy
integer or null <int32>
object (DataSchemaParameter)
object (DataSchemaParameter)
object (DataSchemaParameter)
object (DataSchemaParameter)
Array of objects or null (ProductVersionRule)
Array of objects or null (ProductVersionRule)
Array of objects or null (ProductVersionReferenceValue)
Array of objects or null (ProductVersionDocument)
Array of objects or null (ProductVersionNotification)

Responses

Request samples

Content type
{
  • "code": "f5d62b05-370e-48be-a755-8675ca146431",
  • "version": "string",
  • "createdBy": 0,
  • "statusChangeDate": "2019-08-24T14:15:22Z",
  • "statusChangedBy": 0,
  • "riskParametersSchema": {
    },
  • "pricingOutputSchema": {
    },
  • "backOfficeDataSchema": {
    },
  • "systemDataSchema": {
    },
  • "rules": [
    ],
  • "uwRules": [
    ],
  • "referenceValues": [
    ],
  • "documents": [
    ],
  • "notifications": [
    ]
}

Response samples

Content type
application/json
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Generate sample JSON model for provided Form.io schema definition

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
schema
required
string non-empty

Responses

Request samples

Content type
{
  • "schema": "string"
}

Response samples

Content type
application/json
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Execute MS rule expressions against provided Form.io schema definition. If there are error they will be returned in response for each rule

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
schema
required
any
required
Array of objects (RuleModel)
Array of objects or null (ReferenceValue)
sampleRequest
string or null

Responses

Request samples

Content type
{
  • "schema": null,
  • "expressions": [
    ],
  • "referenceValues": [
    ],
  • "sampleRequest": "string"
}

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

VerifyRiskParameters

Authorizations:
Bearer
path Parameters
productCode
required
string <uuid>
productVersion
required
string <uuid>
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
additional property
object (JsonNode)

Responses

Request samples

Content type
{
  • "property1": {
    },
  • "property2": {
    }
}

Response samples

Content type
application/json
{
  • "modelValidationErrors": [
    ],
  • "ruleError": "string",
  • "isModelInvalid": true,
  • "areRulesInvalid": true
}

Search product versions

Retrieve all product versions filtered by parameters

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
page
integer <int32>
pageSize
integer <int32>
productDefinitionCode
string <uuid>
status
string (ProductDefinitionStatus)
Enum: "Unknown" "Draft" "Approved" "Rejected" "Obsolete"

Responses

Request samples

Content type
{
  • "page": 0,
  • "pageSize": 0,
  • "productDefinitionCode": "f891b4f7-a4b6-4471-9a82-78ceeece2e46",
  • "status": "Unknown"
}

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "page": 0,
  • "pageSize": 0,
  • "pageCount": 0,
  • "totalCount": 0
}