API Explorer

v4.0.0 (397 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":"9f1c6b0c-1877-4c44-9b3e-a81ffb469086", "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:
Implemented in OBPv4.0.0 by dynamicEntity_createCovidAPIDays, operation_id: OBPv4.0.0-dynamicEntity_createCovidAPIDays

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":"440f9643-19ff-4a28-8edc-a2acbe78bc33", "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:
Implemented in OBPv4.0.0 by dynamicEntity_deleteCovidAPIDays, operation_id: OBPv4.0.0-dynamicEntity_deleteCovidAPIDays

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":"80babef3-fbdc-4cbf-94b2-46015eee2e8f", "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:
Implemented in OBPv4.0.0 by dynamicEntity_getCovidAPIDaysList, operation_id: OBPv4.0.0-dynamicEntity_getCovidAPIDaysList

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":"f8bd69f8-c3bd-4bb8-9db5-c2ec9af360e6", "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:
Implemented in OBPv4.0.0 by dynamicEntity_getSingleCovidAPIDays, operation_id: OBPv4.0.0-dynamicEntity_getSingleCovidAPIDays

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":"0170d49c-2514-49c6-8e2a-bdd7c72f40e1", "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:
Implemented in OBPv4.0.0 by dynamicEntity_updateCovidAPIDays, operation_id: OBPv4.0.0-dynamicEntity_updateCovidAPIDays