v5.1.0 filtered by tag: Product-Collection (2 APIs)
Create Product Collection
Create or Update a Product Collection at the Bank.
Use Product Collections to create Product "Baskets", "Portfolios", "Indices", "Collections", "Underlyings-lists", "Buckets" etc. etc.
There is a many to many relationship between Products and Product Collections:
-
A Product can exist in many Collections
-
A Collection can contain many Products.
A collection has collection code, one parent Product and one or more child Products.
Product hiearchy vs Product Collections:
-
You can define a hierarchy of products - so that a child Product inherits attributes of its parent Product - using the parent_product_code in Product.
-
You can define a collection (also known as baskets or buckets) of products using Product Collections.
Authentication is Mandatory
URL Parameters:
BANK_ID: gh.29.uk
JSON response body fields:
product_code: 1234BW
{
"product_collection":[{
"collection_code":"C",
"product_code":"1234BW",
"items":[{
"member_product_code":"A"
},{
"member_product_code":"B"
}]
}]
}
-
CanMaintainProductCollection
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Get Product Collection
Returns information about the financial Product Collection specified by BANK_ID and COLLECTION_CODE:
Authentication is Mandatory
URL Parameters:
BANK_ID: gh.29.uk
JSON response body fields:
bank_id: gh.29.uk
code: 125
description: This an optional field. Maximum length is 2000. It can be any characters here.
id: d8839721-ad8f-45dd-9f78-2080414b93f9
meta:
more_info_url: www.example.com/abc
name: ACCOUNT_MANAGEMENT_FEE
parent_product_code: 787LOW
product_code: 1234BW
type:
value: 5987953
{
"collection_code":"A",
"products":[{
"bank_id":"gh.29.uk",
"code":"1234BW",
"parent_product_code":"parent",
"name":"product name",
"category":"category",
"family":"family",
"super_family":"super family",
"more_info_url":"www.example.com/prod1/more-info.html",
"details":"Details",
"description":"Description",
"meta":{
"license":{
"id":"ODbL-1.0",
"name":"Open Database License"
}
},
"product_attributes":[{
"product_code":"1234BW",
"product_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
"name":"OVERDRAFT_START_DATE",
"type":"DATE_WITH_DAY",
"value":"2012-04-23"
}]
}]
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-50000: Unknown Error.