API Explorer

v4.0.0 (439 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Create new NMBTest

Create new NMBTest.

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "nmb_test":{ "nMBTestId":"abbe5800-1478-45b9-8dfe-117f734955c1", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanCreateDynamicEntity_NMBTest - 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_createNMBTest, operation_id: OBPv4.0.0-dynamicEntity_createNMBTest Tags: _NMBTest, New-Style, Dynamic-Endpoint, Dynamic,

Delete NMBTest by id

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "nmb_test":{ "nMBTestId":"ff377e3b-9f84-48e5-b3cd-3c90313ab6f6", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanDeleteDynamicEntity_NMBTest - 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_deleteNMBTest, operation_id: OBPv4.0.0-dynamicEntity_deleteNMBTest Tags: _NMBTest, New-Style, Dynamic-Endpoint, Dynamic,

Get NMBTest List

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

Authentication is Mandatory

Can do filter on the fields
e.g: /NMBTest?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:

								
									
{ "nmb_test_list":[{ "nmb_test":{ "nMBTestId":"fa1803ee-40c3-4923-91a1-4c23b4e6a36e", "name":"James Brown", "number":698761728 } }] }
Required Roles:
  • CanGetDynamicEntity_NMBTest - 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_getNMBTestList, operation_id: OBPv4.0.0-dynamicEntity_getNMBTestList Tags: _NMBTest, New-Style, Dynamic-Endpoint, Dynamic,

Get NMBTest by id

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "nmb_test":{ "nMBTestId":"3cd3cdfd-861a-4cb6-bf38-4b5b60819645", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanGetDynamicEntity_NMBTest - 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_getSingleNMBTest, operation_id: OBPv4.0.0-dynamicEntity_getSingleNMBTest Tags: _NMBTest, New-Style, Dynamic-Endpoint, Dynamic,

Update NMBTest

Update NMBTest.

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "nmb_test":{ "nMBTestId":"5949329c-010e-4825-9f59-b386b2637828", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanUpdateDynamicEntity_NMBTest - 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_updateNMBTest, operation_id: OBPv4.0.0-dynamicEntity_updateNMBTest Tags: _NMBTest, New-Style, Dynamic-Endpoint, Dynamic,