close
Warning:
Can't synchronize with repository "(default)" (/usr/local/svn/deb2-client does not appear to be a Subversion repository.). Look in the Trac log for more information.
- Timestamp:
-
Feb 18, 2009, 3:21:20 PM (15 years ago)
- Author:
-
Adam
- Comment:
-
--
Legend:
- Unmodified
- Added
- Removed
- Modified
-
|
v1
|
v1
|
|
| | 1 | [[PageOutline]] |
| | 2 | |
| | 3 | = General DEB server API = |
| | 4 | |
| | 5 | Replace servername with actual address of the server. |
| | 6 | |
| | 7 | == Query the database == |
| | 8 | |
| | 9 | '''Request:''' ''servername''/''dictionary_code''?action=list_starts_with&id=''search_query''[&element=''element''] |
| | 10 | |
| | 11 | search_query:: |
| | 12 | search query, must be URL encoded UTF-8 |
| | 13 | element:: |
| | 14 | optional argument, search in specified element, if not given or empty, search in key element |
| | 15 | |
| | 16 | '''Response:''' list of entry IDs |
| | 17 | |
| | 18 | == Get document == |
| | 19 | |
| | 20 | '''Request:''' ''servername''/''dictionary_code''?action=getdoc&id=''document_id''[&transform=''xslt''] |
| | 21 | |
| | 22 | document_id:: |
| | 23 | database ID of selected document |
| | 24 | transform:: |
| | 25 | optional argument, transform resulting XML with given XSL transformation |
| | 26 | |
| | 27 | '''Response:''' entry XML (plain XML or transformed with XSLT) |
| | 28 | |
| | 29 | == Save document == |
| | 30 | |
| | 31 | '''Request:''' ''servername''/''dictionary_code''?action=store&id=''document_id''&data=''encoded data'' |
| | 32 | |
| | 33 | document_id:: |
| | 34 | database ID of selected document |
| | 35 | encoded data:: |
| | 36 | URL UTF-8 encoded representation of an entry |
| | 37 | |
| | 38 | '''Response:''' entry ID |
| | 39 | |
| | 40 | == Delete document == |
| | 41 | |
| | 42 | '''Request:''' ''servername''/''dictionary_code''?action=deldoc&id=''document_id'' |
| | 43 | |
| | 44 | document_id:: |
| | 45 | database ID of selected document |
| | 46 | |
| | 47 | '''Response:''' "deleted" |
