right logo image
right logo image
Log on
⯆

API Explorer

Log off

v5.1.0 (592 APIs)

API Host: https://obp-apisandbox.joinfincubator.com
Bank
Accounts
Views
Counterparties
Transactions

Create new Hospital

Create new Hospital.

Hospital

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"Hospital"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "hospital":{
    "hospitalId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "maternity_departments":"maternity_departments",
    "labor":"labor",
    "nursery":"nursery",
    "maternal_and_health_awareness":"maternal_and_health_awareness",
    "OB_gyn":"OB_gyn",
    "pediatrician":"pediatrician",
    "nutritions":"nutritions",
    "psychatrichs":"psychatrichs",
    "dermatology":"dermatology",
    "endocrine":"endocrine",
    "doctors":"doctors",
    "yoga_trainers":"yoga_trainers",
    "personal_trainers":"personal_trainers",
    "midwife":"personal_trainers",
    "IBCLC":"personal_trainers",
    "lactation_counselor":"personal_trainers",
    "nurses":"personal_trainers"
  }
}
Required Roles:
  • CanCreateDynamicEntity_Hospital - 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_createHospital_mommy_map, operation_id: OBPv4.0.0-dynamicEntity_createHospital_mommy_map Tags: _Hospital(mommy Map), Dynamic-Entity, Dynamic,

Create new My Hospital

Create new My Hospital.

Hospital

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"Hospital"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "hospital":{
    "hospitalId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "maternity_departments":"maternity_departments",
    "labor":"labor",
    "nursery":"nursery",
    "maternal_and_health_awareness":"maternal_and_health_awareness",
    "OB_gyn":"OB_gyn",
    "pediatrician":"pediatrician",
    "nutritions":"nutritions",
    "psychatrichs":"psychatrichs",
    "dermatology":"dermatology",
    "endocrine":"endocrine",
    "doctors":"doctors",
    "yoga_trainers":"yoga_trainers",
    "personal_trainers":"personal_trainers",
    "midwife":"personal_trainers",
    "IBCLC":"personal_trainers",
    "lactation_counselor":"personal_trainers",
    "nurses":"personal_trainers"
  }
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_createMyHospital_mommy_map, operation_id: OBPv4.0.0-dynamicEntity_createMyHospital_mommy_map Tags: _Hospital(mommy Map), Dynamic-Entity, Dynamic,

Delete Hospital by id

Delete Hospital 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":"Hospital"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "hospital":{
    "hospitalId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "maternity_departments":"maternity_departments",
    "labor":"labor",
    "nursery":"nursery",
    "maternal_and_health_awareness":"maternal_and_health_awareness",
    "OB_gyn":"OB_gyn",
    "pediatrician":"pediatrician",
    "nutritions":"nutritions",
    "psychatrichs":"psychatrichs",
    "dermatology":"dermatology",
    "endocrine":"endocrine",
    "doctors":"doctors",
    "yoga_trainers":"yoga_trainers",
    "personal_trainers":"personal_trainers",
    "midwife":"personal_trainers",
    "IBCLC":"personal_trainers",
    "lactation_counselor":"personal_trainers",
    "nurses":"personal_trainers"
  }
}
Required Roles:
  • CanDeleteDynamicEntity_Hospital - 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_deleteHospital_mommy_map, operation_id: OBPv4.0.0-dynamicEntity_deleteHospital_mommy_map Tags: _Hospital(mommy Map), Dynamic-Entity, Dynamic,

Delete My Hospital by id

Delete My Hospital 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":"Hospital"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "hospital":{
    "hospitalId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "maternity_departments":"maternity_departments",
    "labor":"labor",
    "nursery":"nursery",
    "maternal_and_health_awareness":"maternal_and_health_awareness",
    "OB_gyn":"OB_gyn",
    "pediatrician":"pediatrician",
    "nutritions":"nutritions",
    "psychatrichs":"psychatrichs",
    "dermatology":"dermatology",
    "endocrine":"endocrine",
    "doctors":"doctors",
    "yoga_trainers":"yoga_trainers",
    "personal_trainers":"personal_trainers",
    "midwife":"personal_trainers",
    "IBCLC":"personal_trainers",
    "lactation_counselor":"personal_trainers",
    "nurses":"personal_trainers"
  }
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_deleteMyHospital_mommy_map, operation_id: OBPv4.0.0-dynamicEntity_deleteMyHospital_mommy_map Tags: _Hospital(mommy Map), Dynamic-Entity, Dynamic,

Get Hospital List

Get Hospital List.

Hospital

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"Hospital"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Can do filter on the fields
e.g: /Hospital?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",
  "hospital_list":[{
    "bank-id":"gh.29.uk",
    "hospital":{
      "hospitalId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
      "maternity_departments":"maternity_departments",
      "labor":"labor",
      "nursery":"nursery",
      "maternal_and_health_awareness":"maternal_and_health_awareness",
      "OB_gyn":"OB_gyn",
      "pediatrician":"pediatrician",
      "nutritions":"nutritions",
      "psychatrichs":"psychatrichs",
      "dermatology":"dermatology",
      "endocrine":"endocrine",
      "doctors":"doctors",
      "yoga_trainers":"yoga_trainers",
      "personal_trainers":"personal_trainers",
      "midwife":"personal_trainers",
      "IBCLC":"personal_trainers",
      "lactation_counselor":"personal_trainers",
      "nurses":"personal_trainers"
    }
  }]
}
Required Roles:
  • CanGetDynamicEntity_Hospital - 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_getHospitalList_mommy_map, operation_id: OBPv4.0.0-dynamicEntity_getHospitalList_mommy_map Tags: _Hospital(mommy Map), Dynamic-Entity, Dynamic,

