API Explorer

v1.3.0 (152 APIs)

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"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

								
									
{ "bank-id":"gh.29.uk", "odometer":{ "odometerId":"eb083ff7-5579-45f9-a6c4-c750acb1616c", "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), New-Style, 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"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

								
									
{ "bank-id":"gh.29.uk", "odometer":{ "odometerId":"4ffc7d01-96d1-4c13-b43a-658ba4b954a6", "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), New-Style, 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"
    }
  ]
}

Authentication is Mandatory

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":"466395be-4040-4bb0-b71b-7c3decae1e3a", "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), New-Style, 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"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

								
									
{ "bank-id":"gh.29.uk", "odometer":{ "odometerId":"cfb745ba-7f05-4b31-bdf9-744a3dac2ee0", "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), New-Style, 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"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

								
									
{ "bank-id":"gh.29.uk", "odometer":{ "odometerId":"e9f25e38-3fe5-4670-8f45-5f4f62c92e5a", "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), New-Style, Dynamic-Entity, Dynamic,