diff --git a/docs/Standards/Super-Product.md b/docs/Standards/Super-Product.md index b7857af..7b81c41 100644 --- a/docs/Standards/Super-Product.md +++ b/docs/Standards/Super-Product.md @@ -12,9 +12,19 @@ This standards provides a product API set for publicly available superannuation +The API covers retail superannuation products. Product data includes: + +* Name of fund +* Provider +* Status +* Investment Types +* Fees +* Performance +* Links - PDS, Fund and Provider details + The product API contains two API's -| API | Method | Path | Description | +| API | Method | Path | Description | |-|-|-|-| |Get Products | GET | {ProviderURI} **/super/products**| Returns a list of Super Funds offered to the market | |Get ProductDetail | GET | {ProviderURI} **/super/products{productId}**| Returns a specific Fund details offered to the market | diff --git a/docs/Standards/cds_super_product.html b/docs/Standards/cds_super_product.html index 6433ab8..e8793f7 100644 --- a/docs/Standards/cds_super_product.html +++ b/docs/Standards/cds_super_product.html @@ -1,829 +1,5221 @@ - + - - CDR Experimantal Superannuation API - + + + + +
+
+ +
+
+
+

CDR Experimantal Superannuation API

+
+
+
+ +
+
+

Products

+
+
+
+

getProduct

+

Get Superannuation Product Detail

+
+
+
+

+

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

+

+
+ 
/super/products/{productId}
+

+

Usage and SDK Samples

+

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

-    
Content-Type: application/json

