right logo image
right logo image
Log on
⯆

API Explorer

Log off

v5.1.0 filtered by tag: Dynamic-Entity (60 APIs)

API Host: https://obp-apisandbox.joinfincubator.com
Bank
Accounts
Views
Counterparties
Transactions

Create new Book Mark Bank And Account System

Create new Book Mark Bank And Account System.

This entity stores bank_id and account_id

Property List:

  • bank_id: A bank_id
  • account_id: An account_id
  • tag_1: To tag the record

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"BookMarkBankAndAccount_system"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "book_mark_bank_and_account_system":{
    "bookMarkBankAndAccount_systemId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "bank_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d775",
    "account_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d776",
    "tag_1":"Done"
  }
}
Required Roles:
  • CanCreateDynamicEntity_SystemBookMarkBankAndAccount_system - 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 dynamicEntity_createBookMarkBankAndAccount_system_, operation_id: OBPv4.0.0-dynamicEntity_createBookMarkBankAndAccount_system_ Tags: _Book Mark Bank And Account System, Dynamic-Entity, Dynamic,

Create new My Book Mark Bank And Account System

Create new My Book Mark Bank And Account System.

This entity stores bank_id and account_id

Property List:

  • bank_id: A bank_id
  • account_id: An account_id
  • tag_1: To tag the record

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"BookMarkBankAndAccount_system"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "book_mark_bank_and_account_system":{
    "bookMarkBankAndAccount_systemId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "bank_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d775",
    "account_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d776",
    "tag_1":"Done"
  }
}
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 dynamicEntity_createMyBookMarkBankAndAccount_system_, operation_id: OBPv4.0.0-dynamicEntity_createMyBookMarkBankAndAccount_system_ Tags: _Book Mark Bank And Account System, Dynamic-Entity, Dynamic,

Delete Book Mark Bank And Account System by id

Delete Book Mark Bank And Account System by id

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"BookMarkBankAndAccount_system"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "book_mark_bank_and_account_system":{
    "bookMarkBankAndAccount_systemId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "bank_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d775",
    "account_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d776",
    "tag_1":"Done"
  }
}
Required Roles:
  • CanDeleteDynamicEntity_SystemBookMarkBankAndAccount_system - 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 dynamicEntity_deleteBookMarkBankAndAccount_system_, operation_id: OBPv4.0.0-dynamicEntity_deleteBookMarkBankAndAccount_system_ Tags: _Book Mark Bank And Account System, Dynamic-Entity, Dynamic,

Delete My Book Mark Bank And Account System by id

Delete My Book Mark Bank And Account System by id

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"BookMarkBankAndAccount_system"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "book_mark_bank_and_account_system":{
    "bookMarkBankAndAccount_systemId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "bank_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d775",
    "account_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d776",
    "tag_1":"Done"
  }
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_deleteMyBookMarkBankAndAccount_system_, operation_id: OBPv4.0.0-dynamicEntity_deleteMyBookMarkBankAndAccount_system_ Tags: _Book Mark Bank And Account System, Dynamic-Entity, Dynamic,

Get Book Mark Bank And Account System List

Get Book Mark Bank And Account System List.

This entity stores bank_id and account_id

Property List:

  • bank_id: A bank_id
  • account_id: An account_id
  • tag_1: To tag the record

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"BookMarkBankAndAccount_system"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Can do filter on the fields
e.g: /BookMarkBankAndAccount_system?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

Typical Successful Response: 

								
									
{
  "book_mark_bank_and_account_system_list":[{
    "book_mark_bank_and_account_system":{
      "bookMarkBankAndAccount_systemId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
      "bank_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d775",
      "account_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d776",
      "tag_1":"Done"
    }
  }]
}
Required Roles:
  • CanGetDynamicEntity_SystemBookMarkBankAndAccount_system - 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 dynamicEntity_getBookMarkBankAndAccount_systemList_, operation_id: OBPv4.0.0-dynamicEntity_getBookMarkBankAndAccount_systemList_ Tags: _Book Mark Bank And Account System, Dynamic-Entity, Dynamic,

Get Book Mark Bank And Account System by id

Get Book Mark Bank And Account System by id.

This entity stores bank_id and account_id

Property List:

  • bank_id: A bank_id
  • account_id: An account_id
  • tag_1: To tag the record

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"BookMarkBankAndAccount_system"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "book_mark_bank_and_account_system":{
    "bookMarkBankAndAccount_systemId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "bank_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d775",
    "account_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d776",
    "tag_1":"Done"
  }
}
Required Roles:
  • CanGetDynamicEntity_SystemBookMarkBankAndAccount_system - 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 dynamicEntity_getSingleBookMarkBankAndAccount_system_, operation_id: OBPv4.0.0-dynamicEntity_getSingleBookMarkBankAndAccount_system_ Tags: _Book Mark Bank And Account System, Dynamic-Entity, Dynamic,

Get My Book Mark Bank And Account System List

Get My Book Mark Bank And Account System List.

This entity stores bank_id and account_id

Property List:

  • bank_id: A bank_id
  • account_id: An account_id
  • tag_1: To tag the record

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"BookMarkBankAndAccount_system"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Can do filter on the fields
e.g: /BookMarkBankAndAccount_system?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

Typical Successful Response: 

								
									
