API Explorer

v4.0.0 (531 APIs)

Bank
Accounts
Views
Counterparties
Transactions

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":"22b3fb5d-39a5-4a24-ae26-785bff2140e4", "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: _Simon Covid, 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":"86f0b5e8-aa66-440e-a80d-710cd905fcc5", "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: _Simon Covid, 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":"dabd624e-b57a-43d5-af81-1dcc6fc74a56", "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: _Simon Covid, 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":"e18688e3-791e-4883-a811-3a3b474fc609", "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: _Simon Covid, 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":"656193c2-198d-4e16-8d51-265f9521d38d", "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: _Simon Covid, New-Style, Dynamic-Entity, Dynamic,