API Explorer

v4.0.0 (361 APIs)

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":"a73aec2b-3d1d-438f-8340-539787dacc28", "customer_identifier":"bc37e0fb-b75b-48d3-8fe9-c94ff064aa9a", "manufacturer":"BMW" } }
Required Roles:
  • CanCreateDynamicEntity_customer_cars - Please login to request this Role
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:
Implemented in OBPv4.0.0 by dynamicEntity_createcustomer_cars, operation_id: OBPv4.0.0-dynamicEntity_createcustomer_cars

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":"09c9cee9-902c-442f-bb00-065fa6d1315b", "customer_identifier":"bc37e0fb-b75b-48d3-8fe9-c94ff064aa9a", "manufacturer":"BMW" } }
Required Roles:
  • CanDeleteDynamicEntity_customer_cars - Please login to request this Role
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:
Implemented in OBPv4.0.0 by dynamicEntity_deletecustomer_cars, operation_id: OBPv4.0.0-dynamicEntity_deletecustomer_cars

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":"d2bd3c7c-afb7-4698-aa23-c182ce05d77b", "customer_identifier":"bc37e0fb-b75b-48d3-8fe9-c94ff064aa9a", "manufacturer":"BMW" } }] }
Required Roles:
  • CanGetDynamicEntity_customer_cars - Please login to request this Role
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:
Implemented in OBPv4.0.0 by dynamicEntity_getcustomer_carsList, operation_id: OBPv4.0.0-dynamicEntity_getcustomer_carsList

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":"31933bd4-bbed-45c6-a58d-28e16c76eb36", "customer_identifier":"bc37e0fb-b75b-48d3-8fe9-c94ff064aa9a", "manufacturer":"BMW" } }
Required Roles:
  • CanGetDynamicEntity_customer_cars - Please login to request this Role
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:
Implemented in OBPv4.0.0 by dynamicEntity_getSinglecustomer_cars, operation_id: OBPv4.0.0-dynamicEntity_getSinglecustomer_cars

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":"aef9dc75-5be7-47b8-b908-d00dec7ca8f6", "customer_identifier":"bc37e0fb-b75b-48d3-8fe9-c94ff064aa9a", "manufacturer":"BMW" } }
Required Roles:
  • CanUpdateDynamicEntity_customer_cars - Please login to request this Role
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:
Implemented in OBPv4.0.0 by dynamicEntity_updatecustomer_cars, operation_id: OBPv4.0.0-dynamicEntity_updatecustomer_cars