{
  "book_mark_bank_and_account_system_list":[{
    "book_mark_bank_and_account_system":{
      "bookMarkBankAndAccount_systemId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
      "bank_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d775",
      "account_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d776",
      "tag_1":"Done"
    }
  }]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_getMyBookMarkBankAndAccount_systemList_, operation_id: OBPv4.0.0-dynamicEntity_getMyBookMarkBankAndAccount_systemList_ Tags: _Book Mark Bank And Account System, Dynamic-Entity, Dynamic,

Get My Book Mark Bank And Account System by id

Get My Book Mark Bank And Account System by id.

This entity stores bank_id and account_id

Property List:

  • bank_id: A bank_id
  • account_id: An account_id
  • tag_1: To tag the record

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"BookMarkBankAndAccount_system"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "book_mark_bank_and_account_system":{
    "bookMarkBankAndAccount_systemId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "bank_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d775",
    "account_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d776",
    "tag_1":"Done"
  }
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_getSingleMyBookMarkBankAndAccount_system_, operation_id: OBPv4.0.0-dynamicEntity_getSingleMyBookMarkBankAndAccount_system_ Tags: _Book Mark Bank And Account System, Dynamic-Entity, Dynamic,

Update Book Mark Bank And Account System

Update Book Mark Bank And Account System.

This entity stores bank_id and account_id

Property List:

  • bank_id: A bank_id
  • account_id: An account_id
  • tag_1: To tag the record

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"BookMarkBankAndAccount_system"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "book_mark_bank_and_account_system":{
    "bookMarkBankAndAccount_systemId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "bank_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d775",
    "account_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d776",
    "tag_1":"Done"
  }
}
Required Roles:
  • CanUpdateDynamicEntity_SystemBookMarkBankAndAccount_system - 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 dynamicEntity_updateBookMarkBankAndAccount_system_, operation_id: OBPv4.0.0-dynamicEntity_updateBookMarkBankAndAccount_system_ Tags: _Book Mark Bank And Account System, Dynamic-Entity, Dynamic,

Update My Book Mark Bank And Account System

Update My Book Mark Bank And Account System.

This entity stores bank_id and account_id

Property List:

  • bank_id: A bank_id
  • account_id: An account_id
  • tag_1: To tag the record

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"BookMarkBankAndAccount_system"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "book_mark_bank_and_account_system":{
    "bookMarkBankAndAccount_systemId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "bank_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d775",
    "account_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d776",
    "tag_1":"Done"
  }
}
Required Roles:
  • CanUpdateDynamicEntity_SystemBookMarkBankAndAccount_system - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_updateMyBookMarkBankAndAccount_system_, operation_id: OBPv4.0.0-dynamicEntity_updateMyBookMarkBankAndAccount_system_ Tags: _Book Mark Bank And Account System, Dynamic-Entity, Dynamic,

Create new Book Mark Bank And Account

Create new Book Mark Bank And Account.

This entity stores bank_id and account_id

Property List:

  • bank_id: A bank_id
  • account_id: An account_id
  • tag_1: To tag the record

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"BookMarkBankAndAccount"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "book_mark_bank_and_account":{
    "bookMarkBankAndAccountId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "bank_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d775",
    "account_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d776",
    "tag_1":"Done"
  }
}
Required Roles:
  • CanCreateDynamicEntity_BookMarkBankAndAccount - 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 dynamicEntity_createBookMarkBankAndAccount_Gen1_Aeena, operation_id: OBPv4.0.0-dynamicEntity_createBookMarkBankAndAccount_Gen1_Aeena Tags: _Book Mark Bank And Account(Gen1 Aeena), Dynamic-Entity, Dynamic,

Create new My Book Mark Bank And Account

Create new My Book Mark Bank And Account.

This entity stores bank_id and account_id

Property List:

  • bank_id: A bank_id
  • account_id: An account_id
  • tag_1: To tag the record

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"BookMarkBankAndAccount"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "book_mark_bank_and_account":{
    "bookMarkBankAndAccountId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "bank_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d775",
    "account_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d776",
    "tag_1":"Done"
  }
}
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 dynamicEntity_createMyBookMarkBankAndAccount_Gen1_Aeena, operation_id: OBPv4.0.0-dynamicEntity_createMyBookMarkBankAndAccount_Gen1_Aeena Tags: _Book Mark Bank And Account(Gen1 Aeena), Dynamic-Entity, Dynamic,

Delete Book Mark Bank And Account by id

Delete Book Mark Bank And Account by id

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"BookMarkBankAndAccount"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "book_mark_bank_and_account":{
    "bookMarkBankAndAccountId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "bank_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d775",
    "account_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d776",
    "tag_1":"Done"
  }
}
Required Roles:
  • CanDeleteDynamicEntity_BookMarkBankAndAccount - 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 dynamicEntity_deleteBookMarkBankAndAccount_Gen1_Aeena, operation_id: OBPv4.0.0-dynamicEntity_deleteBookMarkBankAndAccount_Gen1_Aeena Tags: _Book Mark Bank And Account(Gen1 Aeena), Dynamic-Entity, Dynamic,

Delete My Book Mark Bank And Account by id

Delete My Book Mark Bank And Account by id

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"BookMarkBankAndAccount"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "book_mark_bank_and_account":{
    "bookMarkBankAndAccountId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "bank_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d775",
    "account_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d776",
    "tag_1":"Done"
  }
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_deleteMyBookMarkBankAndAccount_Gen1_Aeena, operation_id: OBPv4.0.0-dynamicEntity_deleteMyBookMarkBankAndAccount_Gen1_Aeena Tags: _Book Mark Bank And Account(Gen1 Aeena), Dynamic-Entity, Dynamic,

Get Book Mark Bank And Account List

Get Book Mark Bank And Account List.

This entity stores bank_id and account_id

Property List:

  • bank_id: A bank_id
  • account_id: An account_id
  • tag_1: To tag the record

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"BookMarkBankAndAccount"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Can do filter on the fields
e.g: /BookMarkBankAndAccount?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "book_mark_bank_and_account_list":[{
    "bank-id":"gh.29.uk",
    "book_mark_bank_and_account":{
      "bookMarkBankAndAccountId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
      "bank_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d775",
      "account_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d776",
      "tag_1":"Done"
    }
  }]
}
Required Roles:
  • CanGetDynamicEntity_BookMarkBankAndAccount - 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 dynamicEntity_getBookMarkBankAndAccountList_Gen1_Aeena, operation_id: OBPv4.0.0-dynamicEntity_getBookMarkBankAndAccountList_Gen1_Aeena Tags: _Book Mark Bank And Account(Gen1 Aeena), Dynamic-Entity, Dynamic,

Get Book Mark Bank And Account by id

Get Book Mark Bank And Account by id.

This entity stores bank_id and account_id

Property List:

  • bank_id: A bank_id
  • account_id: An account_id
  • tag_1: To tag the record

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"BookMarkBankAndAccount"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "book_mark_bank_and_account":{
    "bookMarkBankAndAccountId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "bank_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d775",
    "account_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d776",
    "tag_1":"Done"
  }
}
Required Roles:
  • CanGetDynamicEntity_BookMarkBankAndAccount - 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 dynamicEntity_getSingleBookMarkBankAndAccount_Gen1_Aeena, operation_id: OBPv4.0.0-dynamicEntity_getSingleBookMarkBankAndAccount_Gen1_Aeena Tags: _Book Mark Bank And Account(Gen1 Aeena), Dynamic-Entity, Dynamic,

