right logo image
right logo image
Log on
⯆

API Explorer

Log off

v5.1.0 (598 APIs)

API Host: https://ifcsandbox.openbankproject.com
Bank
Accounts
Views
Counterparties
Transactions

Create WebUiProps

Create a WebUiProps.

Authentication is Mandatory

Explaination of Fields:

  • name is required String value
  • value is required String value

The line break and double quotations should do escape, example:


{"name": "webui_some", "value": "this value
have "line break" and double quotations."}

should do escape like this:


{"name": "webui_some", "value": "this value\nhave \"line break\" and double quotations."}

Insert image examples:

// set width=100 and height=50
{"name": "webui_some_pic", "value": "here is a picture <img alt="hello" src="http://somedomain.com/images/pic.png" width="100" height="50" />"}

// only set height=50
{"name": "webui_some_pic", "value": "here is a picture <img alt="hello" src="http://somedomain.com/images/pic.png" width="" height="50" />"}

// only width=20%
{"name": "webui_some_pic", "value": "here is a picture <img alt="hello" src="http://somedomain.com/images/pic.png" width="20%" height="" />"}

JSON request body fields:

name: ACCOUNT_MANAGEMENT_FEE

value: 5987953

JSON response body fields:

name: ACCOUNT_MANAGEMENT_FEE

value: 5987953

Typical Successful Response: 

								
									
{
  "name":"webui_api_explorer_url",
  "value":"https://apiexplorer.openbankproject.com",
  "web_ui_props_id":"some-web-ui-props-id"
}
Required Roles:
  • CanCreateWebUiProps - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by createWebUiProps, operation_id: OBPv3.1.0-createWebUiProps Tags: WebUi-Props,

Delete WebUiProps

Delete a WebUiProps specified by WEB_UI_PROPS_ID.

Authentication is Mandatory

URL Parameters:

WEB_UI_PROPS_ID:

JSON response body fields:

Typical Successful Response:
Required Roles:
  • CanDeleteWebUiProps - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by deleteWebUiProps, operation_id: OBPv3.1.0-deleteWebUiProps Tags: WebUi-Props,

Get WebUiProps

Get the all WebUiProps key values, those props key with "webui_" can be stored in DB, this endpoint get all from DB.

url query parameter:
active: It must be a boolean string. and If active = true, it will show
combination of explicit (inserted) + implicit (default) method_routings.

eg:
https://ifcsandbox.openbankproject.com/obp/v3.1.0/management/webui_props
https://ifcsandbox.openbankproject.com/obp/v3.1.0/management/webui_props?active=true

Authentication is Mandatory

JSON response body fields:

name: ACCOUNT_MANAGEMENT_FEE

value: 5987953

Typical Successful Response: 

								
									
{
  "webui_props":[{
    "name":"webui_api_explorer_url",
    "value":"https://apiexplorer.openbankproject.com",
    "web_ui_props_id":"web-ui-props-id"
  }]
}
Required Roles:
  • CanGetWebUiProps - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getWebUiProps, operation_id: OBPv3.1.0-getWebUiProps Tags: WebUi-Props,