right logo image
right logo image
Log on
⯆

API Explorer

Log off

v4.0.0 (543 APIs)

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

A test endpoint

A test endpoint.

Just for debug method body of dynamic resource doc.
better watch the following introduction video first
* Dynamic resourceDoc version1

The endpoint return the response from PractiseEndpoint code.
Here, code.api.DynamicEndpoints.dynamic.practise.PractiseEndpoint.process
You can test the method body grammar, and try the business logic, but need to restart the OBP-API code .

User Authentication is Optional. The User need not be logged in.

URL Parameters:

MY_USER_ID: MY_USER_ID

JSON request body fields:

age: 18

hobby: hobby

name: ACCOUNT_MANAGEMENT_FEE

JSON response body fields:

age: 18

hobby: hobby

name: ACCOUNT_MANAGEMENT_FEE

Typical Successful Response: 

								
									
{
  "name":"ACCOUNT_MANAGEMENT_FEE",
  "age":18,
  "hobby":[]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by test-dynamic-resource-doc, operation_id: OBPv4.0.0-test-dynamic-resource-doc Tags: Dynamic-Resource-Doc,

Create Bank Level Dynamic Resource Doc

Create a Bank Level Dynamic Resource Doc.

The connector_method_body is URL-encoded format String

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

JSON request body fields:

description: Description of the object. Maximum length is 2000. It can be any characters here.

name: ACCOUNT_MANAGEMENT_FEE

roles: CanCreateMyUser

summary:

tags: Create-My-User

JSON response body fields:

description: Description of the object. Maximum length is 2000. It can be any characters here.

name: ACCOUNT_MANAGEMENT_FEE

roles: CanCreateMyUser

summary:

tags: Create-My-User

Typical Successful Response: 

								
									
{
  "error_response_bodies":"OBP-50000: Unknown Error.,OBP-20001: User not logged in. Authentication is required!,OBP-20006: User is missing one or more roles: ,OBP-10001: Incorrect json format.",
  "description":"Create one User",
  "tags":"Create-My-User",
  "dynamic_resource_doc_id":"vce035ca-9a0f-4bfa-b30b-9003aa467f51",
  "request_verb":"POST",
  "method_body":"%20%20%20%20val%20Some(resourceDoc)%20%3D%20callContext.resourceDocument%0A%20%20%20%20val%20hasRequestBody%20%3D%20request.body.isDefined%0A%0A%20%20%20%20%2F%2F%20get%20Path%20Parameters%2C%20example%3A%0A%20%20%20%20%2F%2F%20if%20the%20requestUrl%20of%20resourceDoc%20is%20%2Fhello%2Fbanks%2FBANK_ID%2Fworld%0A%20%20%20%20%2F%2F%20the%20request%20path%20is%20%2Fhello%2Fbanks%2Fbank_x%2Fworld%0A%20%20%20%20%2F%2FpathParams.get(%22BANK_ID%22)%20will%20get%20Option(%22bank_x%22)%20value%0A%0A%20%20%20%20val%20myUserId%20%3D%20pathParams(%22MY_USER_ID%22)%0A%0A%0A%20%20%20%20val%20requestEntity%20%3D%20request.json%20match%20%7B%0A%20%20%20%20%20%20case%20Full(zson)%20%3D%3E%0A%20%20%20%20%20%20%20%20try%20%7B%0A%20%20%20%20%20%20%20%20%20%20zson.extract%5BRequestRootJsonClass%5D%0A%20%20%20%20%20%20%20%20%7D%20catch%20%7B%0A%20%20%20%20%20%20%20%20%20%20case%20e%3A%20MappingException%20%3D%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20return%20Full(errorJsonResponse(s%22%24InvalidJsonFormat%20%24%7Be.msg%7D%22))%0A%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20case%20_%3A%20EmptyBox%20%3D%3E%0A%20%20%20%20%20%20%20%20return%20Full(errorJsonResponse(s%22%24InvalidRequestPayload%20Current%20request%20has%20no%20payload%22))%0A%20%20%20%20%7D%0A%0A%0A%20%20%20%20%2F%2F%20please%20add%20business%20logic%20here%0A%20%20%20%20val%20responseBody%3AResponseRootJsonClass%20%3D%20ResponseRootJsonClass(s%22%24%7BmyUserId%7D_from_path%22%2C%20requestEntity.name%2C%20requestEntity.age%2C%20requestEntity.hobby)%0A%20%20%20%20Future.successful%20%7B%0A%20%20%20%20%20%20(responseBody%2C%20HttpCode.%60200%60(callContext.callContext))%0A%20%20%20%20%7D",
  "roles":"CanCreateMyUser",
  "example_request_body":{
    "name":"Jhon",
    "age":12,
    "hobby":["coding"],
    "_optional_fields_":["hobby"]
  },
  "request_url":"/my_user/MY_USER_ID",
  "bank_id":"gh.29.uk",
  "partial_function_name":"createUser",
  "summary":"Create My User",
  "success_response_body":{
    "my_user_id":"some_id_value",
    "name":"Jhon",
    "age":12,
    "hobby":["coding"],
    "_optional_fields_":["hobby"]
  }
}
Required Roles:
  • CanCreateBankLevelDynamicResourceDoc - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • 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: OBPv4.0.0, function_name: by createBankLevelDynamicResourceDoc, operation_id: OBPv4.0.0-createBankLevelDynamicResourceDoc Tags: Dynamic-Resource-Doc,

Create Dynamic Resource Doc

Create a Dynamic Resource Doc.

The connector_method_body is URL-encoded format String

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON request body fields:

description: Description of the object. Maximum length is 2000. It can be any characters here.

name: ACCOUNT_MANAGEMENT_FEE

roles: CanCreateMyUser

summary:

tags: Create-My-User

JSON response body fields:

description: Description of the object. Maximum length is 2000. It can be any characters here.

name: ACCOUNT_MANAGEMENT_FEE

roles: CanCreateMyUser

summary:

tags: Create-My-User

Typical Successful Response: 

								
									
{
  "error_response_bodies":"OBP-50000: Unknown Error.,OBP-20001: User not logged in. Authentication is required!,OBP-20006: User is missing one or more roles: ,OBP-10001: Incorrect json format.",
  "description":"Create one User",
  "tags":"Create-My-User",
  "dynamic_resource_doc_id":"vce035ca-9a0f-4bfa-b30b-9003aa467f51",
  "request_verb":"POST",
  "method_body":"%20%20%20%20val%20Some(resourceDoc)%20%3D%20callContext.resourceDocument%0A%20%20%20%20val%20hasRequestBody%20%3D%20request.body.isDefined%0A%0A%20%20%20%20%2F%2F%20get%20Path%20Parameters%2C%20example%3A%0A%20%20%20%20%2F%2F%20if%20the%20requestUrl%20of%20resourceDoc%20is%20%2Fhello%2Fbanks%2FBANK_ID%2Fworld%0A%20%20%20%20%2F%2F%20the%20request%20path%20is%20%2Fhello%2Fbanks%2Fbank_x%2Fworld%0A%20%20%20%20%2F%2FpathParams.get(%22BANK_ID%22)%20will%20get%20Option(%22bank_x%22)%20value%0A%0A%20%20%20%20val%20myUserId%20%3D%20pathParams(%22MY_USER_ID%22)%0A%0A%0A%20%20%20%20val%20requestEntity%20%3D%20request.json%20match%20%7B%0A%20%20%20%20%20%20case%20Full(zson)%20%3D%3E%0A%20%20%20%20%20%20%20%20try%20%7B%0A%20%20%20%20%20%20%20%20%20%20zson.extract%5BRequestRootJsonClass%5D%0A%20%20%20%20%20%20%20%20%7D%20catch%20%7B%0A%20%20%20%20%20%20%20%20%20%20case%20e%3A%20MappingException%20%3D%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20return%20Full(errorJsonResponse(s%22%24InvalidJsonFormat%20%24%7Be.msg%7D%22))%0A%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20case%20_%3A%20EmptyBox%20%3D%3E%0A%20%20%20%20%20%20%20%20return%20Full(errorJsonResponse(s%22%24InvalidRequestPayload%20Current%20request%20has%20no%20payload%22))%0A%20%20%20%20%7D%0A%0A%0A%20%20%20%20%2F%2F%20please%20add%20business%20logic%20here%0A%20%20%20%20val%20responseBody%3AResponseRootJsonClass%20%3D%20ResponseRootJsonClass(s%22%24%7BmyUserId%7D_from_path%22%2C%20requestEntity.name%2C%20requestEntity.age%2C%20requestEntity.hobby)%0A%20%20%20%20Future.successful%20%7B%0A%20%20%20%20%20%20(responseBody%2C%20HttpCode.%60200%60(callContext.callContext))%0A%20%20%20%20%7D",
  "roles":"CanCreateMyUser",
  "example_request_body":{
    "name":"Jhon",
    "age":12,
    "hobby":["coding"],
    "_optional_fields_":["hobby"]
  },
  "request_url":"/my_user/MY_USER_ID",
  "bank_id":"gh.29.uk",
  "partial_function_name":"createUser",
  "summary":"Create My User",
  "success_response_body":{
    "my_user_id":"some_id_value",
    "name":"Jhon",
    "age":12,
    "hobby":["coding"],
    "_optional_fields_":["hobby"]
  }
}
Required Roles:
  • CanCreateDynamicResourceDoc - 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: OBPv4.0.0, function_name: by createDynamicResourceDoc, operation_id: OBPv4.0.0-createDynamicResourceDoc Tags: Dynamic-Resource-Doc,

Create Dynamic Resource Doc endpoint code

Create a Dynamic Resource Doc endpoint code.

copy the response and past to PractiseEndpoint, So you can have the benefits of
auto compilation and debug

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON request body fields:

name: ACCOUNT_MANAGEMENT_FEE

JSON response body fields:

code: 125

Typical Successful Response: 

								
									
{
  "code":"println%28%22hello%22%29"
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by buildDynamicEndpointTemplate, operation_id: OBPv4.0.0-buildDynamicEndpointTemplate Tags: Dynamic-Resource-Doc,

Delete Bank Level Dynamic Resource Doc

Delete a Bank Level Dynamic Resource Doc.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

Typical Successful Response: 

								
									
true
Required Roles:
  • CanDeleteBankLevelDynamicResourceDoc - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • 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: OBPv4.0.0, function_name: by deleteBankLevelDynamicResourceDoc, operation_id: OBPv4.0.0-deleteBankLevelDynamicResourceDoc Tags: Dynamic-Resource-Doc,

Delete Dynamic Resource Doc

Delete a Dynamic Resource Doc.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON response body fields:

Typical Successful Response: 

								
									
true
Required Roles:
  • CanDeleteDynamicResourceDoc - 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: OBPv4.0.0, function_name: by deleteDynamicResourceDoc, operation_id: OBPv4.0.0-deleteDynamicResourceDoc Tags: Dynamic-Resource-Doc,

Get Bank Level Dynamic Resource Doc by Id

Get a Bank Level Dynamic Resource Doc by DYNAMIC-RESOURCE-DOC-ID.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

description: Description of the object. Maximum length is 2000. It can be any characters here.

name: ACCOUNT_MANAGEMENT_FEE

roles: CanCreateMyUser

summary:

tags: Create-My-User

Typical Successful Response: 

								
									
{
  "error_response_bodies":"OBP-50000: Unknown Error.,OBP-20001: User not logged in. Authentication is required!,OBP-20006: User is missing one or more roles: ,OBP-10001: Incorrect json format.",
  "description":"Create one User",
  "tags":"Create-My-User",
  "dynamic_resource_doc_id":"vce035ca-9a0f-4bfa-b30b-9003aa467f51",
  "request_verb":"POST",
  "method_body":"%20%20%20%20val%20Some(resourceDoc)%20%3D%20callContext.resourceDocument%0A%20%20%20%20val%20hasRequestBody%20%3D%20request.body.isDefined%0A%0A%20%20%20%20%2F%2F%20get%20Path%20Parameters%2C%20example%3A%0A%20%20%20%20%2F%2F%20if%20the%20requestUrl%20of%20resourceDoc%20is%20%2Fhello%2Fbanks%2FBANK_ID%2Fworld%0A%20%20%20%20%2F%2F%20the%20request%20path%20is%20%2Fhello%2Fbanks%2Fbank_x%2Fworld%0A%20%20%20%20%2F%2FpathParams.get(%22BANK_ID%22)%20will%20get%20Option(%22bank_x%22)%20value%0A%0A%20%20%20%20val%20myUserId%20%3D%20pathParams(%22MY_USER_ID%22)%0A%0A%0A%20%20%20%20val%20requestEntity%20%3D%20request.json%20match%20%7B%0A%20%20%20%20%20%20case%20Full(zson)%20%3D%3E%0A%20%20%20%20%20%20%20%20try%20%7B%0A%20%20%20%20%20%20%20%20%20%20zson.extract%5BRequestRootJsonClass%5D%0A%20%20%20%20%20%20%20%20%7D%20catch%20%7B%0A%20%20%20%20%20%20%20%20%20%20case%20e%3A%20MappingException%20%3D%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20return%20Full(errorJsonResponse(s%22%24InvalidJsonFormat%20%24%7Be.msg%7D%22))%0A%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20case%20_%3A%20EmptyBox%20%3D%3E%0A%20%20%20%20%20%20%20%20return%20Full(errorJsonResponse(s%22%24InvalidRequestPayload%20Current%20request%20has%20no%20payload%22))%0A%20%20%20%20%7D%0A%0A%0A%20%20%20%20%2F%2F%20please%20add%20business%20logic%20here%0A%20%20%20%20val%20responseBody%3AResponseRootJsonClass%20%3D%20ResponseRootJsonClass(s%22%24%7BmyUserId%7D_from_path%22%2C%20requestEntity.name%2C%20requestEntity.age%2C%20requestEntity.hobby)%0A%20%20%20%20Future.successful%20%7B%0A%20%20%20%20%20%20(responseBody%2C%20HttpCode.%60200%60(callContext.callContext))%0A%20%20%20%20%7D",
  "roles":"CanCreateMyUser",
  "example_request_body":{
    "name":"Jhon",
    "age":12,
    "hobby":["coding"],
    "_optional_fields_":["hobby"]
  },
  "request_url":"/my_user/MY_USER_ID",
  "bank_id":"gh.29.uk",
  "partial_function_name":"createUser",
  "summary":"Create My User",
  "success_response_body":{
    "my_user_id":"some_id_value",
    "name":"Jhon",
    "age":12,
    "hobby":["coding"],
    "_optional_fields_":["hobby"]
  }
}
Required Roles:
  • CanGetBankLevelDynamicResourceDoc - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • 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: OBPv4.0.0, function_name: by getBankLevelDynamicResourceDoc, operation_id: OBPv4.0.0-getBankLevelDynamicResourceDoc Tags: Dynamic-Resource-Doc,

Get Dynamic Resource Doc by Id

Get a Dynamic Resource Doc by DYNAMIC-RESOURCE-DOC-ID.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON response body fields:

description: Description of the object. Maximum length is 2000. It can be any characters here.

name: ACCOUNT_MANAGEMENT_FEE

roles: CanCreateMyUser

summary:

tags: Create-My-User

Typical Successful Response: 

								
									
{
  "error_response_bodies":"OBP-50000: Unknown Error.,OBP-20001: User not logged in. Authentication is required!,OBP-20006: User is missing one or more roles: ,OBP-10001: Incorrect json format.",
  "description":"Create one User",
  "tags":"Create-My-User",
  "dynamic_resource_doc_id":"vce035ca-9a0f-4bfa-b30b-9003aa467f51",
  "request_verb":"POST",
  "method_body":"%20%20%20%20val%20Some(resourceDoc)%20%3D%20callContext.resourceDocument%0A%20%20%20%20val%20hasRequestBody%20%3D%20request.body.isDefined%0A%0A%20%20%20%20%2F%2F%20get%20Path%20Parameters%2C%20example%3A%0A%20%20%20%20%2F%2F%20if%20the%20requestUrl%20of%20resourceDoc%20is%20%2Fhello%2Fbanks%2FBANK_ID%2Fworld%0A%20%20%20%20%2F%2F%20the%20request%20path%20is%20%2Fhello%2Fbanks%2Fbank_x%2Fworld%0A%20%20%20%20%2F%2FpathParams.get(%22BANK_ID%22)%20will%20get%20Option(%22bank_x%22)%20value%0A%0A%20%20%20%20val%20myUserId%20%3D%20pathParams(%22MY_USER_ID%22)%0A%0A%0A%20%20%20%20val%20requestEntity%20%3D%20request.json%20match%20%7B%0A%20%20%20%20%20%20case%20Full(zson)%20%3D%3E%0A%20%20%20%20%20%20%20%20try%20%7B%0A%20%20%20%20%20%20%20%20%20%20zson.extract%5BRequestRootJsonClass%5D%0A%20%20%20%20%20%20%20%20%7D%20catch%20%7B%0A%20%20%20%20%20%20%20%20%20%20case%20e%3A%20MappingException%20%3D%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20return%20Full(errorJsonResponse(s%22%24InvalidJsonFormat%20%24%7Be.msg%7D%22))%0A%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20case%20_%3A%20EmptyBox%20%3D%3E%0A%20%20%20%20%20%20%20%20return%20Full(errorJsonResponse(s%22%24InvalidRequestPayload%20Current%20request%20has%20no%20payload%22))%0A%20%20%20%20%7D%0A%0A%0A%20%20%20%20%2F%2F%20please%20add%20business%20logic%20here%0A%20%20%20%20val%20responseBody%3AResponseRootJsonClass%20%3D%20ResponseRootJsonClass(s%22%24%7BmyUserId%7D_from_path%22%2C%20requestEntity.name%2C%20requestEntity.age%2C%20requestEntity.hobby)%0A%20%20%20%20Future.successful%20%7B%0A%20%20%20%20%20%20(responseBody%2C%20HttpCode.%60200%60(callContext.callContext))%0A%20%20%20%20%7D",
  "roles":"CanCreateMyUser",
  "example_request_body":{
    "name":"Jhon",
    "age":12,
    "hobby":["coding"],
    "_optional_fields_":["hobby"]
  },
  "request_url":"/my_user/MY_USER_ID",
  "bank_id":"gh.29.uk",
  "partial_function_name":"createUser",
  "summary":"Create My User",
  "success_response_body":{
    "my_user_id":"some_id_value",
    "name":"Jhon",
    "age":12,
    "hobby":["coding"],
    "_optional_fields_":["hobby"]
  }
}
Required Roles:
  • CanGetDynamicResourceDoc - 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: OBPv4.0.0, function_name: by getDynamicResourceDoc, operation_id: OBPv4.0.0-getDynamicResourceDoc Tags: Dynamic-Resource-Doc,

Get all Bank Level Dynamic Resource Docs

Get all Bank Level Dynamic Resource Docs.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

description: Description of the object. Maximum length is 2000. It can be any characters here.

name: ACCOUNT_MANAGEMENT_FEE

roles: CanCreateMyUser

summary:

tags: Create-My-User

Typical Successful Response: 

								
									
{
  "dynamic-resource-docs":[{
    "error_response_bodies":"OBP-50000: Unknown Error.,OBP-20001: User not logged in. Authentication is required!,OBP-20006: User is missing one or more roles: ,OBP-10001: Incorrect json format.",
    "description":"Create one User",
    "tags":"Create-My-User",
    "dynamic_resource_doc_id":"vce035ca-9a0f-4bfa-b30b-9003aa467f51",
    "request_verb":"POST",
    "method_body":"%20%20%20%20val%20Some(resourceDoc)%20%3D%20callContext.resourceDocument%0A%20%20%20%20val%20hasRequestBody%20%3D%20request.body.isDefined%0A%0A%20%20%20%20%2F%2F%20get%20Path%20Parameters%2C%20example%3A%0A%20%20%20%20%2F%2F%20if%20the%20requestUrl%20of%20resourceDoc%20is%20%2Fhello%2Fbanks%2FBANK_ID%2Fworld%0A%20%20%20%20%2F%2F%20the%20request%20path%20is%20%2Fhello%2Fbanks%2Fbank_x%2Fworld%0A%20%20%20%20%2F%2FpathParams.get(%22BANK_ID%22)%20will%20get%20Option(%22bank_x%22)%20value%0A%0A%20%20%20%20val%20myUserId%20%3D%20pathParams(%22MY_USER_ID%22)%0A%0A%0A%20%20%20%20val%20requestEntity%20%3D%20request.json%20match%20%7B%0A%20%20%20%20%20%20case%20Full(zson)%20%3D%3E%0A%20%20%20%20%20%20%20%20try%20%7B%0A%20%20%20%20%20%20%20%20%20%20zson.extract%5BRequestRootJsonClass%5D%0A%20%20%20%20%20%20%20%20%7D%20catch%20%7B%0A%20%20%20%20%20%20%20%20%20%20case%20e%3A%20MappingException%20%3D%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20return%20Full(errorJsonResponse(s%22%24InvalidJsonFormat%20%24%7Be.msg%7D%22))%0A%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20case%20_%3A%20EmptyBox%20%3D%3E%0A%20%20%20%20%20%20%20%20return%20Full(errorJsonResponse(s%22%24InvalidRequestPayload%20Current%20request%20has%20no%20payload%22))%0A%20%20%20%20%7D%0A%0A%0A%20%20%20%20%2F%2F%20please%20add%20business%20logic%20here%0A%20%20%20%20val%20responseBody%3AResponseRootJsonClass%20%3D%20ResponseRootJsonClass(s%22%24%7BmyUserId%7D_from_path%22%2C%20requestEntity.name%2C%20requestEntity.age%2C%20requestEntity.hobby)%0A%20%20%20%20Future.successful%20%7B%0A%20%20%20%20%20%20(responseBody%2C%20HttpCode.%60200%60(callContext.callContext))%0A%20%20%20%20%7D",
    "roles":"CanCreateMyUser",
    "example_request_body":{
      "name":"Jhon",
      "age":12,
      "hobby":["coding"],
      "_optional_fields_":["hobby"]
    },
    "request_url":"/my_user/MY_USER_ID",
    "bank_id":"gh.29.uk",
    "partial_function_name":"createUser",
    "summary":"Create My User",
    "success_response_body":{
      "my_user_id":"some_id_value",
      "name":"Jhon",
      "age":12,
      "hobby":["coding"],
      "_optional_fields_":["hobby"]
    }
  }]
}
Required Roles:
  • CanGetAllBankLevelDynamicResourceDocs - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • 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: OBPv4.0.0, function_name: by getAllBankLevelDynamicResourceDocs, operation_id: OBPv4.0.0-getAllBankLevelDynamicResourceDocs Tags: Dynamic-Resource-Doc,

Get all Dynamic Resource Docs

Get all Dynamic Resource Docs.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON response body fields:

description: Description of the object. Maximum length is 2000. It can be any characters here.

name: ACCOUNT_MANAGEMENT_FEE

roles: CanCreateMyUser

summary:

tags: Create-My-User

Typical Successful Response: 

								
									
{
  "dynamic-resource-docs":[{
    "error_response_bodies":"OBP-50000: Unknown Error.,OBP-20001: User not logged in. Authentication is required!,OBP-20006: User is missing one or more roles: ,OBP-10001: Incorrect json format.",
    "description":"Create one User",
    "tags":"Create-My-User",
    "dynamic_resource_doc_id":"vce035ca-9a0f-4bfa-b30b-9003aa467f51",
    "request_verb":"POST",
    "method_body":"%20%20%20%20val%20Some(resourceDoc)%20%3D%20callContext.resourceDocument%0A%20%20%20%20val%20hasRequestBody%20%3D%20request.body.isDefined%0A%0A%20%20%20%20%2F%2F%20get%20Path%20Parameters%2C%20example%3A%0A%20%20%20%20%2F%2F%20if%20the%20requestUrl%20of%20resourceDoc%20is%20%2Fhello%2Fbanks%2FBANK_ID%2Fworld%0A%20%20%20%20%2F%2F%20the%20request%20path%20is%20%2Fhello%2Fbanks%2Fbank_x%2Fworld%0A%20%20%20%20%2F%2FpathParams.get(%22BANK_ID%22)%20will%20get%20Option(%22bank_x%22)%20value%0A%0A%20%20%20%20val%20myUserId%20%3D%20pathParams(%22MY_USER_ID%22)%0A%0A%0A%20%20%20%20val%20requestEntity%20%3D%20request.json%20match%20%7B%0A%20%20%20%20%20%20case%20Full(zson)%20%3D%3E%0A%20%20%20%20%20%20%20%20try%20%7B%0A%20%20%20%20%20%20%20%20%20%20zson.extract%5BRequestRootJsonClass%5D%0A%20%20%20%20%20%20%20%20%7D%20catch%20%7B%0A%20%20%20%20%20%20%20%20%20%20case%20e%3A%20MappingException%20%3D%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20return%20Full(errorJsonResponse(s%22%24InvalidJsonFormat%20%24%7Be.msg%7D%22))%0A%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20case%20_%3A%20EmptyBox%20%3D%3E%0A%20%20%20%20%20%20%20%20return%20Full(errorJsonResponse(s%22%24InvalidRequestPayload%20Current%20request%20has%20no%20payload%22))%0A%20%20%20%20%7D%0A%0A%0A%20%20%20%20%2F%2F%20please%20add%20business%20logic%20here%0A%20%20%20%20val%20responseBody%3AResponseRootJsonClass%20%3D%20ResponseRootJsonClass(s%22%24%7BmyUserId%7D_from_path%22%2C%20requestEntity.name%2C%20requestEntity.age%2C%20requestEntity.hobby)%0A%20%20%20%20Future.successful%20%7B%0A%20%20%20%20%20%20(responseBody%2C%20HttpCode.%60200%60(callContext.callContext))%0A%20%20%20%20%7D",
    "roles":"CanCreateMyUser",
    "example_request_body":{
      "name":"Jhon",
      "age":12,
      "hobby":["coding"],
      "_optional_fields_":["hobby"]
    },
    "request_url":"/my_user/MY_USER_ID",
    "bank_id":"gh.29.uk",
    "partial_function_name":"createUser",
    "summary":"Create My User",
    "success_response_body":{
      "my_user_id":"some_id_value",
      "name":"Jhon",
      "age":12,
      "hobby":["coding"],
      "_optional_fields_":["hobby"]
    }
  }]
}
Required Roles:
  • CanGetAllDynamicResourceDocs - 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: OBPv4.0.0, function_name: by getAllDynamicResourceDocs, operation_id: OBPv4.0.0-getAllDynamicResourceDocs Tags: Dynamic-Resource-Doc,

Update Bank Level Dynamic Resource Doc

Update a Bank Level Dynamic Resource Doc.

The connector_method_body is URL-encoded format String

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

description: Description of the object. Maximum length is 2000. It can be any characters here.

name: ACCOUNT_MANAGEMENT_FEE

roles: CanCreateMyUser

summary:

tags: Create-My-User

Typical Successful Response: 

								
									
{
  "error_response_bodies":"OBP-50000: Unknown Error.,OBP-20001: User not logged in. Authentication is required!,OBP-20006: User is missing one or more roles: ,OBP-10001: Incorrect json format.",
  "description":"Create one User",
  "tags":"Create-My-User",
  "dynamic_resource_doc_id":"vce035ca-9a0f-4bfa-b30b-9003aa467f51",
  "request_verb":"POST",
  "method_body":"%20%20%20%20val%20Some(resourceDoc)%20%3D%20callContext.resourceDocument%0A%20%20%20%20val%20hasRequestBody%20%3D%20request.body.isDefined%0A%0A%20%20%20%20%2F%2F%20get%20Path%20Parameters%2C%20example%3A%0A%20%20%20%20%2F%2F%20if%20the%20requestUrl%20of%20resourceDoc%20is%20%2Fhello%2Fbanks%2FBANK_ID%2Fworld%0A%20%20%20%20%2F%2F%20the%20request%20path%20is%20%2Fhello%2Fbanks%2Fbank_x%2Fworld%0A%20%20%20%20%2F%2FpathParams.get(%22BANK_ID%22)%20will%20get%20Option(%22bank_x%22)%20value%0A%0A%20%20%20%20val%20myUserId%20%3D%20pathParams(%22MY_USER_ID%22)%0A%0A%0A%20%20%20%20val%20requestEntity%20%3D%20request.json%20match%20%7B%0A%20%20%20%20%20%20case%20Full(zson)%20%3D%3E%0A%20%20%20%20%20%20%20%20try%20%7B%0A%20%20%20%20%20%20%20%20%20%20zson.extract%5BRequestRootJsonClass%5D%0A%20%20%20%20%20%20%20%20%7D%20catch%20%7B%0A%20%20%20%20%20%20%20%20%20%20case%20e%3A%20MappingException%20%3D%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20return%20Full(errorJsonResponse(s%22%24InvalidJsonFormat%20%24%7Be.msg%7D%22))%0A%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20case%20_%3A%20EmptyBox%20%3D%3E%0A%20%20%20%20%20%20%20%20return%20Full(errorJsonResponse(s%22%24InvalidRequestPayload%20Current%20request%20has%20no%20payload%22))%0A%20%20%20%20%7D%0A%0A%0A%20%20%20%20%2F%2F%20please%20add%20business%20logic%20here%0A%20%20%20%20val%20responseBody%3AResponseRootJsonClass%20%3D%20ResponseRootJsonClass(s%22%24%7BmyUserId%7D_from_path%22%2C%20requestEntity.name%2C%20requestEntity.age%2C%20requestEntity.hobby)%0A%20%20%20%20Future.successful%20%7B%0A%20%20%20%20%20%20(responseBody%2C%20HttpCode.%60200%60(callContext.callContext))%0A%20%20%20%20%7D",
  "roles":"CanCreateMyUser",
  "example_request_body":{
    "name":"Jhon",
    "age":12,
    "hobby":["coding"],
    "_optional_fields_":["hobby"]
  },
  "request_url":"/my_user/MY_USER_ID",
  "bank_id":"gh.29.uk",
  "partial_function_name":"createUser",
  "summary":"Create My User",
  "success_response_body":{
    "my_user_id":"some_id_value",
    "name":"Jhon",
    "age":12,
    "hobby":["coding"],
    "_optional_fields_":["hobby"]
  }
}
Required Roles:
  • CanUpdateBankLevelDynamicResourceDoc - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • 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: OBPv4.0.0, function_name: by updateBankLevelDynamicResourceDoc, operation_id: OBPv4.0.0-updateBankLevelDynamicResourceDoc Tags: Dynamic-Resource-Doc,

Update Dynamic Resource Doc

Update a Dynamic Resource Doc.

The connector_method_body is URL-encoded format String

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON response body fields:

description: Description of the object. Maximum length is 2000. It can be any characters here.

name: ACCOUNT_MANAGEMENT_FEE

roles: CanCreateMyUser

summary:

tags: Create-My-User

Typical Successful Response: 

								
									
{
  "error_response_bodies":"OBP-50000: Unknown Error.,OBP-20001: User not logged in. Authentication is required!,OBP-20006: User is missing one or more roles: ,OBP-10001: Incorrect json format.",
  "description":"Create one User",
  "tags":"Create-My-User",
  "dynamic_resource_doc_id":"vce035ca-9a0f-4bfa-b30b-9003aa467f51",
  "request_verb":"POST",
  "method_body":"%20%20%20%20val%20Some(resourceDoc)%20%3D%20callContext.resourceDocument%0A%20%20%20%20val%20hasRequestBody%20%3D%20request.body.isDefined%0A%0A%20%20%20%20%2F%2F%20get%20Path%20Parameters%2C%20example%3A%0A%20%20%20%20%2F%2F%20if%20the%20requestUrl%20of%20resourceDoc%20is%20%2Fhello%2Fbanks%2FBANK_ID%2Fworld%0A%20%20%20%20%2F%2F%20the%20request%20path%20is%20%2Fhello%2Fbanks%2Fbank_x%2Fworld%0A%20%20%20%20%2F%2FpathParams.get(%22BANK_ID%22)%20will%20get%20Option(%22bank_x%22)%20value%0A%0A%20%20%20%20val%20myUserId%20%3D%20pathParams(%22MY_USER_ID%22)%0A%0A%0A%20%20%20%20val%20requestEntity%20%3D%20request.json%20match%20%7B%0A%20%20%20%20%20%20case%20Full(zson)%20%3D%3E%0A%20%20%20%20%20%20%20%20try%20%7B%0A%20%20%20%20%20%20%20%20%20%20zson.extract%5BRequestRootJsonClass%5D%0A%20%20%20%20%20%20%20%20%7D%20catch%20%7B%0A%20%20%20%20%20%20%20%20%20%20case%20e%3A%20MappingException%20%3D%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20return%20Full(errorJsonResponse(s%22%24InvalidJsonFormat%20%24%7Be.msg%7D%22))%0A%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20case%20_%3A%20EmptyBox%20%3D%3E%0A%20%20%20%20%20%20%20%20return%20Full(errorJsonResponse(s%22%24InvalidRequestPayload%20Current%20request%20has%20no%20payload%22))%0A%20%20%20%20%7D%0A%0A%0A%20%20%20%20%2F%2F%20please%20add%20business%20logic%20here%0A%20%20%20%20val%20responseBody%3AResponseRootJsonClass%20%3D%20ResponseRootJsonClass(s%22%24%7BmyUserId%7D_from_path%22%2C%20requestEntity.name%2C%20requestEntity.age%2C%20requestEntity.hobby)%0A%20%20%20%20Future.successful%20%7B%0A%20%20%20%20%20%20(responseBody%2C%20HttpCode.%60200%60(callContext.callContext))%0A%20%20%20%20%7D",
  "roles":"CanCreateMyUser",
  "example_request_body":{
    "name":"Jhon",
    "age":12,
    "hobby":["coding"],
    "_optional_fields_":["hobby"]
  },
  "request_url":"/my_user/MY_USER_ID",
  "bank_id":"gh.29.uk",
  "partial_function_name":"createUser",
  "summary":"Create My User",
  "success_response_body":{
    "my_user_id":"some_id_value",
    "name":"Jhon",
    "age":12,
    "hobby":["coding"],
    "_optional_fields_":["hobby"]
  }
}
Required Roles:
  • CanUpdateDynamicResourceDoc - 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: OBPv4.0.0, function_name: by updateDynamicResourceDoc, operation_id: OBPv4.0.0-updateDynamicResourceDoc Tags: Dynamic-Resource-Doc,