Get My Book Mark Bank And Account List

Get My Book Mark Bank And Account List.

This entity stores bank_id and account_id

Property List:

  • bank_id: A bank_id
  • account_id: An account_id
  • tag_1: To tag the record

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"BookMarkBankAndAccount"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Can do filter on the fields
e.g: /BookMarkBankAndAccount?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "book_mark_bank_and_account_list":[{
    "bank-id":"gh.29.uk",
    "book_mark_bank_and_account":{
      "bookMarkBankAndAccountId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
      "bank_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d775",
      "account_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d776",
      "tag_1":"Done"
    }
  }]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_getMyBookMarkBankAndAccountList_Gen1_Aeena, operation_id: OBPv4.0.0-dynamicEntity_getMyBookMarkBankAndAccountList_Gen1_Aeena Tags: _Book Mark Bank And Account(Gen1 Aeena), Dynamic-Entity, Dynamic,

Get My Book Mark Bank And Account by id

Get My Book Mark Bank And Account by id.

This entity stores bank_id and account_id

Property List:

  • bank_id: A bank_id
  • account_id: An account_id
  • tag_1: To tag the record

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"BookMarkBankAndAccount"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "book_mark_bank_and_account":{
    "bookMarkBankAndAccountId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "bank_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d775",
    "account_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d776",
    "tag_1":"Done"
  }
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_getSingleMyBookMarkBankAndAccount_Gen1_Aeena, operation_id: OBPv4.0.0-dynamicEntity_getSingleMyBookMarkBankAndAccount_Gen1_Aeena Tags: _Book Mark Bank And Account(Gen1 Aeena), Dynamic-Entity, Dynamic,

Update Book Mark Bank And Account

Update Book Mark Bank And Account.

This entity stores bank_id and account_id

Property List:

  • bank_id: A bank_id
  • account_id: An account_id
  • tag_1: To tag the record

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"BookMarkBankAndAccount"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "book_mark_bank_and_account":{
    "bookMarkBankAndAccountId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "bank_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d775",
    "account_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d776",
    "tag_1":"Done"
  }
}
Required Roles:
  • CanUpdateDynamicEntity_BookMarkBankAndAccount - 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 dynamicEntity_updateBookMarkBankAndAccount_Gen1_Aeena, operation_id: OBPv4.0.0-dynamicEntity_updateBookMarkBankAndAccount_Gen1_Aeena Tags: _Book Mark Bank And Account(Gen1 Aeena), Dynamic-Entity, Dynamic,

Update My Book Mark Bank And Account

Update My Book Mark Bank And Account.

This entity stores bank_id and account_id

Property List:

  • bank_id: A bank_id
  • account_id: An account_id
  • tag_1: To tag the record

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"BookMarkBankAndAccount"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "book_mark_bank_and_account":{
    "bookMarkBankAndAccountId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "bank_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d775",
    "account_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d776",
    "tag_1":"Done"
  }
}
Required Roles:
  • CanUpdateDynamicEntity_BookMarkBankAndAccount - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_updateMyBookMarkBankAndAccount_Gen1_Aeena, operation_id: OBPv4.0.0-dynamicEntity_updateMyBookMarkBankAndAccount_Gen1_Aeena Tags: _Book Mark Bank And Account(Gen1 Aeena), Dynamic-Entity, Dynamic,

Create new Foo Bar

Create new Foo Bar.

Description of this entity, can be markdown text.

Property List:

  • name: description of name field, can be markdown text.
  • number: description of number field, can be markdown text.

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"FooBar"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "foo_bar":{
    "fooBarId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "name":"James Brown",
    "number":698761728
  }
}
Required Roles:
  • CanCreateDynamicEntity_FooBar - 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 dynamicEntity_createFooBar_simonpublic1, operation_id: OBPv4.0.0-dynamicEntity_createFooBar_simonpublic1 Tags: _Foo Bar(simonpublic1), Dynamic-Entity, Dynamic,

Create new My Foo Bar

Create new My Foo Bar.

Description of this entity, can be markdown text.

Property List:

  • name: description of name field, can be markdown text.
  • number: description of number field, can be markdown text.

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"FooBar"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "foo_bar":{
    "fooBarId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "name":"James Brown",
    "number":698761728
  }
}
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 dynamicEntity_createMyFooBar_simonpublic1, operation_id: OBPv4.0.0-dynamicEntity_createMyFooBar_simonpublic1 Tags: _Foo Bar(simonpublic1), Dynamic-Entity, Dynamic,

Delete Foo Bar by id

Delete Foo Bar by id

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"FooBar"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "foo_bar":{
    "fooBarId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "name":"James Brown",
    "number":698761728
  }
}
Required Roles:
  • CanDeleteDynamicEntity_FooBar - 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 dynamicEntity_deleteFooBar_simonpublic1, operation_id: OBPv4.0.0-dynamicEntity_deleteFooBar_simonpublic1 Tags: _Foo Bar(simonpublic1), Dynamic-Entity, Dynamic,

Delete My Foo Bar by id

Delete My Foo Bar by id

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"FooBar"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "foo_bar":{
    "fooBarId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "name":"James Brown",
    "number":698761728
  }
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_deleteMyFooBar_simonpublic1, operation_id: OBPv4.0.0-dynamicEntity_deleteMyFooBar_simonpublic1 Tags: _Foo Bar(simonpublic1), Dynamic-Entity, Dynamic,

Get Foo Bar List

Get Foo Bar List.

Description of this entity, can be markdown text.

Property List:

  • name: description of name field, can be markdown text.
  • number: description of number field, can be markdown text.

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"FooBar"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Can do filter on the fields
e.g: /FooBar?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "foo_bar_list":[{
    "bank-id":"gh.29.uk",
    "foo_bar":{
      "fooBarId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
      "name":"James Brown",
      "number":698761728
    }
  }]
}
Required Roles:
  • CanGetDynamicEntity_FooBar - 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 dynamicEntity_getFooBarList_simonpublic1, operation_id: OBPv4.0.0-dynamicEntity_getFooBarList_simonpublic1 Tags: _Foo Bar(simonpublic1), Dynamic-Entity, Dynamic,

