[[PageOutline]]

= General DEB server API =

Replace servername with actual address of the server. 

== Query the database == 

'''Request:''' ''servername''/''dictionary_code''?action=list_starts_with&id=''search_query''[&element=''element'']

 search_query::
  search query, must be URL encoded UTF-8
 element::
  optional argument, search in specified element, if not given or empty, search in key element 

'''Response:''' list of entry IDs

== Get document ==

'''Request:''' ''servername''/''dictionary_code''?action=getdoc&id=''document_id''[&transform=''xslt'']
 
 document_id::
  database ID of selected document
 transform::
  optional argument, transform resulting XML with given XSL transformation

'''Response:''' entry XML (plain XML or transformed with XSLT)

== Save document ==

'''Request:''' ''servername''/''dictionary_code''?action=store&id=''document_id''&data=''encoded data''
 
 document_id::
  database ID of selected document
 encoded data::
  URL UTF-8 encoded representation of an entry

'''Response:''' entry ID

== Delete document ==

'''Request:''' ''servername''/''dictionary_code''?action=deldoc&id=''document_id''
 
 document_id::
  database ID of selected document

'''Response:''' "deleted"