API Explorer

v2.0.0 (179 APIs)

Bank
Accounts
Views
Counterparties
Transactions

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":"f5b42979-e577-455e-b320-6f58a08c3948", "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":"7e77cce7-55d0-441e-893d-cc5913ab3f41", "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":"666ce040-8b14-4739-8c70-b64bf0e72983", "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":"2fc3b0b8-cf3c-4561-abfc-41479d5fad77", "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":"6f3fea5d-bdc7-4c70-9441-750f67ae1fb8", "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,