-    
{
-  "data" : "",
-  "meta" : { },
-  "links" : {
-    "self" : "self"
+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 {
+            SuperFundProductResponse 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 {
+            SuperFundProductResponse 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 Superannuation Product Detail
+[apiInstance getProductWith:productId
+    xV:xV
+    xMinV:xMinV
+              completionHandler: ^(SuperFundProductResponse output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+ 
var CdrExperimantalSuperannuationApi = require('cdr_experimantal_superannuation_api');
+
+var api = new CdrExperimantalSuperannuationApi.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 Superannuation Product Detail
+                SuperFundProductResponse 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";
 }
+
-

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful response - SuperFundProductResponse -

400

- The following error codes MUST be supported:<br/><ul class="error-code-list"><li><a href="#error-400-field-invalid">400 - Invalid Field</a></li><li><a href="#error-400-field-missing">400 - Missing Field</a></li><li><a href="#error-400-header-invalid-version">400 - Invalid Version</a></li></ul> - ResponseErrorListV2 -

404

- The following error codes MUST be supported:<br/><ul class="error-code-list"><li><a href="#error-404-resource-invalid">404 - Invalid Resource</a></li></ul> - ResponseErrorListV2 -

406

- The following error codes MUST be supported:<br/><ul class="error-code-list"><li><a href="#error-406-header-unsupported-version">406 - Unsupported Version</a></li></ul> - ResponseErrorListV2 -
-
-
-
- Up - 
get /super/products
-
Get Superannuation Products (listProducts)
-

Obtain a list of superannuations 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.

-
- - - - -

Request headers

-
-
- -

Query parameters

-
-
investmentType (optional)
- -
Query Parameter — Used to filter results on the investment type field. Any one of the valid values for this field can be supplied. If absent, defaults to include ALL products. default: ALL
effective (optional)
- -
Query Parameter — 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' default: CURRENT
updated-since (optional)
- -
Query Parameter — Only include products that have been updated after the specified date and time. If absent defaults to include all plans
page (optional)
- -
Query Parameter — Page of results to request (standard pagination)
page-size (optional)
- -
Query Parameter — Page size to request. Default is 25 (standard pagination)
- - -

Return type

-
- SuperFundProductListResponse - -
+
+ 
from __future__ import print_statement
+import time
+import swagger_client
+from swagger_client.rest import ApiException
+from pprint import pprint
 
-    
-
-    
Example data

-    
Content-Type: application/json

-    
{
-  "data" : {
-    "funds" : [ {
-      "additionalInformation" : {
-        "eligibilityUri" : "eligibilityUri",
-        "feesUri" : "feesUri",
-        "termsUri" : "termsUri",
-        "overviewUri" : "overviewUri"
-      },
-      "fees" : [ {
-        "period" : "period",
-        "amount" : "amount",
-        "balance" : "balance",
-        "name" : "name",
-        "description" : "description"
-      }, {
-        "period" : "period",
-        "amount" : "amount",
-        "balance" : "balance",
-        "name" : "name",
-        "description" : "description"
-      } ],
-      "productId" : "productId",
-      "displayName" : "displayName",
-      "description" : "description",
-      "providerUri" : "providerUri",
-      "effectiveTo" : "effectiveTo",
-      "lastUpdated" : "lastUpdated",
-      "performance" : [ {
-        "period" : "period",
-        "name" : "name",
-        "description" : "description",
-        "value" : "value"
-      }, {
-        "period" : "period",
-        "name" : "name",
-        "description" : "description",
-        "value" : "value"
-      } ],
-      "provider" : "provider",
-      "investmentType" : "BALANCED",
-      "effectiveFrom" : "effectiveFrom",
-      "fundInformationUri" : "fundInformationUri"
-    }, {
-      "additionalInformation" : {
-        "eligibilityUri" : "eligibilityUri",
-        "feesUri" : "feesUri",
-        "termsUri" : "termsUri",
-        "overviewUri" : "overviewUri"
-      },
-      "fees" : [ {
-        "period" : "period",
-        "amount" : "amount",
-        "balance" : "balance",
-        "name" : "name",
-        "description" : "description"
-      }, {
-        "period" : "period",
-        "amount" : "amount",
-        "balance" : "balance",
-        "name" : "name",
-        "description" : "description"
-      } ],
-      "productId" : "productId",
-      "displayName" : "displayName",
-      "description" : "description",
-      "providerUri" : "providerUri",
-      "effectiveTo" : "effectiveTo",
-      "lastUpdated" : "lastUpdated",
-      "performance" : [ {
-        "period" : "period",
-        "name" : "name",
-        "description" : "description",
-        "value" : "value"
-      }, {
-        "period" : "period",
-        "name" : "name",
-        "description" : "description",
-        "value" : "value"
-      } ],
-      "provider" : "provider",
-      "investmentType" : "BALANCED",
-      "effectiveFrom" : "effectiveFrom",
-      "fundInformationUri" : "fundInformationUri"
-    } ]
-  },
-  "meta" : {
-    "totalRecords" : 0,
-    "totalPages" : 6
+# 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 Superannuation 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
+ + + + + + + + +
NameDescription
productId* + + +
+
+
+ + String + + +
+ ID of the specific product requested +
+
+
+ Required +
+
+
+
+ +
Header parameters
+ + + + + + + + + + + +
NameDescription
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

+ + + +
+
+
+ +
+ +
+
+ + + + + + + + + + + + + +
NameTypeFormatDescription
x-vStringThe [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 Superannuation Products

+
+
+
+

+

Obtain a list of superannuations 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`.

+

+
+ 
/super/products
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X GET\
+-H "Accept: application/json"\
+"https://data.holder.com.au/cds-au/v1/super/products?investmentType=&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 investmentType = investmentType_example; // String | Used to filter results on the investment 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 {
+            SuperFundProductListResponse result = apiInstance.listProducts(xV, investmentType, effective, updatedSince, page, pageSize, xMinV);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling ProductsApi#listProducts");
+            e.printStackTrace();
+        }
+    }
 }
+
-

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful response - SuperFundProductListResponse -

400

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

406

- The following error codes MUST be supported:<br/><ul class="error-code-list"><li><a href="#error-406-header-unsupported-version">406 - Unsupported Version</a></li></ul> - ResponseErrorListV2 -

422

- The following error codes MUST be supported:<br/><ul class="error-code-list"><li><a href="#error-422-field-invalid-page">422 - Invalid Page</a></li></ul> - ResponseErrorListV2 -
-
-

Super

-
-
- Up - 
get /super/products/{productId}
-
Get Superannuation Product Detail (getProduct)
-
Obtain detailed information on a single super product offered openly to the market
- -

Path parameters

-
-
productId (required)
- -
Path Parameter — ID of the specific product requested
- - - -

Request headers

-
-
- - - -

Return type

-
- SuperFundProductResponse - -
+
+ 
import io.swagger.client.api.ProductsApi;
 
-    
+public class ProductsApiExample {
 
-    
Example data

-    
Content-Type: application/json

-    
{
-  "data" : "",
-  "meta" : { },
-  "links" : {
-    "self" : "self"
+    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 investmentType = investmentType_example; // String | Used to filter results on the investment 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 {
+            SuperFundProductListResponse result = apiInstance.listProducts(xV, investmentType, 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 *investmentType = investmentType_example; // Used to filter results on the investment 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 Superannuation Products
+[apiInstance listProductsWith:xV
+    investmentType:investmentType
+    effective:effective
+    updatedSince:updatedSince
+    page:page
+    pageSize:pageSize
+    xMinV:xMinV
+              completionHandler: ^(SuperFundProductListResponse output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+ 
var CdrExperimantalSuperannuationApi = require('cdr_experimantal_superannuation_api');
+
+var api = new CdrExperimantalSuperannuationApi.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 = { 
+  'investmentType': investmentType_example, // {{String}} Used to filter results on the investment 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 investmentType = investmentType_example;  // String | Used to filter results on the investment 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 Superannuation Products
+                SuperFundProductListResponse result = apiInstance.listProducts(xV, investmentType, 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)
+$investmentType = investmentType_example; // String | Used to filter results on the investment 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, $investmentType, $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 $investmentType = investmentType_example; # String | Used to filter results on the investment 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, investmentType => $investmentType, effective => $effective, updatedSince => $updatedSince, page => $page, pageSize => $pageSize, xMinV => $xMinV);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling ProductsApi->listProducts: $@\n";
 }
+
-

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful response - SuperFundProductResponse -

400

- The following error codes MUST be supported:<br/><ul class="error-code-list"><li><a href="#error-400-field-invalid">400 - Invalid Field</a></li><li><a href="#error-400-field-missing">400 - Missing Field</a></li><li><a href="#error-400-header-invalid-version">400 - Invalid Version</a></li></ul> - ResponseErrorListV2 -

404

- The following error codes MUST be supported:<br/><ul class="error-code-list"><li><a href="#error-404-resource-invalid">404 - Invalid Resource</a></li></ul> - ResponseErrorListV2 -

406

- The following error codes MUST be supported:<br/><ul class="error-code-list"><li><a href="#error-406-header-unsupported-version">406 - Unsupported Version</a></li></ul> - ResponseErrorListV2 -
-
-
-
- Up - 
get /super/products
-
Get Superannuation Products (listProducts)
-

Obtain a list of superannuations 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.

-
- - - - -

Request headers

-
-
- -

Query parameters

-
-
investmentType (optional)
- -
Query Parameter — Used to filter results on the investment type field. Any one of the valid values for this field can be supplied. If absent, defaults to include ALL products. default: ALL
effective (optional)
- -
Query Parameter — 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' default: CURRENT
updated-since (optional)
- -
Query Parameter — Only include products that have been updated after the specified date and time. If absent defaults to include all plans
page (optional)
- -
Query Parameter — Page of results to request (standard pagination)
page-size (optional)
- -
Query Parameter — Page size to request. Default is 25 (standard pagination)
- - -

Return type

-
- SuperFundProductListResponse - -
+
+ 
from __future__ import print_statement
+import time
+import swagger_client
+from swagger_client.rest import ApiException
+from pprint import pprint
 
-    
-
-    
Example data

-    
Content-Type: application/json

-    
{
-  "data" : {
-    "funds" : [ {
-      "additionalInformation" : {
-        "eligibilityUri" : "eligibilityUri",
-        "feesUri" : "feesUri",
-        "termsUri" : "termsUri",
-        "overviewUri" : "overviewUri"
-      },
-      "fees" : [ {
-        "period" : "period",
-        "amount" : "amount",
-        "balance" : "balance",
-        "name" : "name",
-        "description" : "description"
-      }, {
-        "period" : "period",
-        "amount" : "amount",
-        "balance" : "balance",
-        "name" : "name",
-        "description" : "description"
-      } ],
-      "productId" : "productId",
-      "displayName" : "displayName",
-      "description" : "description",
-      "providerUri" : "providerUri",
-      "effectiveTo" : "effectiveTo",
-      "lastUpdated" : "lastUpdated",
-      "performance" : [ {
-        "period" : "period",
-        "name" : "name",
-        "description" : "description",
-        "value" : "value"
-      }, {
-        "period" : "period",
-        "name" : "name",
-        "description" : "description",
-        "value" : "value"
-      } ],
-      "provider" : "provider",
-      "investmentType" : "BALANCED",
-      "effectiveFrom" : "effectiveFrom",
-      "fundInformationUri" : "fundInformationUri"
-    }, {
-      "additionalInformation" : {
-        "eligibilityUri" : "eligibilityUri",
-        "feesUri" : "feesUri",
-        "termsUri" : "termsUri",
-        "overviewUri" : "overviewUri"
-      },
-      "fees" : [ {
-        "period" : "period",
-        "amount" : "amount",
-        "balance" : "balance",
-        "name" : "name",
-        "description" : "description"
-      }, {
-        "period" : "period",
-        "amount" : "amount",
-        "balance" : "balance",
-        "name" : "name",
-        "description" : "description"
-      } ],
-      "productId" : "productId",
-      "displayName" : "displayName",
-      "description" : "description",
-      "providerUri" : "providerUri",
-      "effectiveTo" : "effectiveTo",
-      "lastUpdated" : "lastUpdated",
-      "performance" : [ {
-        "period" : "period",
-        "name" : "name",
-        "description" : "description",
-        "value" : "value"
-      }, {
-        "period" : "period",
-        "name" : "name",
-        "description" : "description",
-        "value" : "value"
-      } ],
-      "provider" : "provider",
-      "investmentType" : "BALANCED",
-      "effectiveFrom" : "effectiveFrom",
-      "fundInformationUri" : "fundInformationUri"
-    } ]
+# 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)
+investmentType = investmentType_example # String | Used to filter results on the investment 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 Superannuation Products
+    api_response = api_instance.list_products(xV, investmentType=investmentType, 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
+ + + + + + + + + + + +
NameDescription
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
+ + + + + + + + + + + + + + + + + + + + +
NameDescription
investmentType + + +
+
+
+ + String + + +
+ Used to filter results on the investment 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

+ + + +
+
+
+ +
+ +
+
+ + + + + + + + + + + + + +
NameTypeFormatDescription
x-vStringThe [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>

+ + + +
+
+
+ +
+ +
+
+ +
+
+
+
+
+

Super

+
+
+
+

getProduct

+

Get Superannuation Product Detail

+
+
+
+

+

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

+

+
+ 
/super/products/{productId}
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X GET\
+-H "Accept: application/json"\
+"https://data.holder.com.au/cds-au/v1/super/products/{productId}"
+
+
+ 
import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import io.swagger.client.api.SuperApi;
+
+import java.io.File;
+import java.util.*;
+
+public class SuperApiExample {
+
+    public static void main(String[] args) {
+        
+        SuperApi apiInstance = new SuperApi();
+        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 {
+            SuperFundProductResponse result = apiInstance.getProduct(productId, xV, xMinV);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling SuperApi#getProduct");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
import io.swagger.client.api.SuperApi;
+
+public class SuperApiExample {
+
+    public static void main(String[] args) {
+        SuperApi apiInstance = new SuperApi();
+        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 {
+            SuperFundProductResponse result = apiInstance.getProduct(productId, xV, xMinV);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling SuperApi#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)
+
+SuperApi *apiInstance = [[SuperApi alloc] init];
+
+// Get Superannuation Product Detail
+[apiInstance getProductWith:productId
+    xV:xV
+    xMinV:xMinV
+              completionHandler: ^(SuperFundProductResponse output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+ 
var CdrExperimantalSuperannuationApi = require('cdr_experimantal_superannuation_api');
+
+var api = new CdrExperimantalSuperannuationApi.SuperApi()
+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 SuperApi();
+            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 Superannuation Product Detail
+                SuperFundProductResponse result = apiInstance.getProduct(productId, xV, xMinV);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling SuperApi.getProduct: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new Swagger\Client\ApiSuperApi();
+$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 SuperApi->getProduct: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::SwaggerClient::Configuration;
+use WWW::SwaggerClient::SuperApi;
+
+my $api_instance = WWW::SwaggerClient::SuperApi->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 SuperApi->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.SuperApi()
+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 Superannuation Product Detail
+    api_response = api_instance.get_product(productId, xV, xMinV=xMinV)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling SuperApi->getProduct: %s\n" % e)
+
+
+ +

Parameters

+ +
Path parameters
+ + + + + + + + +
NameDescription
productId* + + +
+
+
+ + String + + +
+ ID of the specific product requested +
+
+
+ Required +
+
+
+
+ +
Header parameters
+ + + + + + + + + + + +
NameDescription
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

+ + + +
+
+
+ +
+ +
+
+ + + + + + + + + + + + + +
NameTypeFormatDescription
x-vStringThe [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 Superannuation Products

+
+
+
+

+

Obtain a list of superannuations 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`.

+

+
+ 
/super/products
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X GET\
+-H "Accept: application/json"\
+"https://data.holder.com.au/cds-au/v1/super/products?investmentType=&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.SuperApi;
+
+import java.io.File;
+import java.util.*;
+
+public class SuperApiExample {
+
+    public static void main(String[] args) {
+        
+        SuperApi apiInstance = new SuperApi();
+        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 investmentType = investmentType_example; // String | Used to filter results on the investment 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 {
+            SuperFundProductListResponse result = apiInstance.listProducts(xV, investmentType, effective, updatedSince, page, pageSize, xMinV);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling SuperApi#listProducts");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
import io.swagger.client.api.SuperApi;
+
+public class SuperApiExample {
+
+    public static void main(String[] args) {
+        SuperApi apiInstance = new SuperApi();
+        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 investmentType = investmentType_example; // String | Used to filter results on the investment 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 {
+            SuperFundProductListResponse result = apiInstance.listProducts(xV, investmentType, effective, updatedSince, page, pageSize, xMinV);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling SuperApi#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 *investmentType = investmentType_example; // Used to filter results on the investment 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)
+
+SuperApi *apiInstance = [[SuperApi alloc] init];
+
+// Get Superannuation Products
+[apiInstance listProductsWith:xV
+    investmentType:investmentType
+    effective:effective
+    updatedSince:updatedSince
+    page:page
+    pageSize:pageSize
+    xMinV:xMinV
+              completionHandler: ^(SuperFundProductListResponse output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+ 
var CdrExperimantalSuperannuationApi = require('cdr_experimantal_superannuation_api');
+
+var api = new CdrExperimantalSuperannuationApi.SuperApi()
+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 = { 
+  'investmentType': investmentType_example, // {{String}} Used to filter results on the investment 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 SuperApi();
+            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 investmentType = investmentType_example;  // String | Used to filter results on the investment 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 Superannuation Products
+                SuperFundProductListResponse result = apiInstance.listProducts(xV, investmentType, effective, updatedSince, page, pageSize, xMinV);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling SuperApi.listProducts: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new Swagger\Client\ApiSuperApi();
+$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)
+$investmentType = investmentType_example; // String | Used to filter results on the investment 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, $investmentType, $effective, $updatedSince, $page, $pageSize, $xMinV);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling SuperApi->listProducts: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::SwaggerClient::Configuration;
+use WWW::SwaggerClient::SuperApi;
+
+my $api_instance = WWW::SwaggerClient::SuperApi->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 $investmentType = investmentType_example; # String | Used to filter results on the investment 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, investmentType => $investmentType, effective => $effective, updatedSince => $updatedSince, page => $page, pageSize => $pageSize, xMinV => $xMinV);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling SuperApi->listProducts: $@\n";
 }
+
-

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
    • -
- -

Responses

-

200

- Successful response - SuperFundProductListResponse -

400

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

406

- The following error codes MUST be supported:<br/><ul class="error-code-list"><li><a href="#error-406-header-unsupported-version">406 - Unsupported Version</a></li></ul> - ResponseErrorListV2 -

422

- The following error codes MUST be supported:<br/><ul class="error-code-list"><li><a href="#error-422-field-invalid-page">422 - Invalid Page</a></li></ul> - ResponseErrorListV2 -
-
- -

Models

- [ Jump to Methods ] - -

Table of Contents

-
    -
  1. Links
    2. -
  2. LinksPaginated
    3. -
  3. Meta
    4. -
  4. MetaError
    5. -
  5. MetaPaginated
    6. -
  6. ResponseErrorListV2
    7. -
  7. ResponseErrorListV2_errors
    8. -
  8. SuperAdditionalInformation
    9. -
  9. SuperFundProduct
    10. -
  10. SuperFundProductDetail
    11. -
  11. SuperFundProductDetailFeature
    12. -
  12. SuperFundProductFees
    13. -
  13. SuperFundProductListResponse
    14. -
  14. SuperFundProductListResponseData
    15. -
  15. SuperFundProductPerformance
    16. -
  16. SuperFundProductResponse
    17. -
- -
-

Links Up

- -
-
self
String Fully qualified link that generated the current response document
-
-
-
-

LinksPaginated Up

- -
-
self
String Fully qualified link that generated the current response document
-
first (optional)
String URI to the first page of this set. Mandatory if this response is not the first page
-
prev (optional)
String URI to the previous page of this set. Mandatory if this response is not the first page
-
next (optional)
String URI to the next page of this set. Mandatory if this response is not the last page
-
last (optional)
String URI to the last page of this set. Mandatory if this response is not the last page
-
-
-
-

Meta Up

- -
-
-
-
-

MetaError Up

-
Additional data for customised error codes
-
-
urn (optional)
String The CDR error code URN which the application-specific error code extends. Mandatory if the error <code>code</code> is an application-specific error rather than a standardised error code.
-
-
-
-

MetaPaginated Up

- -
-
totalRecords
Integer The total number of records in the full set. See <a href="#pagination">pagination</a>.
-
totalPages
Integer The total number of pages in the full set. See <a href="#pagination">pagination</a>.
-
-
-
-

ResponseErrorListV2 Up

- -
-
errors
array[ResponseErrorListV2_errors]
-
-
-
-

ResponseErrorListV2_errors Up

- -
-
code
String The code of the error encountered. Where the error is specific to the respondent, an application-specific error code, expressed as a string value. If the error is application-specific, the URN code that the specific error extends must be provided in the meta object. Otherwise, the value is the error code URN.
-
title
String A short, human-readable summary of the problem that MUST NOT change from occurrence to occurrence of the problem represented by the error code.
-
detail
String A human-readable explanation specific to this occurrence of the problem.
-
meta (optional)
MetaError
-
-
-
-

SuperAdditionalInformation Up

-
Object that contains links to additional information on specific topics
-
-
overviewUri (optional)
String A link to a general overview of the fund
-
termsUri (optional)
String A link to terms and conditions for the fund
-
eligibilityUri (optional)
String A link to detail on eligibility criteria for the fund
-
feesUri (optional)
String A link to detail on fees for the fund
-
-
-
-

SuperFundProduct Up

- -
-
productId
String The ID of the specific product
-
effectiveFrom (optional)
String The date and time from which this product is effective (ie. is available for origination). Used to enable the articulation of products to the regime before they are available for customers to originate
-
effectiveTo (optional)
String The date and time at which this product will be retired and will no longer be offered. Used to enable the managed deprecation of plans
-
lastUpdated (optional)
String The last date and time that the information for this plan was changed (or the creation date for the plan if it has never been altered)
-
displayName
String The display name of the super fund
-
description
String A description of the super fund
-
provider
String The name of the super fund provider
-
investmentType
String The type of fund type.
-
Enum:
-
CONSERVATIVE
BALANCED
GROWTH
ETHICAL
FIXED_INCOME
OTHER
-
fees
array[SuperFundProductFees] A list of fees that apply to the fund
-
performance
array[SuperFundProductPerformance] Performance data of the fund over a period of time e.g. 1, 3, 5, 8, 10 years
-
fundInformationUri (optional)
String A link to the fund web page
-
providerUri (optional)
String A link to the fund providers web page
-
additionalInformation (optional)
SuperAdditionalInformation
-
-
-
-

SuperFundProductDetail Up

- -
-
features
array[SuperFundProductDetailFeature] Optional list of features of the fund
-
-
-
-

SuperFundProductDetailFeature Up

- -
-
displayName
String The display name of the feature
-
description (optional)
String The description of the feature
-
featureUri (optional)
String The Uri link to the feature
-
-
-
-

SuperFundProductFees Up

- -
-
name
String The display name of the fee
-
description
String The description of the fee
-
period (optional)
String The duration of the fee frequency. Formatted according to <a href="https://en.wikipedia.org/wiki/ISO_8601#Durations">ISO 8601 Durations</a> (excludes recurrence syntax)
-
balance (optional)
String The super fund account balance the fee is based on e.g. 50k
-
amount
String The amount charged for the duration period
-
-
-
-

SuperFundProductListResponse Up

- -
-
data
SuperFundProductListResponseData
-
links
LinksPaginated
-
meta
MetaPaginated
-
-
-
-

SuperFundProductListResponseData Up

- -
-
funds
array[SuperFundProduct] Array of Super Fund Products
-
-
-
-

SuperFundProductPerformance Up

- -
-
name
String The display name of the performances metric. e.g 3 years
-
description
String The description of the performance
-
period (optional)
String The duration of the performance frequency. Formatted according to <a href="https://en.wikipedia.org/wiki/ISO_8601#Durations">ISO 8601 Durations</a> (excludes recurrence syntax)
-
value (optional)
String The percent value of the performance over the given time frame e.g 5%
-
-
-
-

SuperFundProductResponse Up

- -
-
data
-
links
Links
-
meta (optional)
Meta
-
+
+ 
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.SuperApi()
+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)
+investmentType = investmentType_example # String | Used to filter results on the investment 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 Superannuation Products
+    api_response = api_instance.list_products(xV, investmentType=investmentType, effective=effective, updatedSince=updatedSince, page=page, pageSize=pageSize, xMinV=xMinV)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling SuperApi->listProducts: %s\n" % e)
+
+
+ +

Parameters

+ + +
Header parameters
+ + + + + + + + + + + +
NameDescription
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
+ + + + + + + + + + + + + + + + + + + + +
NameDescription
investmentType + + +
+
+
+ + String + + +
+ Used to filter results on the investment 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

+ + + +
+
+
+ +
+ +
+
+ + + + + + + + + + + + + +
NameTypeFormatDescription
x-vStringThe [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>

+ + + +
+
+
+ +
+ +
+
+ +
+
+
+
+
+ +
+
- - + + + + + + + + + \ No newline at end of file diff --git a/docs/Standards/cds_super_product.json b/docs/Standards/cds_super_product.json index a4b3ffa..1bbee51 100644 --- a/docs/Standards/cds_super_product.json +++ b/docs/Standards/cds_super_product.json @@ -458,12 +458,27 @@ "description": "The name of the super fund provider", "type": "string" }, - "investmentType": { - "description": "The type of fund type.", - "enum": [ "CONSERVATIVE", "BALANCED", "GROWTH", "ETHICAL", "FIXED_INCOME", "OTHER" ], - "default": "BALANCED", + "inceptionDate": { + "description": "Inception date of the fund.", + "type": "string", + "x-cds-type": "DateString" + }, + "status": { + "description": "The status. PUBLIC open to any members, CLOSED not open to new members, EMPLOYER open to employee cohorts", + "enum": [ "PUBLIC", "CLOSED", "EMPLOYEE" ], + "default": "PUBLIC", "type": "string" }, + "investmentTypes": { + "description": "The type of investment types supported", + "items": { + "properties": { + "$ref": "#/components/schemas/SuperFundProductInvestmentType" + } + }, + "type": "array", + "required": "investmentType" + }, "fees": { "description": "A list of fees that apply to the fund", "items": { @@ -482,6 +497,11 @@ "description": "A link to the fund web page", "type": "string", "x-cds-type": "URIString" + }, + "pdsUri": { + "description": "A link to the product disclosure statement", + "type": "string", + "x-cds-type": "URIString" }, "providerUri": { "description": "A link to the fund providers web page", @@ -492,9 +512,9 @@ "$ref": "#/components/schemas/SuperAdditionalInformation" } }, - "required": [ "provider", "displayName", "description", "fees", "performance", "productId", "type", "investmentType" ], + "required": [ "provider", "displayName", "description", "investmentTypes", "fees", "performance", "productId", "type", "investmentType" ], "type": "object", - "x-conditional": [ "contract" ] + "x-conditional": [ "" ] }, "Links": { "properties": { @@ -571,6 +591,16 @@ "required": [ "funds" ], "type": "object" }, + "SuperFundProductInvestmentType": { + "properties": { + "investmentType": { + "enum": [ "CONSERVATIVE", "BALANCED", "GROWTH", "ETHICAL", "FIXED_INCOME", "OTHER" ], + "default": "BALANCED", + "type": "string" + } + } + }, + "SuperFundProductFees": { "properties": { "name": { @@ -616,7 +646,7 @@ "x-cds-type": "ExternalRef" }, "value": { - "description": "The percent value of the performance over the given time frame e.g 5%", + "description": "The percent value of the performance over the given time frame e.g 5.1%", "type": "string", "x-cds-type": "RateString" } diff --git a/docs/Standards/cfg/default.cfg b/docs/Standards/cfg/default.cfg new file mode 100644 index 0000000..02f0986 --- /dev/null +++ b/docs/Standards/cfg/default.cfg @@ -0,0 +1,5 @@ + + + + +