API Explorer

Bank
Accounts
Views
Counterparties
Transactions

Create new OBP Reena

Create new OBP Reena.

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":"OBP_Reena"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "obp_reena":{ "oBP_ReenaId":"acd4dad5-72da-4a79-acf1-93101c019a8d", "name":"Reena Aheer", "number":698761728 } }
Required Roles:
  • CanCreateDynamicEntity_OBP_Reena - 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_createOBP_Reena, operation_id: OBPv4.0.0-dynamicEntity_createOBP_Reena Tags: _OBP Reena, New-Style, Dynamic-Entity, Dynamic,

Delete OBP Reena by id

Delete OBP Reena 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":"OBP_Reena"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "obp_reena":{ "oBP_ReenaId":"6670ac69-77c9-4dad-96a6-b88144f10404", "name":"Reena Aheer", "number":698761728 } }
Required Roles:
  • CanDeleteDynamicEntity_OBP_Reena - 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_deleteOBP_Reena, operation_id: OBPv4.0.0-dynamicEntity_deleteOBP_Reena Tags: _OBP Reena, New-Style, Dynamic-Entity, Dynamic,

Get OBP Reena List

Get OBP Reena 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":"OBP_Reena"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Can do filter on the fields
e.g: /OBP_Reena?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", "obp_reena_list":[{ "bank-id":"gh.29.uk", "obp_reena":{ "oBP_ReenaId":"609d3c1d-3f1f-4a2e-acf7-6ed2fe50f2fc", "name":"Reena Aheer", "number":698761728 } }] }
Required Roles:
  • CanGetDynamicEntity_OBP_Reena - 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_getOBP_ReenaList, operation_id: OBPv4.0.0-dynamicEntity_getOBP_ReenaList Tags: _OBP Reena, New-Style, Dynamic-Entity, Dynamic,

Get OBP Reena by id

Get OBP Reena 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":"OBP_Reena"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "obp_reena":{ "oBP_ReenaId":"de2499c5-ab5a-44c4-b184-b845e4f4f7b8", "name":"Reena Aheer", "number":698761728 } }
Required Roles:
  • CanGetDynamicEntity_OBP_Reena - 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_getSingleOBP_Reena, operation_id: OBPv4.0.0-dynamicEntity_getSingleOBP_Reena Tags: _OBP Reena, New-Style, Dynamic-Entity, Dynamic,

Update OBP Reena

Update OBP Reena.

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":"OBP_Reena"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "obp_reena":{ "oBP_ReenaId":"b669ca2a-0569-4ebf-8d57-7c4781d0e8b4", "name":"Reena Aheer", "number":698761728 } }
Required Roles:
  • CanUpdateDynamicEntity_OBP_Reena - 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_updateOBP_Reena, operation_id: OBPv4.0.0-dynamicEntity_updateOBP_Reena Tags: _OBP Reena, New-Style, Dynamic-Entity, Dynamic,