{"swagger":"2.0","info":{"title":"AU Cds Au","description":"Creative Commons Attribution 3.0 Australia (CC BY 3.0 AU)","contact":{"name":"TESOBE GmbH. / Open Bank Project","url":"https://openbankproject.com","email":"contact@tesobe.com"},"version":"v1.0.0"},"host":"apisandbox.openbankproject.com","basePath":"/","schemes":["http","https"],"securityDefinitions":{"directLogin":{"type":"apiKey","description":"https://github.com/OpenBankProject/OBP-API/wiki/Direct-Login","in":"header","name":"Authorization"},"gatewayLogin":{"type":"apiKey","description":"https://github.com/OpenBankProject/OBP-API/wiki/Gateway-Login","in":"header","name":"Authorization"}},"security":[{"directLogin":[],"gatewayLogin":[]}],"paths":{"/cds-au/v1.0.0/banking/accounts":{"get":{"tags":["Banking","Accounts"],"summary":"Get Accounts","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"
Obtain a list of accounts
Authentication is Mandatory
","operationId":"listAccounts","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/cds-au/v1.0.0/banking/accounts/{ACCOUNT_ID}":{"get":{"tags":["Banking","Accounts","Mocked-Data"],"summary":"Get Account Detail","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"NOTE: This endpoint currently only returns example data.
Obtain detailed information on a single account
Authentication is Mandatory
","operationId":"getAccountDetail","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/cds-au/v1.0.0/banking/accounts/{ACCOUNT_ID}/balance":{"get":{"tags":["Banking","Accounts"],"summary":"Get Account Balance","security":[{"directLogin":[],"gatewayLogin":[]}],"description":" Obtain the balance for a single specified account
Authentication is Mandatory
","operationId":"listBalance","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/cds-au/v1.0.0/banking/accounts/{ACCOUNT_ID}/direct-debits":{"get":{"tags":["Banking","Direct Debits","Mocked-Data"],"summary":"Get Direct Debits For Account","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"NOTE: This endpoint currently only returns example data.
Obtain direct debit authorisations for a specific account
Authentication is Mandatory
","operationId":"listDirectDebits","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/cds-au/v1.0.0/banking/accounts/{ACCOUNT_ID}/payments/scheduled":{"get":{"tags":["Banking","Scheduled Payments","Mocked-Data"],"summary":"Get Scheduled Payments for Account","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"NOTE: This endpoint currently only returns example data.
Obtain scheduled, outgoing payments for a specific account
Authentication is Mandatory
","operationId":"listScheduledPayments","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/cds-au/v1.0.0/banking/accounts/{ACCOUNT_ID}/transactions":{"get":{"tags":["Banking","Accounts","Mocked-Data"],"summary":"Get Transactions For Account","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"NOTE: This endpoint currently only returns example data.
Obtain transactions for a specific account.
Some general notes that apply to all end points that retrieve transactions:
Where multiple transactions are returned, transactions should be ordered according to effective date in descending order
As the date and time for a transaction can alter depending on status and transaction type two separate date/times are included in the payload. There are still some scenarios where neither of these time stamps is available. For the purpose of filtering and ordering it is expected that the data holder will use the "effective" date/time which will be defined as:
Posted date/time if available, then
Execution date/time if available, then
A reasonable date/time nominated by the data holder using internal data structures
For transaction amounts it should be assumed that a negative value indicates a reduction of the available balance on the account while a positive value indicates an increase in the available balance on the account
Authentication is Mandatory
","operationId":"getTransactions","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/cds-au/v1.0.0/banking/accounts/{ACCOUNT_ID}/transactions/{TRANSACTION_ID}":{"get":{"tags":["Banking","Accounts","Mocked-Data"],"summary":"Get Transaction Detail","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"NOTE: This endpoint currently only returns example data.
Obtain detailed information on a transaction for a specific account
Authentication is Mandatory
","operationId":"getTransactionDetail","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"TRANSACTION_ID","description":"The transaction id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/cds-au/v1.0.0/banking/accounts/balances":{"get":{"tags":["Banking","Accounts","Mocked-Data"],"summary":"Get Bulk Balances","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"NOTE: This endpoint currently only returns example data.
Obtain balances for multiple, filtered accounts
Authentication is Mandatory
","operationId":"listBalancesBulk","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"post":{"tags":["Banking","Accounts","Mocked-Data"],"summary":"Get Balances For Specific Accounts","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"NOTE: This endpoint currently only returns example data.
Obtain balances for a specified list of accounts
Authentication is Mandatory
","operationId":"listBalancesSpecificAccounts","parameters":[{"in":"body","name":"body","description":"JvalueCaseClass object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/JvalueCaseClass"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/cds-au/v1.0.0/banking/accounts/direct-debits":{"get":{"tags":["Banking","Direct Debits","Mocked-Data"],"summary":"Get Bulk Direct Debits","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"NOTE: This endpoint currently only returns example data.
Obtain direct debit authorisations for multiple, filtered accounts
Authentication is Mandatory
","operationId":"listDirectDebitsBulk","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"post":{"tags":["Banking","Direct Debits","Mocked-Data"],"summary":"Get Direct Debits For Specific Accounts","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"NOTE: This endpoint currently only returns example data.
Obtain direct debit authorisations for a specified list of accounts
Authentication is Mandatory
","operationId":"listDirectDebitsSpecificAccounts","parameters":[{"in":"body","name":"body","description":"JvalueCaseClass object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/JvalueCaseClass"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/cds-au/v1.0.0/banking/payees":{"get":{"tags":["Banking","Payees","Mocked-Data"],"summary":"Get Payees","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"NOTE: This endpoint currently only returns example data.
Obtain a list of pre-registered payees
Authentication is Mandatory
","operationId":"listPayees","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/cds-au/v1.0.0/banking/payees/PAYEE_ID":{"get":{"tags":["Banking","Payees","Mocked-Data"],"summary":"Get Payee Detail","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"NOTE: This endpoint currently only returns example data.
Obtain detailed information on a single payee
Authentication is Mandatory
","operationId":"getPayeeDetail","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/cds-au/v1.0.0/banking/payments/scheduled":{"get":{"tags":["Banking","Scheduled Payments","Mocked-Data"],"summary":"Get Scheduled Payments Bulk","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"NOTE: This endpoint currently only returns example data.
Obtain scheduled payments for multiple, filtered accounts that are the source of funds for the payments
Authentication is Mandatory
","operationId":"listScheduledPaymentsBulk","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"post":{"tags":["Banking","Scheduled Payments","Mocked-Data"],"summary":"Get Scheduled Payments For Specific Accounts","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"NOTE: This endpoint currently only returns example data.
Obtain scheduled payments for a specified list of accounts
Authentication is Mandatory
","operationId":"listScheduledPaymentsSpecificAccounts","parameters":[{"in":"body","name":"body","description":"JvalueCaseClass object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/JvalueCaseClass"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/cds-au/v1.0.0/banking/products":{"get":{"tags":["Banking","Products","Mocked-Data"],"summary":"Get Products","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"NOTE: This endpoint currently only returns example data.
Obtain a list of products that are currently openly offered to the market
Note that the results returned by this end point are expected to be ordered according to updated-since
In the product reference payloads there are a number of recurring conventions that are explained here, in one place.
In the product detail payload there are a number of arrays articulating generic features, constraints, prices, etc. The intent of these arrays is as follows:
Each element in an array has the same structure so that clients can reliably interpret the payloads
Each element as a type element that is an enumeration of the specific aspect of a product being described, such as types of fees.
Each element has a field name [additionalValue](#productfeaturetypedoc). This is a generic field with contents that will vary based on the type of object being described. The contents of this field for the ADDITIONAL_CARDS feature is the number of cards allowed while the contents of this field for the MAX_LIMIT constraint would be the maximum credit limit allowed for the product.
An element in these arrays of the same type may appear more than once. For instance, a product may offer two separate loyalty programs that the customer can select from. A fixed term mortgage may have different rates for different term lengths.
An element in these arrays may contain an additionalInfo and additionalInfoUri field. The additionalInfo field is used to provide displayable text clarifying the purpose of the element in some way when the product is presented to a customer. The additionalInfoUri provides a link to externally hosted information specifically relevant to that feature of the product.
Depending on the type of data being represented there may be additional specific fields.
As the complexities and nuances of a financial product can not easily be fully expressed in a data structure without a high degree of complexity it is necessary to provide additional reference information that a potential customer can access so that they are fully informed of the features and implications of the product. The payloads for product reference therefore contain numerous fields that are provided to allow the product holder to describe the product more fully using a web page hosted on their online channels.
These URIs do not need to all link to different pages. If desired, they can all link to a single hosted page and use difference HTML anchors to focus on a specific topic such as eligibility or fees.
From the moment that a customer applies for a product and an account is created the account and the product that spawned it will diverge. Rates and features of the product may change and a discount may be negotiated for the account.
For this reason, while productCategory is a common field between accounts and products, there is no specific ID that can be used to link an account to a product within the regime.
Similarly, many of the fields and objects in the product payload will appear in the account detail payload but the structures and semantics are not identical as one refers to a product that can potentially be originated and one refers to an account that actual has been instantiated and created along with the associated decisions inherent in that process.
It is expected that data consumers needing this data will call relatively frequently to ensure the data they have is representative of the current offering from a bank. To minimise the volume and frequency of these calls the ability to set a lastUpdated field with the date and time of the last update to this product is included. A call for a list of products can then be filtered to only return products that have been updated since the last time that data was obtained using the updated-since query parameter.
In addition, the concept of effective date and time has also been included. This allows for a product to be marked for obsolescence, or introduction, from a certain time without the need for an update to show that a product has been changed. The inclusion of these dates also removes the need to represent deleted products in the payload. Products that are no long offered can be marked not effective for a few weeks before they are then removed from the product set as an option entirely.
Authentication is Mandatory
","operationId":"listProducts","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/cds-au/v1.0.0/banking/products/PRODUCT_ID":{"get":{"tags":["Banking","Products","Mocked-Data"],"summary":"Get Product Detail","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"NOTE: This endpoint currently only returns example data.
Obtain detailed information on a single product offered openly to the market
Authentication is Mandatory
","operationId":"getProductDetail","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/cds-au/v1.0.0/common/customer":{"get":{"tags":["Common","Customer","Mocked-Data"],"summary":"Get Customer","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"NOTE: This endpoint currently only returns example data.
Obtain basic information on the customer that has authorised the current session
Authentication is Mandatory
","operationId":"getCustomer","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/cds-au/v1.0.0/common/customer/detail":{"get":{"tags":["Common","Customer","Mocked-Data"],"summary":"Get Customer Detail","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"NOTE: This endpoint currently only returns example data.
Obtain detailed information on the authorised customer within the current session.
Authentication is Mandatory
","operationId":"getCustomerDetail","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/cds-au/v1.0.0/discovery/outages":{"get":{"tags":["Common","Discovery","Mocked-Data"],"summary":"Get Outages","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"NOTE: This endpoint currently only returns example data.
Obtain a list of scheduled outages for the implementation
Authentication is Mandatory
","operationId":"getOutages","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/cds-au/v1.0.0/discovery/status":{"get":{"tags":["Common","Discovery","Mocked-Data"],"summary":"Get Status","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"NOTE: This endpoint currently only returns example data.
Obtain a health check status for the implementation
Authentication is Mandatory
","operationId":"getStatus","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/CovidAPIDays":{"get":{"tags":["_Covid APIDays","Dynamic-Entity","Dynamic"],"summary":"Get Covid APIDays List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Covid APIDays List.
Description of this entity, can be markdown text.
Property List:
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)
Create new Covid APIDays.
Description of this entity, can be markdown text.
Property List:
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
","operationId":"dynamicEntity_createCovidAPIDays_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"covid_api_days":{"type":"object","properties":{"covidAPIDaysId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["covidAPIDaysId","name","number"]}},"required":["covid_api_days"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/CovidAPIDays/COVID_API_DAYS_ID":{"delete":{"tags":["_Covid APIDays","Dynamic-Entity","Dynamic"],"summary":"Delete Covid APIDays by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"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
","operationId":"dynamicEntity_deleteCovidAPIDays_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"204":{"description":"Success","schema":{"type":"object","properties":{"covid_api_days":{"type":"object","properties":{"covidAPIDaysId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["covidAPIDaysId","name","number"]}},"required":["covid_api_days"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"get":{"tags":["_Covid APIDays","Dynamic-Entity","Dynamic"],"summary":"Get Covid APIDays by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Covid APIDays by id.
Description of this entity, can be markdown text.
Property List:
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
","operationId":"dynamicEntity_getSingleCovidAPIDays_","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"covid_api_days":{"type":"object","properties":{"covidAPIDaysId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["covidAPIDaysId","name","number"]}},"required":["covid_api_days"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"put":{"tags":["_Covid APIDays","Dynamic-Entity","Dynamic"],"summary":"Update Covid APIDays","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update Covid APIDays.
Description of this entity, can be markdown text.
Property List:
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
","operationId":"dynamicEntity_updateCovidAPIDays_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"covid_api_days":{"type":"object","properties":{"covidAPIDaysId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["covidAPIDaysId","name","number"]}},"required":["covid_api_days"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/FishPort":{"get":{"tags":["_Fish Port","Dynamic-Entity","Dynamic"],"summary":"Get Fish Port List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Fish Port List.
Portfolio of fishbased values
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"FishPort" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
Can do filter on the fields
e.g: /FishPort?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)
Create new Fish Port.
Portfolio of fishbased values
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"FishPort" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_createFishPort_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"fish":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"6987233228"}},"required":["fish","number"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"fish_port":{"type":"object","properties":{"fishPortId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"fish":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"6987233228"}},"required":["fishPortId","fish","number"]}},"required":["fish_port"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/FishPort/FISH_PORT_ID":{"delete":{"tags":["_Fish Port","Dynamic-Entity","Dynamic"],"summary":"Delete Fish Port by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete Fish Port 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":"FishPort" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_deleteFishPort_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"fish":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"6987233228"}},"required":["fish","number"]}}],"responses":{"204":{"description":"Success","schema":{"type":"object","properties":{"fish_port":{"type":"object","properties":{"fishPortId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"fish":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"6987233228"}},"required":["fishPortId","fish","number"]}},"required":["fish_port"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"get":{"tags":["_Fish Port","Dynamic-Entity","Dynamic"],"summary":"Get Fish Port by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Fish Port by id.
Portfolio of fishbased values
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"FishPort" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_getSingleFishPort_","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"fish_port":{"type":"object","properties":{"fishPortId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"fish":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"6987233228"}},"required":["fishPortId","fish","number"]}},"required":["fish_port"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"put":{"tags":["_Fish Port","Dynamic-Entity","Dynamic"],"summary":"Update Fish Port","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update Fish Port.
Portfolio of fishbased values
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"FishPort" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_updateFishPort_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"fish":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"6987233228"}},"required":["fish","number"]}}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"fish_port":{"type":"object","properties":{"fishPortId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"fish":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"6987233228"}},"required":["fishPortId","fish","number"]}},"required":["fish_port"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/FooBar":{"get":{"tags":["_Foo Bar","Dynamic-Entity","Dynamic"],"summary":"Get Foo Bar List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Foo Bar List.
Description of this entity, can be markdown text.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"FooBar" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
Can do filter on the fields
e.g: /FooBar?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)
Create new Foo Bar.
Description of this entity, can be markdown text.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"FooBar" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_createFooBar_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"foo_bar":{"type":"object","properties":{"fooBarId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["fooBarId","name","number"]}},"required":["foo_bar"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/FooBar/FOO_BAR_ID":{"delete":{"tags":["_Foo Bar","Dynamic-Entity","Dynamic"],"summary":"Delete Foo Bar by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete Foo Bar 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":"FooBar" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_deleteFooBar_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"204":{"description":"Success","schema":{"type":"object","properties":{"foo_bar":{"type":"object","properties":{"fooBarId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["fooBarId","name","number"]}},"required":["foo_bar"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"get":{"tags":["_Foo Bar","Dynamic-Entity","Dynamic"],"summary":"Get Foo Bar by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Foo Bar by id.
Description of this entity, can be markdown text.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"FooBar" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_getSingleFooBar_","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"foo_bar":{"type":"object","properties":{"fooBarId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["fooBarId","name","number"]}},"required":["foo_bar"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"put":{"tags":["_Foo Bar","Dynamic-Entity","Dynamic"],"summary":"Update Foo Bar","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update Foo Bar.
Description of this entity, can be markdown text.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"FooBar" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_updateFooBar_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"foo_bar":{"type":"object","properties":{"fooBarId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["fooBarId","name","number"]}},"required":["foo_bar"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/SimonCovid":{"get":{"tags":["_Simon Covid","Dynamic-Entity","Dynamic"],"summary":"Get Simon Covid List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Simon Covid List.
Let's put Covid99 stuff here
Property List:
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)
Create new Simon Covid.
Let's put Covid99 stuff here
Property List:
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
","operationId":"dynamicEntity_createSimonCovid_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"simon_covid":{"type":"object","properties":{"simonCovidId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["simonCovidId","name","number"]}},"required":["simon_covid"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/SimonCovid/SIMON_COVID_ID":{"delete":{"tags":["_Simon Covid","Dynamic-Entity","Dynamic"],"summary":"Delete Simon Covid by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"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
","operationId":"dynamicEntity_deleteSimonCovid_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"204":{"description":"Success","schema":{"type":"object","properties":{"simon_covid":{"type":"object","properties":{"simonCovidId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["simonCovidId","name","number"]}},"required":["simon_covid"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"get":{"tags":["_Simon Covid","Dynamic-Entity","Dynamic"],"summary":"Get Simon Covid by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Simon Covid by id.
Let's put Covid99 stuff here
Property List:
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
","operationId":"dynamicEntity_getSingleSimonCovid_","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"simon_covid":{"type":"object","properties":{"simonCovidId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["simonCovidId","name","number"]}},"required":["simon_covid"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"put":{"tags":["_Simon Covid","Dynamic-Entity","Dynamic"],"summary":"Update Simon Covid","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update Simon Covid.
Let's put Covid99 stuff here
Property List:
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
","operationId":"dynamicEntity_updateSimonCovid_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"simon_covid":{"type":"object","properties":{"simonCovidId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["simonCovidId","name","number"]}},"required":["simon_covid"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/banks/gh.29.uk/D-Entity1":{"get":{"tags":["_D Entity1(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Get D Entity1 List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get D Entity1 List.
Description of this entity, can be markdown text.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"D-Entity1" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
Can do filter on the fields
e.g: /D-Entity1?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)
Create new D Entity1.
Description of this entity, can be markdown text.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"D-Entity1" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_createD-Entity1_gh.29.uk","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"d-entity1":{"type":"object","properties":{"d-Entity1Id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["d-Entity1Id","name","number"]}},"required":["bank-id","d-entity1"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/banks/gh.29.uk/D-Entity1/D-ENTITY1_ID":{"delete":{"tags":["_D Entity1(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Delete D Entity1 by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete D Entity1 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":"D-Entity1" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_deleteD-Entity1_gh.29.uk","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"204":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"d-entity1":{"type":"object","properties":{"d-Entity1Id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["d-Entity1Id","name","number"]}},"required":["bank-id","d-entity1"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"get":{"tags":["_D Entity1(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Get D Entity1 by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get D Entity1 by id.
Description of this entity, can be markdown text.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"D-Entity1" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_getSingleD-Entity1_gh.29.uk","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"d-entity1":{"type":"object","properties":{"d-Entity1Id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["d-Entity1Id","name","number"]}},"required":["bank-id","d-entity1"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"put":{"tags":["_D Entity1(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Update D Entity1","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update D Entity1.
Description of this entity, can be markdown text.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"D-Entity1" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_updateD-Entity1_gh.29.uk","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"d-entity1":{"type":"object","properties":{"d-Entity1Id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["d-Entity1Id","name","number"]}},"required":["bank-id","d-entity1"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/banks/gh.29.uk/InsurancePolicy":{"get":{"tags":["_Insurance Policy(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Get Insurance Policy List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Insurance Policy List.
Which insurance policies the customer already has.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"InsurancePolicy" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
Can do filter on the fields
e.g: /InsurancePolicy?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)
Create new Insurance Policy.
Which insurance policies the customer already has.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"InsurancePolicy" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_createInsurancePolicy_gh.29.uk","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"insurance_policy":{"type":"object","properties":{"insurancePolicyId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["insurancePolicyId","name","number"]}},"required":["bank-id","insurance_policy"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/banks/gh.29.uk/InsurancePolicy/INSURANCE_POLICY_ID":{"delete":{"tags":["_Insurance Policy(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Delete Insurance Policy by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete Insurance Policy 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":"InsurancePolicy" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_deleteInsurancePolicy_gh.29.uk","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"204":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"insurance_policy":{"type":"object","properties":{"insurancePolicyId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["insurancePolicyId","name","number"]}},"required":["bank-id","insurance_policy"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"get":{"tags":["_Insurance Policy(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Get Insurance Policy by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Insurance Policy by id.
Which insurance policies the customer already has.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"InsurancePolicy" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_getSingleInsurancePolicy_gh.29.uk","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"insurance_policy":{"type":"object","properties":{"insurancePolicyId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["insurancePolicyId","name","number"]}},"required":["bank-id","insurance_policy"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"put":{"tags":["_Insurance Policy(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Update Insurance Policy","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update Insurance Policy.
Which insurance policies the customer already has.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"InsurancePolicy" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_updateInsurancePolicy_gh.29.uk","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"insurance_policy":{"type":"object","properties":{"insurancePolicyId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["insurancePolicyId","name","number"]}},"required":["bank-id","insurance_policy"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/banks/gh.29.uk/InsurancePremium":{"get":{"tags":["_Insurance Premium(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Get Insurance Premium List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Insurance Premium List.
Retrive the premium for the customer.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"InsurancePremium" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
Can do filter on the fields
e.g: /InsurancePremium?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)
Create new Insurance Premium.
Retrive the premium for the customer.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"InsurancePremium" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_createInsurancePremium_gh.29.uk","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"insurance_premium":{"type":"object","properties":{"insurancePremiumId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["insurancePremiumId","name","number"]}},"required":["bank-id","insurance_premium"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/banks/gh.29.uk/InsurancePremium/INSURANCE_PREMIUM_ID":{"delete":{"tags":["_Insurance Premium(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Delete Insurance Premium by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete Insurance Premium 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":"InsurancePremium" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_deleteInsurancePremium_gh.29.uk","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"204":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"insurance_premium":{"type":"object","properties":{"insurancePremiumId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["insurancePremiumId","name","number"]}},"required":["bank-id","insurance_premium"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"get":{"tags":["_Insurance Premium(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Get Insurance Premium by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Insurance Premium by id.
Retrive the premium for the customer.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"InsurancePremium" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_getSingleInsurancePremium_gh.29.uk","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"insurance_premium":{"type":"object","properties":{"insurancePremiumId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["insurancePremiumId","name","number"]}},"required":["bank-id","insurance_premium"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"put":{"tags":["_Insurance Premium(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Update Insurance Premium","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update Insurance Premium.
Retrive the premium for the customer.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"InsurancePremium" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_updateInsurancePremium_gh.29.uk","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"insurance_premium":{"type":"object","properties":{"insurancePremiumId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["insurancePremiumId","name","number"]}},"required":["bank-id","insurance_premium"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/banks/gh.29.uk/MarchHare":{"get":{"tags":["_March Hare(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Get March Hare List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get March Hare List.
Description of this entity, can be markdown text.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"MarchHare" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
Can do filter on the fields
e.g: /MarchHare?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)
Create new March Hare.
Description of this entity, can be markdown text.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"MarchHare" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_createMarchHare_gh.29.uk","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"march_hare":{"type":"object","properties":{"marchHareId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["marchHareId","name","number"]}},"required":["bank-id","march_hare"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/banks/gh.29.uk/MarchHare/MARCH_HARE_ID":{"delete":{"tags":["_March Hare(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Delete March Hare by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete March Hare 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":"MarchHare" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_deleteMarchHare_gh.29.uk","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"204":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"march_hare":{"type":"object","properties":{"marchHareId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["marchHareId","name","number"]}},"required":["bank-id","march_hare"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"get":{"tags":["_March Hare(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Get March Hare by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get March Hare by id.
Description of this entity, can be markdown text.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"MarchHare" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_getSingleMarchHare_gh.29.uk","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"march_hare":{"type":"object","properties":{"marchHareId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["marchHareId","name","number"]}},"required":["bank-id","march_hare"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"put":{"tags":["_March Hare(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Update March Hare","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update March Hare.
Description of this entity, can be markdown text.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"MarchHare" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_updateMarchHare_gh.29.uk","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"march_hare":{"type":"object","properties":{"marchHareId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["marchHareId","name","number"]}},"required":["bank-id","march_hare"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/banks/gh.29.uk/Odometer":{"get":{"tags":["_Odometer(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Get Odometer List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Odometer List.
Verify odometer information for flexible contracts.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"Odometer" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
Can do filter on the fields
e.g: /Odometer?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)
Create new Odometer.
Verify odometer information for flexible contracts.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"Odometer" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_createOdometer_gh.29.uk","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"odometer":{"type":"object","properties":{"odometerId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["odometerId","name","number"]}},"required":["bank-id","odometer"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/banks/gh.29.uk/Odometer/ODOMETER_ID":{"delete":{"tags":["_Odometer(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Delete Odometer by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete Odometer 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":"Odometer" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_deleteOdometer_gh.29.uk","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"204":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"odometer":{"type":"object","properties":{"odometerId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["odometerId","name","number"]}},"required":["bank-id","odometer"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"get":{"tags":["_Odometer(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Get Odometer by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Odometer by id.
Verify odometer information for flexible contracts.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"Odometer" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_getSingleOdometer_gh.29.uk","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"odometer":{"type":"object","properties":{"odometerId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["odometerId","name","number"]}},"required":["bank-id","odometer"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"put":{"tags":["_Odometer(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Update Odometer","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update Odometer.
Verify odometer information for flexible contracts.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"Odometer" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_updateOdometer_gh.29.uk","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"odometer":{"type":"object","properties":{"odometerId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["odometerId","name","number"]}},"required":["bank-id","odometer"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/banks/obp.testing.01/ObpActivity":{"get":{"tags":["_Obp Activity(obp.testing.01)","Dynamic-Entity","Dynamic"],"summary":"Get Obp Activity List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Obp Activity List.
Description of this entity, can be markdown text.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"ObpActivity" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
Can do filter on the fields
e.g: /ObpActivity?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)
Create new Obp Activity.
Description of this entity, can be markdown text.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"ObpActivity" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_createObpActivity_obp.testing.01","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"username":{"type":"string","example":"James Brown"},"created_date":{"type":"string","example":"698761728"}},"required":["name","username","created_date"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"obp_activity":{"type":"object","properties":{"obpActivityId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"username":{"type":"string","example":"James Brown"},"created_date":{"type":"string","example":"698761728"}},"required":["obpActivityId","name","username","created_date"]}},"required":["bank-id","obp_activity"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/banks/obp.testing.01/ObpActivity/OBP_ACTIVITY_ID":{"delete":{"tags":["_Obp Activity(obp.testing.01)","Dynamic-Entity","Dynamic"],"summary":"Delete Obp Activity by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete Obp Activity 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":"ObpActivity" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_deleteObpActivity_obp.testing.01","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"username":{"type":"string","example":"James Brown"},"created_date":{"type":"string","example":"698761728"}},"required":["name","username","created_date"]}}],"responses":{"204":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"obp_activity":{"type":"object","properties":{"obpActivityId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"username":{"type":"string","example":"James Brown"},"created_date":{"type":"string","example":"698761728"}},"required":["obpActivityId","name","username","created_date"]}},"required":["bank-id","obp_activity"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"get":{"tags":["_Obp Activity(obp.testing.01)","Dynamic-Entity","Dynamic"],"summary":"Get Obp Activity by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Obp Activity by id.
Description of this entity, can be markdown text.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"ObpActivity" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_getSingleObpActivity_obp.testing.01","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"obp_activity":{"type":"object","properties":{"obpActivityId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"username":{"type":"string","example":"James Brown"},"created_date":{"type":"string","example":"698761728"}},"required":["obpActivityId","name","username","created_date"]}},"required":["bank-id","obp_activity"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"put":{"tags":["_Obp Activity(obp.testing.01)","Dynamic-Entity","Dynamic"],"summary":"Update Obp Activity","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update Obp Activity.
Description of this entity, can be markdown text.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"ObpActivity" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_updateObpActivity_obp.testing.01","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"username":{"type":"string","example":"James Brown"},"created_date":{"type":"string","example":"698761728"}},"required":["name","username","created_date"]}}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"obp_activity":{"type":"object","properties":{"obpActivityId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"username":{"type":"string","example":"James Brown"},"created_date":{"type":"string","example":"698761728"}},"required":["obpActivityId","name","username","created_date"]}},"required":["bank-id","obp_activity"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/customer_cars":{"get":{"tags":["_Customer Cars","Dynamic-Entity","Dynamic"],"summary":"Get Customer Cars List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Customer Cars List.
The car the customer arrived in
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"customer_cars" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
Can do filter on the fields
e.g: /customer_cars?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)
Create new Customer Cars.
The car the customer arrived in
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"customer_cars" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_createcustomer_cars_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"customer_identifier":{"type":"string","example":"bc37e0fb-b75b-48d3-8fe9-c94ff064aa9a"},"manufacturer":{"type":"string","example":"BMW"}},"required":["customer_identifier","manufacturer"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"customer_cars":{"type":"object","properties":{"customer_carsId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_identifier":{"type":"string","example":"bc37e0fb-b75b-48d3-8fe9-c94ff064aa9a"},"manufacturer":{"type":"string","example":"BMW"}},"required":["customer_carsId","customer_identifier","manufacturer"]}},"required":["customer_cars"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/customer_cars/CUSTOMER_CARS_ID":{"delete":{"tags":["_Customer Cars","Dynamic-Entity","Dynamic"],"summary":"Delete Customer Cars by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete Customer Cars 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":"customer_cars" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_deletecustomer_cars_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"customer_identifier":{"type":"string","example":"bc37e0fb-b75b-48d3-8fe9-c94ff064aa9a"},"manufacturer":{"type":"string","example":"BMW"}},"required":["customer_identifier","manufacturer"]}}],"responses":{"204":{"description":"Success","schema":{"type":"object","properties":{"customer_cars":{"type":"object","properties":{"customer_carsId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_identifier":{"type":"string","example":"bc37e0fb-b75b-48d3-8fe9-c94ff064aa9a"},"manufacturer":{"type":"string","example":"BMW"}},"required":["customer_carsId","customer_identifier","manufacturer"]}},"required":["customer_cars"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"get":{"tags":["_Customer Cars","Dynamic-Entity","Dynamic"],"summary":"Get Customer Cars by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Customer Cars by id.
The car the customer arrived in
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"customer_cars" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_getSinglecustomer_cars_","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"customer_cars":{"type":"object","properties":{"customer_carsId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_identifier":{"type":"string","example":"bc37e0fb-b75b-48d3-8fe9-c94ff064aa9a"},"manufacturer":{"type":"string","example":"BMW"}},"required":["customer_carsId","customer_identifier","manufacturer"]}},"required":["customer_cars"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"put":{"tags":["_Customer Cars","Dynamic-Entity","Dynamic"],"summary":"Update Customer Cars","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update Customer Cars.
The car the customer arrived in
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"customer_cars" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_updatecustomer_cars_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"customer_identifier":{"type":"string","example":"bc37e0fb-b75b-48d3-8fe9-c94ff064aa9a"},"manufacturer":{"type":"string","example":"BMW"}},"required":["customer_identifier","manufacturer"]}}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"customer_cars":{"type":"object","properties":{"customer_carsId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_identifier":{"type":"string","example":"bc37e0fb-b75b-48d3-8fe9-c94ff064aa9a"},"manufacturer":{"type":"string","example":"BMW"}},"required":["customer_carsId","customer_identifier","manufacturer"]}},"required":["customer_cars"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/my/test_daniel707":{"get":{"tags":["_Test Daniel707","Dynamic-Entity","Dynamic"],"summary":"Get My Test Daniel707 List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get My Test Daniel707 List.
Description of this entity, can be markdown text.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"test_daniel707" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
Can do filter on the fields
e.g: /test_daniel707?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)
Create new My Test Daniel707.
Description of this entity, can be markdown text.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"test_daniel707" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_createMytest_daniel707_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"test_daniel707":{"type":"object","properties":{"test_daniel707Id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["test_daniel707Id","name","number"]}},"required":["test_daniel707"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/my/test_daniel707/TEST_DANIEL707_ID":{"delete":{"tags":["_Test Daniel707","Dynamic-Entity","Dynamic"],"summary":"Delete My Test Daniel707 by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete My Test Daniel707 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":"test_daniel707" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_deleteMytest_daniel707_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"204":{"description":"Success","schema":{"type":"object","properties":{"test_daniel707":{"type":"object","properties":{"test_daniel707Id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["test_daniel707Id","name","number"]}},"required":["test_daniel707"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"get":{"tags":["_Test Daniel707","Dynamic-Entity","Dynamic"],"summary":"Get My Test Daniel707 by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get My Test Daniel707 by id.
Description of this entity, can be markdown text.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"test_daniel707" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_getSingleMytest_daniel707_","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"test_daniel707":{"type":"object","properties":{"test_daniel707Id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["test_daniel707Id","name","number"]}},"required":["test_daniel707"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"put":{"tags":["_Test Daniel707","Dynamic-Entity","Dynamic"],"summary":"Update My Test Daniel707","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update My Test Daniel707.
Description of this entity, can be markdown text.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"test_daniel707" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_updateMytest_daniel707_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"test_daniel707":{"type":"object","properties":{"test_daniel707Id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["test_daniel707Id","name","number"]}},"required":["test_daniel707"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/dynamic-endpoint/accounts":{"post":{"tags":["Bank Accounts (Dynamic Endpoint)","Dynamic-Endpoint","Dynamic"],"summary":"Post Accounts","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"POST Accounts
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEndpointProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"url_pattern", "value":"http://obp_mock//accounts" }, { "key":"http_method", "value":"POST" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEndpoint_POST_accounts","parameters":[],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"name":{"type":"string","example":"family account"},"balance":{"type":"integer","format":"int32","example":"1"}},"required":["name","balance"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/dynamic-endpoint/accounts/{ACCOUNT_ID}":{"get":{"tags":["Bank Accounts (Dynamic Endpoint)","Dynamic-Endpoint","Dynamic"],"summary":"Get Bank Account By Id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Bank Account
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEndpointProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"url_pattern", "value":"http://obp_mock//accounts/{account_id}" }, { "key":"http_method", "value":"GET" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEndpoint_GET_accounts_ACCOUNT_ID","parameters":[{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"name":{"type":"string","example":"family account"},"balance":{"type":"integer","format":"int32","example":"1"}},"required":["name","balance"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/sustrans":{"get":{"tags":["_Sustrans","Dynamic-Entity","Dynamic"],"summary":"Get Sustrans List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Sustrans List.
Description of this entity, can be markdown text.
Property List:
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)
Create new Sustrans.
Description of this entity, can be markdown text.
Property List:
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
","operationId":"dynamicEntity_createsustrans_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"sustrans":{"type":"object","properties":{"sustransId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["sustransId","name","number"]}},"required":["sustrans"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/sustrans/SUSTRANS_ID":{"delete":{"tags":["_Sustrans","Dynamic-Entity","Dynamic"],"summary":"Delete Sustrans by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"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
","operationId":"dynamicEntity_deletesustrans_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"204":{"description":"Success","schema":{"type":"object","properties":{"sustrans":{"type":"object","properties":{"sustransId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["sustransId","name","number"]}},"required":["sustrans"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"get":{"tags":["_Sustrans","Dynamic-Entity","Dynamic"],"summary":"Get Sustrans by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Sustrans by id.
Description of this entity, can be markdown text.
Property List:
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
","operationId":"dynamicEntity_getSinglesustrans_","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"sustrans":{"type":"object","properties":{"sustransId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["sustransId","name","number"]}},"required":["sustrans"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"put":{"tags":["_Sustrans","Dynamic-Entity","Dynamic"],"summary":"Update Sustrans","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update Sustrans.
Description of this entity, can be markdown text.
Property List:
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
","operationId":"dynamicEntity_updatesustrans_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"sustrans":{"type":"object","properties":{"sustransId":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["sustransId","name","number"]}},"required":["sustrans"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/test-dynamic-resource-doc/my_user/MY_USER_ID":{"post":{"tags":["Dynamic-Resource-Doc"],"summary":"A test endpoint","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"A test endpoint.
Just for debug method body of dynamic resource doc.
better watch the following introduction video first
* Dynamic resourceDoc version1
The endpoint return the response from PractiseEndpoint code.
Here, code.api.DynamicEndpoints.dynamic.practise.PractiseEndpoint.process
You can test the method body grammar, and try the business logic, but need to restart the OBP-API code .
Authentication is Optional
","operationId":"test-dynamic-resource-doc","parameters":[{"in":"body","name":"body","description":"RequestRootJsonClass object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/RequestRootJsonClass"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/RequestRootJsonClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}},"/test1":{"get":{"tags":["_Test1","Dynamic-Entity","Dynamic"],"summary":"Get Test1 List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Test1 List.
Description of this entity, can be markdown text.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"test1" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
Can do filter on the fields
e.g: /test1?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)
Create new Test1.
Description of this entity, can be markdown text.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"test1" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_createtest1_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"test1":{"type":"object","properties":{"test1Id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["test1Id","name","number"]}},"required":["test1"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/test1/TEST1_ID":{"delete":{"tags":["_Test1","Dynamic-Entity","Dynamic"],"summary":"Delete Test1 by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete Test1 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":"test1" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_deletetest1_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"204":{"description":"Success","schema":{"type":"object","properties":{"test1":{"type":"object","properties":{"test1Id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["test1Id","name","number"]}},"required":["test1"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"get":{"tags":["_Test1","Dynamic-Entity","Dynamic"],"summary":"Get Test1 by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Test1 by id.
Description of this entity, can be markdown text.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"test1" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_getSingletest1_","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"test1":{"type":"object","properties":{"test1Id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["test1Id","name","number"]}},"required":["test1"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"put":{"tags":["_Test1","Dynamic-Entity","Dynamic"],"summary":"Update Test1","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update Test1.
Description of this entity, can be markdown text.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"test1" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_updatetest1_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"test1":{"type":"object","properties":{"test1Id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["test1Id","name","number"]}},"required":["test1"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/test_daniel707":{"get":{"tags":["_Test Daniel707","Dynamic-Entity","Dynamic"],"summary":"Get Test Daniel707 List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Test Daniel707 List.
Description of this entity, can be markdown text.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"test_daniel707" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
Can do filter on the fields
e.g: /test_daniel707?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)
Create new Test Daniel707.
Description of this entity, can be markdown text.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"test_daniel707" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_createtest_daniel707_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"test_daniel707":{"type":"object","properties":{"test_daniel707Id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["test_daniel707Id","name","number"]}},"required":["test_daniel707"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/test_daniel707/TEST_DANIEL707_ID":{"delete":{"tags":["_Test Daniel707","Dynamic-Entity","Dynamic"],"summary":"Delete Test Daniel707 by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete Test Daniel707 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":"test_daniel707" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_deletetest_daniel707_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"204":{"description":"Success","schema":{"type":"object","properties":{"test_daniel707":{"type":"object","properties":{"test_daniel707Id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["test_daniel707Id","name","number"]}},"required":["test_daniel707"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"get":{"tags":["_Test Daniel707","Dynamic-Entity","Dynamic"],"summary":"Get Test Daniel707 by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Test Daniel707 by id.
Description of this entity, can be markdown text.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"test_daniel707" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_getSingletest_daniel707_","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"test_daniel707":{"type":"object","properties":{"test_daniel707Id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["test_daniel707Id","name","number"]}},"required":["test_daniel707"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"put":{"tags":["_Test Daniel707","Dynamic-Entity","Dynamic"],"summary":"Update Test Daniel707","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update Test Daniel707.
Description of this entity, can be markdown text.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"test_daniel707" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_updatetest_daniel707_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"test_daniel707":{"type":"object","properties":{"test_daniel707Id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["test_daniel707Id","name","number"]}},"required":["test_daniel707"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}}},"definitions":{"ErrorUserNotLoggedIn":{"properties":{"message":{"type":"string","example":"OBP-20001: User not logged in. Authentication is required!"}}},"EmptyClassJson":{"required":["jsonString"],"properties":{"jsonString":{"type":"string","example":"{}"}}},"JvalueCaseClass":{"required":["jvalueToCaseclass"],"properties":{"jvalueToCaseclass":{"type":"object","properties":{"data":{"type":"object","properties":{"accountIds":{"type":"array","items":{"type":"string","example":"accountIds"}}},"required":["accountIds"]},"meta":{"type":"string","example":" "}},"required":["data","meta"]}}},"ErrorUnknownError":{"properties":{"message":{"type":"string","example":"OBP-50000: Unknown Error."}}},"RequestRootJsonClass":{"required":["name","age","hobby"],"properties":{"name":{"type":"string","example":"ACCOUNT_MANAGEMENT_FEE"},"age":{"type":"integer","format":"int64","example":"18"},"hobby":{"type":"array","items":{"type":"string"}}}}}}