Get Foo Bar by id

Get Foo Bar by id.

Description of this entity, can be markdown text.

Property List:

  • name: description of name field, can be markdown text.
  • number: description of number field, can be markdown text.

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"FooBar"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "foo_bar":{
    "fooBarId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "name":"James Brown",
    "number":698761728
  }
}
Required Roles:
  • CanGetDynamicEntity_FooBar - 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 dynamicEntity_getSingleFooBar_simonpublic1, operation_id: OBPv4.0.0-dynamicEntity_getSingleFooBar_simonpublic1 Tags: _Foo Bar(simonpublic1), Dynamic-Entity, Dynamic,

Get My Foo Bar List

Get My Foo Bar List.

Description of this entity, can be markdown text.

Property List:

  • name: description of name field, can be markdown text.
  • number: description of number field, can be markdown text.

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"FooBar"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Can do filter on the fields
e.g: /FooBar?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "foo_bar_list":[{
    "bank-id":"gh.29.uk",
    "foo_bar":{
      "fooBarId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
      "name":"James Brown",
      "number":698761728
    }
  }]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_getMyFooBarList_simonpublic1, operation_id: OBPv4.0.0-dynamicEntity_getMyFooBarList_simonpublic1 Tags: _Foo Bar(simonpublic1), Dynamic-Entity, Dynamic,

Get My Foo Bar by id

Get My Foo Bar by id.

Description of this entity, can be markdown text.

Property List:

  • name: description of name field, can be markdown text.
  • number: description of number field, can be markdown text.

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"FooBar"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "foo_bar":{
    "fooBarId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "name":"James Brown",
    "number":698761728
  }
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_getSingleMyFooBar_simonpublic1, operation_id: OBPv4.0.0-dynamicEntity_getSingleMyFooBar_simonpublic1 Tags: _Foo Bar(simonpublic1), Dynamic-Entity, Dynamic,

Update Foo Bar

Update Foo Bar.

Description of this entity, can be markdown text.

Property List:

  • name: description of name field, can be markdown text.
  • number: description of number field, can be markdown text.

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"FooBar"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "foo_bar":{
    "fooBarId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "name":"James Brown",
    "number":698761728
  }
}
Required Roles:
  • CanUpdateDynamicEntity_FooBar - 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 dynamicEntity_updateFooBar_simonpublic1, operation_id: OBPv4.0.0-dynamicEntity_updateFooBar_simonpublic1 Tags: _Foo Bar(simonpublic1), Dynamic-Entity, Dynamic,

Update My Foo Bar

Update My Foo Bar.

Description of this entity, can be markdown text.

Property List:

  • name: description of name field, can be markdown text.
  • number: description of number field, can be markdown text.

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"FooBar"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "foo_bar":{
    "fooBarId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "name":"James Brown",
    "number":698761728
  }
}
Required Roles:
  • CanUpdateDynamicEntity_FooBar - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_updateMyFooBar_simonpublic1, operation_id: OBPv4.0.0-dynamicEntity_updateMyFooBar_simonpublic1 Tags: _Foo Bar(simonpublic1), Dynamic-Entity, Dynamic,

Create new Hospital

Create new Hospital.

Hospital

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"Hospital"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "hospital":{
    "hospitalId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "maternity_departments":"maternity_departments",
    "labor":"labor",
    "nursery":"nursery",
    "maternal_and_health_awareness":"maternal_and_health_awareness",
    "OB_gyn":"OB_gyn",
    "pediatrician":"pediatrician",
    "nutritions":"nutritions",
    "psychatrichs":"psychatrichs",
    "dermatology":"dermatology",
    "endocrine":"endocrine",
    "doctors":"doctors",
    "yoga_trainers":"yoga_trainers",
    "personal_trainers":"personal_trainers",
    "midwife":"personal_trainers",
    "IBCLC":"personal_trainers",
    "lactation_counselor":"personal_trainers",
    "nurses":"personal_trainers"
  }
}
Required Roles:
  • CanCreateDynamicEntity_Hospital - 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 dynamicEntity_createHospital_mommy_map, operation_id: OBPv4.0.0-dynamicEntity_createHospital_mommy_map Tags: _Hospital(mommy Map), Dynamic-Entity, Dynamic,

Create new My Hospital

Create new My Hospital.

Hospital

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"Hospital"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "hospital":{
    "hospitalId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "maternity_departments":"maternity_departments",
    "labor":"labor",
    "nursery":"nursery",
    "maternal_and_health_awareness":"maternal_and_health_awareness",
    "OB_gyn":"OB_gyn",
    "pediatrician":"pediatrician",
    "nutritions":"nutritions",
    "psychatrichs":"psychatrichs",
    "dermatology":"dermatology",
    "endocrine":"endocrine",
    "doctors":"doctors",
    "yoga_trainers":"yoga_trainers",
    "personal_trainers":"personal_trainers",
    "midwife":"personal_trainers",
    "IBCLC":"personal_trainers",
    "lactation_counselor":"personal_trainers",
    "nurses":"personal_trainers"
  }
}
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 dynamicEntity_createMyHospital_mommy_map, operation_id: OBPv4.0.0-dynamicEntity_createMyHospital_mommy_map Tags: _Hospital(mommy Map), Dynamic-Entity, Dynamic,

Delete Hospital by id

Delete Hospital by id

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"Hospital"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "hospital":{
    "hospitalId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "maternity_departments":"maternity_departments",
    "labor":"labor",
    "nursery":"nursery",
    "maternal_and_health_awareness":"maternal_and_health_awareness",
    "OB_gyn":"OB_gyn",
    "pediatrician":"pediatrician",
    "nutritions":"nutritions",
    "psychatrichs":"psychatrichs",
    "dermatology":"dermatology",
    "endocrine":"endocrine",
    "doctors":"doctors",
    "yoga_trainers":"yoga_trainers",
    "personal_trainers":"personal_trainers",
    "midwife":"personal_trainers",
    "IBCLC":"personal_trainers",
    "lactation_counselor":"personal_trainers",
    "nurses":"personal_trainers"
  }
}
Required Roles:
  • CanDeleteDynamicEntity_Hospital - 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 dynamicEntity_deleteHospital_mommy_map, operation_id: OBPv4.0.0-dynamicEntity_deleteHospital_mommy_map Tags: _Hospital(mommy Map), Dynamic-Entity, Dynamic,

