right logo image
right logo image
Log on
⯆

API Explorer

Log off

v5.1.0 (610 APIs)

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

Create new Customer Cars

Create new Customer Cars.

The car the customer arrived in

Property List:

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

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "customer_cars":{
    "customer_carsId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "customer_identifier":"bc37e0fb-b75b-48d3-8fe9-c94ff064aa9a",
    "manufacturer":"BMW"
  }
}
Required Roles:
  • CanCreateDynamicEntity_Systemcustomer_cars - 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_createcustomer_cars_, operation_id: OBPv4.0.0-dynamicEntity_createcustomer_cars_ Tags: _Customer Cars, Dynamic-Entity, Dynamic,

Delete Customer Cars by id

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

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "customer_cars":{
    "customer_carsId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "customer_identifier":"bc37e0fb-b75b-48d3-8fe9-c94ff064aa9a",
    "manufacturer":"BMW"
  }
}
Required Roles:
  • CanDeleteDynamicEntity_Systemcustomer_cars - 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_deletecustomer_cars_, operation_id: OBPv4.0.0-dynamicEntity_deletecustomer_cars_ Tags: _Customer Cars, Dynamic-Entity, Dynamic,

Get Customer Cars List

Get Customer Cars List.

The car the customer arrived in

Property List:

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

Authentication is Mandatory

Can do filter on the fields
e.g: /customer_cars?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: 

								
									
{
  "customer_cars_list":[{
    "customer_cars":{
      "customer_carsId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
      "customer_identifier":"bc37e0fb-b75b-48d3-8fe9-c94ff064aa9a",
      "manufacturer":"BMW"
    }
  }]
}
Required Roles:
  • CanGetDynamicEntity_Systemcustomer_cars - 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_getcustomer_carsList_, operation_id: OBPv4.0.0-dynamicEntity_getcustomer_carsList_ Tags: _Customer Cars, Dynamic-Entity, Dynamic,

Get Customer Cars by id

Get Customer Cars by id.

The car the customer arrived in

Property List:

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

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "customer_cars":{
    "customer_carsId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "customer_identifier":"bc37e0fb-b75b-48d3-8fe9-c94ff064aa9a",
    "manufacturer":"BMW"
  }
}
Required Roles:
  • CanGetDynamicEntity_Systemcustomer_cars - 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_getSinglecustomer_cars_, operation_id: OBPv4.0.0-dynamicEntity_getSinglecustomer_cars_ Tags: _Customer Cars, Dynamic-Entity, Dynamic,

Update Customer Cars

Update Customer Cars.

The car the customer arrived in

Property List:

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

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "customer_cars":{
    "customer_carsId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "customer_identifier":"bc37e0fb-b75b-48d3-8fe9-c94ff064aa9a",
    "manufacturer":"BMW"
  }
}
Required Roles:
  • CanUpdateDynamicEntity_Systemcustomer_cars - 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_updatecustomer_cars_, operation_id: OBPv4.0.0-dynamicEntity_updatecustomer_cars_ Tags: _Customer Cars, Dynamic-Entity, Dynamic,