API Explorer

v4.0.0 (490 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":"22aa46b6-8f87-41e2-ad6a-ef60899f72d3", "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":"e62b6b47-acb1-44b0-a0c1-736f17f0ba66", "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":"9efff5e9-e65d-4d39-8bd7-140a9fda8dce", "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":"567628c9-6e39-4156-9e49-4881c666abf2", "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":"500cd497-d841-4576-b1d3-b0fd2a91a31d", "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,