Delete My Hospital by id

Delete My Hospital by id

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"Hospital"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "hospital":{
    "hospitalId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "maternity_departments":"maternity_departments",
    "labor":"labor",
    "nursery":"nursery",
    "maternal_and_health_awareness":"maternal_and_health_awareness",
    "OB_gyn":"OB_gyn",
    "pediatrician":"pediatrician",
    "nutritions":"nutritions",
    "psychatrichs":"psychatrichs",
    "dermatology":"dermatology",
    "endocrine":"endocrine",
    "doctors":"doctors",
    "yoga_trainers":"yoga_trainers",
    "personal_trainers":"personal_trainers",
    "midwife":"personal_trainers",
    "IBCLC":"personal_trainers",
    "lactation_counselor":"personal_trainers",
    "nurses":"personal_trainers"
  }
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_deleteMyHospital_mommy_map, operation_id: OBPv4.0.0-dynamicEntity_deleteMyHospital_mommy_map Tags: _Hospital(mommy Map), Dynamic-Entity, Dynamic,

Get Hospital List

Get Hospital List.

Hospital

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"Hospital"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Can do filter on the fields
e.g: /Hospital?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "hospital_list":[{
    "bank-id":"gh.29.uk",
    "hospital":{
      "hospitalId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
      "maternity_departments":"maternity_departments",
      "labor":"labor",
      "nursery":"nursery",
      "maternal_and_health_awareness":"maternal_and_health_awareness",
      "OB_gyn":"OB_gyn",
      "pediatrician":"pediatrician",
      "nutritions":"nutritions",
      "psychatrichs":"psychatrichs",
      "dermatology":"dermatology",
      "endocrine":"endocrine",
      "doctors":"doctors",
      "yoga_trainers":"yoga_trainers",
      "personal_trainers":"personal_trainers",
      "midwife":"personal_trainers",
      "IBCLC":"personal_trainers",
      "lactation_counselor":"personal_trainers",
      "nurses":"personal_trainers"
    }
  }]
}
Required Roles:
  • CanGetDynamicEntity_Hospital - 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 dynamicEntity_getHospitalList_mommy_map, operation_id: OBPv4.0.0-dynamicEntity_getHospitalList_mommy_map Tags: _Hospital(mommy Map), Dynamic-Entity, Dynamic,

Get Hospital by id

Get Hospital by id.

Hospital

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"Hospital"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "hospital":{
    "hospitalId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "maternity_departments":"maternity_departments",
    "labor":"labor",
    "nursery":"nursery",
    "maternal_and_health_awareness":"maternal_and_health_awareness",
    "OB_gyn":"OB_gyn",
    "pediatrician":"pediatrician",
    "nutritions":"nutritions",
    "psychatrichs":"psychatrichs",
    "dermatology":"dermatology",
    "endocrine":"endocrine",
    "doctors":"doctors",
    "yoga_trainers":"yoga_trainers",
    "personal_trainers":"personal_trainers",
    "midwife":"personal_trainers",
    "IBCLC":"personal_trainers",
    "lactation_counselor":"personal_trainers",
    "nurses":"personal_trainers"
  }
}
Required Roles:
  • CanGetDynamicEntity_Hospital - 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 dynamicEntity_getSingleHospital_mommy_map, operation_id: OBPv4.0.0-dynamicEntity_getSingleHospital_mommy_map Tags: _Hospital(mommy Map), Dynamic-Entity, Dynamic,

Get My Hospital List

Get My Hospital List.

Hospital

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"Hospital"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Can do filter on the fields
e.g: /Hospital?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "hospital_list":[{
    "bank-id":"gh.29.uk",
    "hospital":{
      "hospitalId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
      "maternity_departments":"maternity_departments",
      "labor":"labor",
      "nursery":"nursery",
      "maternal_and_health_awareness":"maternal_and_health_awareness",
      "OB_gyn":"OB_gyn",
      "pediatrician":"pediatrician",
      "nutritions":"nutritions",
      "psychatrichs":"psychatrichs",
      "dermatology":"dermatology",
      "endocrine":"endocrine",
      "doctors":"doctors",
      "yoga_trainers":"yoga_trainers",
      "personal_trainers":"personal_trainers",
      "midwife":"personal_trainers",
      "IBCLC":"personal_trainers",
      "lactation_counselor":"personal_trainers",
      "nurses":"personal_trainers"
    }
  }]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_getMyHospitalList_mommy_map, operation_id: OBPv4.0.0-dynamicEntity_getMyHospitalList_mommy_map Tags: _Hospital(mommy Map), Dynamic-Entity, Dynamic,

Get My Hospital by id

Get My Hospital by id.

Hospital

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"Hospital"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "hospital":{
    "hospitalId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "maternity_departments":"maternity_departments",
    "labor":"labor",
    "nursery":"nursery",
    "maternal_and_health_awareness":"maternal_and_health_awareness",
    "OB_gyn":"OB_gyn",
    "pediatrician":"pediatrician",
    "nutritions":"nutritions",
    "psychatrichs":"psychatrichs",
    "dermatology":"dermatology",
    "endocrine":"endocrine",
    "doctors":"doctors",
    "yoga_trainers":"yoga_trainers",
    "personal_trainers":"personal_trainers",
    "midwife":"personal_trainers",
    "IBCLC":"personal_trainers",
    "lactation_counselor":"personal_trainers",
    "nurses":"personal_trainers"
  }
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_getSingleMyHospital_mommy_map, operation_id: OBPv4.0.0-dynamicEntity_getSingleMyHospital_mommy_map Tags: _Hospital(mommy Map), Dynamic-Entity, Dynamic,

Update Hospital

Update Hospital.

