API Explorer

v4.0.0 (329 APIs)

Bank
Accounts
Views
Counterparties
Transactions

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:

								
									
{ "sustransId":"1414b0a3-fd4c-4fe0-bacc-9b9158485e0f", "name":"James Brown", "number":698761728 }
Required Roles:
  • CanCreateDynamicEntity_sustrans - Please login to request this Role
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.
Implemented in OBPv4.0.0 by createsustrans

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:

								
									
{ "sustransId":"74354407-7b64-4c05-8d66-e329f896102b", "name":"James Brown", "number":698761728 }
Required Roles:
  • CanDeleteDynamicEntity_sustrans - Please login to request this Role
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.
Implemented in OBPv4.0.0 by deletesustrans

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":[{ "sustransId":"08eaa69d-418f-46ce-ada1-965e5fa1ef25", "name":"James Brown", "number":698761728 }] }
Required Roles:
  • CanGetDynamicEntity_sustrans - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Implemented in OBPv4.0.0 by getsustransList

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:

								
									
{ "sustransId":"01038fc7-1d71-4cb0-b5af-436113b57ae4", "name":"James Brown", "number":698761728 }
Required Roles:
  • CanGetDynamicEntity_sustrans - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Implemented in OBPv4.0.0 by getSinglesustrans

Update exists Sustrans

Update exists 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:

								
									
{ "sustransId":"4a91f8b3-e0b3-4294-8f0a-be6b2091ad86", "name":"James Brown", "number":698761728 }
Required Roles:
  • CanUpdateDynamicEntity_sustrans - Please login to request this Role
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.
Implemented in OBPv4.0.0 by updatesustrans