Changes between Version 1 and Version 2 of AjaxAPI
- Timestamp:
- 11/10/08 16:11:41 (5 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
AjaxAPI
v1 v2 1 1 = AJAX API for !TelHosting Software = 2 2 3 [[TOC(depth=2, noheading)]] 4 5 == Login == 6 7 === be_login (inputLogin, processResult, processError) === 3 '''Note''': ''This reference is work in progress. Please expect changes. Once the interface is final, the reference will be posted in PDF and WebHelp navigable format with the other references.'' 4 5 This reference describes the new !JavaScript-format AJAX interface 6 that the !TelHosting Software exports. Unlike the SOAP API, the AJAX interface 7 is now active and available for testing with domains in the '''vip.tel''' zone. 8 9 This interface closely follows the web interface layout, and is divided 10 into the following groups of functions: 11 12 * '''Login''' - logging into the !TelHosting Software system 13 * '''Wizard''' - preferences 14 * '''Settings''' - password and related settings 15 * ''' Folder management''' - subdomains 16 * ''' Profile management''' - profiles and associated records 17 * ''' Text header management''' - TXT record contents 18 * ''' Location management''' - LOC record contents 19 * ''' Record management''' - NAPTR (naming authority pointer) record(s) content 20 * ''' Group management''' - groups of readers for privacy settings 21 * ''' Keyword management''' - keywords for search indexing 22 23 The document assumes that the reader is familiar with basics of the .tel technology. For introductory materials, please read the [/../pages/whitepapers.html whitepapers]. 24 25 [[TOC(depth=1, inline, noheading)]] 26 27 = Login = 28 29 == be_login (inputLogin, processResult, processError) == 8 30 9 31 {{{ … … 48 70 49 71 50 == = be_logout (null, processResult, processError) ===72 == be_logout (null, processResult, processError) == 51 73 52 74 {{{ … … 73 95 no validation required as the method does not have any input values 74 96 75 == = be_passwordRetrieval (inputLogin, processResult, processError) ===97 == be_passwordRetrieval (inputLogin, processResult, processError) == 76 98 77 99 {{{ … … 103 125 the input is not validated 104 126 105 = = Wizard ==106 107 == = be_setDashboardPreferences (inputPreferences, processResult, processError) ===127 = Wizard = 128 129 == be_setDashboardPreferences (inputPreferences, processResult, processError) == 108 130 109 131 {{{ … … 136 158 137 159 138 == = be_getDashboardPreferences (null, processResult, processError) ===160 == be_getDashboardPreferences (null, processResult, processError) == 139 161 140 162 {{{ … … 170 192 171 193 172 = = Settings ==173 174 == = be_changePassword (inputPassword, processResult, processError) ===194 = Settings = 195 196 == be_changePassword (inputPassword, processResult, processError) == 175 197 176 198 {{{ … … 202 224 ||newPassword||presence||checks if input value is not empty or _null_||AJAX API 203 225 204 == = be_changeEmail (inputEmail, processResult, processError) ===226 == be_changeEmail (inputEmail, processResult, processError) == 205 227 206 228 {{{ … … 233 255 ||newEmail||email||checks if input is a valid email||AJAX API 234 256 235 == = be_clearRecentLocations (null, processResult, processError) ===257 == be_clearRecentLocations (null, processResult, processError) == 236 258 237 259 {{{ … … 259 281 no validation required as method has no input values 260 282 261 = = Folder management ==262 263 == = be_getSubFolderList (inputFolder, processResult, processError) ===283 = Folder management = 284 285 == be_getSubFolderList (inputFolder, processResult, processError) == 264 286 265 287 {{{ … … 273 295 */ 274 296 297 298 275 299 input = { 276 300 domainName: "tel", /** gets a list of all folders */ … … 284 308 {id: 14, name: "henry.tel", soConnection: "Incomplete"}], 285 309 actionMessages: ["request successful", 310 311 286 312 "2nd message here", 287 313 "3rd message here"] … … 300 326 ||recursive||type cast check||checks if value is a boolean value||JSON framework 301 327 302 == = be_storeFolder (inputFolder, processResult, processError) ===328 == be_storeFolder (inputFolder, processResult, processError) == 303 329 304 330 {{{ … … 343 369 344 370 345 == = be_deleteFolder (inputFolder, processResult, processError) ===371 == be_deleteFolder (inputFolder, processResult, processError) == 346 372 347 373 {{{ … … 375 401 376 402 377 = = Profile management ==378 379 == = be_getProfileList (inputProfile, processResult, processError) ===403 = Profile management = 404 405 == be_getProfileList (inputProfile, processResult, processError) == 380 406 381 407 {{{ … … 416 442 417 443 418 == = be_activateProfile (inputProfile, processResult, processError) ===444 == be_activateProfile (inputProfile, processResult, processError) == 419 445 420 446 {{{ … … 448 474 ||profileId||presence||checks if input value is present and not _null_||AJAX API & backend 449 475 450 == = be_deleteProfile (inputProfile, processResult, processError) ===476 == be_deleteProfile (inputProfile, processResult, processError) == 451 477 452 478 {{{ … … 482 508 483 509 484 == = be_storeProfile (inputProfile, processResult, processError) ===510 == be_storeProfile (inputProfile, processResult, processError) == 485 511 486 512 {{{ … … 523 549 524 550 525 = = Text header management ==526 527 == = be_getTextHeader (inputTextHeader, processResult, processError) ===551 = Text header management = 552 553 == be_getTextHeader (inputTextHeader, processResult, processError) == 528 554 529 555 {{{ … … 562 588 563 589 564 == = be_storeTextHeader (inputTextHeader, processResult, processError) ===590 == be_storeTextHeader (inputTextHeader, processResult, processError) == 565 591 566 592 {{{ … … 605 631 "2nd message here", 606 632 "3rd message here"], 607 apiId: 23, /** warning: can be different from the supplied one== =*/633 apiId: 23, /** warning: can be different from the supplied one== */ 608 634 }; 609 635 … … 621 647 ||text||presence||checks if input is not _null_||AJAX API 622 648 ||profileId||existance||checks if porfile is existing||backend 623 ||apiId||existance||checks if apiId is existing, if id = =0||backend624 625 626 == = be_deleteTextHeader (inputTextHeader, processResult, processError) ===649 ||apiId||existance||checks if apiId is existing, if id = 0||backend 650 651 652 == be_deleteTextHeader (inputTextHeader, processResult, processError) == 627 653 628 654 {{{ … … 649 675 }; 650 676 }}} 651 === validation: be_deleteTextHeader (inputTextHeader, processResult, processError) == =677 === validation: be_deleteTextHeader (inputTextHeader, processResult, processError) == 652 678 ||'''value'''||'''name'''||'''description'''||'''implemented''' 653 679 ||domainName||presence||checks if input value is present and not _null_||AJAX API … … 655 681 656 682 657 = = Location management ==658 659 660 == = be_getLocRecord (inputLocRecord, processResult, processError) ===683 = Location management = 684 685 686 == be_getLocRecord (inputLocRecord, processResult, processError) == 661 687 662 688 {{{ … … 695 721 696 722 697 == = be_storeLocation (inputLocation, processResult, processError) ===723 == be_storeLocation (inputLocation, processResult, processError) == 698 724 699 725 {{{ … … 738 764 }}} 739 765 740 === validation: be_storeLocation (inputLocation, processResult, processError) == =741 ||'''value'''||'''name'''||'''description'''||'''implemented''' 742 ||domainName||presence||checks if input value is present and not _null_||AJAX API 743 ||domainName||existance||checks if domain is existing||backend 744 ||apiId||existance||checks if id / record is existing, if id = =0||backend766 === validation: be_storeLocation (inputLocation, processResult, processError) == 767 ||'''value'''||'''name'''||'''description'''||'''implemented''' 768 ||domainName||presence||checks if input value is present and not _null_||AJAX API 769 ||domainName||existance||checks if domain is existing||backend 770 ||apiId||existance||checks if id / record is existing, if id = 0||backend 745 771 ||latitude||presence||checks if input value is present and not _null_||AJAX API 746 772 ||longitude||presence||checks if input value is present and not _null_||AJAX API 747 773 748 == = be_deleteLocation (inputLocation, processResult, processError) ===774 == be_deleteLocation (inputLocation, processResult, processError) == 749 775 750 776 {{{ … … 781 807 782 808 783 == = be_saveLocationSearchString (inputSearchString, processResult, processError) ===809 == be_saveLocationSearchString (inputSearchString, processResult, processError) == 784 810 785 811 {{{ … … 815 841 }}} 816 842 817 === validation: be_saveLocationSearchString (inputSearchString, processResult, processError) == =843 === validation: be_saveLocationSearchString (inputSearchString, processResult, processError) == 818 844 no validation is required as the input can be arbitrary strings 819 845 820 == = be_getLocationSearchString (inputSearchString, processResult, processError) ===846 == be_getLocationSearchString (inputSearchString, processResult, processError) == 821 847 822 848 {{{ … … 853 879 854 880 855 = = Record management ==856 857 == = be_getRecordList (inputRecord, processResult, processError) ===881 = Record management = 882 883 == be_getRecordList (inputRecord, processResult, processError) == 858 884 859 885 {{{ … … 900 926 }}} 901 927 902 === validation: be_getRecordList (inputRecord, processResult, processError) == =928 === validation: be_getRecordList (inputRecord, processResult, processError) == 903 929 ||'''value'''||'''name'''||'''description'''||'''implemented''' 904 930 ||domainName||presence||checks if input value is present and not _null_||AJAX API 905 931 ||domainName||privileges||checks if the logged in user has the rights to access the domain based on usertype and domain delegation||backend 906 932 ||domainName||existance||checks if domain is existing||backend 907 ||profileId||existance||if profileId = =-1, check if profile is existing||combination of AJAX API & backend908 909 910 == = be_storeRecord (inputRecord, processResult, processError) ===933 ||profileId||existance||if profileId = -1, check if profile is existing||combination of AJAX API & backend 934 935 936 == be_storeRecord (inputRecord, processResult, processError) == 911 937 912 938 {{{ … … 947 973 "record data invalid", 948 974 "more errors here..."], 949 fieldErrors: ["value", "value invalid== ="]975 fieldErrors: ["value", "value invalid== "] 950 976 }; 951 977 }}} … … 955 981 ||domainName||presence||checks if input value is present and not _null_||AJAX API 956 982 ||domainName||existance||checks if domain is existing||backend 957 ||apiId||existance||if apiId = =0, check if a domain with the given apiId is existing||backend983 ||apiId||existance||if apiId = 0, check if a domain with the given apiId is existing||backend 958 984 ||serviceKeys||privileges||checks, if the user is allowed to use the given services based on "Allowed record types" permission||backend 959 985 ||serviceKeys||allow generic|| checks, if user is allowed to use generic record types based on permission "Allowed generic record types"||backend … … 962 988 ||serviceKeys, value, label||NAPTR limit||checks if record does not exceed encrytable NAPTR limits||backend 963 989 964 == = be_getServiceKeys (null, processResult, processError) ===990 == be_getServiceKeys (null, processResult, processError) == 965 991 966 992 {{{ … … 993 1019 994 1020 995 == = be_getLocations (null, processResult, processError) ===1021 == be_getLocations (null, processResult, processError) == 996 1022 997 1023 {{{ … … 1026 1052 1027 1053 1028 == = be_orderRecords (inputRecords, processResult, processError) ===1054 == be_orderRecords (inputRecords, processResult, processError) == 1029 1055 1030 1056 {{{ … … 1059 1085 }}} 1060 1086 1061 == = be_orderRecords (inputRecords, processResult, processError) ===1087 == be_orderRecords (inputRecords, processResult, processError) == 1062 1088 ||'''value'''||'''name'''||'''description'''||'''implemented''' 1063 1089 ||domainName||existance||checks if domain is existing||backend … … 1068 1094 1069 1095 1070 == = be_enableRecords (inputRecords, processResult, processError) ===1096 == be_enableRecords (inputRecords, processResult, processError) == 1071 1097 1072 1098 {{{ … … 1101 1127 }}} 1102 1128 1103 === validation: be_enableRecords (inputRecords, processResult, processError) == =1129 === validation: be_enableRecords (inputRecords, processResult, processError) == 1104 1130 1105 1131 ||'''value'''||'''name'''||'''description'''||'''implemented''' … … 1111 1137 1112 1138 1113 == = be_disableRecords (inputRecords, processResult, processError) ===1139 == be_disableRecords (inputRecords, processResult, processError) == 1114 1140 1115 1141 {{{ … … 1144 1170 }}} 1145 1171 1146 === validation: be_disableRecords (inputRecords, processResult, processError) == =1172 === validation: be_disableRecords (inputRecords, processResult, processError) == 1147 1173 ||'''value'''||'''name'''||'''description'''||'''implemented''' 1148 1174 ||domainName||existance||checks if domain is existing||backend … … 1154 1180 1155 1181 1156 == = be_deleteRecords (inputRecords, processResult, processError) ===1182 == be_deleteRecords (inputRecords, processResult, processError) == 1157 1183 1158 1184 {{{ … … 1183 1209 }}} 1184 1210 1185 === validation: be_deleteRecords (inputRecords, processResult, processError) == =1211 === validation: be_deleteRecords (inputRecords, processResult, processError) == 1186 1212 ||'''value'''||'''name'''||'''description'''||'''implemented''' 1187 1213 ||domainName||existance||checks if domain is existing||backend … … 1195 1221 1196 1222 1197 == = be_copyRecords (inputRecords, processResult, processError) ===1223 == be_copyRecords (inputRecords, processResult, processError) == 1198 1224 1199 1225 {{{ … … 1232 1258 }}} 1233 1259 1234 === validation: be_copyRecords (inputRecords, processResult, processError) == =1260 === validation: be_copyRecords (inputRecords, processResult, processError) == 1235 1261 1236 1262 ||'''value'''||'''name'''||'''description'''||'''implemented''' … … 1242 1268 1243 1269 1244 == = be_moveRecords (inputRecords, processResult, processError) ===1270 == be_moveRecords (inputRecords, processResult, processError) == 1245 1271 1246 1272 {{{ … … 1280 1306 }}} 1281 1307 1282 === validation: be_moveRecords (inputRecords, processResult, processError) == =1308 === validation: be_moveRecords (inputRecords, processResult, processError) == 1283 1309 ||'''value'''||'''name'''||'''description'''||'''implemented''' 1284 1310 ||domainName||existance||checks if domain is existing||backend … … 1289 1315 1290 1316 1291 == = be_getNTNAPTRRecordList (inputRecord, processResult, processError) ===1317 == be_getNTNAPTRRecordList (inputRecord, processResult, processError) == 1292 1318 1293 1319 {{{ … … 1329 1355 }}} 1330 1356 1331 === validation: be_getNTNAPTRRecord (inputRecord, processResult, processError) == =1332 ||'''value'''||'''name'''||'''description'''||'''implemented''' 1333 ||domainName||existance||checks if domain is existing||backend 1334 ||profileId||existance||if profileId `= =` -1, check if a profile with the given id is existing||backend1335 1336 1337 == = be_storeNTNAPTRRecord (inputRecord, processResult, processError) ===1357 === validation: be_getNTNAPTRRecord (inputRecord, processResult, processError) == 1358 ||'''value'''||'''name'''||'''description'''||'''implemented''' 1359 ||domainName||existance||checks if domain is existing||backend 1360 ||profileId||existance||if profileId `=` -1, check if a profile with the given id is existing||backend 1361 1362 1363 == be_storeNTNAPTRRecord (inputRecord, processResult, processError) == 1338 1364 1339 1365 {{{ … … 1378 1404 }}} 1379 1405 1380 === validation: be_storeRecord (inputRecord, processResult, processError) == =1381 ||'''value'''||'''name'''||'''description'''||'''implemented''' 1382 ||domainName||existance||checks if domain is existing||backend 1383 ||apiId||existance||if apiId = =0, check if a non-terminal NAPTR with the given apiId is existing||backend1384 1385 1386 == = be_deleteNTNAPTRRecords (inputRecord, processResult, processError) ===1406 === validation: be_storeRecord (inputRecord, processResult, processError) == 1407 ||'''value'''||'''name'''||'''description'''||'''implemented''' 1408 ||domainName||existance||checks if domain is existing||backend 1409 ||apiId||existance||if apiId = 0, check if a non-terminal NAPTR with the given apiId is existing||backend 1410 1411 1412 == be_deleteNTNAPTRRecords (inputRecord, processResult, processError) == 1387 1413 1388 1414 {{{ … … 1420 1446 }}} 1421 1447 1422 === validation: be_deleteNTNAPTRRecords (inputRecord, processResult, processError) == =1448 === validation: be_deleteNTNAPTRRecords (inputRecord, processResult, processError) == 1423 1449 ||'''value'''||'''name'''||'''description'''||'''implemented''' 1424 1450 ||domainName||existance||checks if domain is existing||backend … … 1427 1453 1428 1454 1429 = = Group management ==1430 1431 == = be_getGroupList (inputGroup, processResult, processError) ===1455 = Group management = 1456 1457 == be_getGroupList (inputGroup, processResult, processError) == 1432 1458 1433 1459 … … 1460 1486 }}} 1461 1487 1462 === validation: be_getGroupList (inputGroup, processResult, processError) == =1488 === validation: be_getGroupList (inputGroup, processResult, processError) == 1463 1489 ||'''value'''||'''name'''||'''description'''||'''implemented''' 1464 1490 ||domainName||existance||checks if domain is existing||backend … … 1468 1494 1469 1495 1470 == = be_getGroupRecords (inputGroup, processResult, processError) ===1496 == be_getGroupRecords (inputGroup, processResult, processError) == 1471 1497 1472 1498 {{{ … … 1513 1539 }}} 1514 1540 1515 === validation: be_getGroupList (inputGroup, processResult, processError) == =1541 === validation: be_getGroupList (inputGroup, processResult, processError) == 1516 1542 ||'''value'''||'''name'''||'''description'''||'''implemented''' 1517 1543 ||domainName||existance||checks if domain is existing||backend … … 1521 1547 1522 1548 1523 == = be_getGroupFriends (inputGroup, processResult, processError) ===1549 == be_getGroupFriends (inputGroup, processResult, processError) == 1524 1550 1525 1551 {{{ … … 1550 1576 }}} 1551 1577 1552 === validation: be_getGroupFriends (inputGroup, processResult, processError) == =1578 === validation: be_getGroupFriends (inputGroup, processResult, processError) == 1553 1579 ||'''value'''||'''name'''||'''description'''||'''implemented''' 1554 1580 ||domainName||existance||checks if domain is existing||backend … … 1558 1584 1559 1585 1560 == = be_addRecordsToGroup (inputGroup, processResult, processError) ===1586 == be_addRecordsToGroup (inputGroup, processResult, processError) == 1561 1587 1562 1588 {{{ … … 1587 1613 }}} 1588 1614 1589 === validation: be_addRecordsToGroup (inputGroup, processResult, processError) == =1615 === validation: be_addRecordsToGroup (inputGroup, processResult, processError) == 1590 1616 ||'''value'''||'''name'''||'''description'''||'''implemented''' 1591 1617 ||domainName||existance||checks if domain is existing||backend … … 1596 1622 ||apiIds||NAPTR limit||checks if record does not exceed encrytable NAPTR limits||backend 1597 1623 1598 == = be_removeRecordsFromGroup (inputGroup, processResult, processError) ===1624 == be_removeRecordsFromGroup (inputGroup, processResult, processError) == 1599 1625 1600 1626 {{{ … … 1626 1652 }}} 1627 1653 1628 === validation: be_removeRecordsFromGroup (inputGroup, processResult, processError) == =1654 === validation: be_removeRecordsFromGroup (inputGroup, processResult, processError) == 1629 1655 ||'''value'''||'''name'''||'''description'''||'''implemented''' 1630 1656 ||domainName||existance||checks if domain is existing||backend … … 1635 1661 1636 1662 1637 == = be_addFriendsToGroup (inputGroup, processResult, processError) ===1663 == be_addFriendsToGroup (inputGroup, processResult, processError) == 1638 1664 1639 1665 {{{ … … 1664 1690 }}} 1665 1691 1666 === validation: be_addFriendsToGroup (inputGroup, processResult, processError) == =1692 === validation: be_addFriendsToGroup (inputGroup, processResult, processError) == 1667 1693 ||'''value'''||'''name'''||'''description'''||'''implemented''' 1668 1694 ||domainName||existance||checks if domain is existing||backend … … 1673 1699 1674 1700 1675 == = be_removeFriendsFromGroup (inputGroup, processResult, processError) ===1701 == be_removeFriendsFromGroup (inputGroup, processResult, processError) == 1676 1702 1677 1703 {{{ … … 1708 1734 }}} 1709 1735 1710 === validation: be_removeFriendsFromGroup (inputGroup, processResult, processError) == =1736 === validation: be_removeFriendsFromGroup (inputGroup, processResult, processError) == 1711 1737 ||'''value'''||'''name'''||'''description'''||'''implemented''' 1712 1738 ||domainName||existance||checks if domain is existing||backend … … 1717 1743 1718 1744 1719 == = be_storeGroup (inputGroup, processResult, processError) ===1745 == be_storeGroup (inputGroup, processResult, processError) == 1720 1746 1721 1747 {{{ … … 1751 1777 }}} 1752 1778 1753 === validation: be_storeGroup (inputGroup, processResult, processError) == =1779 === validation: be_storeGroup (inputGroup, processResult, processError) == 1754 1780 ||'''value'''||'''name'''||'''description'''||'''implemented''' 1755 1781 ||domainName||existance||checks if domain is existing||backend 1756 1782 ||domainName||presence||checks if input value is present and not _null_||AJAX API 1757 1783 ||domainName||privileges||checks if the logged in user has the rights to access the domain based on usertype and domain delegation||backend 1758 ||groupId||group limit||if groupId = = null, check if use is allowed to create a new group based on "Max. #of groups" permission||backend1784 ||groupId||group limit||if groupId = null, check if use is allowed to create a new group based on "Max. * of groups" permission||backend 1759 1785 ||readerIds||existance||checks if records are existing and accessible for logged in user||backend 1760 1786 ||groupName||uniqueness||checks if given group name is unique (for logged in user)||backend 1761 1787 1762 1788 1763 == = be_deleteGroup (inputGroup, processResult, processError) ===1789 == be_deleteGroup (inputGroup, processResult, processError) == 1764 1790 1765 1791 {{{ … … 1787 1813 }}} 1788 1814 1789 === validation: be_addRecordsToGroup (inputGroup, processResult, processError) == =1815 === validation: be_addRecordsToGroup (inputGroup, processResult, processError) == 1790 1816 ||'''value'''||'''name'''||'''description'''||'''implemented''' 1791 1817 ||domainName||existance||checks if domain is existing||backend … … 1797 1823 1798 1824 1799 = =Friending1800 1801 1802 == = be_getSOUserName (domain, processResult, processError) ===1825 = Friending 1826 1827 1828 == be_getSOUserName (domain, processResult, processError) == 1803 1829 1804 1830 {{{ … … 1833 1859 }}} 1834 1860 1835 === validation: be_getSOUserName (domain, processResult, processError) == =1836 ||'''value'''||'''name'''||'''description'''||'''implemented''' 1837 ||domainName||presence||checks if input value is present and not _null_||AJAX API 1838 ||domainName||existance||checks if domain is existing||backend 1839 1840 1841 == = be_getChallenge (credentials, processResult, processError) ===1861 === validation: be_getSOUserName (domain, processResult, processError) == 1862 ||'''value'''||'''name'''||'''description'''||'''implemented''' 1863 ||domainName||presence||checks if input value is present and not _null_||AJAX API 1864 ||domainName||existance||checks if domain is existing||backend 1865 1866 1867 == be_getChallenge (credentials, processResult, processError) == 1842 1868 1843 1869 {{{ … … 1870 1896 }}} 1871 1897 1872 === validation: be_getChallenge (credentials, processResult, processError) == =1898 === validation: be_getChallenge (credentials, processResult, processError) == 1873 1899 ||'''value'''||'''name'''||'''description'''||'''implemented''' 1874 1900 ||soWebUsername||login||check of combination username and password||SOAP API (backend) … … 1876 1902 1877 1903 1878 == = be_sendChallengeAnswer (challengeAnswer, processResult, processError) ===1904 == be_sendChallengeAnswer (challengeAnswer, processResult, processError) == 1879 1905 1880 1906 {{{ … … 1911 1937 }}} 1912 1938 1913 === validation: be_sendChallengeAnswer (challengeAnswer, processResult, processError) == =1939 === validation: be_sendChallengeAnswer (challengeAnswer, processResult, processError) == 1914 1940 ||'''value'''||'''name'''||'''description'''||'''implemented''' 1915 1941 ||soWebUsername||login||check of combination username, password and answer||SOAP API (backend) … … 1918 1944 1919 1945 1920 == = be_getMessageList (null, processResult, processError) ===1946 == be_getMessageList (null, processResult, processError) == 1921 1947 1922 1948 {{{ … … 1953 1979 }}} 1954 1980 1955 === validation: be_getMessageList (null, processResult, processError) == =1956 ||'''value'''||'''name'''||'''description'''||'''implemented''' 1957 ||domainName||presence||checks if input value is present and not _null_||AJAX API 1958 ||domainName||existance||checks if domain is existing||backend 1959 1960 1961 1962 == = be_getMessages (messageIdList, processResult, processError) ===1981 === validation: be_getMessageList (null, processResult, processError) == 1982 ||'''value'''||'''name'''||'''description'''||'''implemented''' 1983 ||domainName||presence||checks if input value is present and not _null_||AJAX API 1984 ||domainName||existance||checks if domain is existing||backend 1985 1986 1987 1988 == be_getMessages (messageIdList, processResult, processError) == 1963 1989 1964 1990 {{{ … … 2006 2032 isRejectable: true, from: "henri.tel", to: "cartman", 2007 2033 received: "2008-06-15 04:20", 2008 coverNote: "Duh== ="} ]2034 coverNote: "Duh== "} ] 2009 2035 }; 2010 2036 … … 2016 2042 }}} 2017 2043 2018 === validation: be_getMessageList (null, processResult, processError) == =2044 === validation: be_getMessageList (null, processResult, processError) == 2019 2045 ||'''value'''||'''name'''||'''description'''||'''implemented''' 2020 2046 ||idList||existance||checks if the ids in list are existing||SOAP API (backend) … … 2023 2049 2024 2050 2025 == = be_acceptRequestMessage (message, processResult, processError) ===2051 == be_acceptRequestMessage (message, processResult, processError) == 2026 2052 2027 2053 {{{ … … 2069 2095 }}} 2070 2096 2071 === validation: be_acceptRequestMessage (message, processResult, processError) == =2097 === validation: be_acceptRequestMessage (message, processResult, processError) == 2072 2098 ||'''value'''||'''name'''||'''description'''||'''implemented''' 2073 2099 ||id||existance||checks if the ids in list are existing||SOAP API (backend) … … 2078 2104 2079 2105 2080 == = be_acceptRequestMessages (message, processResult, processError) ===2106 == be_acceptRequestMessages (message, processResult, processError) == 2081 2107 2082 2108 {{{ … … 2123 2149 }}} 2124 2150 2125 === validation: be_acceptRequestMessages (message, processResult, processError) == =2151 === validation: be_acceptRequestMessages (message, processResult, processError) == 2126 2152 ||'''value'''||'''name'''||'''description'''||'''implemented''' 2127 2153 ||id||existance||checks if the ids in list are existing||SOAP API (backend) … … 2131 2157 2132 2158 2133 == = be_acceptInvitationMessages (message, processResult, processError) ===2159 == be_acceptInvitationMessages (message, processResult, processError) == 2134 2160 2135 2161 {{{ … … 2175 2201 }}} 2176 2202 2177 === validation: be_acceptRequestMessages (message, processResult, processError) == =2203 === validation: be_acceptRequestMessages (message, processResult, processError) == 2178 2204 ||'''value'''||'''name'''||'''description'''||'''implemented''' 2179 2205 ||id||existance||checks if the ids in list are existing||SOAP API (backend) … … 2183 2209 2184 2210 2185 == = be_rejectMessages (message, processResult, processError) ===2211 == be_rejectMessages (message, processResult, processError) == 2186 2212 2187 2213 {{{ … … 2215 2241 }}} 2216 2242 2217 === validation: be_rejectMessages (message, processResult, processError) == =2243 === validation: be_rejectMessages (message, processResult, processError) == 2218 2244 ||'''value'''||'''name'''||'''description'''||'''implemented''' 2219 2245 ||idList||existance||checks if field is not empty or null||AJAX API … … 2222 2248 2223 2249 2224 == = be_sendFriendingRequest (newReqMessage, processResult, processError) ===2250 == be_sendFriendingRequest (newReqMessage, processResult, processError) == 2225 2251 2226 2252 {{{ … … 2261 2287 }}} 2262 2288 2263 === validation: be_sendFriendingRequest (newReqMessage, processResult, processError) == =2289 === validation: be_sendFriendingRequest (newReqMessage, processResult, processError) == 2264 2290 ||'''value'''||'''name'''||'''description'''||'''implemented''' 2265 2291 ||to||existance||checks if field is not empty or null||AJAX API … … 2269 2295 2270 2296 2271 == = be_sendFriendingInvitation (newInvMessage, processResult, processResult) ===2297 == be_sendFriendingInvitation (newInvMessage, processResult, processResult) == 2272 2298 2273 2299 {{{ … … 2315 2341 }}} 2316 2342 2317 === validation: be_sendFriendingInvitation (newInvMessage, processResult, processResult) == =2343 === validation: be_sendFriendingInvitation (newInvMessage, processResult, processResult) == 2318 2344 ||'''value'''||'''name'''||'''description'''||'''implemented''' 2319 2345 ||from||existance||checks if domain is existing (domain is not existing, if not belonging to user)||backend 2320 2346 ||to||existance||checks SO can deliver message to domain and/or domain is existing||SOAP API (backend) 2321 2347 ||readerName||uniqueness||checks if readerName is unique||backend 2322 ||readerName||reader limit||checks if user can create more readers based on permission "Max. #of readers"||backend2323 2324 2325 == = be_getFriendList (friendInput, processResult, processError) ===2348 ||readerName||reader limit||checks if user can create more readers based on permission "Max. * of readers"||backend 2349 2350 2351 == be_getFriendList (friendInput, processResult, processError) == 2326 2352 2327 2353 {{{ … … 2353 2379 }}} 2354 2380 2355 === validation: be_getFriendList (friendInput, processResult, processError) == =2381 === validation: be_getFriendList (friendInput, processResult, processError) == 2356 2382 ||'''value'''||'''name'''||'''description'''||'''implemented''' 2357 2383 ||domainName||presence||checks if domain is not empty or _null_||AJAX API … … 2359 2385 2360 2386 2361 == = be_deleteFriends (friendInput, processResult, processError) ===2387 == be_deleteFriends (friendInput, processResult, processError) == 2362 2388 2363 2389 {{{ … … 2385 2411 2386 2412 2387 === validation: be_deleteFriends (friendInput, processResult, processError) == =2413 === validation: be_deleteFriends (friendInput, processResult, processError) == 2388 2414 ||'''value'''||'''name'''||'''description'''||'''implemented''' 2389 2415 ||domainName||presence||checks if domain is not empty or _null_||AJAX API … … 2392 2418 2393 2419 2394 == = be_renameFriend (friendInput, processResult, processError) ===2420 == be_renameFriend (friendInput, processResult, processError) == 2395 2421 2396 2422 {{{ … … 2422 2448 }}} 2423 2449 2424 === validation: be_renameFriend (friendInput, processResult, processError) == =2450 === validation: be_renameFriend (friendInput, processResult, processError) == 2425 2451 ||'''value'''||'''name'''||'''description'''||'''implemented''' 2426 2452 ||domainName||presence||checks if domain is not empty or _null_||AJAX API … … 2430 2456 2431 2457 2432 = = Keyword management ==2458 = Keyword management = 2433 2459 2434 2460 Currently available keyword types (short forms): 2435 2461 `s, fn, ln, nn, dob, g, ms, pa, a1, a2, a3, tc, sp, pc, c, ll, o, d, jt, hi, ft, bpa, bn, bar, bsa, sa, aux` 2436 2462 2437 == = be_getValidKeywords (null, processResult, processError) ===2463 == be_getValidKeywords (null, processResult, processError) == 2438 2464 2439 2465 {{{ … … 2468 2494 }}} 2469 2495 2470 === validation: be_getValidKeywords (null, processResult, processError) == =2496 === validation: be_getValidKeywords (null, processResult, processError) == 2471 2497 no validation required as the method does not have any input values 2472 2498 2473 2499 2474 == = be_getKeywords (domain, processResult, processError) ===2500 == be_getKeywords (domain, processResult, processError) == 2475 2501 2476 2502 {{{ … … 2509 2535 }}} 2510 2536 2511 === validation: be_getKeywords (domain, processResult, processError) == =2537 === validation: be_getKeywords (domain, processResult, processError) == 2512 2538 ||'''value'''||'''name'''||'''description'''||'''implemented''' 2513 2539 ||domainName||presence||checks if domain is not empty or null||AJAX API … … 2516 2542 2517 2543 2518 == = be_getSuggestions (inputKeyword, processResult, processError) ===2544 == be_getSuggestions (inputKeyword, processResult, processError) == 2519 2545 2520 2546 {{{ … … 2548 2574 }}} 2549 2575 2550 === validation: be_getSuggestions (inputKeyword, processResult, processError) == =2576 === validation: be_getSuggestions (inputKeyword, processResult, processError) == 2551 2577 ||'''value'''||'''name'''||'''description'''||'''implemented''' 2552 2578 ||type||presence||checks if the type is not empty or null||SOAP API … … 2555 2581 2556 2582 2557 == = be_addKeyword (newKeyword, processResult, processError) ===2583 == be_addKeyword (newKeyword, processResult, processError) == 2558 2584 2559 2585 {{{ … … 2588 2614 }}} 2589 2615 2590 === validation: be_addKeyword (newKeyword, processResult, processError) == =2616 === validation: be_addKeyword (newKeyword, processResult, processError) == 2591 2617 ||'''value'''||'''name'''||'''description'''||'''implemented''' 2592 2618 ||domainName||presence||checks if domain is not empty or _null_||SOAP API … … 2594 2620 ||type||presence||checks if the type is not empty or null||SOAP API 2595 2621 ||type||valid||checks if input value is valid (in list of defined keyword types)||backend 2596 ||type||limit||checks if the use is allowed to create a new search data entry based on "Max. #of keywords" permission||backend2622 ||type||limit||checks if the use is allowed to create a new search data entry based on "Max. * of keywords" permission||backend 2597 2623 ||type||allowed||checks if use is allowed to use the given type based "Allowed keywords" permission||backend 2598 2624 2599 2625 2600 == = be_addSecondaryKeywords (newKeywords, processResult, processError) ===2626 == be_addSecondaryKeywords (newKeywords, processResult, processError) == 2601 2627 2602 2628 {{{ … … 2635 2661 }}} 2636 2662 2637 === validation: be_addSecondaryKeywords (newKeywords, processResult, processError) === 2638 ||'''value'''||'''name'''||'''description'''||'''implemented''' 2663 === validation: be_addSecondaryKeywords (newKeywords, processResult, processError) == 2664 ||'''value'''||'''name'''||'''description'''||'''implemented''' 2665 2639 2666 ||domainName||presence||checks if domain is not empty or null||SOAP API 2640 2667 ||domainName||existance||checks if domain is existing (domain is not existing, if not belonging to user)||backend … … 2642 2669 ||primaryKeywordId||secondary keywords allowed||checks if primary keyword is capabile for secondary keywords||backend 2643 2670 ||keywords.sp||valid||checks if input value is valid (in list of defined keyword types)||backend 2644 ||keywords.sp||limit||checks if the use is allowed to create a new search data entry based on "Max. #of keywords" permission||backend2671 ||keywords.sp||limit||checks if the use is allowed to create a new search data entry based on "Max. * of keywords" permission||backend 2645 2672 ||keywords.sp||allowed||checks if use is allowed to use the given type based "Allowed keywords" permission||backend 2646 2673 2647 == = be_updateKeyword (keywordData, processResult, processError) ===2674 == be_updateKeyword (keywordData, processResult, processError) == 2648 2675 2649 2676 {{{ … … 2683 2710 }}} 2684 2711 2685 == = be_deleteKeywords (keywords, processResult, processError) ===2712 == be_deleteKeywords (keywords, processResult, processError) == 2686 2713 2687 2714 {{{ … … 2709 2736 }}} 2710 2737 2711 === validation: be_deleteKeywords (keywords, processResult, processError) == =2738 === validation: be_deleteKeywords (keywords, processResult, processError) == 2712 2739 ||'''value'''||'''name'''||'''description'''||'''implemented''' 2713 2740 ||domainName||presence||checks if domain is not empty or _null_||backend … … 2716 2743 2717 2744 2718 == = be_copyKeywords (keywords, processResult, processError) ===2745 == be_copyKeywords (keywords, processResult, processError) == 2719 2746 2720 2747 {{{ … … 2755 2782 }}} 2756 2783 2757 === validation: be_copyKeywords (keywords, processResult, processError) == =2784 === validation: be_copyKeywords (keywords, processResult, processError) == 2758 2785 ||'''value'''||'''name'''||'''description'''||'''implemented''' 2759 2786 ||domainName||presence||checks if domain is not empty or _null_||SOAP API … … 2765 2792 2766 2793 2767 == = be_moveKeywords (keywords, processResult, processError) ===2794 == be_moveKeywords (keywords, processResult, processError) == 2768 2795 2769 2796 {{{ … … 2801 2828 }}} 2802 2829 2803 === validation: be_moveKeywords (keywords, processResult, processError) == =2830 === validation: be_moveKeywords (keywords, processResult, processError) == 2804 2831 ||'''value'''||'''name'''||'''description'''||'''implemented''' 2805 2832 ||domainName||presence||checks if domain is not empty or _null_||SOAP API … … 2811 2838 2812 2839 2813 == = be_reorderSubkeywords (subkeywordOrder, processResult, processError) ===2840 == be_reorderSubkeywords (subkeywordOrder, processResult, processError) == 2814 2841 2815 2842 {{{ … … 2843 2870 }}} 2844 2871 2845 === validation: be_reorderSubkeywords (subkeywordOrder, processResult, processError) == =2872 === validation: be_reorderSubkeywords (subkeywordOrder, processResult, processError) == 2846 2873 ||'''value'''||'''name'''||'''description'''||'''implemented''' 2847 2874 ||domain||presence||checks if domain is not empty or _null_||SOAP API
