CDR Experimantal Home Insurance API

Home

getProduct

Get Home Insurance Product Detail

Obtain detailed information on a single home insurance product offered openly to the market


/insurance/home/products/{productId}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"https://data.holder.com.au/cds-au/v1/insurance/home/products/{productId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HomeApi;

import java.io.File;
import java.util.*;

public class HomeApiExample {

    public static void main(String[] args) {
        
        HomeApi apiInstance = new HomeApi();
        String productId = productId_example; // String | ID of the specific product requested
        String xV = xV_example; // String | Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
        String xMinV = xMinV_example; // String | Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
        try {
            InsuranceHomeProductResponse result = apiInstance.getProduct(productId, xV, xMinV);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HomeApi#getProduct");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HomeApi;

public class HomeApiExample {

    public static void main(String[] args) {
        HomeApi apiInstance = new HomeApi();
        String productId = productId_example; // String | ID of the specific product requested
        String xV = xV_example; // String | Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
        String xMinV = xMinV_example; // String | Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
        try {
            InsuranceHomeProductResponse result = apiInstance.getProduct(productId, xV, xMinV);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HomeApi#getProduct");
            e.printStackTrace();
        }
    }
}
String *productId = productId_example; // ID of the specific product requested
String *xV = xV_example; // Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
String *xMinV = xMinV_example; // Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. (optional)

HomeApi *apiInstance = [[HomeApi alloc] init];

// Get Home Insurance Product Detail
[apiInstance getProductWith:productId
    xV:xV
    xMinV:xMinV
              completionHandler: ^(InsuranceHomeProductResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdrExperimantalHomeInsuranceApi = require('cdr_experimantal_home_insurance_api');

var api = new CdrExperimantalHomeInsuranceApi.HomeApi()
var productId = productId_example; // {{String}} ID of the specific product requested
var xV = xV_example; // {{String}} Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
var opts = { 
  'xMinV': xMinV_example // {{String}} Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProduct(productId, xV, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getProductExample
    {
        public void main()
        {

            var apiInstance = new HomeApi();
            var productId = productId_example;  // String | ID of the specific product requested
            var xV = xV_example;  // String | Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
            var xMinV = xMinV_example;  // String | Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. (optional) 

            try
            {
                // Get Home Insurance Product Detail
                InsuranceHomeProductResponse result = apiInstance.getProduct(productId, xV, xMinV);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HomeApi.getProduct: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiHomeApi();
$productId = productId_example; // String | ID of the specific product requested
$xV = xV_example; // String | Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
$xMinV = xMinV_example; // String | Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

try {
    $result = $api_instance->getProduct($productId, $xV, $xMinV);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HomeApi->getProduct: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HomeApi;

my $api_instance = WWW::SwaggerClient::HomeApi->new();
my $productId = productId_example; # String | ID of the specific product requested
my $xV = xV_example; # String | Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
my $xMinV = xMinV_example; # String | Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

eval { 
    my $result = $api_instance->getProduct(productId => $productId, xV => $xV, xMinV => $xMinV);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HomeApi->getProduct: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.HomeApi()
productId = productId_example # String | ID of the specific product requested
xV = xV_example # String | Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
xMinV = xMinV_example # String | Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. (optional)

try: 
    # Get Home Insurance Product Detail
    api_response = api_instance.get_product(productId, xV, xMinV=xMinV)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HomeApi->getProduct: %s\n" % e)

Parameters

Path parameters
Name Description
productId*
String
ID of the specific product requested
Required
Header parameters
Name Description
x-v*
String
Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
Required
x-min-v
String
Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

Responses

Status: 200 - Successful response

Name Type Format Description
x-v String The [version](#response-headers) of the API end point that the data holder has responded with.

Status: 400 - The following error codes MUST be supported:<br/><ul class="error-code-list"><li>[400 - Invalid Field](#error-400-field-invalid)</li><li>[400 - Missing Field](#error-400-field-missing)</li><li>[400 - Invalid Version](#error-400-header-invalid-version)</li></ul>

Status: 404 - The following error codes MUST be supported:<br/><ul class="error-code-list"><li>[404 - Invalid Resource](#error-404-resource-invalid)</li></ul>

Status: 406 - The following error codes MUST be supported:<br/><ul class="error-code-list"><li>[406 - Unsupported Version](#error-406-header-unsupported-version)</li></ul>


listProducts

Get Home Insurance Products

Obtain a list of home insurance products that are currently offered to the market. Note that the results returned by this end point are expected to be ordered in descending order according to `lastUpdated`.


/insurance/home/products

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"https://data.holder.com.au/cds-au/v1/insurance/home/products?insuranceType=&effective=&updated-since=&page=&page-size="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HomeApi;

import java.io.File;
import java.util.*;

public class HomeApiExample {

    public static void main(String[] args) {
        
        HomeApi apiInstance = new HomeApi();
        String xV = xV_example; // String | Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
        String insuranceType = insuranceType_example; // String | Used to filter results on the insurance type field. Any one of the valid values for this field can be supplied. If absent, defaults to include ALL products.
        String effective = effective_example; // String | Allows for the filtering of productd based on whether the current time is within the period of time defined as effective by the effectiveFrom and effectiveTo fields. Valid values are ‘CURRENT’, ‘FUTURE’ and ‘ALL’. If absent defaults to 'CURRENT'
        String updatedSince = updatedSince_example; // String | Only include products that have been updated after the specified date and time.  If absent defaults to include all plans
        Integer page = 56; // Integer | Page of results to request (standard pagination)
        Integer pageSize = 56; // Integer | Page size to request.  Default is 25 (standard pagination)
        String xMinV = xMinV_example; // String | Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
        try {
            InsuranceHomeProductListResponse result = apiInstance.listProducts(xV, insuranceType, effective, updatedSince, page, pageSize, xMinV);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HomeApi#listProducts");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HomeApi;

public class HomeApiExample {

    public static void main(String[] args) {
        HomeApi apiInstance = new HomeApi();
        String xV = xV_example; // String | Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
        String insuranceType = insuranceType_example; // String | Used to filter results on the insurance type field. Any one of the valid values for this field can be supplied. If absent, defaults to include ALL products.
        String effective = effective_example; // String | Allows for the filtering of productd based on whether the current time is within the period of time defined as effective by the effectiveFrom and effectiveTo fields. Valid values are ‘CURRENT’, ‘FUTURE’ and ‘ALL’. If absent defaults to 'CURRENT'
        String updatedSince = updatedSince_example; // String | Only include products that have been updated after the specified date and time.  If absent defaults to include all plans
        Integer page = 56; // Integer | Page of results to request (standard pagination)
        Integer pageSize = 56; // Integer | Page size to request.  Default is 25 (standard pagination)
        String xMinV = xMinV_example; // String | Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
        try {
            InsuranceHomeProductListResponse result = apiInstance.listProducts(xV, insuranceType, effective, updatedSince, page, pageSize, xMinV);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HomeApi#listProducts");
            e.printStackTrace();
        }
    }
}
String *xV = xV_example; // Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
String *insuranceType = insuranceType_example; // Used to filter results on the insurance type field. Any one of the valid values for this field can be supplied. If absent, defaults to include ALL products. (optional) (default to ALL)
String *effective = effective_example; // Allows for the filtering of productd based on whether the current time is within the period of time defined as effective by the effectiveFrom and effectiveTo fields. Valid values are ‘CURRENT’, ‘FUTURE’ and ‘ALL’. If absent defaults to 'CURRENT' (optional) (default to CURRENT)
String *updatedSince = updatedSince_example; // Only include products that have been updated after the specified date and time.  If absent defaults to include all plans (optional)
Integer *page = 56; // Page of results to request (standard pagination) (optional)
Integer *pageSize = 56; // Page size to request.  Default is 25 (standard pagination) (optional)
String *xMinV = xMinV_example; // Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. (optional)

HomeApi *apiInstance = [[HomeApi alloc] init];

// Get Home Insurance Products
[apiInstance listProductsWith:xV
    insuranceType:insuranceType
    effective:effective
    updatedSince:updatedSince
    page:page
    pageSize:pageSize
    xMinV:xMinV
              completionHandler: ^(InsuranceHomeProductListResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdrExperimantalHomeInsuranceApi = require('cdr_experimantal_home_insurance_api');

var api = new CdrExperimantalHomeInsuranceApi.HomeApi()
var xV = xV_example; // {{String}} Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
var opts = { 
  'insuranceType': insuranceType_example, // {{String}} Used to filter results on the insurance type field. Any one of the valid values for this field can be supplied. If absent, defaults to include ALL products.
  'effective': effective_example, // {{String}} Allows for the filtering of productd based on whether the current time is within the period of time defined as effective by the effectiveFrom and effectiveTo fields. Valid values are ‘CURRENT’, ‘FUTURE’ and ‘ALL’. If absent defaults to 'CURRENT'
  'updatedSince': updatedSince_example, // {{String}} Only include products that have been updated after the specified date and time.  If absent defaults to include all plans
  'page': 56, // {{Integer}} Page of results to request (standard pagination)
  'pageSize': 56, // {{Integer}} Page size to request.  Default is 25 (standard pagination)
  'xMinV': xMinV_example // {{String}} Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listProducts(xV, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listProductsExample
    {
        public void main()
        {

            var apiInstance = new HomeApi();
            var xV = xV_example;  // String | Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
            var insuranceType = insuranceType_example;  // String | Used to filter results on the insurance type field. Any one of the valid values for this field can be supplied. If absent, defaults to include ALL products. (optional)  (default to ALL)
            var effective = effective_example;  // String | Allows for the filtering of productd based on whether the current time is within the period of time defined as effective by the effectiveFrom and effectiveTo fields. Valid values are ‘CURRENT’, ‘FUTURE’ and ‘ALL’. If absent defaults to 'CURRENT' (optional)  (default to CURRENT)
            var updatedSince = updatedSince_example;  // String | Only include products that have been updated after the specified date and time.  If absent defaults to include all plans (optional) 
            var page = 56;  // Integer | Page of results to request (standard pagination) (optional) 
            var pageSize = 56;  // Integer | Page size to request.  Default is 25 (standard pagination) (optional) 
            var xMinV = xMinV_example;  // String | Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. (optional) 

            try
            {
                // Get Home Insurance Products
                InsuranceHomeProductListResponse result = apiInstance.listProducts(xV, insuranceType, effective, updatedSince, page, pageSize, xMinV);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HomeApi.listProducts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiHomeApi();
$xV = xV_example; // String | Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
$insuranceType = insuranceType_example; // String | Used to filter results on the insurance type field. Any one of the valid values for this field can be supplied. If absent, defaults to include ALL products.
$effective = effective_example; // String | Allows for the filtering of productd based on whether the current time is within the period of time defined as effective by the effectiveFrom and effectiveTo fields. Valid values are ‘CURRENT’, ‘FUTURE’ and ‘ALL’. If absent defaults to 'CURRENT'
$updatedSince = updatedSince_example; // String | Only include products that have been updated after the specified date and time.  If absent defaults to include all plans
$page = 56; // Integer | Page of results to request (standard pagination)
$pageSize = 56; // Integer | Page size to request.  Default is 25 (standard pagination)
$xMinV = xMinV_example; // String | Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

try {
    $result = $api_instance->listProducts($xV, $insuranceType, $effective, $updatedSince, $page, $pageSize, $xMinV);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HomeApi->listProducts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HomeApi;

my $api_instance = WWW::SwaggerClient::HomeApi->new();
my $xV = xV_example; # String | Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
my $insuranceType = insuranceType_example; # String | Used to filter results on the insurance type field. Any one of the valid values for this field can be supplied. If absent, defaults to include ALL products.
my $effective = effective_example; # String | Allows for the filtering of productd based on whether the current time is within the period of time defined as effective by the effectiveFrom and effectiveTo fields. Valid values are ‘CURRENT’, ‘FUTURE’ and ‘ALL’. If absent defaults to 'CURRENT'
my $updatedSince = updatedSince_example; # String | Only include products that have been updated after the specified date and time.  If absent defaults to include all plans
my $page = 56; # Integer | Page of results to request (standard pagination)
my $pageSize = 56; # Integer | Page size to request.  Default is 25 (standard pagination)
my $xMinV = xMinV_example; # String | Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

eval { 
    my $result = $api_instance->listProducts(xV => $xV, insuranceType => $insuranceType, effective => $effective, updatedSince => $updatedSince, page => $page, pageSize => $pageSize, xMinV => $xMinV);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HomeApi->listProducts: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.HomeApi()
xV = xV_example # String | Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
insuranceType = insuranceType_example # String | Used to filter results on the insurance type field. Any one of the valid values for this field can be supplied. If absent, defaults to include ALL products. (optional) (default to ALL)
effective = effective_example # String | Allows for the filtering of productd based on whether the current time is within the period of time defined as effective by the effectiveFrom and effectiveTo fields. Valid values are ‘CURRENT’, ‘FUTURE’ and ‘ALL’. If absent defaults to 'CURRENT' (optional) (default to CURRENT)
updatedSince = updatedSince_example # String | Only include products that have been updated after the specified date and time.  If absent defaults to include all plans (optional)
page = 56 # Integer | Page of results to request (standard pagination) (optional)
pageSize = 56 # Integer | Page size to request.  Default is 25 (standard pagination) (optional)
xMinV = xMinV_example # String | Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. (optional)

try: 
    # Get Home Insurance Products
    api_response = api_instance.list_products(xV, insuranceType=insuranceType, effective=effective, updatedSince=updatedSince, page=page, pageSize=pageSize, xMinV=xMinV)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HomeApi->listProducts: %s\n" % e)

Parameters

Header parameters
Name Description
x-v*
String
Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
Required
x-min-v
String
Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
Query parameters
Name Description
insuranceType
String
Used to filter results on the insurance type field. Any one of the valid values for this field can be supplied. If absent, defaults to include ALL products.
effective
String
Allows for the filtering of productd based on whether the current time is within the period of time defined as effective by the effectiveFrom and effectiveTo fields. Valid values are ‘CURRENT’, ‘FUTURE’ and ‘ALL’. If absent defaults to 'CURRENT'
updated-since
String
Only include products that have been updated after the specified date and time. If absent defaults to include all plans
page
Integer
Page of results to request (standard pagination)
page-size
Integer
Page size to request. Default is 25 (standard pagination)

Responses

Status: 200 - Successful response

Name Type Format Description
x-v String The [version](#response-headers) of the API end point that the data holder has responded with.

Status: 400 - The following error codes MUST be supported:<br/><ul class="error-code-list"><li>[400 - Invalid Field](#error-400-field-invalid)</li><li>[400 - Missing Field](#error-400-field-missing)</li><li>[400 - Invalid Page Size](#error-400-field-invalid-page-size)</li><li>[400 - Invalid Version](#error-400-header-invalid-version)</li></ul>

Status: 406 - The following error codes MUST be supported:<br/><ul class="error-code-list"><li>[406 - Unsupported Version](#error-406-header-unsupported-version)</li></ul>

Status: 422 - The following error codes MUST be supported:<br/><ul class="error-code-list"><li>[422 - Invalid Page](#error-422-field-invalid-page)</li></ul>


Insurance

getProduct

Get Home Insurance Product Detail

Obtain detailed information on a single home insurance product offered openly to the market


/insurance/home/products/{productId}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"https://data.holder.com.au/cds-au/v1/insurance/home/products/{productId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InsuranceApi;

import java.io.File;
import java.util.*;

public class InsuranceApiExample {

    public static void main(String[] args) {
        
        InsuranceApi apiInstance = new InsuranceApi();
        String productId = productId_example; // String | ID of the specific product requested
        String xV = xV_example; // String | Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
        String xMinV = xMinV_example; // String | Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
        try {
            InsuranceHomeProductResponse result = apiInstance.getProduct(productId, xV, xMinV);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InsuranceApi#getProduct");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InsuranceApi;

public class InsuranceApiExample {

    public static void main(String[] args) {
        InsuranceApi apiInstance = new InsuranceApi();
        String productId = productId_example; // String | ID of the specific product requested
        String xV = xV_example; // String | Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
        String xMinV = xMinV_example; // String | Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
        try {
            InsuranceHomeProductResponse result = apiInstance.getProduct(productId, xV, xMinV);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InsuranceApi#getProduct");
            e.printStackTrace();
        }
    }
}
String *productId = productId_example; // ID of the specific product requested
String *xV = xV_example; // Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
String *xMinV = xMinV_example; // Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. (optional)

InsuranceApi *apiInstance = [[InsuranceApi alloc] init];

// Get Home Insurance Product Detail
[apiInstance getProductWith:productId
    xV:xV
    xMinV:xMinV
              completionHandler: ^(InsuranceHomeProductResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdrExperimantalHomeInsuranceApi = require('cdr_experimantal_home_insurance_api');

var api = new CdrExperimantalHomeInsuranceApi.InsuranceApi()
var productId = productId_example; // {{String}} ID of the specific product requested
var xV = xV_example; // {{String}} Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
var opts = { 
  'xMinV': xMinV_example // {{String}} Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProduct(productId, xV, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getProductExample
    {
        public void main()
        {

            var apiInstance = new InsuranceApi();
            var productId = productId_example;  // String | ID of the specific product requested
            var xV = xV_example;  // String | Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
            var xMinV = xMinV_example;  // String | Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. (optional) 

            try
            {
                // Get Home Insurance Product Detail
                InsuranceHomeProductResponse result = apiInstance.getProduct(productId, xV, xMinV);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InsuranceApi.getProduct: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiInsuranceApi();
$productId = productId_example; // String | ID of the specific product requested
$xV = xV_example; // String | Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
$xMinV = xMinV_example; // String | Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

try {
    $result = $api_instance->getProduct($productId, $xV, $xMinV);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InsuranceApi->getProduct: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InsuranceApi;

my $api_instance = WWW::SwaggerClient::InsuranceApi->new();
my $productId = productId_example; # String | ID of the specific product requested
my $xV = xV_example; # String | Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
my $xMinV = xMinV_example; # String | Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

eval { 
    my $result = $api_instance->getProduct(productId => $productId, xV => $xV, xMinV => $xMinV);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InsuranceApi->getProduct: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.InsuranceApi()
productId = productId_example # String | ID of the specific product requested
xV = xV_example # String | Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
xMinV = xMinV_example # String | Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. (optional)

try: 
    # Get Home Insurance Product Detail
    api_response = api_instance.get_product(productId, xV, xMinV=xMinV)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InsuranceApi->getProduct: %s\n" % e)

Parameters

Path parameters
Name Description
productId*
String
ID of the specific product requested
Required
Header parameters
Name Description
x-v*
String
Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
Required
x-min-v
String
Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

Responses

Status: 200 - Successful response

Name Type Format Description
x-v String The [version](#response-headers) of the API end point that the data holder has responded with.

Status: 400 - The following error codes MUST be supported:<br/><ul class="error-code-list"><li>[400 - Invalid Field](#error-400-field-invalid)</li><li>[400 - Missing Field](#error-400-field-missing)</li><li>[400 - Invalid Version](#error-400-header-invalid-version)</li></ul>

Status: 404 - The following error codes MUST be supported:<br/><ul class="error-code-list"><li>[404 - Invalid Resource](#error-404-resource-invalid)</li></ul>

Status: 406 - The following error codes MUST be supported:<br/><ul class="error-code-list"><li>[406 - Unsupported Version](#error-406-header-unsupported-version)</li></ul>


listProducts

Get Home Insurance Products

Obtain a list of home insurance products that are currently offered to the market. Note that the results returned by this end point are expected to be ordered in descending order according to `lastUpdated`.


/insurance/home/products

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"https://data.holder.com.au/cds-au/v1/insurance/home/products?insuranceType=&effective=&updated-since=&page=&page-size="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InsuranceApi;

import java.io.File;
import java.util.*;

public class InsuranceApiExample {

    public static void main(String[] args) {
        
        InsuranceApi apiInstance = new InsuranceApi();
        String xV = xV_example; // String | Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
        String insuranceType = insuranceType_example; // String | Used to filter results on the insurance type field. Any one of the valid values for this field can be supplied. If absent, defaults to include ALL products.
        String effective = effective_example; // String | Allows for the filtering of productd based on whether the current time is within the period of time defined as effective by the effectiveFrom and effectiveTo fields. Valid values are ‘CURRENT’, ‘FUTURE’ and ‘ALL’. If absent defaults to 'CURRENT'
        String updatedSince = updatedSince_example; // String | Only include products that have been updated after the specified date and time.  If absent defaults to include all plans
        Integer page = 56; // Integer | Page of results to request (standard pagination)
        Integer pageSize = 56; // Integer | Page size to request.  Default is 25 (standard pagination)
        String xMinV = xMinV_example; // String | Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
        try {
            InsuranceHomeProductListResponse result = apiInstance.listProducts(xV, insuranceType, effective, updatedSince, page, pageSize, xMinV);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InsuranceApi#listProducts");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InsuranceApi;

public class InsuranceApiExample {

    public static void main(String[] args) {
        InsuranceApi apiInstance = new InsuranceApi();
        String xV = xV_example; // String | Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
        String insuranceType = insuranceType_example; // String | Used to filter results on the insurance type field. Any one of the valid values for this field can be supplied. If absent, defaults to include ALL products.
        String effective = effective_example; // String | Allows for the filtering of productd based on whether the current time is within the period of time defined as effective by the effectiveFrom and effectiveTo fields. Valid values are ‘CURRENT’, ‘FUTURE’ and ‘ALL’. If absent defaults to 'CURRENT'
        String updatedSince = updatedSince_example; // String | Only include products that have been updated after the specified date and time.  If absent defaults to include all plans
        Integer page = 56; // Integer | Page of results to request (standard pagination)
        Integer pageSize = 56; // Integer | Page size to request.  Default is 25 (standard pagination)
        String xMinV = xMinV_example; // String | Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
        try {
            InsuranceHomeProductListResponse result = apiInstance.listProducts(xV, insuranceType, effective, updatedSince, page, pageSize, xMinV);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InsuranceApi#listProducts");
            e.printStackTrace();
        }
    }
}
String *xV = xV_example; // Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
String *insuranceType = insuranceType_example; // Used to filter results on the insurance type field. Any one of the valid values for this field can be supplied. If absent, defaults to include ALL products. (optional) (default to ALL)
String *effective = effective_example; // Allows for the filtering of productd based on whether the current time is within the period of time defined as effective by the effectiveFrom and effectiveTo fields. Valid values are ‘CURRENT’, ‘FUTURE’ and ‘ALL’. If absent defaults to 'CURRENT' (optional) (default to CURRENT)
String *updatedSince = updatedSince_example; // Only include products that have been updated after the specified date and time.  If absent defaults to include all plans (optional)
Integer *page = 56; // Page of results to request (standard pagination) (optional)
Integer *pageSize = 56; // Page size to request.  Default is 25 (standard pagination) (optional)
String *xMinV = xMinV_example; // Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. (optional)

InsuranceApi *apiInstance = [[InsuranceApi alloc] init];

// Get Home Insurance Products
[apiInstance listProductsWith:xV
    insuranceType:insuranceType
    effective:effective
    updatedSince:updatedSince
    page:page
    pageSize:pageSize
    xMinV:xMinV
              completionHandler: ^(InsuranceHomeProductListResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdrExperimantalHomeInsuranceApi = require('cdr_experimantal_home_insurance_api');

var api = new CdrExperimantalHomeInsuranceApi.InsuranceApi()
var xV = xV_example; // {{String}} Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
var opts = { 
  'insuranceType': insuranceType_example, // {{String}} Used to filter results on the insurance type field. Any one of the valid values for this field can be supplied. If absent, defaults to include ALL products.
  'effective': effective_example, // {{String}} Allows for the filtering of productd based on whether the current time is within the period of time defined as effective by the effectiveFrom and effectiveTo fields. Valid values are ‘CURRENT’, ‘FUTURE’ and ‘ALL’. If absent defaults to 'CURRENT'
  'updatedSince': updatedSince_example, // {{String}} Only include products that have been updated after the specified date and time.  If absent defaults to include all plans
  'page': 56, // {{Integer}} Page of results to request (standard pagination)
  'pageSize': 56, // {{Integer}} Page size to request.  Default is 25 (standard pagination)
  'xMinV': xMinV_example // {{String}} Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listProducts(xV, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listProductsExample
    {
        public void main()
        {

            var apiInstance = new InsuranceApi();
            var xV = xV_example;  // String | Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
            var insuranceType = insuranceType_example;  // String | Used to filter results on the insurance type field. Any one of the valid values for this field can be supplied. If absent, defaults to include ALL products. (optional)  (default to ALL)
            var effective = effective_example;  // String | Allows for the filtering of productd based on whether the current time is within the period of time defined as effective by the effectiveFrom and effectiveTo fields. Valid values are ‘CURRENT’, ‘FUTURE’ and ‘ALL’. If absent defaults to 'CURRENT' (optional)  (default to CURRENT)
            var updatedSince = updatedSince_example;  // String | Only include products that have been updated after the specified date and time.  If absent defaults to include all plans (optional) 
            var page = 56;  // Integer | Page of results to request (standard pagination) (optional) 
            var pageSize = 56;  // Integer | Page size to request.  Default is 25 (standard pagination) (optional) 
            var xMinV = xMinV_example;  // String | Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. (optional) 

            try
            {
                // Get Home Insurance Products
                InsuranceHomeProductListResponse result = apiInstance.listProducts(xV, insuranceType, effective, updatedSince, page, pageSize, xMinV);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InsuranceApi.listProducts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiInsuranceApi();
$xV = xV_example; // String | Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
$insuranceType = insuranceType_example; // String | Used to filter results on the insurance type field. Any one of the valid values for this field can be supplied. If absent, defaults to include ALL products.
$effective = effective_example; // String | Allows for the filtering of productd based on whether the current time is within the period of time defined as effective by the effectiveFrom and effectiveTo fields. Valid values are ‘CURRENT’, ‘FUTURE’ and ‘ALL’. If absent defaults to 'CURRENT'
$updatedSince = updatedSince_example; // String | Only include products that have been updated after the specified date and time.  If absent defaults to include all plans
$page = 56; // Integer | Page of results to request (standard pagination)
$pageSize = 56; // Integer | Page size to request.  Default is 25 (standard pagination)
$xMinV = xMinV_example; // String | Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

try {
    $result = $api_instance->listProducts($xV, $insuranceType, $effective, $updatedSince, $page, $pageSize, $xMinV);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InsuranceApi->listProducts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InsuranceApi;

my $api_instance = WWW::SwaggerClient::InsuranceApi->new();
my $xV = xV_example; # String | Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
my $insuranceType = insuranceType_example; # String | Used to filter results on the insurance type field. Any one of the valid values for this field can be supplied. If absent, defaults to include ALL products.
my $effective = effective_example; # String | Allows for the filtering of productd based on whether the current time is within the period of time defined as effective by the effectiveFrom and effectiveTo fields. Valid values are ‘CURRENT’, ‘FUTURE’ and ‘ALL’. If absent defaults to 'CURRENT'
my $updatedSince = updatedSince_example; # String | Only include products that have been updated after the specified date and time.  If absent defaults to include all plans
my $page = 56; # Integer | Page of results to request (standard pagination)
my $pageSize = 56; # Integer | Page size to request.  Default is 25 (standard pagination)
my $xMinV = xMinV_example; # String | Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

eval { 
    my $result = $api_instance->listProducts(xV => $xV, insuranceType => $insuranceType, effective => $effective, updatedSince => $updatedSince, page => $page, pageSize => $pageSize, xMinV => $xMinV);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InsuranceApi->listProducts: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.InsuranceApi()
xV = xV_example # String | Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
insuranceType = insuranceType_example # String | Used to filter results on the insurance type field. Any one of the valid values for this field can be supplied. If absent, defaults to include ALL products. (optional) (default to ALL)
effective = effective_example # String | Allows for the filtering of productd based on whether the current time is within the period of time defined as effective by the effectiveFrom and effectiveTo fields. Valid values are ‘CURRENT’, ‘FUTURE’ and ‘ALL’. If absent defaults to 'CURRENT' (optional) (default to CURRENT)
updatedSince = updatedSince_example # String | Only include products that have been updated after the specified date and time.  If absent defaults to include all plans (optional)
page = 56 # Integer | Page of results to request (standard pagination) (optional)
pageSize = 56 # Integer | Page size to request.  Default is 25 (standard pagination) (optional)
xMinV = xMinV_example # String | Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. (optional)

try: 
    # Get Home Insurance Products
    api_response = api_instance.list_products(xV, insuranceType=insuranceType, effective=effective, updatedSince=updatedSince, page=page, pageSize=pageSize, xMinV=xMinV)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InsuranceApi->listProducts: %s\n" % e)

Parameters

Header parameters
Name Description
x-v*
String
Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
Required
x-min-v
String
Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
Query parameters
Name Description
insuranceType
String
Used to filter results on the insurance type field. Any one of the valid values for this field can be supplied. If absent, defaults to include ALL products.
effective
String
Allows for the filtering of productd based on whether the current time is within the period of time defined as effective by the effectiveFrom and effectiveTo fields. Valid values are ‘CURRENT’, ‘FUTURE’ and ‘ALL’. If absent defaults to 'CURRENT'
updated-since
String
Only include products that have been updated after the specified date and time. If absent defaults to include all plans
page
Integer
Page of results to request (standard pagination)
page-size
Integer
Page size to request. Default is 25 (standard pagination)

Responses

Status: 200 - Successful response

Name Type Format Description
x-v String The [version](#response-headers) of the API end point that the data holder has responded with.

Status: 400 - The following error codes MUST be supported:<br/><ul class="error-code-list"><li>[400 - Invalid Field](#error-400-field-invalid)</li><li>[400 - Missing Field](#error-400-field-missing)</li><li>[400 - Invalid Page Size](#error-400-field-invalid-page-size)</li><li>[400 - Invalid Version](#error-400-header-invalid-version)</li></ul>

Status: 406 - The following error codes MUST be supported:<br/><ul class="error-code-list"><li>[406 - Unsupported Version](#error-406-header-unsupported-version)</li></ul>

Status: 422 - The following error codes MUST be supported:<br/><ul class="error-code-list"><li>[422 - Invalid Page](#error-422-field-invalid-page)</li></ul>


Products

getProduct

Get Home Insurance Product Detail

Obtain detailed information on a single home insurance product offered openly to the market


/insurance/home/products/{productId}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"https://data.holder.com.au/cds-au/v1/insurance/home/products/{productId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProductsApi;

import java.io.File;
import java.util.*;

public class ProductsApiExample {

    public static void main(String[] args) {
        
        ProductsApi apiInstance = new ProductsApi();
        String productId = productId_example; // String | ID of the specific product requested
        String xV = xV_example; // String | Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
        String xMinV = xMinV_example; // String | Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
        try {
            InsuranceHomeProductResponse result = apiInstance.getProduct(productId, xV, xMinV);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#getProduct");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductsApi;

public class ProductsApiExample {

    public static void main(String[] args) {
        ProductsApi apiInstance = new ProductsApi();
        String productId = productId_example; // String | ID of the specific product requested
        String xV = xV_example; // String | Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
        String xMinV = xMinV_example; // String | Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
        try {
            InsuranceHomeProductResponse result = apiInstance.getProduct(productId, xV, xMinV);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#getProduct");
            e.printStackTrace();
        }
    }
}
String *productId = productId_example; // ID of the specific product requested
String *xV = xV_example; // Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
String *xMinV = xMinV_example; // Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. (optional)

ProductsApi *apiInstance = [[ProductsApi alloc] init];

// Get Home Insurance Product Detail
[apiInstance getProductWith:productId
    xV:xV
    xMinV:xMinV
              completionHandler: ^(InsuranceHomeProductResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdrExperimantalHomeInsuranceApi = require('cdr_experimantal_home_insurance_api');

var api = new CdrExperimantalHomeInsuranceApi.ProductsApi()
var productId = productId_example; // {{String}} ID of the specific product requested
var xV = xV_example; // {{String}} Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
var opts = { 
  'xMinV': xMinV_example // {{String}} Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProduct(productId, xV, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getProductExample
    {
        public void main()
        {

            var apiInstance = new ProductsApi();
            var productId = productId_example;  // String | ID of the specific product requested
            var xV = xV_example;  // String | Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
            var xMinV = xMinV_example;  // String | Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. (optional) 

            try
            {
                // Get Home Insurance Product Detail
                InsuranceHomeProductResponse result = apiInstance.getProduct(productId, xV, xMinV);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductsApi.getProduct: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiProductsApi();
$productId = productId_example; // String | ID of the specific product requested
$xV = xV_example; // String | Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
$xMinV = xMinV_example; // String | Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

try {
    $result = $api_instance->getProduct($productId, $xV, $xMinV);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductsApi->getProduct: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProductsApi;

my $api_instance = WWW::SwaggerClient::ProductsApi->new();
my $productId = productId_example; # String | ID of the specific product requested
my $xV = xV_example; # String | Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
my $xMinV = xMinV_example; # String | Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

eval { 
    my $result = $api_instance->getProduct(productId => $productId, xV => $xV, xMinV => $xMinV);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProductsApi->getProduct: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ProductsApi()
productId = productId_example # String | ID of the specific product requested
xV = xV_example # String | Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
xMinV = xMinV_example # String | Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. (optional)

try: 
    # Get Home Insurance Product Detail
    api_response = api_instance.get_product(productId, xV, xMinV=xMinV)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductsApi->getProduct: %s\n" % e)

Parameters

Path parameters
Name Description
productId*
String
ID of the specific product requested
Required
Header parameters
Name Description
x-v*
String
Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
Required
x-min-v
String
Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

Responses

Status: 200 - Successful response

Name Type Format Description
x-v String The [version](#response-headers) of the API end point that the data holder has responded with.

Status: 400 - The following error codes MUST be supported:<br/><ul class="error-code-list"><li>[400 - Invalid Field](#error-400-field-invalid)</li><li>[400 - Missing Field](#error-400-field-missing)</li><li>[400 - Invalid Version](#error-400-header-invalid-version)</li></ul>

Status: 404 - The following error codes MUST be supported:<br/><ul class="error-code-list"><li>[404 - Invalid Resource](#error-404-resource-invalid)</li></ul>

Status: 406 - The following error codes MUST be supported:<br/><ul class="error-code-list"><li>[406 - Unsupported Version](#error-406-header-unsupported-version)</li></ul>


listProducts

Get Home Insurance Products

Obtain a list of home insurance products that are currently offered to the market. Note that the results returned by this end point are expected to be ordered in descending order according to `lastUpdated`.


/insurance/home/products

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"https://data.holder.com.au/cds-au/v1/insurance/home/products?insuranceType=&effective=&updated-since=&page=&page-size="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProductsApi;

import java.io.File;
import java.util.*;

public class ProductsApiExample {

    public static void main(String[] args) {
        
        ProductsApi apiInstance = new ProductsApi();
        String xV = xV_example; // String | Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
        String insuranceType = insuranceType_example; // String | Used to filter results on the insurance type field. Any one of the valid values for this field can be supplied. If absent, defaults to include ALL products.
        String effective = effective_example; // String | Allows for the filtering of productd based on whether the current time is within the period of time defined as effective by the effectiveFrom and effectiveTo fields. Valid values are ‘CURRENT’, ‘FUTURE’ and ‘ALL’. If absent defaults to 'CURRENT'
        String updatedSince = updatedSince_example; // String | Only include products that have been updated after the specified date and time.  If absent defaults to include all plans
        Integer page = 56; // Integer | Page of results to request (standard pagination)
        Integer pageSize = 56; // Integer | Page size to request.  Default is 25 (standard pagination)
        String xMinV = xMinV_example; // String | Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
        try {
            InsuranceHomeProductListResponse result = apiInstance.listProducts(xV, insuranceType, effective, updatedSince, page, pageSize, xMinV);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#listProducts");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductsApi;

public class ProductsApiExample {

    public static void main(String[] args) {
        ProductsApi apiInstance = new ProductsApi();
        String xV = xV_example; // String | Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
        String insuranceType = insuranceType_example; // String | Used to filter results on the insurance type field. Any one of the valid values for this field can be supplied. If absent, defaults to include ALL products.
        String effective = effective_example; // String | Allows for the filtering of productd based on whether the current time is within the period of time defined as effective by the effectiveFrom and effectiveTo fields. Valid values are ‘CURRENT’, ‘FUTURE’ and ‘ALL’. If absent defaults to 'CURRENT'
        String updatedSince = updatedSince_example; // String | Only include products that have been updated after the specified date and time.  If absent defaults to include all plans
        Integer page = 56; // Integer | Page of results to request (standard pagination)
        Integer pageSize = 56; // Integer | Page size to request.  Default is 25 (standard pagination)
        String xMinV = xMinV_example; // String | Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
        try {
            InsuranceHomeProductListResponse result = apiInstance.listProducts(xV, insuranceType, effective, updatedSince, page, pageSize, xMinV);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#listProducts");
            e.printStackTrace();
        }
    }
}
String *xV = xV_example; // Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
String *insuranceType = insuranceType_example; // Used to filter results on the insurance type field. Any one of the valid values for this field can be supplied. If absent, defaults to include ALL products. (optional) (default to ALL)
String *effective = effective_example; // Allows for the filtering of productd based on whether the current time is within the period of time defined as effective by the effectiveFrom and effectiveTo fields. Valid values are ‘CURRENT’, ‘FUTURE’ and ‘ALL’. If absent defaults to 'CURRENT' (optional) (default to CURRENT)
String *updatedSince = updatedSince_example; // Only include products that have been updated after the specified date and time.  If absent defaults to include all plans (optional)
Integer *page = 56; // Page of results to request (standard pagination) (optional)
Integer *pageSize = 56; // Page size to request.  Default is 25 (standard pagination) (optional)
String *xMinV = xMinV_example; // Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. (optional)

ProductsApi *apiInstance = [[ProductsApi alloc] init];

// Get Home Insurance Products
[apiInstance listProductsWith:xV
    insuranceType:insuranceType
    effective:effective
    updatedSince:updatedSince
    page:page
    pageSize:pageSize
    xMinV:xMinV
              completionHandler: ^(InsuranceHomeProductListResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdrExperimantalHomeInsuranceApi = require('cdr_experimantal_home_insurance_api');

var api = new CdrExperimantalHomeInsuranceApi.ProductsApi()
var xV = xV_example; // {{String}} Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
var opts = { 
  'insuranceType': insuranceType_example, // {{String}} Used to filter results on the insurance type field. Any one of the valid values for this field can be supplied. If absent, defaults to include ALL products.
  'effective': effective_example, // {{String}} Allows for the filtering of productd based on whether the current time is within the period of time defined as effective by the effectiveFrom and effectiveTo fields. Valid values are ‘CURRENT’, ‘FUTURE’ and ‘ALL’. If absent defaults to 'CURRENT'
  'updatedSince': updatedSince_example, // {{String}} Only include products that have been updated after the specified date and time.  If absent defaults to include all plans
  'page': 56, // {{Integer}} Page of results to request (standard pagination)
  'pageSize': 56, // {{Integer}} Page size to request.  Default is 25 (standard pagination)
  'xMinV': xMinV_example // {{String}} Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listProducts(xV, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listProductsExample
    {
        public void main()
        {

            var apiInstance = new ProductsApi();
            var xV = xV_example;  // String | Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
            var insuranceType = insuranceType_example;  // String | Used to filter results on the insurance type field. Any one of the valid values for this field can be supplied. If absent, defaults to include ALL products. (optional)  (default to ALL)
            var effective = effective_example;  // String | Allows for the filtering of productd based on whether the current time is within the period of time defined as effective by the effectiveFrom and effectiveTo fields. Valid values are ‘CURRENT’, ‘FUTURE’ and ‘ALL’. If absent defaults to 'CURRENT' (optional)  (default to CURRENT)
            var updatedSince = updatedSince_example;  // String | Only include products that have been updated after the specified date and time.  If absent defaults to include all plans (optional) 
            var page = 56;  // Integer | Page of results to request (standard pagination) (optional) 
            var pageSize = 56;  // Integer | Page size to request.  Default is 25 (standard pagination) (optional) 
            var xMinV = xMinV_example;  // String | Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. (optional) 

            try
            {
                // Get Home Insurance Products
                InsuranceHomeProductListResponse result = apiInstance.listProducts(xV, insuranceType, effective, updatedSince, page, pageSize, xMinV);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductsApi.listProducts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiProductsApi();
$xV = xV_example; // String | Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
$insuranceType = insuranceType_example; // String | Used to filter results on the insurance type field. Any one of the valid values for this field can be supplied. If absent, defaults to include ALL products.
$effective = effective_example; // String | Allows for the filtering of productd based on whether the current time is within the period of time defined as effective by the effectiveFrom and effectiveTo fields. Valid values are ‘CURRENT’, ‘FUTURE’ and ‘ALL’. If absent defaults to 'CURRENT'
$updatedSince = updatedSince_example; // String | Only include products that have been updated after the specified date and time.  If absent defaults to include all plans
$page = 56; // Integer | Page of results to request (standard pagination)
$pageSize = 56; // Integer | Page size to request.  Default is 25 (standard pagination)
$xMinV = xMinV_example; // String | Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

try {
    $result = $api_instance->listProducts($xV, $insuranceType, $effective, $updatedSince, $page, $pageSize, $xMinV);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductsApi->listProducts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProductsApi;

my $api_instance = WWW::SwaggerClient::ProductsApi->new();
my $xV = xV_example; # String | Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
my $insuranceType = insuranceType_example; # String | Used to filter results on the insurance type field. Any one of the valid values for this field can be supplied. If absent, defaults to include ALL products.
my $effective = effective_example; # String | Allows for the filtering of productd based on whether the current time is within the period of time defined as effective by the effectiveFrom and effectiveTo fields. Valid values are ‘CURRENT’, ‘FUTURE’ and ‘ALL’. If absent defaults to 'CURRENT'
my $updatedSince = updatedSince_example; # String | Only include products that have been updated after the specified date and time.  If absent defaults to include all plans
my $page = 56; # Integer | Page of results to request (standard pagination)
my $pageSize = 56; # Integer | Page size to request.  Default is 25 (standard pagination)
my $xMinV = xMinV_example; # String | Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

eval { 
    my $result = $api_instance->listProducts(xV => $xV, insuranceType => $insuranceType, effective => $effective, updatedSince => $updatedSince, page => $page, pageSize => $pageSize, xMinV => $xMinV);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProductsApi->listProducts: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ProductsApi()
xV = xV_example # String | Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
insuranceType = insuranceType_example # String | Used to filter results on the insurance type field. Any one of the valid values for this field can be supplied. If absent, defaults to include ALL products. (optional) (default to ALL)
effective = effective_example # String | Allows for the filtering of productd based on whether the current time is within the period of time defined as effective by the effectiveFrom and effectiveTo fields. Valid values are ‘CURRENT’, ‘FUTURE’ and ‘ALL’. If absent defaults to 'CURRENT' (optional) (default to CURRENT)
updatedSince = updatedSince_example # String | Only include products that have been updated after the specified date and time.  If absent defaults to include all plans (optional)
page = 56 # Integer | Page of results to request (standard pagination) (optional)
pageSize = 56 # Integer | Page size to request.  Default is 25 (standard pagination) (optional)
xMinV = xMinV_example # String | Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. (optional)

try: 
    # Get Home Insurance Products
    api_response = api_instance.list_products(xV, insuranceType=insuranceType, effective=effective, updatedSince=updatedSince, page=page, pageSize=pageSize, xMinV=xMinV)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductsApi->listProducts: %s\n" % e)

Parameters

Header parameters
Name Description
x-v*
String
Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
Required
x-min-v
String
Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
Query parameters
Name Description
insuranceType
String
Used to filter results on the insurance type field. Any one of the valid values for this field can be supplied. If absent, defaults to include ALL products.
effective
String
Allows for the filtering of productd based on whether the current time is within the period of time defined as effective by the effectiveFrom and effectiveTo fields. Valid values are ‘CURRENT’, ‘FUTURE’ and ‘ALL’. If absent defaults to 'CURRENT'
updated-since
String
Only include products that have been updated after the specified date and time. If absent defaults to include all plans
page
Integer
Page of results to request (standard pagination)
page-size
Integer
Page size to request. Default is 25 (standard pagination)

Responses

Status: 200 - Successful response

Name Type Format Description
x-v String The [version](#response-headers) of the API end point that the data holder has responded with.

Status: 400 - The following error codes MUST be supported:<br/><ul class="error-code-list"><li>[400 - Invalid Field](#error-400-field-invalid)</li><li>[400 - Missing Field](#error-400-field-missing)</li><li>[400 - Invalid Page Size](#error-400-field-invalid-page-size)</li><li>[400 - Invalid Version](#error-400-header-invalid-version)</li></ul>

Status: 406 - The following error codes MUST be supported:<br/><ul class="error-code-list"><li>[406 - Unsupported Version](#error-406-header-unsupported-version)</li></ul>

Status: 422 - The following error codes MUST be supported:<br/><ul class="error-code-list"><li>[422 - Invalid Page](#error-422-field-invalid-page)</li></ul>