{"resource_docs":[{"operation_id":"OBPv3.1.0-getProductCollection","implemented_by":{"version":"OBPv3.1.0","function":"getProductCollection"},"request_verb":"GET","request_url":"/obp/v3.1.0/banks/BANK_ID/product-collections/COLLECTION_CODE","summary":"Get Product Collection","description":"
Returns information about the financial Product Collection specified by BANK_ID and COLLECTION_CODE:
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\n\nJSON response body fields:
\nbank_id: gh.29.uk
\n\ncode: 125
\n\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\nmeta:
\nmore_info_url: www.example.com/abc
\nname: ACCOUNT_MANAGEMENT_FEE
\nparent_product_code: 787LOW
\n\nproduct_code: 1234BW
\n\n\ntype:
\nvalue: 5987953
\n\n","description_markdown":"Returns information about the financial Product Collection specified by BANK_ID and COLLECTION_CODE:\n\n \n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[COLLECTION_CODE](/glossary#collection_code): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**category**](/glossary#category): \n\n\n\n[**code**](/glossary#code): 125\n\n\n\n[**collection_code**](/glossary#collection_code): \n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**details**](/glossary#details): \n\n\n\n[**family**](/glossary#family): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**license**](/glossary#license): \n\n\n\n[**meta**](/glossary#meta): \n\n\n\n[**more_info_url**](/glossary#more_info_url): www.example.com/abc\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**parent_product_code**](/glossary#parent_product_code): 787LOW\n\n\n\n[**product_attribute_id**](/glossary#product_attribute_id): \n\n\n\n[**product_code**](/glossary#product_code): 1234BW\n\n\n\n[**products**](/glossary#products): \n\n\n\n[**super_family**](/glossary#super_family): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[product_attributes](/glossary#product_attributes): \n\n\n","success_response_body":{"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"}]}]},"error_response_bodies":["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."],"tags":["Product-Collection","Product"],"typed_success_response_body":{"type":"object","properties":{"products":{"type":"array","items":{"type":"object","properties":{"super_family":{"type":"string"},"description":{"type":"string"},"details":{"type":"string"},"parent_product_code":{"type":"string"},"bank_id":{"type":"string"},"code":{"type":"string"},"more_info_url":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"family":{"type":"string"},"product_attributes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"product_code":{"type":"string"},"product_attribute_id":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}}},"name":{"type":"string"},"category":{"type":"string"}}}},"collection_code":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/product-collections/COLLECTION_CODE","connector_methods":[]},{"operation_id":"OBPv3.1.0-createProductCollection","implemented_by":{"version":"OBPv3.1.0","function":"createProductCollection"},"request_verb":"PUT","request_url":"/obp/v3.1.0/banks/BANK_ID/product-collections/COLLECTION_CODE","summary":"Create Product Collection","description":"Create or Update a Product Collection at the Bank.
\nUse Product Collections to create Product "Baskets", "Portfolios", "Indices", "Collections", "Underlyings-lists", "Buckets" etc. etc.
\nThere is a many to many relationship between Products and Product Collections:
\nA Product can exist in many Collections
\nA Collection can contain many Products.
\nA collection has collection code, one parent Product and one or more child Products.
\nProduct hiearchy vs Product Collections:
\nYou can define a hierarchy of products - so that a child Product inherits attributes of its parent Product - using the parent_product_code in Product.
\nYou can define a collection (also known as baskets or buckets) of products using Product Collections.
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\n\nJSON response body fields:
\n\n\n\nproduct_code: 1234BW
\n\n","description_markdown":"Create or Update a Product Collection at the Bank.\n\nUse Product Collections to create Product \"Baskets\", \"Portfolios\", \"Indices\", \"Collections\", \"Underlyings-lists\", \"Buckets\" etc. etc.\n\nThere is a many to many relationship between Products and Product Collections:\n\n* A Product can exist in many Collections\n\n* A Collection can contain many Products.\n\nA collection has collection code, one parent Product and one or more child Products.\n\n\n\n\nProduct hiearchy vs Product Collections:\n\n* 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.\n\n* You can define a collection (also known as baskets or buckets) of products using Product Collections.\n\n \n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[COLLECTION_CODE](/glossary#collection_code): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**collection_code**](/glossary#collection_code): \n\n\n\n[**items**](/glossary#items): \n\n\n\n[**member_product_code**](/glossary#member_product_code): \n\n\n\n[**product_code**](/glossary#product_code): 1234BW\n\n\n\n[**product_collection**](/glossary#product_collection): \n\n\n","example_request_body":{"parent_product_code":"A","children_product_codes":["B","C","D"]},"success_response_body":{"product_collection":[{"collection_code":"C","product_code":"1234BW","items":[{"member_product_code":"A"},{"member_product_code":"B"}]}]},"error_response_bodies":["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."],"tags":["Product-Collection","Product"],"typed_request_body":{"type":"object","properties":{"parent_product_code":{"type":"string"},"children_product_codes":{"type":"array","items":{"type":"string"}}}},"typed_success_response_body":{"type":"object","properties":{"product_collection":{"type":"array","items":{"type":"object","properties":{"collection_code":{"type":"string"},"product_code":{"type":"string"},"items":{"type":"array","items":{"type":"object","properties":{"member_product_code":{"type":"string"}}}}}}}}},"roles":[{"role":"CanMaintainProductCollection","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/product-collections/COLLECTION_CODE","connector_methods":[]}]}