Hospital

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"Hospital"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "hospital":{
    "hospitalId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "maternity_departments":"maternity_departments",
    "labor":"labor",
    "nursery":"nursery",
    "maternal_and_health_awareness":"maternal_and_health_awareness",
    "OB_gyn":"OB_gyn",
    "pediatrician":"pediatrician",
    "nutritions":"nutritions",
    "psychatrichs":"psychatrichs",
    "dermatology":"dermatology",
    "endocrine":"endocrine",
    "doctors":"doctors",
    "yoga_trainers":"yoga_trainers",
    "personal_trainers":"personal_trainers",
    "midwife":"personal_trainers",
    "IBCLC":"personal_trainers",
    "lactation_counselor":"personal_trainers",
    "nurses":"personal_trainers"
  }
}
Required Roles:
  • CanUpdateDynamicEntity_Hospital - 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 dynamicEntity_updateHospital_mommy_map, operation_id: OBPv4.0.0-dynamicEntity_updateHospital_mommy_map Tags: _Hospital(mommy Map), Dynamic-Entity, Dynamic,

Update My Hospital

Update My Hospital.

Hospital

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"Hospital"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "hospital":{
    "hospitalId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "maternity_departments":"maternity_departments",
    "labor":"labor",
    "nursery":"nursery",
    "maternal_and_health_awareness":"maternal_and_health_awareness",
    "OB_gyn":"OB_gyn",
    "pediatrician":"pediatrician",
    "nutritions":"nutritions",
    "psychatrichs":"psychatrichs",
    "dermatology":"dermatology",
    "endocrine":"endocrine",
    "doctors":"doctors",
    "yoga_trainers":"yoga_trainers",
    "personal_trainers":"personal_trainers",
    "midwife":"personal_trainers",
    "IBCLC":"personal_trainers",
    "lactation_counselor":"personal_trainers",
    "nurses":"personal_trainers"
  }
}
Required Roles:
  • CanUpdateDynamicEntity_Hospital - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_updateMyHospital_mommy_map, operation_id: OBPv4.0.0-dynamicEntity_updateMyHospital_mommy_map Tags: _Hospital(mommy Map), Dynamic-Entity, Dynamic,

Create new My Risk Check

Create new My Risk Check.

Random risk checks performed by bank employee

Property List:

  • customer: OBP Customer ID
  • check_type: Check if the real value of customer real estate matches the value
  • employee_number: Number of Employee doing the check
  • passed: Did risk check passed
  • day: Day the check was performed

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"risk_check"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "risk_check":{
    "risk_checkId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "customer":"6ccb96f6-c404-11ed-a94e-54e1adfac5b1",
    "check_type":"Real Estate Evaluation",
    "employee_number":698761728,
    "passed":true,
    "day":"2023-12-16"
  }
}
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 dynamicEntity_createMyrisk_check_tobank, operation_id: OBPv4.0.0-dynamicEntity_createMyrisk_check_tobank Tags: _Risk Check(tobank), Dynamic-Entity, Dynamic,

Create new Risk Check

Create new Risk Check.

Random risk checks performed by bank employee

Property List:

  • customer: OBP Customer ID
  • check_type: Check if the real value of customer real estate matches the value
  • employee_number: Number of Employee doing the check
  • passed: Did risk check passed
  • day: Day the check was performed

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"risk_check"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "risk_check":{
    "risk_checkId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "customer":"6ccb96f6-c404-11ed-a94e-54e1adfac5b1",
    "check_type":"Real Estate Evaluation",
    "employee_number":698761728,
    "passed":true,
    "day":"2023-12-16"
  }
}
Required Roles:
  • CanCreateDynamicEntity_risk_check - 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 dynamicEntity_createrisk_check_tobank, operation_id: OBPv4.0.0-dynamicEntity_createrisk_check_tobank Tags: _Risk Check(tobank), Dynamic-Entity, Dynamic,

Delete My Risk Check by id

Delete My Risk Check by id

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"risk_check"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "risk_check":{
    "risk_checkId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "customer":"6ccb96f6-c404-11ed-a94e-54e1adfac5b1",
    "check_type":"Real Estate Evaluation",
    "employee_number":698761728,
    "passed":true,
    "day":"2023-12-16"
  }
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_deleteMyrisk_check_tobank, operation_id: OBPv4.0.0-dynamicEntity_deleteMyrisk_check_tobank Tags: _Risk Check(tobank), Dynamic-Entity, Dynamic,

Delete Risk Check by id

Delete Risk Check by id

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"risk_check"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "risk_check":{
    "risk_checkId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "customer":"6ccb96f6-c404-11ed-a94e-54e1adfac5b1",
    "check_type":"Real Estate Evaluation",
    "employee_number":698761728,
    "passed":true,
    "day":"2023-12-16"
  }
}
Required Roles:
  • CanDeleteDynamicEntity_risk_check - 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 dynamicEntity_deleterisk_check_tobank, operation_id: OBPv4.0.0-dynamicEntity_deleterisk_check_tobank Tags: _Risk Check(tobank), Dynamic-Entity, Dynamic,

Get My Risk Check List

Get My Risk Check List.

Random risk checks performed by bank employee

Property List:

  • customer: OBP Customer ID
  • check_type: Check if the real value of customer real estate matches the value
  • employee_number: Number of Employee doing the check
  • passed: Did risk check passed
  • day: Day the check was performed

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"risk_check"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Can do filter on the fields
e.g: /risk_check?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "risk_check_list":[{
    "bank-id":"gh.29.uk",
    "risk_check":{
      "risk_checkId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
      "customer":"6ccb96f6-c404-11ed-a94e-54e1adfac5b1",
      "check_type":"Real Estate Evaluation",
      "employee_number":698761728,
      "passed":true,
      "day":"2023-12-16"
    }
  }]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_getMyrisk_checkList_tobank, operation_id: OBPv4.0.0-dynamicEntity_getMyrisk_checkList_tobank Tags: _Risk Check(tobank), Dynamic-Entity, Dynamic,

Get My Risk Check by id

Get My Risk Check by id.

Random risk checks performed by bank employee

Property List:

  • customer: OBP Customer ID
  • check_type: Check if the real value of customer real estate matches the value
  • employee_number: Number of Employee doing the check
  • passed: Did risk check passed
  • day: Day the check was performed

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"risk_check"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "risk_check":{
    "risk_checkId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "customer":"6ccb96f6-c404-11ed-a94e-54e1adfac5b1",
    "check_type":"Real Estate Evaluation",
    "employee_number":698761728,
    "passed":true,
    "day":"2023-12-16"
  }
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_getSingleMyrisk_check_tobank, operation_id: OBPv4.0.0-dynamicEntity_getSingleMyrisk_check_tobank Tags: _Risk Check(tobank), Dynamic-Entity, Dynamic,

