GET Offer/Product/{client}/{product}?effectiveDate={effectiveDate}

This API provides details about an insurance product.

Request Information

URI Parameters

Name	Description	Type	Additional information
client	The client identification code.	string	Required
product	The product code. Valid product codes can be obtained via the Category API.	string	Required
effectiveDate	The configuration effective date to be used for the product retrieval. This parameter is optional; it exists to allow retrieval of the product data for a specific date, but in most cases it should be omitted.	date	None.

Body Parameters

None.

Response Information

Resource Description

A single object, containing product name, description, a listing of included coverage benefits, and links to the insurance certificate and insurance distribution guide (if available).

Magnesium.Insurance.Contracts.Offers.ProductDetail

Name	Type	Additional information
CertificateUrl	string	None.
DistributionGuideUrl	string	None.
ExclusionsUrl	string	None.
Description	string	None.
IsAnnual	boolean	None.
IsVisitorsToCanada	boolean	None.
IncludesTripCan	boolean	None.
IsMedical	boolean	None.
UseStartDateForEffectiveDate	boolean	None.
SupportsRenewal	boolean	None.
CanBeToppedUp	boolean	None.
CanPurchase	boolean	None.
CanRenew	boolean	None.
Commission	Magnesium.Insurance.Contracts.Offers.ProductCommission	None.
Benefits	Collection of Magnesium.Insurance.Contracts.Offers.ProductBenefit	None.
Consents	Collection of Magnesium.Insurance.Contracts.Offers.ProductConsent	None.
Appropriateness	string	None.
Name	string	None.
ProductCode	string	None.

Response Formats

application/json, text/json, text/html

Sample:

{
  "CertificateUrl": "https://api.allianz-assistance.ca/Offer/Product/SampleClient/SampleProduct/Certificate",
  "DistributionGuideUrl": "https://api.allianz-assistance.ca/Offer/Product/SampleClient/SampleProduct/DistributionGuide",
  "ExclusionsUrl": "https://api.allianz-assistance.ca/Offer/Product/SampleClient/SampleProduct/Exclusions",
  "Description": "Sample Product Description",
  "IsAnnual": false,
  "IsVisitorsToCanada": false,
  "IncludesTripCan": false,
  "IsMedical": false,
  "UseStartDateForEffectiveDate": false,
  "SupportsRenewal": false,
  "CanBeToppedUp": false,
  "CanPurchase": false,
  "CanRenew": false,
  "Commission": {
    "Percentage": 0.0,
    "Description": null
  },
  "Benefits": [
    {
      "Name": "Sample Benefit Name",
      "Limit": "Sample Benefit Limit"
    },
    {
      "Name": "Sample Benefit Name 2",
      "Limit": "Sample Benefit Limit 2"
    }
  ],
  "Consents": [],
  "Appropriateness": null,
  "Name": "Sampple Insurance Product",
  "ProductCode": "SampleProduct"
}