Endpoints

This endpoint retrieves the default product details such as the product Id, product code and product type.

Input parameters: No input.

Output parameters:

• productId - The product Id.

• typeId - The product type.

• productCode - The product code.

This endpoint gets the product items and the covered risks for each of them.

Input parameters: insuranceProductId - The Id of the specific Pet Insurance product.

Output parameters: An array of product item objects. Each product item object contains the following properties:

• code - The code of the item.

• id - The Id of the item.

• name - The name of the item (aka the cover).

• items - An array of objects representing the covered risks within the cover. Each covered risk contains the following properties: id, name, and limit.

This endpoint generates the required input to calculate the price of each cover via the FTOS_IP_PremiumAmountAPI.

Input parameters:

• quoteId - The id of the current quote.

• cover - The specified cover.

Output parameters:

• petType - The type of the pet (dog or cat).

• size - The size of the pet (small, medium or large).

• cover - The specified cover.

• age - The age of the pet.

The FTOS_IP_PremiumAmountAPI endpoint calculates the premium amount for the items included in a product. The endpoint runs the formulas assigned to each item.

Input parameters:

1. insuranceTypeName - The name of an Insurance Type configured in the system and stored on the FTOS_IP_InsuranceType entity.

2. productCode - TheThe code of the insurance product.

3. insuranceProductItemDetails - An array with details needed to identify and run the formulas - namely the code and calculation details, as follows:

3.1. code - The code of the Item.

3.2. calculationsDetails - The calculation details:

3.2.1. petType - The type of the pet (dog or cat).

3.2.2. size - The size of the pet (small, medium or large).

3.2.3. cover - The specified cover.

3.2.4. age - The age of the pet.

Output parameters:

• result - An array of objects containing details about the prices.

• insuranceProductItemFormula - The name of the FTOS_IP_ InsuranceProductItemFormula record, containing the Formula attached to the Item.

• formulaResult - The result returned by the Formula.

This endpoint generates the required input structure to be consumed by the PolicyGenerationAPI - which creates the insurance policy for the quote.

Input parameters: quoteId - The Id of the quote.

Output parameters: An object with all the requested parameters. For more details about the output of this endpoint, see the Pet Insurance Policy Structure page.

This endpoint generates new policies in the core system. The following information is sent in order for the action to be successful.

Input parameters: The object generated by the FTOS_INSQB_GetPolicyInputStructure endpoint - see also the Pet Insurance Policy Structure page.

Output parameters: result - An array of objects containing details about the issued policy:

• policyData - Array of cover details for each generated policy

• policyBeginDate - The policy start date.

• policyEndDate - The policy end date.

• policyId - GUID identifying the policy inside the Core Insurance Master system.

• policyNumber - The policy number.

This endpoint calls the report functionality and generates the Insurance Policy Certificate for the pet owner.

Input parameters: policyId - The Id of the Policy.

Output parameters: Data - The link to the specific report.