{"resource_docs":[{"operation_id":"OBPv4.0.0-getMyApiCollectionByName","implemented_by":{"version":"OBPv4.0.0","function":"getMyApiCollectionByName"},"request_verb":"GET","request_url":"/obp/v4.0.0/my/api-collections/name/API_COLLECTION_NAME","summary":"Get My Api Collection By Name","description":"
Get Api Collection By API_COLLECTION_NAME.
\nAuthentication is Mandatory
\nURL Parameters:
\nAPI_COLLECTION_NAME: Favourites
\nJSON response body fields:
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\napi_collection_name: Favourites
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nis_sharable: is_sharable
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\n","description_markdown":"Get Api Collection By API_COLLECTION_NAME.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[API_COLLECTION_NAME](/glossary#): Favourites\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**api_collection_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**api_collection_name**](/glossary#): Favourites\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[**is_sharable**](/glossary#): is_sharable\n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n","success_response_body":{"api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","api_collection_name":"Favourites","is_sharable":true,"description":"This an optional field. Maximum length is 2000. It can be any characters here."},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20057: User not found by userId.","OBP-50000: Unknown Error."],"tags":["Api-Collection"],"typed_success_response_body":{"type":"object","properties":{"description":{"type":"string"},"api_collection_id":{"type":"string"},"api_collection_name":{"type":"string"},"is_sharable":{"type":"boolean"},"user_id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/my/api-collections/name/API_COLLECTION_NAME","connector_methods":[]},{"operation_id":"OBPv4.0.0-getMyApiCollectionEndpoints","implemented_by":{"version":"OBPv4.0.0","function":"getMyApiCollectionEndpoints"},"request_verb":"GET","request_url":"/obp/v4.0.0/my/api-collections/API_COLLECTION_NAME/api-collection-endpoints","summary":"Get My Api Collection Endpoints","description":"Get Api Collection Endpoints By API_COLLECTION_NAME.
\nAuthentication is Mandatory
\nURL Parameters:
\nAPI_COLLECTION_NAME: Favourites
\nJSON response body fields:
\napi_collection_endpoint_id: 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\napi_collection_endpoints: api_collection_endpoints
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\noperation_id: OBPv4.0.0-getBanks
\n","description_markdown":"Get Api Collection Endpoints By API_COLLECTION_NAME.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[API_COLLECTION_NAME](/glossary#): Favourites\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**api_collection_endpoint_id**](/glossary#): 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**api_collection_endpoints**](/glossary#): api_collection_endpoints\n\n\n\n[**api_collection_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**operation_id**](/glossary#): OBPv4.0.0-getBanks\n\n\n","success_response_body":{"api_collection_endpoints":[{"api_collection_endpoint_id":"8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","operation_id":"OBPv4.0.0-getBanks"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20057: User not found by userId.","OBP-50000: Unknown Error."],"tags":["Api-Collection"],"typed_success_response_body":{"type":"object","properties":{"api_collection_endpoints":{"type":"array","items":{"type":"object","properties":{"operation_id":{"type":"string"},"api_collection_id":{"type":"string"},"api_collection_endpoint_id":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/my/api-collections/API_COLLECTION_NAME/api-collection-endpoints","connector_methods":[]},{"operation_id":"OBPv4.0.0-getFeaturedApiCollections","implemented_by":{"version":"OBPv4.0.0","function":"getFeaturedApiCollections"},"request_verb":"GET","request_url":"/obp/v4.0.0/api-collections/featured","summary":"Get Featured Api Collections","description":"Get Featured Api Collections.
\nAuthentication is Optional
\nJSON response body fields:
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\napi_collection_name: Favourites
\napi_collections: api_collections
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nis_sharable: is_sharable
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\n","description_markdown":"Get Featured Api Collections.\n\nAuthentication is Optional\n\n\n**JSON response body fields:**\n\n\n\n[**api_collection_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**api_collection_name**](/glossary#): Favourites\n\n\n\n[**api_collections**](/glossary#): api_collections\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[**is_sharable**](/glossary#): is_sharable\n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n","success_response_body":{"api_collections":[{"api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","api_collection_name":"Favourites","is_sharable":true,"description":"This an optional field. Maximum length is 2000. It can be any characters here."}]},"error_response_bodies":["OBP-50000: Unknown Error."],"tags":["Api-Collection"],"typed_success_response_body":{"type":"object","properties":{"api_collections":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"api_collection_id":{"type":"string"},"api_collection_name":{"type":"string"},"is_sharable":{"type":"boolean"},"user_id":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/api-collections/featured","connector_methods":[]},{"operation_id":"OBPv4.0.0-getSharableApiCollectionById","implemented_by":{"version":"OBPv4.0.0","function":"getSharableApiCollectionById"},"request_verb":"GET","request_url":"/obp/v4.0.0/api-collections/sharable/API_COLLECTION_ID","summary":"Get Sharable Api Collection By Id","description":"Get Sharable Api Collection By Id.
\nAuthentication is Optional
URL Parameters:
\nAPI_COLLECTION_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\napi_collection_name: Favourites
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nis_sharable: is_sharable
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\n","description_markdown":"Get Sharable Api Collection By Id.\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n[API_COLLECTION_ID](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**api_collection_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**api_collection_name**](/glossary#): Favourites\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[**is_sharable**](/glossary#): is_sharable\n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n","success_response_body":{"api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","api_collection_name":"Favourites","is_sharable":true,"description":"This an optional field. Maximum length is 2000. It can be any characters here."},"error_response_bodies":["OBP-50000: Unknown Error."],"tags":["Api-Collection"],"typed_success_response_body":{"type":"object","properties":{"description":{"type":"string"},"api_collection_id":{"type":"string"},"api_collection_name":{"type":"string"},"is_sharable":{"type":"boolean"},"user_id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/api-collections/sharable/API_COLLECTION_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-getApiCollectionsForUser","implemented_by":{"version":"OBPv4.0.0","function":"getApiCollectionsForUser"},"request_verb":"GET","request_url":"/obp/v4.0.0/users/USER_ID/api-collections","summary":"Get Api Collections for User","description":"Get Api Collections for User.
\nAuthentication is Mandatory
\nURL Parameters:
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\napi_collection_name: Favourites
\napi_collections: api_collections
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nis_sharable: is_sharable
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\n","description_markdown":"Get Api Collections for User.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[USER_ID](/glossary#User.user_id): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**api_collection_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**api_collection_name**](/glossary#): Favourites\n\n\n\n[**api_collections**](/glossary#): api_collections\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[**is_sharable**](/glossary#): is_sharable\n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n","success_response_body":{"api_collections":[{"api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","api_collection_name":"Favourites","is_sharable":true,"description":"This an optional field. Maximum length is 2000. It can be any characters here."}]},"error_response_bodies":["OBP-20057: User not found by userId.","OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: "],"tags":["Api-Collection"],"typed_success_response_body":{"type":"object","properties":{"api_collections":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"api_collection_id":{"type":"string"},"api_collection_name":{"type":"string"},"is_sharable":{"type":"boolean"},"user_id":{"type":"string"}}}}}},"roles":[{"role":"CanGetApiCollectionsForUser","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/users/USER_ID/api-collections","connector_methods":[]},{"operation_id":"OBPv4.0.0-deleteMyApiCollectionEndpointById","implemented_by":{"version":"OBPv4.0.0","function":"deleteMyApiCollectionEndpointById"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/my/api-collection-ids/API_COLLECTION_ID/api-collection-endpoint-ids/API_COLLECTION_ENDPOINT_ID","summary":"Delete My Api Collection Endpoint By Id","description":"glossary-item-not-found
\nDelete Api Collection Endpoint
\nDelete Api Collection Endpoint By Id
Authentication is Mandatory
\nURL Parameters:
\nAPI_COLLECTION_ENDPOINT_ID: 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nAPI_COLLECTION_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\n","description_markdown":"glossary-item-not-found\nDelete Api Collection Endpoint\nDelete Api Collection Endpoint By Id\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[API_COLLECTION_ENDPOINT_ID](/glossary#): 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[API_COLLECTION_ID](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":true,"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20057: User not found by userId.","OBP-50000: Unknown Error."],"tags":["Api-Collection"],"typed_success_response_body":{"type":"object","properties":{"value":{"type":"boolean"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/my/api-collection-ids/API_COLLECTION_ID/api-collection-endpoint-ids/API_COLLECTION_ENDPOINT_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-deleteMyApiCollection","implemented_by":{"version":"OBPv4.0.0","function":"deleteMyApiCollection"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/my/api-collections/API_COLLECTION_ID","summary":"Delete My Api Collection","description":"Delete Api Collection By API_COLLECTION_ID
\nglossary-item-not-found
\nAuthentication is Mandatory
\nURL Parameters:
\nAPI_COLLECTION_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\n","description_markdown":"Delete Api Collection By API_COLLECTION_ID\n\nglossary-item-not-found\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[API_COLLECTION_ID](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":true,"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20057: User not found by userId.","OBP-50000: Unknown Error."],"tags":["Api-Collection"],"typed_success_response_body":{"type":"object","properties":{"value":{"type":"boolean"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/my/api-collections/API_COLLECTION_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-getApiCollectionEndpoints","implemented_by":{"version":"OBPv4.0.0","function":"getApiCollectionEndpoints"},"request_verb":"GET","request_url":"/obp/v4.0.0/api-collections/API_COLLECTION_ID/api-collection-endpoints","summary":"Get Api Collection Endpoints","description":"Get Api Collection Endpoints By API_COLLECTION_ID.
\nAuthentication is Optional
\nURL Parameters:
\nAPI_COLLECTION_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\napi_collection_endpoint_id: 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\napi_collection_endpoints: api_collection_endpoints
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\noperation_id: OBPv4.0.0-getBanks
\n","description_markdown":"Get Api Collection Endpoints By API_COLLECTION_ID.\n\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n[API_COLLECTION_ID](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**api_collection_endpoint_id**](/glossary#): 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**api_collection_endpoints**](/glossary#): api_collection_endpoints\n\n\n\n[**api_collection_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**operation_id**](/glossary#): OBPv4.0.0-getBanks\n\n\n","success_response_body":{"api_collection_endpoints":[{"api_collection_endpoint_id":"8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","operation_id":"OBPv4.0.0-getBanks"}]},"error_response_bodies":["OBP-50000: Unknown Error."],"tags":["Api-Collection"],"typed_success_response_body":{"type":"object","properties":{"api_collection_endpoints":{"type":"array","items":{"type":"object","properties":{"operation_id":{"type":"string"},"api_collection_id":{"type":"string"},"api_collection_endpoint_id":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/api-collections/API_COLLECTION_ID/api-collection-endpoints","connector_methods":[]},{"operation_id":"OBPv4.0.0-getMyApiCollectionEndpoint","implemented_by":{"version":"OBPv4.0.0","function":"getMyApiCollectionEndpoint"},"request_verb":"GET","request_url":"/obp/v4.0.0/my/api-collections/API_COLLECTION_NAME/api-collection-endpoints/OPERATION_ID","summary":"Get My Api Collection Endpoint","description":"Get Api Collection Endpoint By API_COLLECTION_NAME and OPERATION_ID.
\nAuthentication is Optional
\nURL Parameters:
\nAPI_COLLECTION_NAME: Favourites
\nOPERATION_ID: OBPv4.0.0-getBanks
\nJSON response body fields:
\napi_collection_endpoint_id: 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\noperation_id: OBPv4.0.0-getBanks
\n","description_markdown":"Get Api Collection Endpoint By API_COLLECTION_NAME and OPERATION_ID.\n\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n[API_COLLECTION_NAME](/glossary#): Favourites\n\n\n\n[OPERATION_ID](/glossary#): OBPv4.0.0-getBanks\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**api_collection_endpoint_id**](/glossary#): 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**api_collection_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**operation_id**](/glossary#): OBPv4.0.0-getBanks\n\n\n","success_response_body":{"api_collection_endpoint_id":"8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","operation_id":"OBPv4.0.0-getBanks"},"error_response_bodies":["OBP-20057: User not found by userId.","OBP-50000: Unknown Error."],"tags":["Api-Collection"],"typed_success_response_body":{"type":"object","properties":{"operation_id":{"type":"string"},"api_collection_id":{"type":"string"},"api_collection_endpoint_id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/my/api-collections/API_COLLECTION_NAME/api-collection-endpoints/OPERATION_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-deleteMyApiCollectionEndpoint","implemented_by":{"version":"OBPv4.0.0","function":"deleteMyApiCollectionEndpoint"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/my/api-collections/API_COLLECTION_NAME/api-collection-endpoints/OPERATION_ID","summary":"Delete My Api Collection Endpoint","description":"glossary-item-not-found
\nDelete Api Collection Endpoint By OPERATION_ID
\nAuthentication is Mandatory
\nURL Parameters:
\nAPI_COLLECTION_NAME: Favourites
\nOPERATION_ID: OBPv4.0.0-getBanks
\nJSON response body fields:
\n","description_markdown":"glossary-item-not-found\n\n\nDelete Api Collection Endpoint By OPERATION_ID\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[API_COLLECTION_NAME](/glossary#): Favourites\n\n\n\n[OPERATION_ID](/glossary#): OBPv4.0.0-getBanks\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":true,"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20057: User not found by userId.","OBP-50000: Unknown Error."],"tags":["Api-Collection"],"typed_success_response_body":{"type":"object","properties":{"value":{"type":"boolean"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/my/api-collections/API_COLLECTION_NAME/api-collection-endpoints/OPERATION_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-getMyApiCollectionById","implemented_by":{"version":"OBPv4.0.0","function":"getMyApiCollectionById"},"request_verb":"GET","request_url":"/obp/v4.0.0/my/api-collections/API_COLLECTION_ID","summary":"Get My Api Collection By Id","description":"Get Api Collection By API_COLLECTION_ID.
\nAuthentication is Mandatory
\nURL Parameters:
\nAPI_COLLECTION_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\napi_collection_name: Favourites
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nis_sharable: is_sharable
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\n","description_markdown":"Get Api Collection By API_COLLECTION_ID.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[API_COLLECTION_ID](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**api_collection_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**api_collection_name**](/glossary#): Favourites\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[**is_sharable**](/glossary#): is_sharable\n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n","success_response_body":{"api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","api_collection_name":"Favourites","is_sharable":true,"description":"This an optional field. Maximum length is 2000. It can be any characters here."},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20057: User not found by userId.","OBP-50000: Unknown Error."],"tags":["Api-Collection"],"typed_success_response_body":{"type":"object","properties":{"description":{"type":"string"},"api_collection_id":{"type":"string"},"api_collection_name":{"type":"string"},"is_sharable":{"type":"boolean"},"user_id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/my/api-collections/API_COLLECTION_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-deleteMyApiCollectionEndpointByOperationId","implemented_by":{"version":"OBPv4.0.0","function":"deleteMyApiCollectionEndpointByOperationId"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/my/api-collection-ids/API_COLLECTION_ID/api-collection-endpoints/OPERATION_ID","summary":"Delete My Api Collection Endpoint By Id","description":"glossary-item-not-found
\nDelete Api Collection Endpoint By OPERATION_ID
\nAuthentication is Mandatory
\nURL Parameters:
\nAPI_COLLECTION_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nOPERATION_ID: OBPv4.0.0-getBanks
\nJSON response body fields:
\n","description_markdown":"glossary-item-not-found\n\nDelete Api Collection Endpoint By OPERATION_ID\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[API_COLLECTION_ID](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[OPERATION_ID](/glossary#): OBPv4.0.0-getBanks\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":true,"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20057: User not found by userId.","OBP-50000: Unknown Error."],"tags":["Api-Collection"],"typed_success_response_body":{"type":"object","properties":{"value":{"type":"boolean"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/my/api-collection-ids/API_COLLECTION_ID/api-collection-endpoints/OPERATION_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-createMyApiCollection","implemented_by":{"version":"OBPv4.0.0","function":"createMyApiCollection"},"request_verb":"POST","request_url":"/obp/v4.0.0/my/api-collections","summary":"Create My Api Collection","description":"Create Api Collection for logged in user.
\nAuthentication is Mandatory
\nJSON request body fields:
\napi_collection_name: Favourites
\nis_sharable: is_sharable
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nJSON response body fields:
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\napi_collection_name: Favourites
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nis_sharable: is_sharable
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\n","description_markdown":"Create Api Collection for logged in user.\n\nAuthentication is Mandatory\n\n\n**JSON request body fields:**\n\n\n\n[**api_collection_name**](/glossary#): Favourites\n\n\n\n[**is_sharable**](/glossary#): is_sharable\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\n\n**JSON response body fields:**\n\n\n\n[**api_collection_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**api_collection_name**](/glossary#): Favourites\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[**is_sharable**](/glossary#): is_sharable\n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n","example_request_body":{"api_collection_name":"Favourites","is_sharable":true,"description":"This an optional field. Maximum length is 2000. It can be any characters here."},"success_response_body":{"api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","api_collection_name":"Favourites","is_sharable":true,"description":"This an optional field. Maximum length is 2000. It can be any characters here."},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-20057: User not found by userId.","OBP-50000: Unknown Error."],"tags":["Api-Collection"],"typed_request_body":{"type":"object","properties":{"api_collection_name":{"type":"string"},"is_sharable":{"type":"boolean"},"description":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"description":{"type":"string"},"api_collection_id":{"type":"string"},"api_collection_name":{"type":"string"},"is_sharable":{"type":"boolean"},"user_id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/my/api-collections","connector_methods":[]},{"operation_id":"OBPv4.0.0-createMyApiCollectionEndpointById","implemented_by":{"version":"OBPv4.0.0","function":"createMyApiCollectionEndpointById"},"request_verb":"POST","request_url":"/obp/v4.0.0/my/api-collection-ids/API_COLLECTION_ID/api-collection-endpoints","summary":"Create My Api Collection Endpoint By Id","description":"Create Api Collection Endpoint By Id.
\nglossary-item-not-found
\nAuthentication is Mandatory
\nURL Parameters:
\nAPI_COLLECTION_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON request body fields:
\noperation_id: OBPv4.0.0-getBanks
\nJSON response body fields:
\napi_collection_endpoint_id: 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\noperation_id: OBPv4.0.0-getBanks
\n","description_markdown":"Create Api Collection Endpoint By Id.\n\nglossary-item-not-found\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[API_COLLECTION_ID](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**operation_id**](/glossary#): OBPv4.0.0-getBanks\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**api_collection_endpoint_id**](/glossary#): 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**api_collection_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**operation_id**](/glossary#): OBPv4.0.0-getBanks\n\n\n","example_request_body":{"operation_id":"OBPv4.0.0-getBanks"},"success_response_body":{"api_collection_endpoint_id":"8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","operation_id":"OBPv4.0.0-getBanks"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["Api-Collection"],"typed_request_body":{"type":"object","properties":{"operation_id":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"operation_id":{"type":"string"},"api_collection_id":{"type":"string"},"api_collection_endpoint_id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/my/api-collection-ids/API_COLLECTION_ID/api-collection-endpoints","connector_methods":[]},{"operation_id":"OBPv4.0.0-getMyApiCollections","implemented_by":{"version":"OBPv4.0.0","function":"getMyApiCollections"},"request_verb":"GET","request_url":"/obp/v4.0.0/my/api-collections","summary":"Get My Api Collections","description":"Get all the apiCollections for logged in user.
\nAuthentication is Mandatory
\nJSON response body fields:
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\napi_collection_name: Favourites
\napi_collections: api_collections
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nis_sharable: is_sharable
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\n","description_markdown":"Get all the apiCollections for logged in user.\n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n\n[**api_collection_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**api_collection_name**](/glossary#): Favourites\n\n\n\n[**api_collections**](/glossary#): api_collections\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[**is_sharable**](/glossary#): is_sharable\n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n","success_response_body":{"api_collections":[{"api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","api_collection_name":"Favourites","is_sharable":true,"description":"This an optional field. Maximum length is 2000. It can be any characters here."}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Api-Collection"],"typed_success_response_body":{"type":"object","properties":{"api_collections":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"api_collection_id":{"type":"string"},"api_collection_name":{"type":"string"},"is_sharable":{"type":"boolean"},"user_id":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/my/api-collections","connector_methods":[]},{"operation_id":"OBPv4.0.0-getMyApiCollectionEndpointsById","implemented_by":{"version":"OBPv4.0.0","function":"getMyApiCollectionEndpointsById"},"request_verb":"GET","request_url":"/obp/v4.0.0/my/api-collection-ids/API_COLLECTION_ID/api-collection-endpoints","summary":"Get My Api Collection Endpoints By Id","description":"Get Api Collection Endpoints By API_COLLECTION_ID.
\nAuthentication is Mandatory
\nURL Parameters:
\nAPI_COLLECTION_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\napi_collection_endpoint_id: 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\napi_collection_endpoints: api_collection_endpoints
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\noperation_id: OBPv4.0.0-getBanks
\n","description_markdown":"Get Api Collection Endpoints By API_COLLECTION_ID.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[API_COLLECTION_ID](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**api_collection_endpoint_id**](/glossary#): 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**api_collection_endpoints**](/glossary#): api_collection_endpoints\n\n\n\n[**api_collection_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**operation_id**](/glossary#): OBPv4.0.0-getBanks\n\n\n","success_response_body":{"api_collection_endpoints":[{"api_collection_endpoint_id":"8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","operation_id":"OBPv4.0.0-getBanks"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20057: User not found by userId.","OBP-50000: Unknown Error."],"tags":["Api-Collection"],"typed_success_response_body":{"type":"object","properties":{"api_collection_endpoints":{"type":"array","items":{"type":"object","properties":{"operation_id":{"type":"string"},"api_collection_id":{"type":"string"},"api_collection_endpoint_id":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/my/api-collection-ids/API_COLLECTION_ID/api-collection-endpoints","connector_methods":[]},{"operation_id":"OBPv4.0.0-createMyApiCollectionEndpoint","implemented_by":{"version":"OBPv4.0.0","function":"createMyApiCollectionEndpoint"},"request_verb":"POST","request_url":"/obp/v4.0.0/my/api-collections/API_COLLECTION_NAME/api-collection-endpoints","summary":"Create My Api Collection Endpoint","description":"Create Api Collection Endpoint.
\nglossary-item-not-found
\nAuthentication is Mandatory
\nURL Parameters:
\nAPI_COLLECTION_NAME: Favourites
\nJSON request body fields:
\noperation_id: OBPv4.0.0-getBanks
\nJSON response body fields:
\napi_collection_endpoint_id: 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\noperation_id: OBPv4.0.0-getBanks
\n","description_markdown":"Create Api Collection Endpoint.\n\nglossary-item-not-found\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[API_COLLECTION_NAME](/glossary#): Favourites\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**operation_id**](/glossary#): OBPv4.0.0-getBanks\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**api_collection_endpoint_id**](/glossary#): 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**api_collection_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**operation_id**](/glossary#): OBPv4.0.0-getBanks\n\n\n","example_request_body":{"operation_id":"OBPv4.0.0-getBanks"},"success_response_body":{"api_collection_endpoint_id":"8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","operation_id":"OBPv4.0.0-getBanks"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["Api-Collection"],"typed_request_body":{"type":"object","properties":{"operation_id":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"operation_id":{"type":"string"},"api_collection_id":{"type":"string"},"api_collection_endpoint_id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/my/api-collections/API_COLLECTION_NAME/api-collection-endpoints","connector_methods":[]}]}