right logo image
right logo image
Log on
⯆

API Explorer

Log off

v4.0.0 (541 APIs)

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

Create new March Hare

Create new March Hare.

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

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "march_hare":{
    "marchHareId":"3b76ec52-f4d9-4699-9495-dc0fbe61252d",
    "name":"James Brown",
    "number":698761728
  }
}
Required Roles:
  • CanCreateDynamicEntity_MarchHare - 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_createMarchHare_gh.29.uk, operation_id: OBPv4.0.0-dynamicEntity_createMarchHare_gh.29.uk Tags: _March Hare(gh.29.uk), New-Style, Dynamic-Entity, Dynamic,

Delete March Hare by id

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

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "march_hare":{
    "marchHareId":"53f471ec-afb0-4e92-943f-c35421fe2894",
    "name":"James Brown",
    "number":698761728
  }
}
Required Roles:
  • CanDeleteDynamicEntity_MarchHare - 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_deleteMarchHare_gh.29.uk, operation_id: OBPv4.0.0-dynamicEntity_deleteMarchHare_gh.29.uk Tags: _March Hare(gh.29.uk), New-Style, Dynamic-Entity, Dynamic,

Get March Hare List

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

Authentication is Mandatory

Can do filter on the fields
e.g: /MarchHare?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",
  "march_hare_list":[{
    "bank-id":"gh.29.uk",
    "march_hare":{
      "marchHareId":"3c7e9be3-11ed-4791-bb98-a8bdfa8945ab",
      "name":"James Brown",
      "number":698761728
    }
  }]
}
Required Roles:
  • CanGetDynamicEntity_MarchHare - 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_getMarchHareList_gh.29.uk, operation_id: OBPv4.0.0-dynamicEntity_getMarchHareList_gh.29.uk Tags: _March Hare(gh.29.uk), New-Style, Dynamic-Entity, Dynamic,

Get March Hare by id

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

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "march_hare":{
    "marchHareId":"df6aa229-0929-4082-9d72-4c51e22fbaaa",
    "name":"James Brown",
    "number":698761728
  }
}
Required Roles:
  • CanGetDynamicEntity_MarchHare - 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_getSingleMarchHare_gh.29.uk, operation_id: OBPv4.0.0-dynamicEntity_getSingleMarchHare_gh.29.uk Tags: _March Hare(gh.29.uk), New-Style, Dynamic-Entity, Dynamic,

Update March Hare

Update March Hare.

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

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "march_hare":{
    "marchHareId":"c89c03e7-1ee8-4f1d-b17d-fc3d1aaea3fd",
    "name":"James Brown",
    "number":698761728
  }
}
Required Roles:
  • CanUpdateDynamicEntity_MarchHare - 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_updateMarchHare_gh.29.uk, operation_id: OBPv4.0.0-dynamicEntity_updateMarchHare_gh.29.uk Tags: _March Hare(gh.29.uk), New-Style, Dynamic-Entity, Dynamic,