right logo image
right logo image
Log on
⯆

API Explorer

Log off

v1.3.0 (153 APIs)

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

Create new Odometer

Create new Odometer.

Verify odometer information for flexible contracts.

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

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "odometer":{
    "odometerId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "name":"James Brown",
    "number":698761728
  }
}
Required Roles:
  • CanCreateDynamicEntity_Odometer - 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_createOdometer_gh.29.uk, operation_id: OBPv4.0.0-dynamicEntity_createOdometer_gh.29.uk Tags: _Odometer(gh.29.uk), Dynamic-Entity, Dynamic,

Delete Odometer by id

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

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "odometer":{
    "odometerId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "name":"James Brown",
    "number":698761728
  }
}
Required Roles:
  • CanDeleteDynamicEntity_Odometer - 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_deleteOdometer_gh.29.uk, operation_id: OBPv4.0.0-dynamicEntity_deleteOdometer_gh.29.uk Tags: _Odometer(gh.29.uk), Dynamic-Entity, Dynamic,

Get Odometer List

Get Odometer List.

Verify odometer information for flexible contracts.

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

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Can do filter on the fields
e.g: /Odometer?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",
  "odometer_list":[{
    "bank-id":"gh.29.uk",
    "odometer":{
      "odometerId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
      "name":"James Brown",
      "number":698761728
    }
  }]
}
Required Roles:
  • CanGetDynamicEntity_Odometer - 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_getOdometerList_gh.29.uk, operation_id: OBPv4.0.0-dynamicEntity_getOdometerList_gh.29.uk Tags: _Odometer(gh.29.uk), Dynamic-Entity, Dynamic,

Get Odometer by id

Get Odometer by id.

Verify odometer information for flexible contracts.

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

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "odometer":{
    "odometerId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "name":"James Brown",
    "number":698761728
  }
}
Required Roles:
  • CanGetDynamicEntity_Odometer - 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_getSingleOdometer_gh.29.uk, operation_id: OBPv4.0.0-dynamicEntity_getSingleOdometer_gh.29.uk Tags: _Odometer(gh.29.uk), Dynamic-Entity, Dynamic,

Update Odometer

Update Odometer.

Verify odometer information for flexible contracts.

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

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "odometer":{
    "odometerId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "name":"James Brown",
    "number":698761728
  }
}
Required Roles:
  • CanUpdateDynamicEntity_Odometer - 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_updateOdometer_gh.29.uk, operation_id: OBPv4.0.0-dynamicEntity_updateOdometer_gh.29.uk Tags: _Odometer(gh.29.uk), Dynamic-Entity, Dynamic,