API Explorer

v4.0.0 (490 APIs)

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":"2f409f49-e190-4a99-97b2-b2db106ec596", "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, operation_id: OBPv4.0.0-dynamicEntity_createMarchHare Tags: _MarchHare, 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":"00929cc9-539b-44eb-9214-d21fbcb69074", "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, operation_id: OBPv4.0.0-dynamicEntity_deleteMarchHare Tags: _MarchHare, 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":"a611a8cc-fb86-4cf4-945c-aba1f969de8e", "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, operation_id: OBPv4.0.0-dynamicEntity_getMarchHareList Tags: _MarchHare, 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":"57a2e543-8568-4fbb-b38b-c4f85404026a", "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, operation_id: OBPv4.0.0-dynamicEntity_getSingleMarchHare Tags: _MarchHare, 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":"8647cdd0-4e09-40a4-98fd-bc6795e57d79", "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, operation_id: OBPv4.0.0-dynamicEntity_updateMarchHare Tags: _MarchHare, New-Style, Dynamic-Entity, Dynamic,