Get Risk Check List

Get Risk Check List.

Random risk checks performed by bank employee

Property List:

  • customer: OBP Customer ID
  • check_type: Check if the real value of customer real estate matches the value
  • employee_number: Number of Employee doing the check
  • passed: Did risk check passed
  • day: Day the check was performed

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"risk_check"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Can do filter on the fields
e.g: /risk_check?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "risk_check_list":[{
    "bank-id":"gh.29.uk",
    "risk_check":{
      "risk_checkId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
      "customer":"6ccb96f6-c404-11ed-a94e-54e1adfac5b1",
      "check_type":"Real Estate Evaluation",
      "employee_number":698761728,
      "passed":true,
      "day":"2023-12-16"
    }
  }]
}
Required Roles:
  • CanGetDynamicEntity_risk_check - 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 dynamicEntity_getrisk_checkList_tobank, operation_id: OBPv4.0.0-dynamicEntity_getrisk_checkList_tobank Tags: _Risk Check(tobank), Dynamic-Entity, Dynamic,

Get Risk Check by id

Get Risk Check by id.

Random risk checks performed by bank employee

Property List:

  • customer: OBP Customer ID
  • check_type: Check if the real value of customer real estate matches the value
  • employee_number: Number of Employee doing the check
  • passed: Did risk check passed
  • day: Day the check was performed

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"risk_check"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "risk_check":{
    "risk_checkId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "customer":"6ccb96f6-c404-11ed-a94e-54e1adfac5b1",
    "check_type":"Real Estate Evaluation",
    "employee_number":698761728,
    "passed":true,
    "day":"2023-12-16"
  }
}
Required Roles:
  • CanGetDynamicEntity_risk_check - 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 dynamicEntity_getSinglerisk_check_tobank, operation_id: OBPv4.0.0-dynamicEntity_getSinglerisk_check_tobank Tags: _Risk Check(tobank), Dynamic-Entity, Dynamic,

Update My Risk Check

Update My Risk Check.

Random risk checks performed by bank employee

Property List:

  • customer: OBP Customer ID
  • check_type: Check if the real value of customer real estate matches the value
  • employee_number: Number of Employee doing the check
  • passed: Did risk check passed
  • day: Day the check was performed

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"risk_check"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "risk_check":{
    "risk_checkId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "customer":"6ccb96f6-c404-11ed-a94e-54e1adfac5b1",
    "check_type":"Real Estate Evaluation",
    "employee_number":698761728,
    "passed":true,
    "day":"2023-12-16"
  }
}
Required Roles:
  • CanUpdateDynamicEntity_risk_check - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_updateMyrisk_check_tobank, operation_id: OBPv4.0.0-dynamicEntity_updateMyrisk_check_tobank Tags: _Risk Check(tobank), Dynamic-Entity, Dynamic,

Update Risk Check

Update Risk Check.

Random risk checks performed by bank employee

Property List:

  • customer: OBP Customer ID
  • check_type: Check if the real value of customer real estate matches the value
  • employee_number: Number of Employee doing the check
  • passed: Did risk check passed
  • day: Day the check was performed

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"risk_check"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "risk_check":{
    "risk_checkId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "customer":"6ccb96f6-c404-11ed-a94e-54e1adfac5b1",
    "check_type":"Real Estate Evaluation",
    "employee_number":698761728,
    "passed":true,
    "day":"2023-12-16"
  }
}
Required Roles:
  • CanUpdateDynamicEntity_risk_check - 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 dynamicEntity_updaterisk_check_tobank, operation_id: OBPv4.0.0-dynamicEntity_updaterisk_check_tobank Tags: _Risk Check(tobank), Dynamic-Entity, Dynamic,

Create new My Risk Checks

Create new My Risk Checks.

Random risk checks performed by bank employee

Property List:

  • customer: OBP Customer ID
  • check_type: Check if the real value of customer real estate matches the value
  • employee_number: Number of Employee doing the check
  • passed: Did risk check passed
  • day: Day the check was performed

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"risk_checks"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "risk_checks":{
    "risk_checksId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "customer":"6ccb96f6-c404-11ed-a94e-54e1adfac5b1",
    "check_type":"Real Estate Evaluation",
    "employee_number":698761728,
    "passed":true,
    "day":"2023-12-16"
  }
}
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 dynamicEntity_createMyrisk_checks_tobank, operation_id: OBPv4.0.0-dynamicEntity_createMyrisk_checks_tobank Tags: _Risk Checks(tobank), Dynamic-Entity, Dynamic,

Create new Risk Checks

Create new Risk Checks.

Random risk checks performed by bank employee

Property List:

  • customer: OBP Customer ID
  • check_type: Check if the real value of customer real estate matches the value
  • employee_number: Number of Employee doing the check
  • passed: Did risk check passed
  • day: Day the check was performed

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"risk_checks"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "risk_checks":{
    "risk_checksId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "customer":"6ccb96f6-c404-11ed-a94e-54e1adfac5b1",
    "check_type":"Real Estate Evaluation",
    "employee_number":698761728,
    "passed":true,
    "day":"2023-12-16"
  }
}
Required Roles:
  • CanCreateDynamicEntity_risk_checks - 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 dynamicEntity_createrisk_checks_tobank, operation_id: OBPv4.0.0-dynamicEntity_createrisk_checks_tobank Tags: _Risk Checks(tobank), Dynamic-Entity, Dynamic,

Delete My Risk Checks by id

Delete My Risk Checks by id

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"risk_checks"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "risk_checks":{
    "risk_checksId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "customer":"6ccb96f6-c404-11ed-a94e-54e1adfac5b1",
    "check_type":"Real Estate Evaluation",
    "employee_number":698761728,
    "passed":true,
    "day":"2023-12-16"
  }
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_deleteMyrisk_checks_tobank, operation_id: OBPv4.0.0-dynamicEntity_deleteMyrisk_checks_tobank Tags: _Risk Checks(tobank), Dynamic-Entity, Dynamic,