Get Hospital by id

Get Hospital by id.

Hospital

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"Hospital"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "hospital":{
    "hospitalId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "maternity_departments":"maternity_departments",
    "labor":"labor",
    "nursery":"nursery",
    "maternal_and_health_awareness":"maternal_and_health_awareness",
    "OB_gyn":"OB_gyn",
    "pediatrician":"pediatrician",
    "nutritions":"nutritions",
    "psychatrichs":"psychatrichs",
    "dermatology":"dermatology",
    "endocrine":"endocrine",
    "doctors":"doctors",
    "yoga_trainers":"yoga_trainers",
    "personal_trainers":"personal_trainers",
    "midwife":"personal_trainers",
    "IBCLC":"personal_trainers",
    "lactation_counselor":"personal_trainers",
    "nurses":"personal_trainers"
  }
}
Required Roles:
  • CanGetDynamicEntity_Hospital - 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_getSingleHospital_mommy_map, operation_id: OBPv4.0.0-dynamicEntity_getSingleHospital_mommy_map Tags: _Hospital(mommy Map), Dynamic-Entity, Dynamic,

Get My Hospital List

Get My Hospital List.

Hospital

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"Hospital"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Can do filter on the fields
e.g: /Hospital?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",
  "hospital_list":[{
    "bank-id":"gh.29.uk",
    "hospital":{
      "hospitalId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
      "maternity_departments":"maternity_departments",
      "labor":"labor",
      "nursery":"nursery",
      "maternal_and_health_awareness":"maternal_and_health_awareness",
      "OB_gyn":"OB_gyn",
      "pediatrician":"pediatrician",
      "nutritions":"nutritions",
      "psychatrichs":"psychatrichs",
      "dermatology":"dermatology",
      "endocrine":"endocrine",
      "doctors":"doctors",
      "yoga_trainers":"yoga_trainers",
      "personal_trainers":"personal_trainers",
      "midwife":"personal_trainers",
      "IBCLC":"personal_trainers",
      "lactation_counselor":"personal_trainers",
      "nurses":"personal_trainers"
    }
  }]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_getMyHospitalList_mommy_map, operation_id: OBPv4.0.0-dynamicEntity_getMyHospitalList_mommy_map Tags: _Hospital(mommy Map), Dynamic-Entity, Dynamic,

Get My Hospital by id

Get My Hospital by id.

Hospital

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"Hospital"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "hospital":{
    "hospitalId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "maternity_departments":"maternity_departments",
    "labor":"labor",
    "nursery":"nursery",
    "maternal_and_health_awareness":"maternal_and_health_awareness",
    "OB_gyn":"OB_gyn",
    "pediatrician":"pediatrician",
    "nutritions":"nutritions",
    "psychatrichs":"psychatrichs",
    "dermatology":"dermatology",
    "endocrine":"endocrine",
    "doctors":"doctors",
    "yoga_trainers":"yoga_trainers",
    "personal_trainers":"personal_trainers",
    "midwife":"personal_trainers",
    "IBCLC":"personal_trainers",
    "lactation_counselor":"personal_trainers",
    "nurses":"personal_trainers"
  }
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_getSingleMyHospital_mommy_map, operation_id: OBPv4.0.0-dynamicEntity_getSingleMyHospital_mommy_map Tags: _Hospital(mommy Map), Dynamic-Entity, Dynamic,

Update Hospital

Update Hospital.

Hospital

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"Hospital"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "hospital":{
    "hospitalId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "maternity_departments":"maternity_departments",
    "labor":"labor",
    "nursery":"nursery",
    "maternal_and_health_awareness":"maternal_and_health_awareness",
    "OB_gyn":"OB_gyn",
    "pediatrician":"pediatrician",
    "nutritions":"nutritions",
    "psychatrichs":"psychatrichs",
    "dermatology":"dermatology",
    "endocrine":"endocrine",
    "doctors":"doctors",
    "yoga_trainers":"yoga_trainers",
    "personal_trainers":"personal_trainers",
    "midwife":"personal_trainers",
    "IBCLC":"personal_trainers",
    "lactation_counselor":"personal_trainers",
    "nurses":"personal_trainers"
  }
}
Required Roles:
  • CanUpdateDynamicEntity_Hospital - 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_updateHospital_mommy_map, operation_id: OBPv4.0.0-dynamicEntity_updateHospital_mommy_map Tags: _Hospital(mommy Map), Dynamic-Entity, Dynamic,

Update My Hospital

Update My Hospital.

Hospital

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"Hospital"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "hospital":{
    "hospitalId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "maternity_departments":"maternity_departments",
    "labor":"labor",
    "nursery":"nursery",
    "maternal_and_health_awareness":"maternal_and_health_awareness",
    "OB_gyn":"OB_gyn",
    "pediatrician":"pediatrician",
    "nutritions":"nutritions",
    "psychatrichs":"psychatrichs",
    "dermatology":"dermatology",
    "endocrine":"endocrine",
    "doctors":"doctors",
    "yoga_trainers":"yoga_trainers",
    "personal_trainers":"personal_trainers",
    "midwife":"personal_trainers",
    "IBCLC":"personal_trainers",
    "lactation_counselor":"personal_trainers",
    "nurses":"personal_trainers"
  }
}
Required Roles:
  • CanUpdateDynamicEntity_Hospital - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_updateMyHospital_mommy_map, operation_id: OBPv4.0.0-dynamicEntity_updateMyHospital_mommy_map Tags: _Hospital(mommy Map), Dynamic-Entity, Dynamic,