right logo image
right logo image
Log on
⯆

API Explorer

Log off

v5.0.0 (564 APIs)

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

Create new Obp Activity

Create new Obp Activity.

Description of this entity, can be markdown text.

Property List:

  • name: description of name field, can be markdown text.
  • username: description of name field, can be markdown text.
  • created_date: 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":"ObpActivity"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "obp_activity":{
    "obpActivityId":"5d895708-33b3-4e83-a322-7b4f533c1c21",
    "name":"James Brown",
    "username":"James Brown",
    "created_date":"698761728"
  }
}
Required Roles:
  • CanCreateDynamicEntity_ObpActivity - 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_createObpActivity_obp.testing.01, operation_id: OBPv4.0.0-dynamicEntity_createObpActivity_obp.testing.01 Tags: _Obp Activity(obp.testing.01), Dynamic-Entity, Dynamic,

Delete Obp Activity by id

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

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "obp_activity":{
    "obpActivityId":"b45b9da1-5c65-4d05-8af2-2551d1589cee",
    "name":"James Brown",
    "username":"James Brown",
    "created_date":"698761728"
  }
}
Required Roles:
  • CanDeleteDynamicEntity_ObpActivity - 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_deleteObpActivity_obp.testing.01, operation_id: OBPv4.0.0-dynamicEntity_deleteObpActivity_obp.testing.01 Tags: _Obp Activity(obp.testing.01), Dynamic-Entity, Dynamic,

Get Obp Activity List

Get Obp Activity List.

Description of this entity, can be markdown text.

Property List:

  • name: description of name field, can be markdown text.
  • username: description of name field, can be markdown text.
  • created_date: 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":"ObpActivity"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Can do filter on the fields
e.g: /ObpActivity?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_activity_list":[{
    "bank-id":"gh.29.uk",
    "obp_activity":{
      "obpActivityId":"c742f195-ffbd-4ffd-b39c-e12e5ac254a2",
      "name":"James Brown",
      "username":"James Brown",
      "created_date":"698761728"
    }
  }]
}
Required Roles:
  • CanGetDynamicEntity_ObpActivity - 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_getObpActivityList_obp.testing.01, operation_id: OBPv4.0.0-dynamicEntity_getObpActivityList_obp.testing.01 Tags: _Obp Activity(obp.testing.01), Dynamic-Entity, Dynamic,

Get Obp Activity by id

Get Obp Activity by id.

Description of this entity, can be markdown text.

Property List:

  • name: description of name field, can be markdown text.
  • username: description of name field, can be markdown text.
  • created_date: 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":"ObpActivity"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "obp_activity":{
    "obpActivityId":"22ca96b0-7d36-4365-8a92-bf8f488b7cf6",
    "name":"James Brown",
    "username":"James Brown",
    "created_date":"698761728"
  }
}
Required Roles:
  • CanGetDynamicEntity_ObpActivity - 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_getSingleObpActivity_obp.testing.01, operation_id: OBPv4.0.0-dynamicEntity_getSingleObpActivity_obp.testing.01 Tags: _Obp Activity(obp.testing.01), Dynamic-Entity, Dynamic,

Update Obp Activity

Update Obp Activity.

Description of this entity, can be markdown text.

Property List:

  • name: description of name field, can be markdown text.
  • username: description of name field, can be markdown text.
  • created_date: 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":"ObpActivity"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "obp_activity":{
    "obpActivityId":"d2051e66-5363-4718-b845-bd44adb5179e",
    "name":"James Brown",
    "username":"James Brown",
    "created_date":"698761728"
  }
}
Required Roles:
  • CanUpdateDynamicEntity_ObpActivity - 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_updateObpActivity_obp.testing.01, operation_id: OBPv4.0.0-dynamicEntity_updateObpActivity_obp.testing.01 Tags: _Obp Activity(obp.testing.01), Dynamic-Entity, Dynamic,