Developer Area

Changes between Version 1 and Version 2 of AjaxAPI

Show
Ignore:
Timestamp:
11/10/08 16:11:41 (6 years ago)
Author:
nadya (IP: 217.33.138.50)
Comment:

add toc and intro

Legend:

Unmodified
Added
Removed
Modified
  • AjaxAPI

    v1 v2  
    11= AJAX API for !TelHosting Software = 
    22 
    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 
     5This reference describes the new !JavaScript-format AJAX interface 
     6that the !TelHosting Software exports. Unlike the SOAP API, the AJAX interface 
     7is now active and available for testing with domains in the '''vip.tel''' zone. 
     8 
     9This interface closely follows the web interface layout, and is divided 
     10into 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 
     23The 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) == 
    830 
    931{{{ 
     
    4870         
    4971 
    50 === be_logout (null, processResult, processError) === 
     72== be_logout (null, processResult, processError) == 
    5173 
    5274{{{ 
     
    7395no validation required as the method does not have any input values 
    7496 
    75 === be_passwordRetrieval (inputLogin, processResult, processError) === 
     97== be_passwordRetrieval (inputLogin, processResult, processError) == 
    7698 
    7799{{{ 
     
    103125the input is not validated 
    104126 
    105 == Wizard == 
    106  
    107 === be_setDashboardPreferences (inputPreferences, processResult, processError) === 
     127= Wizard = 
     128 
     129== be_setDashboardPreferences (inputPreferences, processResult, processError) == 
    108130 
    109131{{{ 
     
    136158         
    137159 
    138 === be_getDashboardPreferences (null, processResult, processError) === 
     160== be_getDashboardPreferences (null, processResult, processError) == 
    139161 
    140162{{{ 
     
    170192 
    171193 
    172 == Settings == 
    173  
    174 === be_changePassword (inputPassword, processResult, processError) === 
     194= Settings = 
     195 
     196== be_changePassword (inputPassword, processResult, processError) == 
    175197 
    176198{{{ 
     
    202224||newPassword||presence||checks if input value is not empty or _null_||AJAX API 
    203225 
    204 === be_changeEmail (inputEmail, processResult, processError) === 
     226== be_changeEmail (inputEmail, processResult, processError) == 
    205227 
    206228{{{ 
     
    233255||newEmail||email||checks if input is a valid email||AJAX API 
    234256 
    235 === be_clearRecentLocations (null, processResult, processError) === 
     257== be_clearRecentLocations (null, processResult, processError) == 
    236258 
    237259{{{ 
     
    259281no validation required as method has no input values 
    260282 
    261 == Folder management == 
    262  
    263 === be_getSubFolderList (inputFolder, processResult, processError) === 
     283= Folder management = 
     284 
     285== be_getSubFolderList (inputFolder, processResult, processError) == 
    264286 
    265287{{{ 
     
    273295 */ 
    274296 
     297 
     298 
    275299input = { 
    276300        domainName: "tel",  /** gets a list of all folders */ 
     
    284308                     {id: 14, name: "henry.tel", soConnection: "Incomplete"}], 
    285309        actionMessages: ["request successful", 
     310 
     311 
    286312                         "2nd message here", 
    287313                         "3rd message here"] 
     
    300326||recursive||type cast check||checks if value is a boolean value||JSON framework 
    301327 
    302 === be_storeFolder (inputFolder, processResult, processError) === 
     328== be_storeFolder (inputFolder, processResult, processError) == 
    303329 
    304330{{{ 
     
    343369 
    344370 
    345 === be_deleteFolder (inputFolder, processResult, processError) === 
     371== be_deleteFolder (inputFolder, processResult, processError) == 
    346372 
    347373{{{ 
     
    375401 
    376402 
    377 == Profile management == 
    378  
    379 === be_getProfileList (inputProfile, processResult, processError) === 
     403= Profile management = 
     404 
     405== be_getProfileList (inputProfile, processResult, processError) == 
    380406 
    381407{{{ 
     
    416442 
    417443 
    418 === be_activateProfile (inputProfile, processResult, processError) === 
     444== be_activateProfile (inputProfile, processResult, processError) == 
    419445 
    420446{{{ 
     
    448474||profileId||presence||checks if input value is present and not _null_||AJAX API & backend 
    449475 
    450 === be_deleteProfile (inputProfile, processResult, processError) === 
     476== be_deleteProfile (inputProfile, processResult, processError) == 
    451477 
    452478{{{ 
     
    482508 
    483509 
    484 === be_storeProfile (inputProfile, processResult, processError) === 
     510== be_storeProfile (inputProfile, processResult, processError) == 
    485511 
    486512{{{ 
     
    523549 
    524550 
    525 == Text header management == 
    526  
    527 === be_getTextHeader (inputTextHeader, processResult, processError) === 
     551= Text header management = 
     552 
     553== be_getTextHeader (inputTextHeader, processResult, processError) == 
    528554 
    529555{{{ 
     
    562588 
    563589 
    564 === be_storeTextHeader (inputTextHeader, processResult, processError) === 
     590== be_storeTextHeader (inputTextHeader, processResult, processError) == 
    565591 
    566592{{{ 
     
    605631                         "2nd message here", 
    606632                         "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==  */ 
    608634};  
    609635 
     
    621647||text||presence||checks if input is not _null_||AJAX API 
    622648||profileId||existance||checks if porfile is existing||backend 
    623 ||apiId||existance||checks if apiId is existing, if id == 0||backend 
    624  
    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) == 
    627653 
    628654{{{ 
     
    649675}; 
    650676}}} 
    651 === validation: be_deleteTextHeader (inputTextHeader, processResult, processError) === 
     677=== validation: be_deleteTextHeader (inputTextHeader, processResult, processError) == 
    652678||'''value'''||'''name'''||'''description'''||'''implemented''' 
    653679||domainName||presence||checks if input value is present and not _null_||AJAX API 
     
    655681 
    656682 
    657 == Location management == 
    658  
    659  
    660 === be_getLocRecord (inputLocRecord, processResult, processError) === 
     683= Location management = 
     684 
     685 
     686== be_getLocRecord (inputLocRecord, processResult, processError) == 
    661687 
    662688{{{ 
     
    695721 
    696722 
    697 === be_storeLocation (inputLocation, processResult, processError) === 
     723== be_storeLocation (inputLocation, processResult, processError) == 
    698724 
    699725{{{ 
     
    738764}}} 
    739765 
    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||backend 
     766=== 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 
    745771||latitude||presence||checks if input value is present and not _null_||AJAX API 
    746772||longitude||presence||checks if input value is present and not _null_||AJAX API 
    747773 
    748 === be_deleteLocation (inputLocation, processResult, processError) === 
     774== be_deleteLocation (inputLocation, processResult, processError) == 
    749775 
    750776{{{ 
     
    781807 
    782808 
    783 === be_saveLocationSearchString (inputSearchString, processResult, processError) === 
     809== be_saveLocationSearchString (inputSearchString, processResult, processError) == 
    784810 
    785811{{{ 
     
    815841}}} 
    816842 
    817 === validation: be_saveLocationSearchString (inputSearchString, processResult, processError) === 
     843=== validation: be_saveLocationSearchString (inputSearchString, processResult, processError) == 
    818844no validation is required as the input can be arbitrary strings 
    819845 
    820 === be_getLocationSearchString (inputSearchString, processResult, processError) === 
     846== be_getLocationSearchString (inputSearchString, processResult, processError) == 
    821847 
    822848{{{ 
     
    853879 
    854880 
    855 == Record management == 
    856  
    857 === be_getRecordList (inputRecord, processResult, processError) === 
     881= Record management = 
     882 
     883== be_getRecordList (inputRecord, processResult, processError) == 
    858884 
    859885{{{ 
     
    900926}}} 
    901927 
    902 === validation: be_getRecordList (inputRecord, processResult, processError) === 
     928=== validation: be_getRecordList (inputRecord, processResult, processError) == 
    903929||'''value'''||'''name'''||'''description'''||'''implemented''' 
    904930||domainName||presence||checks if input value is present and not _null_||AJAX API 
    905931||domainName||privileges||checks if the logged in user has the rights to access the domain based on usertype and domain delegation||backend 
    906932||domainName||existance||checks if domain is existing||backend 
    907 ||profileId||existance||if profileId == -1, check if profile is existing||combination of AJAX API & backend 
    908  
    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) == 
    911937 
    912938{{{ 
     
    947973                       "record data invalid", 
    948974                       "more errors here..."], 
    949         fieldErrors: ["value", "value invalid=== "] 
     975        fieldErrors: ["value", "value invalid== "] 
    950976};  
    951977}}} 
     
    955981||domainName||presence||checks if input value is present and not _null_||AJAX API 
    956982||domainName||existance||checks if domain is existing||backend 
    957 ||apiId||existance||if apiId == 0, check if a domain with the given apiId is existing||backend 
     983||apiId||existance||if apiId = 0, check if a domain with the given apiId is existing||backend 
    958984||serviceKeys||privileges||checks, if the user is allowed to use the given services based on "Allowed record types" permission||backend 
    959985||serviceKeys||allow generic|| checks, if user is allowed to use generic record types based on permission "Allowed generic record types"||backend 
     
    962988||serviceKeys, value, label||NAPTR limit||checks if record does not exceed encrytable NAPTR limits||backend 
    963989 
    964 === be_getServiceKeys (null, processResult, processError) === 
     990== be_getServiceKeys (null, processResult, processError) == 
    965991 
    966992{{{ 
     
    9931019 
    9941020 
    995 === be_getLocations (null, processResult, processError) === 
     1021== be_getLocations (null, processResult, processError) == 
    9961022 
    9971023{{{ 
     
    10261052 
    10271053 
    1028 === be_orderRecords (inputRecords, processResult, processError) === 
     1054== be_orderRecords (inputRecords, processResult, processError) == 
    10291055 
    10301056{{{ 
     
    10591085}}} 
    10601086 
    1061 === be_orderRecords (inputRecords, processResult, processError) === 
     1087== be_orderRecords (inputRecords, processResult, processError) == 
    10621088||'''value'''||'''name'''||'''description'''||'''implemented''' 
    10631089||domainName||existance||checks if domain is existing||backend 
     
    10681094 
    10691095 
    1070 === be_enableRecords (inputRecords, processResult, processError) === 
     1096== be_enableRecords (inputRecords, processResult, processError) == 
    10711097 
    10721098{{{ 
     
    11011127}}} 
    11021128 
    1103 === validation: be_enableRecords (inputRecords, processResult, processError) === 
     1129=== validation: be_enableRecords (inputRecords, processResult, processError) == 
    11041130 
    11051131||'''value'''||'''name'''||'''description'''||'''implemented''' 
     
    11111137 
    11121138 
    1113 === be_disableRecords (inputRecords, processResult, processError) === 
     1139== be_disableRecords (inputRecords, processResult, processError) == 
    11141140 
    11151141{{{ 
     
    11441170}}} 
    11451171 
    1146 === validation: be_disableRecords (inputRecords, processResult, processError) === 
     1172=== validation: be_disableRecords (inputRecords, processResult, processError) == 
    11471173||'''value'''||'''name'''||'''description'''||'''implemented''' 
    11481174||domainName||existance||checks if domain is existing||backend 
     
    11541180 
    11551181 
    1156 === be_deleteRecords (inputRecords, processResult, processError) === 
     1182== be_deleteRecords (inputRecords, processResult, processError) == 
    11571183 
    11581184{{{ 
     
    11831209}}} 
    11841210 
    1185 === validation: be_deleteRecords (inputRecords, processResult, processError) === 
     1211=== validation: be_deleteRecords (inputRecords, processResult, processError) == 
    11861212||'''value'''||'''name'''||'''description'''||'''implemented''' 
    11871213||domainName||existance||checks if domain is existing||backend 
     
    11951221 
    11961222 
    1197 === be_copyRecords (inputRecords, processResult, processError) === 
     1223== be_copyRecords (inputRecords, processResult, processError) == 
    11981224 
    11991225{{{ 
     
    12321258}}} 
    12331259 
    1234 === validation: be_copyRecords (inputRecords, processResult, processError) === 
     1260=== validation: be_copyRecords (inputRecords, processResult, processError) == 
    12351261 
    12361262||'''value'''||'''name'''||'''description'''||'''implemented''' 
     
    12421268 
    12431269 
    1244 === be_moveRecords (inputRecords, processResult, processError) === 
     1270== be_moveRecords (inputRecords, processResult, processError) == 
    12451271 
    12461272{{{ 
     
    12801306}}} 
    12811307 
    1282 === validation: be_moveRecords (inputRecords, processResult, processError) === 
     1308=== validation: be_moveRecords (inputRecords, processResult, processError) == 
    12831309||'''value'''||'''name'''||'''description'''||'''implemented''' 
    12841310||domainName||existance||checks if domain is existing||backend 
     
    12891315 
    12901316 
    1291 === be_getNTNAPTRRecordList (inputRecord, processResult, processError) === 
     1317== be_getNTNAPTRRecordList (inputRecord, processResult, processError) == 
    12921318 
    12931319{{{ 
     
    13291355}}} 
    13301356 
    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||backend 
    1335  
    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) == 
    13381364 
    13391365{{{ 
     
    13781404}}} 
    13791405 
    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||backend 
    1384  
    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) == 
    13871413 
    13881414{{{ 
     
    14201446}}} 
    14211447 
    1422 === validation: be_deleteNTNAPTRRecords (inputRecord, processResult, processError) === 
     1448=== validation: be_deleteNTNAPTRRecords (inputRecord, processResult, processError) == 
    14231449||'''value'''||'''name'''||'''description'''||'''implemented''' 
    14241450||domainName||existance||checks if domain is existing||backend 
     
    14271453 
    14281454 
    1429 == Group management == 
    1430  
    1431 === be_getGroupList (inputGroup, processResult, processError) === 
     1455= Group management = 
     1456 
     1457== be_getGroupList (inputGroup, processResult, processError) == 
    14321458 
    14331459 
     
    14601486}}} 
    14611487 
    1462 === validation: be_getGroupList (inputGroup, processResult, processError) === 
     1488=== validation: be_getGroupList (inputGroup, processResult, processError) == 
    14631489||'''value'''||'''name'''||'''description'''||'''implemented''' 
    14641490||domainName||existance||checks if domain is existing||backend 
     
    14681494 
    14691495 
    1470 === be_getGroupRecords (inputGroup, processResult, processError) === 
     1496== be_getGroupRecords (inputGroup, processResult, processError) == 
    14711497 
    14721498{{{ 
     
    15131539}}} 
    15141540 
    1515 === validation: be_getGroupList (inputGroup, processResult, processError) === 
     1541=== validation: be_getGroupList (inputGroup, processResult, processError) == 
    15161542||'''value'''||'''name'''||'''description'''||'''implemented''' 
    15171543||domainName||existance||checks if domain is existing||backend 
     
    15211547 
    15221548 
    1523 === be_getGroupFriends (inputGroup, processResult, processError) === 
     1549== be_getGroupFriends (inputGroup, processResult, processError) == 
    15241550 
    15251551{{{ 
     
    15501576}}} 
    15511577 
    1552 === validation: be_getGroupFriends (inputGroup, processResult, processError) === 
     1578=== validation: be_getGroupFriends (inputGroup, processResult, processError) == 
    15531579||'''value'''||'''name'''||'''description'''||'''implemented''' 
    15541580||domainName||existance||checks if domain is existing||backend 
     
    15581584 
    15591585 
    1560 === be_addRecordsToGroup (inputGroup, processResult, processError) === 
     1586== be_addRecordsToGroup (inputGroup, processResult, processError) == 
    15611587 
    15621588{{{ 
     
    15871613}}} 
    15881614 
    1589 === validation: be_addRecordsToGroup (inputGroup, processResult, processError) === 
     1615=== validation: be_addRecordsToGroup (inputGroup, processResult, processError) == 
    15901616||'''value'''||'''name'''||'''description'''||'''implemented''' 
    15911617||domainName||existance||checks if domain is existing||backend 
     
    15961622||apiIds||NAPTR limit||checks if record does not exceed encrytable NAPTR limits||backend 
    15971623 
    1598 === be_removeRecordsFromGroup (inputGroup, processResult, processError) === 
     1624== be_removeRecordsFromGroup (inputGroup, processResult, processError) == 
    15991625 
    16001626{{{ 
     
    16261652}}} 
    16271653 
    1628 === validation: be_removeRecordsFromGroup (inputGroup, processResult, processError) === 
     1654=== validation: be_removeRecordsFromGroup (inputGroup, processResult, processError) == 
    16291655||'''value'''||'''name'''||'''description'''||'''implemented''' 
    16301656||domainName||existance||checks if domain is existing||backend 
     
    16351661 
    16361662 
    1637 === be_addFriendsToGroup (inputGroup, processResult, processError) === 
     1663== be_addFriendsToGroup (inputGroup, processResult, processError) == 
    16381664 
    16391665{{{ 
     
    16641690}}} 
    16651691 
    1666 === validation: be_addFriendsToGroup (inputGroup, processResult, processError) === 
     1692=== validation: be_addFriendsToGroup (inputGroup, processResult, processError) == 
    16671693||'''value'''||'''name'''||'''description'''||'''implemented''' 
    16681694||domainName||existance||checks if domain is existing||backend 
     
    16731699 
    16741700 
    1675 === be_removeFriendsFromGroup (inputGroup, processResult, processError) === 
     1701== be_removeFriendsFromGroup (inputGroup, processResult, processError) == 
    16761702 
    16771703{{{ 
     
    17081734}}} 
    17091735 
    1710 === validation: be_removeFriendsFromGroup (inputGroup, processResult, processError) === 
     1736=== validation: be_removeFriendsFromGroup (inputGroup, processResult, processError) == 
    17111737||'''value'''||'''name'''||'''description'''||'''implemented''' 
    17121738||domainName||existance||checks if domain is existing||backend 
     
    17171743 
    17181744 
    1719 === be_storeGroup (inputGroup, processResult, processError) === 
     1745== be_storeGroup (inputGroup, processResult, processError) == 
    17201746 
    17211747{{{ 
     
    17511777}}} 
    17521778 
    1753 === validation: be_storeGroup (inputGroup, processResult, processError) === 
     1779=== validation: be_storeGroup (inputGroup, processResult, processError) == 
    17541780||'''value'''||'''name'''||'''description'''||'''implemented''' 
    17551781||domainName||existance||checks if domain is existing||backend 
    17561782||domainName||presence||checks if input value is present and not _null_||AJAX API 
    17571783||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||backend 
     1784||groupId||group limit||if groupId = null, check if use is allowed to create a new group based on "Max.  * of groups" permission||backend 
    17591785||readerIds||existance||checks if records are existing and accessible for logged in user||backend 
    17601786||groupName||uniqueness||checks if given group name is unique (for logged in user)||backend 
    17611787 
    17621788 
    1763 === be_deleteGroup (inputGroup, processResult, processError) === 
     1789== be_deleteGroup (inputGroup, processResult, processError) == 
    17641790 
    17651791{{{ 
     
    17871813}}} 
    17881814 
    1789 === validation: be_addRecordsToGroup (inputGroup, processResult, processError) === 
     1815=== validation: be_addRecordsToGroup (inputGroup, processResult, processError) == 
    17901816||'''value'''||'''name'''||'''description'''||'''implemented''' 
    17911817||domainName||existance||checks if domain is existing||backend 
     
    17971823 
    17981824 
    1799 == Friending 
    1800  
    1801  
    1802 === be_getSOUserName (domain, processResult, processError) === 
     1825= Friending 
     1826 
     1827 
     1828== be_getSOUserName (domain, processResult, processError) == 
    18031829 
    18041830{{{ 
     
    18331859}}} 
    18341860 
    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) == 
    18421868 
    18431869{{{ 
     
    18701896}}} 
    18711897 
    1872 === validation: be_getChallenge (credentials, processResult, processError) === 
     1898=== validation: be_getChallenge (credentials, processResult, processError) == 
    18731899||'''value'''||'''name'''||'''description'''||'''implemented''' 
    18741900||soWebUsername||login||check of combination username and password||SOAP API (backend) 
     
    18761902 
    18771903 
    1878 === be_sendChallengeAnswer (challengeAnswer, processResult, processError) === 
     1904== be_sendChallengeAnswer (challengeAnswer, processResult, processError) == 
    18791905 
    18801906{{{ 
     
    19111937}}} 
    19121938 
    1913 === validation: be_sendChallengeAnswer (challengeAnswer, processResult, processError) === 
     1939=== validation: be_sendChallengeAnswer (challengeAnswer, processResult, processError) == 
    19141940||'''value'''||'''name'''||'''description'''||'''implemented''' 
    19151941||soWebUsername||login||check of combination username, password and answer||SOAP API (backend) 
     
    19181944 
    19191945 
    1920 === be_getMessageList (null, processResult, processError) === 
     1946== be_getMessageList (null, processResult, processError) == 
    19211947 
    19221948{{{ 
     
    19531979}}} 
    19541980 
    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) == 
    19631989 
    19641990{{{ 
     
    20062032                        isRejectable: true, from: "henri.tel", to: "cartman", 
    20072033                        received: "2008-06-15 04:20", 
    2008                         coverNote: "Duh=== "} ] 
     2034                        coverNote: "Duh== "} ] 
    20092035}; 
    20102036 
     
    20162042}}} 
    20172043 
    2018 === validation: be_getMessageList (null, processResult, processError) === 
     2044=== validation: be_getMessageList (null, processResult, processError) == 
    20192045||'''value'''||'''name'''||'''description'''||'''implemented''' 
    20202046||idList||existance||checks if the ids in list are existing||SOAP API (backend) 
     
    20232049 
    20242050 
    2025 === be_acceptRequestMessage (message, processResult, processError) === 
     2051== be_acceptRequestMessage (message, processResult, processError) == 
    20262052 
    20272053{{{ 
     
    20692095}}} 
    20702096 
    2071 === validation: be_acceptRequestMessage (message, processResult, processError) === 
     2097=== validation: be_acceptRequestMessage (message, processResult, processError) == 
    20722098||'''value'''||'''name'''||'''description'''||'''implemented''' 
    20732099||id||existance||checks if the ids in list are existing||SOAP API (backend) 
     
    20782104 
    20792105 
    2080 === be_acceptRequestMessages (message, processResult, processError) === 
     2106== be_acceptRequestMessages (message, processResult, processError) == 
    20812107 
    20822108{{{ 
     
    21232149}}} 
    21242150 
    2125 === validation: be_acceptRequestMessages (message, processResult, processError) === 
     2151=== validation: be_acceptRequestMessages (message, processResult, processError) == 
    21262152||'''value'''||'''name'''||'''description'''||'''implemented''' 
    21272153||id||existance||checks if the ids in list are existing||SOAP API (backend) 
     
    21312157 
    21322158 
    2133 === be_acceptInvitationMessages (message, processResult, processError) === 
     2159== be_acceptInvitationMessages (message, processResult, processError) == 
    21342160 
    21352161{{{ 
     
    21752201}}} 
    21762202 
    2177 === validation: be_acceptRequestMessages (message, processResult, processError) === 
     2203=== validation: be_acceptRequestMessages (message, processResult, processError) == 
    21782204||'''value'''||'''name'''||'''description'''||'''implemented''' 
    21792205||id||existance||checks if the ids in list are existing||SOAP API (backend) 
     
    21832209 
    21842210 
    2185 === be_rejectMessages (message, processResult, processError) === 
     2211== be_rejectMessages (message, processResult, processError) == 
    21862212 
    21872213{{{ 
     
    22152241}}} 
    22162242 
    2217 === validation: be_rejectMessages (message, processResult, processError) === 
     2243=== validation: be_rejectMessages (message, processResult, processError) == 
    22182244||'''value'''||'''name'''||'''description'''||'''implemented''' 
    22192245||idList||existance||checks if field is not empty or null||AJAX API 
     
    22222248 
    22232249 
    2224 === be_sendFriendingRequest (newReqMessage, processResult, processError) === 
     2250== be_sendFriendingRequest (newReqMessage, processResult, processError) == 
    22252251 
    22262252{{{ 
     
    22612287}}} 
    22622288 
    2263 === validation: be_sendFriendingRequest (newReqMessage, processResult, processError) === 
     2289=== validation: be_sendFriendingRequest (newReqMessage, processResult, processError) == 
    22642290||'''value'''||'''name'''||'''description'''||'''implemented''' 
    22652291||to||existance||checks if field is not empty or null||AJAX API 
     
    22692295 
    22702296 
    2271 === be_sendFriendingInvitation (newInvMessage, processResult, processResult) === 
     2297== be_sendFriendingInvitation (newInvMessage, processResult, processResult) == 
    22722298 
    22732299{{{ 
     
    23152341}}} 
    23162342 
    2317 === validation: be_sendFriendingInvitation (newInvMessage, processResult, processResult) === 
     2343=== validation: be_sendFriendingInvitation (newInvMessage, processResult, processResult) == 
    23182344||'''value'''||'''name'''||'''description'''||'''implemented''' 
    23192345||from||existance||checks if domain is existing (domain is not existing, if not belonging to user)||backend 
    23202346||to||existance||checks SO can deliver message to domain and/or domain is existing||SOAP API (backend) 
    23212347||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"||backend 
    2323  
    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) == 
    23262352 
    23272353{{{ 
     
    23532379}}} 
    23542380 
    2355 === validation: be_getFriendList (friendInput, processResult, processError) === 
     2381=== validation: be_getFriendList (friendInput, processResult, processError) == 
    23562382||'''value'''||'''name'''||'''description'''||'''implemented''' 
    23572383||domainName||presence||checks if domain is not empty or _null_||AJAX API 
     
    23592385 
    23602386 
    2361 === be_deleteFriends (friendInput, processResult, processError) === 
     2387== be_deleteFriends (friendInput, processResult, processError) == 
    23622388 
    23632389{{{ 
     
    23852411 
    23862412 
    2387 === validation: be_deleteFriends (friendInput, processResult, processError) === 
     2413=== validation: be_deleteFriends (friendInput, processResult, processError) == 
    23882414||'''value'''||'''name'''||'''description'''||'''implemented''' 
    23892415||domainName||presence||checks if domain is not empty or _null_||AJAX API 
     
    23922418 
    23932419 
    2394 === be_renameFriend (friendInput, processResult, processError) === 
     2420== be_renameFriend (friendInput, processResult, processError) == 
    23952421 
    23962422{{{ 
     
    24222448}}} 
    24232449 
    2424 === validation: be_renameFriend (friendInput, processResult, processError) === 
     2450=== validation: be_renameFriend (friendInput, processResult, processError) == 
    24252451||'''value'''||'''name'''||'''description'''||'''implemented''' 
    24262452||domainName||presence||checks if domain is not empty or _null_||AJAX API 
     
    24302456 
    24312457 
    2432 == Keyword management == 
     2458= Keyword management = 
    24332459 
    24342460Currently available keyword types (short forms): 
    24352461`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` 
    24362462 
    2437 === be_getValidKeywords (null, processResult, processError) === 
     2463== be_getValidKeywords (null, processResult, processError) == 
    24382464 
    24392465{{{ 
     
    24682494}}} 
    24692495 
    2470 === validation: be_getValidKeywords (null, processResult, processError) === 
     2496=== validation: be_getValidKeywords (null, processResult, processError) == 
    24712497no validation required as the method does not have any input values 
    24722498 
    24732499 
    2474 === be_getKeywords (domain, processResult, processError) === 
     2500== be_getKeywords (domain, processResult, processError) == 
    24752501 
    24762502{{{ 
     
    25092535}}} 
    25102536 
    2511 === validation: be_getKeywords (domain, processResult, processError) === 
     2537=== validation: be_getKeywords (domain, processResult, processError) == 
    25122538||'''value'''||'''name'''||'''description'''||'''implemented''' 
    25132539||domainName||presence||checks if domain is not empty or null||AJAX API 
     
    25162542 
    25172543 
    2518 === be_getSuggestions (inputKeyword, processResult, processError) === 
     2544== be_getSuggestions (inputKeyword, processResult, processError) == 
    25192545 
    25202546{{{ 
     
    25482574}}} 
    25492575 
    2550 === validation: be_getSuggestions (inputKeyword, processResult, processError) === 
     2576=== validation: be_getSuggestions (inputKeyword, processResult, processError) == 
    25512577||'''value'''||'''name'''||'''description'''||'''implemented''' 
    25522578||type||presence||checks if the type is not empty or null||SOAP API 
     
    25552581 
    25562582 
    2557 === be_addKeyword (newKeyword, processResult, processError) === 
     2583== be_addKeyword (newKeyword, processResult, processError) == 
    25582584 
    25592585{{{ 
     
    25882614}}} 
    25892615 
    2590 === validation: be_addKeyword (newKeyword, processResult, processError) === 
     2616=== validation: be_addKeyword (newKeyword, processResult, processError) == 
    25912617||'''value'''||'''name'''||'''description'''||'''implemented''' 
    25922618||domainName||presence||checks if domain is not empty or _null_||SOAP API 
     
    25942620||type||presence||checks if the type is not empty or null||SOAP API 
    25952621||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||backend 
     2622||type||limit||checks if the use is allowed to create a new search data entry based on "Max.  * of keywords" permission||backend 
    25972623||type||allowed||checks if use is allowed to use the given type based  "Allowed keywords" permission||backend 
    25982624 
    25992625 
    2600 === be_addSecondaryKeywords (newKeywords, processResult, processError) === 
     2626== be_addSecondaryKeywords (newKeywords, processResult, processError) == 
    26012627 
    26022628{{{ 
     
    26352661}}} 
    26362662 
    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 
    26392666||domainName||presence||checks if domain is not empty or null||SOAP API 
    26402667||domainName||existance||checks if domain is existing (domain is not existing, if not belonging to user)||backend 
     
    26422669||primaryKeywordId||secondary keywords allowed||checks if primary keyword is capabile for secondary keywords||backend 
    26432670||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||backend 
     2671||keywords.sp||limit||checks if the use is allowed to create a new search data entry based on "Max.  * of keywords" permission||backend 
    26452672||keywords.sp||allowed||checks if use is allowed to use the given type based  "Allowed keywords" permission||backend 
    26462673 
    2647 === be_updateKeyword (keywordData, processResult, processError) === 
     2674== be_updateKeyword (keywordData, processResult, processError) == 
    26482675 
    26492676{{{ 
     
    26832710}}} 
    26842711 
    2685 === be_deleteKeywords (keywords, processResult, processError) === 
     2712== be_deleteKeywords (keywords, processResult, processError) == 
    26862713 
    26872714{{{ 
     
    27092736}}} 
    27102737 
    2711 === validation: be_deleteKeywords (keywords, processResult, processError) === 
     2738=== validation: be_deleteKeywords (keywords, processResult, processError) == 
    27122739||'''value'''||'''name'''||'''description'''||'''implemented''' 
    27132740||domainName||presence||checks if domain is not empty or _null_||backend 
     
    27162743 
    27172744 
    2718 === be_copyKeywords (keywords, processResult, processError) === 
     2745== be_copyKeywords (keywords, processResult, processError) == 
    27192746 
    27202747{{{ 
     
    27552782}}} 
    27562783 
    2757 === validation: be_copyKeywords (keywords, processResult, processError) === 
     2784=== validation: be_copyKeywords (keywords, processResult, processError) == 
    27582785||'''value'''||'''name'''||'''description'''||'''implemented''' 
    27592786||domainName||presence||checks if domain is not empty or _null_||SOAP API 
     
    27652792 
    27662793 
    2767 === be_moveKeywords (keywords, processResult, processError) === 
     2794== be_moveKeywords (keywords, processResult, processError) == 
    27682795 
    27692796{{{ 
     
    28012828}}} 
    28022829 
    2803 === validation: be_moveKeywords (keywords, processResult, processError) === 
     2830=== validation: be_moveKeywords (keywords, processResult, processError) == 
    28042831||'''value'''||'''name'''||'''description'''||'''implemented''' 
    28052832||domainName||presence||checks if domain is not empty or _null_||SOAP API 
     
    28112838 
    28122839 
    2813 === be_reorderSubkeywords (subkeywordOrder, processResult, processError) === 
     2840== be_reorderSubkeywords (subkeywordOrder, processResult, processError) == 
    28142841 
    28152842{{{ 
     
    28432870}}} 
    28442871 
    2845 === validation: be_reorderSubkeywords (subkeywordOrder, processResult, processError) === 
     2872=== validation: be_reorderSubkeywords (subkeywordOrder, processResult, processError) == 
    28462873||'''value'''||'''name'''||'''description'''||'''implemented''' 
    28472874||domain||presence||checks if domain is not empty or _null_||SOAP API 
Telnic
Search This Site
Partners
Neustar
ICANN
Main site | WHOIS | Sell .tel | FAQ | Archived Site | About Telnic | Contact Us