https://real-time.data-quality-service.com/rest/describe/bank/
Describe
The request description describes the interface of the request in JSON format.
URL for the description of a request
Sample Requests
GET /rest/describe/bank/check_account GET /rest/describe/bank/search_bank GET /rest/describe/bank/check_credit
When calling the request description, the following two objects will be returned:
-
links self-reference (self) and link for running the request (exec).
-
content contains descriptions of all optional parameters and the input and output arguments
Sample Response for the description of a request search_bank
{
"links": [
{
"rel": "self",
"href": "https://real-time.data-quality-service.com/rest/describe/bank/search_bank"
},
{
"rel": "exec",
"href": "https://real-time.data-quality-service.com/rest/bank/search_bank?language=en"
}
],
"content": [
{
"parameters": [
{
"name": "language",
"type": "Enum",
"values": {
"deutsch": "de",
"english": "en",
"français": "fr"
},
"defaultValue": "en"
},
{
"name": "country",
"type": "String",
"length": 2,
"defaultValue": "DE"
},
{
"name": "par_force_evalue_tab",
"type": "Numeric",
"defaultValue": 0,
"minimumValue": 0,
"maximumValue": 1
},
{
"name": "par_force_list_max",
"type": "Numeric",
"defaultValue": 0,
"minimumValue": 0,
"maximumValue": 1
},
{
"name": "par_force_time_out",
"type": "Numeric",
"defaultValue": 0,
"minimumValue": 0,
"maximumValue": 1
},
{
"name": "par_force_min_mval",
"type": "Numeric",
"defaultValue": 0,
"minimumValue": 0,
"maximumValue": 1
},
{
"name": "par_show_deleted",
"type": "Numeric",
"defaultValue": 0,
"minimumValue": 0,
"maximumValue": 1
},
{
"name": "par_time_out",
"type": "Numeric",
"defaultValue": 0,
"minimumValue": 0,
"maximumValue": 300
},
{
"name": "par_reduce",
"type": "Numeric",
"defaultValue": 2,
"minimumValue": 0,
"maximumValue": 3
},
{
"name": "par_min_mval",
"type": "Numeric",
"defaultValue": 60,
"minimumValue": 1,
"maximumValue": 100
},
{
"name": "par_list_max",
"type": "Numeric",
"defaultValue": "10",
"minimumValue": 1,
"maximumValue": "100"
},
{
"name": "par_iban_format",
"type": "Numeric",
"defaultValue": 1,
"minimumValue": 0,
"maximumValue": 1
},
{
"name": "par_iban_case",
"type": "Numeric",
"defaultValue": 1,
"minimumValue": 0,
"maximumValue": 1
},
{
"name": "par_evalue_tab",
"type": "String",
"length": 256,
"defaultValue": "standard"
}
],
"requestName": "search_bank",
"inputArguments": [
{
"name": "in_bic",
"type": "String",
"length": "12"
},
{
"name": "in_bcn",
"type": "String",
"length": "65"
},
{
"name": "in_zip",
"type": "String",
"length": "17"
},
{
"name": "in_bank_name",
"type": "String",
"length": "129"
},
{
"name": "in_city",
"type": "String",
"length": "129"
}
],
"outputArguments": [
{
"name": "out_bic",
"type": "String",
"length": "12"
},
{
"name": "out_bcn",
"type": "String",
"length": "65"
},
{
"name": "out_bank_name",
"type": "String",
"length": "129"
},
{
"name": "out_bank_network",
"type": "String",
"length": "129"
},
{
"name": "out_country_code",
"type": "String",
"length": "7"
},
{
"name": "out_zip",
"type": "String",
"length": "17"
},
{
"name": "out_city",
"type": "String",
"length": "129"
},
{
"name": "out_clearing_area",
"type": "String",
"length": "129"
},
{
"name": "out_office_type",
"type": "String",
"length": "9"
},
{
"name": "out_mvals",
"type": "String",
"length": "257"
},
{
"name": "out_mval",
"type": "String",
"length": "4"
},
{
"name": "out_list_count",
"type": "String",
"length": "4"
}
]
}
]
}Running a blank Request
Most parameters and input arguments are optional. If you omit them, they either use the default value or they are ignored. The request will return the following two objects:
-
info The info object may contain warnings, e.g. if an invalid parameter was passed.
-
content The content object contains the output arguments.
Sample Request
GET /rest/bank/search_bank?country=de&in_bank_name=sparkasse%20pforzheim
Sample Response for the requst search_bank
{
"info": [],
"content": [
{
"out_bank_network": "Girozentralen und Sparkassen",
"out_zip": "75172",
"out_city": "PFORZHEIM",
"out_bcn": "66650085",
"out_office_type": "1",
"out_bank_name": "SPARKASSE PFORZHEIM CALW",
"out_list_count": "4",
"out_mval": "100",
"out_bic": "PZHSDE66XXX",
"out_mvals": "name_strict=2x100;",
"out_clearing_area": "Baden-Wurttemberg",
"out_country_code": "DE"
},
{
"out_bank_network": "Girozentralen und Sparkassen",
"out_zip": "75417",
"out_city": "MUEHLACKER",
"out_bcn": "66650085",
"out_office_type": "2",
"out_bank_name": "SPARKASSE PFORZHEIM CALW",
"out_list_count": "4",
"out_mval": "100",
"out_bic": "PZHSDE66XXX",
"out_mvals": "name_strict=2x100;",
"out_clearing_area": "Baden-Wurttemberg",
"out_country_code": "DE"
},
{
"out_bank_network": "",
"out_zip": "75363",
"out_city": "CALW",
"out_bcn": "",
"out_office_type": "2",
"out_bank_name": "SPARKASSE PFORZHEIM CALW",
"out_list_count": "4",
"out_mval": "100",
"out_bic": "",
"out_mvals": "name_strict=2x100;",
"out_clearing_area": "CALW",
"out_country_code": "DE"
},
{
"out_bank_network": "",
"out_zip": "",
"out_city": "NAGOLD",
"out_bcn": "",
"out_office_type": "2",
"out_bank_name": "SPARKASSE PFORZHEIM CALW",
"out_list_count": "4",
"out_mval": "100",
"out_bic": "",
"out_mvals": "name_strict=2x100;",
"out_clearing_area": "NAGOLD",
"out_country_code": "DE"
}
]
}