Delete Risk Checks by id

Delete Risk Checks by id

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"risk_checks"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "risk_checks":{
    "risk_checksId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "customer":"6ccb96f6-c404-11ed-a94e-54e1adfac5b1",
    "check_type":"Real Estate Evaluation",
    "employee_number":698761728,
    "passed":true,
    "day":"2023-12-16"
  }
}
Required Roles:
  • CanDeleteDynamicEntity_risk_checks - 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 dynamicEntity_deleterisk_checks_tobank, operation_id: OBPv4.0.0-dynamicEntity_deleterisk_checks_tobank Tags: _Risk Checks(tobank), Dynamic-Entity, Dynamic,

Get My Risk Checks List

Get My Risk Checks List.

Random risk checks performed by bank employee

Property List:

  • customer: OBP Customer ID
  • check_type: Check if the real value of customer real estate matches the value
  • employee_number: Number of Employee doing the check
  • passed: Did risk check passed
  • day: Day the check was performed

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"risk_checks"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Can do filter on the fields
e.g: /risk_checks?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "risk_checks_list":[{
    "bank-id":"gh.29.uk",
    "risk_checks":{
      "risk_checksId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
      "customer":"6ccb96f6-c404-11ed-a94e-54e1adfac5b1",
      "check_type":"Real Estate Evaluation",
      "employee_number":698761728,
      "passed":true,
      "day":"2023-12-16"
    }
  }]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_getMyrisk_checksList_tobank, operation_id: OBPv4.0.0-dynamicEntity_getMyrisk_checksList_tobank Tags: _Risk Checks(tobank), Dynamic-Entity, Dynamic,

Get My Risk Checks by id

Get My Risk Checks by id.

Random risk checks performed by bank employee

Property List:

  • customer: OBP Customer ID
  • check_type: Check if the real value of customer real estate matches the value
  • employee_number: Number of Employee doing the check
  • passed: Did risk check passed
  • day: Day the check was performed

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"risk_checks"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "risk_checks":{
    "risk_checksId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "customer":"6ccb96f6-c404-11ed-a94e-54e1adfac5b1",
    "check_type":"Real Estate Evaluation",
    "employee_number":698761728,
    "passed":true,
    "day":"2023-12-16"
  }
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_getSingleMyrisk_checks_tobank, operation_id: OBPv4.0.0-dynamicEntity_getSingleMyrisk_checks_tobank Tags: _Risk Checks(tobank), Dynamic-Entity, Dynamic,

Get Risk Checks List

Get Risk Checks List.

Random risk checks performed by bank employee

Property List:

  • customer: OBP Customer ID
  • check_type: Check if the real value of customer real estate matches the value
  • employee_number: Number of Employee doing the check
  • passed: Did risk check passed
  • day: Day the check was performed

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"risk_checks"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Can do filter on the fields
e.g: /risk_checks?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "risk_checks_list":[{
    "bank-id":"gh.29.uk",
    "risk_checks":{
      "risk_checksId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
      "customer":"6ccb96f6-c404-11ed-a94e-54e1adfac5b1",
      "check_type":"Real Estate Evaluation",
      "employee_number":698761728,
      "passed":true,
      "day":"2023-12-16"
    }
  }]
}
Required Roles:
  • CanGetDynamicEntity_risk_checks - 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 dynamicEntity_getrisk_checksList_tobank, operation_id: OBPv4.0.0-dynamicEntity_getrisk_checksList_tobank Tags: _Risk Checks(tobank), Dynamic-Entity, Dynamic,

Get Risk Checks by id

Get Risk Checks by id.

Random risk checks performed by bank employee

Property List:

  • customer: OBP Customer ID
  • check_type: Check if the real value of customer real estate matches the value
  • employee_number: Number of Employee doing the check
  • passed: Did risk check passed
  • day: Day the check was performed

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"risk_checks"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "risk_checks":{
    "risk_checksId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "customer":"6ccb96f6-c404-11ed-a94e-54e1adfac5b1",
    "check_type":"Real Estate Evaluation",
    "employee_number":698761728,
    "passed":true,
    "day":"2023-12-16"
  }
}
Required Roles:
  • CanGetDynamicEntity_risk_checks - 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 dynamicEntity_getSinglerisk_checks_tobank, operation_id: OBPv4.0.0-dynamicEntity_getSinglerisk_checks_tobank Tags: _Risk Checks(tobank), Dynamic-Entity, Dynamic,

Update My Risk Checks

Update My Risk Checks.

Random risk checks performed by bank employee

Property List:

  • customer: OBP Customer ID
  • check_type: Check if the real value of customer real estate matches the value
  • employee_number: Number of Employee doing the check
  • passed: Did risk check passed
  • day: Day the check was performed

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"risk_checks"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "risk_checks":{
    "risk_checksId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "customer":"6ccb96f6-c404-11ed-a94e-54e1adfac5b1",
    "check_type":"Real Estate Evaluation",
    "employee_number":698761728,
    "passed":true,
    "day":"2023-12-16"
  }
}
Required Roles:
  • CanUpdateDynamicEntity_risk_checks - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_updateMyrisk_checks_tobank, operation_id: OBPv4.0.0-dynamicEntity_updateMyrisk_checks_tobank Tags: _Risk Checks(tobank), Dynamic-Entity, Dynamic,

Update Risk Checks

Update Risk Checks.

Random risk checks performed by bank employee

Property List:

  • customer: OBP Customer ID
  • check_type: Check if the real value of customer real estate matches the value
  • employee_number: Number of Employee doing the check
  • passed: Did risk check passed
  • day: Day the check was performed

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"risk_checks"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "risk_checks":{
    "risk_checksId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "customer":"6ccb96f6-c404-11ed-a94e-54e1adfac5b1",
    "check_type":"Real Estate Evaluation",
    "employee_number":698761728,
    "passed":true,
    "day":"2023-12-16"
  }
}
Required Roles:
  • CanUpdateDynamicEntity_risk_checks - 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 dynamicEntity_updaterisk_checks_tobank, operation_id: OBPv4.0.0-dynamicEntity_updaterisk_checks_tobank Tags: _Risk Checks(tobank), Dynamic-Entity, Dynamic,