API Explorer

v4.0.0 filtered by tag: Dynamic-Entity (65 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Create new Covid APIDays

Create new Covid APIDays.

Description of this entity, can be markdown text.

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "covid_api_days":{ "covidAPIDaysId":"62dd7ba7-e9a0-4972-950a-30f472840a4f", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanCreateDynamicEntity_CovidAPIDays - 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_createCovidAPIDays, operation_id: OBPv4.0.0-dynamicEntity_createCovidAPIDays Tags: _CovidAPIDays, New-Style, Dynamic-Entity, Dynamic,

Delete Covid APIDays by id

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "covid_api_days":{ "covidAPIDaysId":"7a69bb52-278e-48f7-bebf-b4785ee6bb1e", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanDeleteDynamicEntity_CovidAPIDays - 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_deleteCovidAPIDays, operation_id: OBPv4.0.0-dynamicEntity_deleteCovidAPIDays Tags: _CovidAPIDays, New-Style, Dynamic-Entity, Dynamic,

Get Covid APIDays List

Get Covid APIDays List.

Description of this entity, can be markdown text.

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

Authentication is Mandatory

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

								
									
{ "covid_api_days_list":[{ "covid_api_days":{ "covidAPIDaysId":"fdd89c0f-d6b6-4bd1-9a06-5b31133173b6", "name":"James Brown", "number":698761728 } }] }
Required Roles:
  • CanGetDynamicEntity_CovidAPIDays - 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_getCovidAPIDaysList, operation_id: OBPv4.0.0-dynamicEntity_getCovidAPIDaysList Tags: _CovidAPIDays, New-Style, Dynamic-Entity, Dynamic,

Get Covid APIDays by id

Get Covid APIDays by id.

Description of this entity, can be markdown text.

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "covid_api_days":{ "covidAPIDaysId":"cfdf0e32-b258-4b1b-8dae-43a8a86bffce", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanGetDynamicEntity_CovidAPIDays - 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_getSingleCovidAPIDays, operation_id: OBPv4.0.0-dynamicEntity_getSingleCovidAPIDays Tags: _CovidAPIDays, New-Style, Dynamic-Entity, Dynamic,

Update Covid APIDays

Update Covid APIDays.

Description of this entity, can be markdown text.

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "covid_api_days":{ "covidAPIDaysId":"7154d2a5-7f76-4491-a64b-a766b6e6dd6f", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanUpdateDynamicEntity_CovidAPIDays - 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_updateCovidAPIDays, operation_id: OBPv4.0.0-dynamicEntity_updateCovidAPIDays Tags: _CovidAPIDays, New-Style, Dynamic-Entity, Dynamic,

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":"fbb5695c-e196-4041-b01e-f7d343b7469a", "customer_identifier":"bc37e0fb-b75b-48d3-8fe9-c94ff064aa9a", "manufacturer":"BMW" } }
Required Roles:
  • CanCreateDynamicEntity_customer_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, New-Style, 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":"8aea5eb5-6c81-44b7-9c05-fbe4da5562bb", "customer_identifier":"bc37e0fb-b75b-48d3-8fe9-c94ff064aa9a", "manufacturer":"BMW" } }
Required Roles:
  • CanDeleteDynamicEntity_customer_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, New-Style, 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":"18b3c25b-af54-4293-baf6-13ef9dd3a4ee", "customer_identifier":"bc37e0fb-b75b-48d3-8fe9-c94ff064aa9a", "manufacturer":"BMW" } }] }
Required Roles:
  • CanGetDynamicEntity_customer_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, New-Style, 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":"7de2963f-4326-427a-a108-d009b7d05055", "customer_identifier":"bc37e0fb-b75b-48d3-8fe9-c94ff064aa9a", "manufacturer":"BMW" } }
Required Roles:
  • CanGetDynamicEntity_customer_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, New-Style, 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":"4e2828cb-4218-4d35-8283-b14a8e29f8e1", "customer_identifier":"bc37e0fb-b75b-48d3-8fe9-c94ff064aa9a", "manufacturer":"BMW" } }
Required Roles:
  • CanUpdateDynamicEntity_customer_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, New-Style, Dynamic-Entity, Dynamic,

Create new D Entity1

Create new D Entity1.

Description of this entity, can be markdown text.

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "d-entity1":{ "d-Entity1Id":"b494b95e-f21e-423e-ae6f-ff805f8a8ad5", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanCreateDynamicEntity_D-Entity1 - 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_createD-Entity1, operation_id: OBPv4.0.0-dynamicEntity_createD-Entity1 Tags: _D Entity1, New-Style, Dynamic-Entity, Dynamic,

Delete D Entity1 by id

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "d-entity1":{ "d-Entity1Id":"7c5fed10-5b98-4d87-9ecd-99d3d529f929", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanDeleteDynamicEntity_D-Entity1 - 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_deleteD-Entity1, operation_id: OBPv4.0.0-dynamicEntity_deleteD-Entity1 Tags: _D Entity1, New-Style, Dynamic-Entity, Dynamic,

Get D Entity1 List

Get D Entity1 List.

Description of this entity, can be markdown text.

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

Authentication is Mandatory

Can do filter on the fields
e.g: /D-Entity1?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", "d-entity1_list":[{ "bank-id":"gh.29.uk", "d-entity1":{ "d-Entity1Id":"9230b2d0-3376-48c4-bbcc-caa25e1cb62e", "name":"James Brown", "number":698761728 } }] }
Required Roles:
  • CanGetDynamicEntity_D-Entity1 - 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_getD-Entity1List, operation_id: OBPv4.0.0-dynamicEntity_getD-Entity1List Tags: _D Entity1, New-Style, Dynamic-Entity, Dynamic,

Get D Entity1 by id

Get D Entity1 by id.

Description of this entity, can be markdown text.

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "d-entity1":{ "d-Entity1Id":"5fb5739e-19b2-4c80-a088-de4cb55d48f3", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanGetDynamicEntity_D-Entity1 - 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_getSingleD-Entity1, operation_id: OBPv4.0.0-dynamicEntity_getSingleD-Entity1 Tags: _D Entity1, New-Style, Dynamic-Entity, Dynamic,

Update D Entity1

Update D Entity1.

Description of this entity, can be markdown text.

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "d-entity1":{ "d-Entity1Id":"0f50cc70-e467-4ee0-8a1f-cb546f5a5e99", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanUpdateDynamicEntity_D-Entity1 - 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_updateD-Entity1, operation_id: OBPv4.0.0-dynamicEntity_updateD-Entity1 Tags: _D Entity1, New-Style, Dynamic-Entity, Dynamic,

Create new Fish Port

Create new Fish Port.

Portfolio of fishbased values

Property List:

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "fish_port":{ "fishPortId":"cf85d404-29c1-4e62-ac0a-195d527a87e7", "fish":"James Brown", "number":6987233228 } }
Required Roles:
  • CanCreateDynamicEntity_FishPort - 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_createFishPort, operation_id: OBPv4.0.0-dynamicEntity_createFishPort Tags: _FishPort, New-Style, Dynamic-Entity, Dynamic,

Delete Fish Port by id

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "fish_port":{ "fishPortId":"9728c189-0f33-4bd0-961d-08f74aa5461a", "fish":"James Brown", "number":6987233228 } }
Required Roles:
  • CanDeleteDynamicEntity_FishPort - 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_deleteFishPort, operation_id: OBPv4.0.0-dynamicEntity_deleteFishPort Tags: _FishPort, New-Style, Dynamic-Entity, Dynamic,

Get Fish Port List

Get Fish Port List.

Portfolio of fishbased values

Property List:

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

Authentication is Mandatory

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

								
									
{ "fish_port_list":[{ "fish_port":{ "fishPortId":"03857c23-a77b-4e0d-ba81-7f83f52168e3", "fish":"James Brown", "number":6987233228 } }] }
Required Roles:
  • CanGetDynamicEntity_FishPort - 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_getFishPortList, operation_id: OBPv4.0.0-dynamicEntity_getFishPortList Tags: _FishPort, New-Style, Dynamic-Entity, Dynamic,

Get Fish Port by id

Get Fish Port by id.

Portfolio of fishbased values

Property List:

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "fish_port":{ "fishPortId":"d48583df-4788-4cd1-ba7c-27d1c594a189", "fish":"James Brown", "number":6987233228 } }
Required Roles:
  • CanGetDynamicEntity_FishPort - 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_getSingleFishPort, operation_id: OBPv4.0.0-dynamicEntity_getSingleFishPort Tags: _FishPort, New-Style, Dynamic-Entity, Dynamic,

Update Fish Port

Update Fish Port.

Portfolio of fishbased values

Property List:

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "fish_port":{ "fishPortId":"1b6d3bf6-d5c6-404b-8ed4-8136fbcfbc77", "fish":"James Brown", "number":6987233228 } }
Required Roles:
  • CanUpdateDynamicEntity_FishPort - 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_updateFishPort, operation_id: OBPv4.0.0-dynamicEntity_updateFishPort Tags: _FishPort, New-Style, Dynamic-Entity, Dynamic,

Create new Foo Bar

Create new Foo Bar.

Description of this entity, can be markdown text.

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "foo_bar":{ "fooBarId":"f91a1fba-f606-4234-b856-b092da50e281", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanCreateDynamicEntity_FooBar - 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_createFooBar, operation_id: OBPv4.0.0-dynamicEntity_createFooBar Tags: _FooBar, New-Style, Dynamic-Entity, Dynamic,

Delete Foo Bar by id

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "foo_bar":{ "fooBarId":"5a6be3ce-9d91-4a9c-b2a8-ae64bc83b473", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanDeleteDynamicEntity_FooBar - 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_deleteFooBar, operation_id: OBPv4.0.0-dynamicEntity_deleteFooBar Tags: _FooBar, New-Style, Dynamic-Entity, Dynamic,

Get Foo Bar List

Get Foo Bar List.

Description of this entity, can be markdown text.

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

Authentication is Mandatory

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

								
									
{ "foo_bar_list":[{ "foo_bar":{ "fooBarId":"64b75c98-e59e-405e-8e2b-51258258af6b", "name":"James Brown", "number":698761728 } }] }
Required Roles:
  • CanGetDynamicEntity_FooBar - 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_getFooBarList, operation_id: OBPv4.0.0-dynamicEntity_getFooBarList Tags: _FooBar, New-Style, Dynamic-Entity, Dynamic,

Get Foo Bar by id

Get Foo Bar by id.

Description of this entity, can be markdown text.

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "foo_bar":{ "fooBarId":"b883edfc-3daa-4355-ace6-0048b98c4a21", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanGetDynamicEntity_FooBar - 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_getSingleFooBar, operation_id: OBPv4.0.0-dynamicEntity_getSingleFooBar Tags: _FooBar, New-Style, Dynamic-Entity, Dynamic,

Update Foo Bar

Update Foo Bar.

Description of this entity, can be markdown text.

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "foo_bar":{ "fooBarId":"2dfc3ab8-5740-46a3-b03f-a6c8547165d8", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanUpdateDynamicEntity_FooBar - 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_updateFooBar, operation_id: OBPv4.0.0-dynamicEntity_updateFooBar Tags: _FooBar, New-Style, Dynamic-Entity, Dynamic,

Create new Insurance Policy

Create new Insurance Policy.

Which insurance policies the customer already has.

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "insurance_policy":{ "insurancePolicyId":"3d6b97e8-03b0-410e-bc75-08ad4bf341f1", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanCreateDynamicEntity_InsurancePolicy - 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_createInsurancePolicy, operation_id: OBPv4.0.0-dynamicEntity_createInsurancePolicy Tags: _InsurancePolicy, New-Style, Dynamic-Entity, Dynamic,

Delete Insurance Policy by id

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "insurance_policy":{ "insurancePolicyId":"5f82378c-9714-4549-8fe9-80015f224b1a", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanDeleteDynamicEntity_InsurancePolicy - 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_deleteInsurancePolicy, operation_id: OBPv4.0.0-dynamicEntity_deleteInsurancePolicy Tags: _InsurancePolicy, New-Style, Dynamic-Entity, Dynamic,

Get Insurance Policy List

Get Insurance Policy List.

Which insurance policies the customer already has.

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

Authentication is Mandatory

Can do filter on the fields
e.g: /InsurancePolicy?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", "insurance_policy_list":[{ "bank-id":"gh.29.uk", "insurance_policy":{ "insurancePolicyId":"967f3a82-411a-4670-9258-cb887afae08d", "name":"James Brown", "number":698761728 } }] }
Required Roles:
  • CanGetDynamicEntity_InsurancePolicy - 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_getInsurancePolicyList, operation_id: OBPv4.0.0-dynamicEntity_getInsurancePolicyList Tags: _InsurancePolicy, New-Style, Dynamic-Entity, Dynamic,

Get Insurance Policy by id

Get Insurance Policy by id.

Which insurance policies the customer already has.

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "insurance_policy":{ "insurancePolicyId":"cc2261b3-cb6d-4e06-a74c-16f0133800ea", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanGetDynamicEntity_InsurancePolicy - 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_getSingleInsurancePolicy, operation_id: OBPv4.0.0-dynamicEntity_getSingleInsurancePolicy Tags: _InsurancePolicy, New-Style, Dynamic-Entity, Dynamic,

Update Insurance Policy

Update Insurance Policy.

Which insurance policies the customer already has.

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "insurance_policy":{ "insurancePolicyId":"ad7a71b2-3915-4902-9a43-3a68499ea252", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanUpdateDynamicEntity_InsurancePolicy - 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_updateInsurancePolicy, operation_id: OBPv4.0.0-dynamicEntity_updateInsurancePolicy Tags: _InsurancePolicy, New-Style, Dynamic-Entity, Dynamic,

Create new Insurance Premium

Create new Insurance Premium.

Retrive the premium for the customer.

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "insurance_premium":{ "insurancePremiumId":"4261548a-db7a-4152-b8f9-2a33127ebc5a", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanCreateDynamicEntity_InsurancePremium - 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_createInsurancePremium, operation_id: OBPv4.0.0-dynamicEntity_createInsurancePremium Tags: _InsurancePremium, New-Style, Dynamic-Entity, Dynamic,

Delete Insurance Premium by id

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "insurance_premium":{ "insurancePremiumId":"1a453fb3-007e-4a07-b2ca-59daad7d2077", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanDeleteDynamicEntity_InsurancePremium - 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_deleteInsurancePremium, operation_id: OBPv4.0.0-dynamicEntity_deleteInsurancePremium Tags: _InsurancePremium, New-Style, Dynamic-Entity, Dynamic,

Get Insurance Premium List

Get Insurance Premium List.

Retrive the premium for the customer.

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

Authentication is Mandatory

Can do filter on the fields
e.g: /InsurancePremium?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", "insurance_premium_list":[{ "bank-id":"gh.29.uk", "insurance_premium":{ "insurancePremiumId":"4288afdb-4af9-4732-8106-0e419bf6d172", "name":"James Brown", "number":698761728 } }] }
Required Roles:
  • CanGetDynamicEntity_InsurancePremium - 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_getInsurancePremiumList, operation_id: OBPv4.0.0-dynamicEntity_getInsurancePremiumList Tags: _InsurancePremium, New-Style, Dynamic-Entity, Dynamic,

Get Insurance Premium by id

Get Insurance Premium by id.

Retrive the premium for the customer.

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "insurance_premium":{ "insurancePremiumId":"ae39de2f-da43-449d-a727-30ad7a6835b6", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanGetDynamicEntity_InsurancePremium - 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_getSingleInsurancePremium, operation_id: OBPv4.0.0-dynamicEntity_getSingleInsurancePremium Tags: _InsurancePremium, New-Style, Dynamic-Entity, Dynamic,

Update Insurance Premium

Update Insurance Premium.

Retrive the premium for the customer.

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "insurance_premium":{ "insurancePremiumId":"1bdb7135-463e-4032-81a8-34c5ed686a58", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanUpdateDynamicEntity_InsurancePremium - 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_updateInsurancePremium, operation_id: OBPv4.0.0-dynamicEntity_updateInsurancePremium Tags: _InsurancePremium, New-Style, Dynamic-Entity, Dynamic,

Create new March Hare

Create new March Hare.

Description of this entity, can be markdown text.

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "march_hare":{ "marchHareId":"1d2fb0ae-a66f-47d8-9818-02e9f9d9458b", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanCreateDynamicEntity_MarchHare - 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_createMarchHare, operation_id: OBPv4.0.0-dynamicEntity_createMarchHare Tags: _MarchHare, New-Style, Dynamic-Entity, Dynamic,

Delete March Hare by id

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "march_hare":{ "marchHareId":"f30535dc-6928-4667-bb96-bd436496d68e", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanDeleteDynamicEntity_MarchHare - 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_deleteMarchHare, operation_id: OBPv4.0.0-dynamicEntity_deleteMarchHare Tags: _MarchHare, New-Style, Dynamic-Entity, Dynamic,

Get March Hare List

Get March Hare List.

Description of this entity, can be markdown text.

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

Authentication is Mandatory

Can do filter on the fields
e.g: /MarchHare?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", "march_hare_list":[{ "bank-id":"gh.29.uk", "march_hare":{ "marchHareId":"68082d4b-c3bc-4bf3-87ea-146d4c250dce", "name":"James Brown", "number":698761728 } }] }
Required Roles:
  • CanGetDynamicEntity_MarchHare - 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_getMarchHareList, operation_id: OBPv4.0.0-dynamicEntity_getMarchHareList Tags: _MarchHare, New-Style, Dynamic-Entity, Dynamic,

Get March Hare by id

Get March Hare by id.

Description of this entity, can be markdown text.

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "march_hare":{ "marchHareId":"ec85f596-6322-4a86-a35c-d125de035298", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanGetDynamicEntity_MarchHare - 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_getSingleMarchHare, operation_id: OBPv4.0.0-dynamicEntity_getSingleMarchHare Tags: _MarchHare, New-Style, Dynamic-Entity, Dynamic,

Update March Hare

Update March Hare.

Description of this entity, can be markdown text.

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "march_hare":{ "marchHareId":"120ed163-cf29-49e9-bfc7-9434827f8a2a", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanUpdateDynamicEntity_MarchHare - 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_updateMarchHare, operation_id: OBPv4.0.0-dynamicEntity_updateMarchHare Tags: _MarchHare, New-Style, Dynamic-Entity, Dynamic,

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":"be7cd182-e032-4b36-a3fe-d89690b63f32", "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, operation_id: OBPv4.0.0-dynamicEntity_createObpActivity Tags: _ObpActivity, New-Style, 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":"dec691f6-6a92-42a0-b04b-16c2ff79774c", "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, operation_id: OBPv4.0.0-dynamicEntity_deleteObpActivity Tags: _ObpActivity, New-Style, 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":"1d2287dd-d6a9-4e45-96c7-bc2fdfeaafdc", "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, operation_id: OBPv4.0.0-dynamicEntity_getObpActivityList Tags: _ObpActivity, New-Style, 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":"6a37a8e1-fcbc-45b5-a71e-46c1f5b4fb08", "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, operation_id: OBPv4.0.0-dynamicEntity_getSingleObpActivity Tags: _ObpActivity, New-Style, 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":"68f43cdb-3364-4964-b070-204e3c14b8bf", "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, operation_id: OBPv4.0.0-dynamicEntity_updateObpActivity Tags: _ObpActivity, New-Style, Dynamic-Entity, Dynamic,

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":"2f6d56f6-b0e9-484d-821c-13639979f97e", "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, operation_id: OBPv4.0.0-dynamicEntity_createOdometer Tags: _Odometer, 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":"61b1d557-a8e9-425c-8268-492d5482d6c7", "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, operation_id: OBPv4.0.0-dynamicEntity_deleteOdometer Tags: _Odometer, 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":"8833bfb0-1bdf-47b2-8cf4-cbdda44c434d", "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, operation_id: OBPv4.0.0-dynamicEntity_getOdometerList Tags: _Odometer, 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":"74cdf3f9-3269-4293-ae3f-c113611ed1cb", "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, operation_id: OBPv4.0.0-dynamicEntity_getSingleOdometer Tags: _Odometer, 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":"88136bcf-14b1-4f48-82e6-7cb9028a1260", "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, operation_id: OBPv4.0.0-dynamicEntity_updateOdometer Tags: _Odometer, New-Style, Dynamic-Entity, Dynamic,

Create new Simon Covid

Create new Simon Covid.

Let's put Covid99 stuff here

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "simon_covid":{ "simonCovidId":"4bdf0107-84c1-4cdc-b82b-74dfcb538343", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanCreateDynamicEntity_SimonCovid - 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_createSimonCovid, operation_id: OBPv4.0.0-dynamicEntity_createSimonCovid Tags: _SimonCovid, New-Style, Dynamic-Entity, Dynamic,

Delete Simon Covid by id

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "simon_covid":{ "simonCovidId":"04f0ab44-2695-43b0-a9bd-338fe7836303", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanDeleteDynamicEntity_SimonCovid - 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_deleteSimonCovid, operation_id: OBPv4.0.0-dynamicEntity_deleteSimonCovid Tags: _SimonCovid, New-Style, Dynamic-Entity, Dynamic,

Get Simon Covid List

Get Simon Covid List.

Let's put Covid99 stuff here

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

Authentication is Mandatory

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

								
									
{ "simon_covid_list":[{ "simon_covid":{ "simonCovidId":"d8c2015c-4d40-4e57-89c3-819ae7f743ef", "name":"James Brown", "number":698761728 } }] }
Required Roles:
  • CanGetDynamicEntity_SimonCovid - 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_getSimonCovidList, operation_id: OBPv4.0.0-dynamicEntity_getSimonCovidList Tags: _SimonCovid, New-Style, Dynamic-Entity, Dynamic,

Get Simon Covid by id

Get Simon Covid by id.

Let's put Covid99 stuff here

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "simon_covid":{ "simonCovidId":"638d3708-31ff-4a5b-a3a9-04772346a821", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanGetDynamicEntity_SimonCovid - 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_getSingleSimonCovid, operation_id: OBPv4.0.0-dynamicEntity_getSingleSimonCovid Tags: _SimonCovid, New-Style, Dynamic-Entity, Dynamic,

Update Simon Covid

Update Simon Covid.

Let's put Covid99 stuff here

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "simon_covid":{ "simonCovidId":"f9f8f6cf-4f9c-48ea-a052-615260d3e9f8", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanUpdateDynamicEntity_SimonCovid - 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_updateSimonCovid, operation_id: OBPv4.0.0-dynamicEntity_updateSimonCovid Tags: _SimonCovid, New-Style, Dynamic-Entity, Dynamic,

Create new Sustrans

Create new Sustrans.

Description of this entity, can be markdown text.

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "sustrans":{ "sustransId":"03adbeff-d9eb-4f22-bd6e-baba4e883762", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanCreateDynamicEntity_sustrans - 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_createsustrans, operation_id: OBPv4.0.0-dynamicEntity_createsustrans Tags: _Sustrans, New-Style, Dynamic-Entity, Dynamic,

Delete Sustrans by id

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "sustrans":{ "sustransId":"aff2c3d0-e02b-4633-a1a9-178a91b8074f", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanDeleteDynamicEntity_sustrans - 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_deletesustrans, operation_id: OBPv4.0.0-dynamicEntity_deletesustrans Tags: _Sustrans, New-Style, Dynamic-Entity, Dynamic,

Get Sustrans List

Get Sustrans List.

Description of this entity, can be markdown text.

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

Authentication is Mandatory

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

								
									
{ "sustrans_list":[{ "sustrans":{ "sustransId":"7cd56641-c718-4f2a-96dd-65489277fdc4", "name":"James Brown", "number":698761728 } }] }
Required Roles:
  • CanGetDynamicEntity_sustrans - 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_getsustransList, operation_id: OBPv4.0.0-dynamicEntity_getsustransList Tags: _Sustrans, New-Style, Dynamic-Entity, Dynamic,

Get Sustrans by id

Get Sustrans by id.

Description of this entity, can be markdown text.

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "sustrans":{ "sustransId":"8655bc2a-e3db-4aca-8427-2ec4afa891be", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanGetDynamicEntity_sustrans - 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_getSinglesustrans, operation_id: OBPv4.0.0-dynamicEntity_getSinglesustrans Tags: _Sustrans, New-Style, Dynamic-Entity, Dynamic,

Update Sustrans

Update Sustrans.

Description of this entity, can be markdown text.

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "sustrans":{ "sustransId":"47422960-9297-4b5c-8535-2cb6ac40fdb3", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanUpdateDynamicEntity_sustrans - 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_updatesustrans, operation_id: OBPv4.0.0-dynamicEntity_updatesustrans Tags: _Sustrans, New-Style, Dynamic-Entity, Dynamic,

Create new Test1

Create new Test1.

Description of this entity, can be markdown text.

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "test1":{ "test1Id":"186b9a20-2729-433c-a523-097c3f957cc3", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanCreateDynamicEntity_test1 - 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_createtest1, operation_id: OBPv4.0.0-dynamicEntity_createtest1 Tags: _Test1, New-Style, Dynamic-Entity, Dynamic,

Delete Test1 by id

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "test1":{ "test1Id":"6340f68d-6e33-412d-8725-49261f5e3ff4", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanDeleteDynamicEntity_test1 - 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_deletetest1, operation_id: OBPv4.0.0-dynamicEntity_deletetest1 Tags: _Test1, New-Style, Dynamic-Entity, Dynamic,

Get Test1 List

Get Test1 List.

Description of this entity, can be markdown text.

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

Authentication is Mandatory

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

								
									
{ "test1_list":[{ "test1":{ "test1Id":"c977b1b1-4225-4db3-b06b-b3f221d9cc3d", "name":"James Brown", "number":698761728 } }] }
Required Roles:
  • CanGetDynamicEntity_test1 - 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_gettest1List, operation_id: OBPv4.0.0-dynamicEntity_gettest1List Tags: _Test1, New-Style, Dynamic-Entity, Dynamic,

Get Test1 by id

Get Test1 by id.

Description of this entity, can be markdown text.

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "test1":{ "test1Id":"d5f96ee1-91ff-4ef8-8b46-10f3877f84e6", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanGetDynamicEntity_test1 - 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_getSingletest1, operation_id: OBPv4.0.0-dynamicEntity_getSingletest1 Tags: _Test1, New-Style, Dynamic-Entity, Dynamic,

Update Test1

Update Test1.

Description of this entity, can be markdown text.

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "test1":{ "test1Id":"9e591277-58b2-413c-9284-e7abde3f5141", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanUpdateDynamicEntity_test1 - 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_updatetest1, operation_id: OBPv4.0.0-dynamicEntity_updatetest1 Tags: _Test1, New-Style, Dynamic-Entity, Dynamic,