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":"c52bd661-959e-481c-a3af-11709e365cc0", "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":"cf769844-ca7b-4670-a994-a5ebfe05cbd5", "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":"e658535e-15e6-4cdd-91a5-883f6da79a49", "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":"4b3f8d98-6a6c-4dd1-92fb-6f1f6a13fff2", "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":"b1afe804-6fac-4339-9aac-bef0cb638e63", "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,