Decentral Search Broker REST interface
Resource Group¶
Retrieve the name of the broker¶
GET/name
Retrieve the name of the respective decentral search broker.
Headers
Accept: text/plain200Headers
Content-Type: text/plainBody
DKTK SearchbrokerRegister a new decentral search client¶
PUT/banks/{email}
Register a new decentral search client identified by an email address
string(required) Example: emailthe email address of the bank to be created
Headers
Accept: text/plain201Headers
Content-Type: text/plainBody
Auth Token400401409DELETE/banks/{email}
Delete a bank identified by its email
string(required) Example: emailthe email address of the bank to be created
Headers
Content-Type: application/xml
Authorization: Auth Token204404401Retrieve the registration status of a bank¶
GET/banks/{email}/status
Retrieve the registration status of a bank.
string(required) Example: emailthe email address of the bank
Headers
Authorization: Auth Token200202403404Retrieve the inquiries¶
GET/inquiries
Retrieve the registration status of a bank.
Headers
Authorization: Auth Token200Headers
Content-Type: application/xmlBody
{ to be added }401500Retrieve the query for a specific inquiry¶
GET/inquiries/{inquiryid}/query
Retrieve the registration status of a bank.
- inquiryid
string(required) Example: idthe ID of the specific inquiry
Headers
Authorization: Auth Token200Headers
Content-Type: application/xmlBody
{ to be added }400401404500Retrieve the contact data for a specific inquiry¶
GET/inquiries/{inquiryid}/contact
Retrieve the registration status of a bank.
- inquiryid
string(required) Example: idthe ID of the specific inquiry
Headers
Authorization: Auth Token200Headers
Content-Type: application/xmlBody
{ to be added }400401404500Retrieve the inquiry information for a specific inquiry¶
GET/inquiries/{inquiryid}/info
Retrieve the registration status of a bank.
- inquiryid
string(required) Example: idthe ID of the specific inquiry
Headers
Authorization: Auth Token200Headers
Content-Type: application/xmlBody
{ to be added }400401404500Retrieve the expose for a specific inquiry¶
GET/inquiries/{inquiryid}/expose
Retrieve the registration status of a bank.
- inquiryid
string(required) Example: idthe ID of the specific inquiry
Headers
Authorization: Auth Token200Headers
Content-Type: application/pdfBody
{ binary data, PDF file }400401404Retrieve the expose for a specific inquiry¶
GET/exposes/{exposeid}
Retrieve the registration status of a bank.
- exposeid
string(required) Example: idthe ID of the specific expose
Headers
Authorization: Auth Token200Headers
Content-Type: application/pdfBody
{ binary data, PDF file }400401404Reply to a specific inquiry¶
PUT/inquiries/{inquiryid}/replies/{bankemail}
Retrieve the registration status of a bank.
- inquiryid
string(required) Example: idthe ID of the specific inquiry
- bankemail
string(required) Example: emailthe email address of the bank to be created
Headers
Content-Type: text/plain
Authorization: Auth Token200This response means that the bank is registered.
Headers
Content-Type: text/plainBody
{ to be added }400401404500