GET Offer/Category/{client}/{categoryGroup}?effectiveDate={effectiveDate}

This API provides a list of available products, optionally grouped in a set of product categories, as determined by client configuration.

Request Information

URI Parameters

Name	Description	Type	Additional information
client	The client identification code.	string	Required
categoryGroup	A code which specifies a configured set of products, and the manner of their grouping.	string	Required
effectiveDate	The configuration effective date to be used for the category retrieval. This parameter is optional; it exists to allow retrieval of the product categorization for a specific date, but in most cases it should be omitted.	date	None.

Body Parameters

None.

Response Information

Resource Description

An array of objects, with each containing the category’s name and description, and a list of products included in that category.

Collection of Magnesium.Insurance.Contracts.Offers.Category

Name	Type	Additional information
Name	string	None.
DisplayName	string	None.
Description	string	None.
Products	Collection of Magnesium.Insurance.Contracts.Offers.CategoryProduct	None.

Response Formats

application/json, text/json, text/html

Sample:

[
  {
    "Name": "sample string 1",
    "DisplayName": "sample string 2",
    "Description": "sample string 3",
    "Products": [
      {
        "ProductName": "sample string 1",
        "ProductUrl": "sample string 2"
      },
      {
        "ProductName": "sample string 1",
        "ProductUrl": "sample string 2"
      }
    ]
  },
  {
    "Name": "sample string 1",
    "DisplayName": "sample string 2",
    "Description": "sample string 3",
    "Products": [
      {
        "ProductName": "sample string 1",
        "ProductUrl": "sample string 2"
      },
      {
        "ProductName": "sample string 1",
        "ProductUrl": "sample string 2"
      }
    ]
  }
]