Changes between Version 17 and Version 18 of RestfulAPI


Ignore:
Timestamp:
06/27/08 09:48:24 (6 years ago)
Author:
johnbywater
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • RestfulAPI

    v17 v18  
    11= The CKAN RESTful API = 
    22 
    3 == URIs == 
     3== Locations == 
    44 
    5  * !http://ckan.net/api/rest/package/list 
    6  * !http://ckan.net/api/rest/package/create/:name 
    7  * !http://ckan.net/api/rest/package/update/:name 
    8  * !http://ckan.net/api/rest/package/read/:name 
     5|| '''Resourse Name''' || '''Location''' || 
     6|| Package Register || !http://ckan.net/api/rest/package || 
     7|| Package Entity || !http://ckan.net/api/rest/package/NAME || 
     8|| Tags Regsiter || !http://ckan.net/api/rest/tag || 
     9|| Tag Entity || !http://ckan.net/api/rest/tag/NAME || 
    910 
    10 e.g. to get a list of all packages on CKAN visit: 
     11== Methods, Data Formats, Status Codes == 
    1112 
    12 http://www.ckan.net/api/rest/package/list 
    13  
    14 == Data Formats == 
    15  
    16 || '''Request''' || HTTP Parameters || 
    17 || '''Response''' || JSON || 
    18  
    19 == POST Method Params == 
    20  
    21 === Create POST === 
    22  
    23 || '''Name''' || '''Value''' || 
    24 || name || lower case  alphanumeric string, optionally with dashes and underscores, string length at least 2 characters || 
    25  
    26 === Update POST === 
    27  
    28 || '''Name''' || '''Value''' || 
    29 || name || established name string (can't be updated) || 
    30 || title || string || 
    31 || url || string || 
    32 || download_url || string || 
    33 || licences || list of license ids || 
    34 || tags || space-separated list of tag strings || 
    35 || notes || multi-line string || 
    36 || log_message || string || 
     13|| '''Resource Name''' || '''HTTP Method''' || '''Data Format''' || ''Status Codes''    || 
     14|| Packages Register   || GET               || Package-List      ||  200, 301, 401      || 
     15|| Packages Register   || POST              || Package           ||  200, 301, 401, 409 || 
     16|| Package Entity      || GET               || Package           ||  200, 301, 401, 404 || 
     17|| Package Entity      || PUT               || Package           ||  200, 301, 401, 404 || 
     18|| Package Entity      || DELETE            || None              ||  200, 301, 401, 404 || 
     19|| Tags Register       || GET               || Tag-List          ||  200, 301, 401      || 
     20|| Tags Register       || POST              || Tag               ||  200, 301, 401, 409 || 
     21|| Tag Entity          || GET               || Tag               ||  200, 301, 401, 404 || 
     22|| Tag Entity          || PUT               || Tag               ||  200, 301, 401, 404 || 
     23|| Tag Entity          || DELETE            || None              ||  200, 301, 401, 404 || 
    3724 
    3825 
    39 == Methods == 
    40   
    41 || '''Action''' || '''Methods''' ||  
    42 || list || GET || 
    43 || create || POST || 
    44 || update || POST || 
    45 || read || GET || 
     26== Status Codes == 
    4627 
    47 == Status Codes == 
    48   
    49 || '''Action-Method''' || '''Success''' || '''Exception''' || 
    50 || list GET || 200 || 400 Invalid Request, 404 Not Found || 
    51 || create POST || 200 || 400 Invalid Request, 409 Conflict || 
    52 || update POST || 200 || 400 Invalid Request || 
    53 || read GET || 200 || 404 Not Found || 
    54  
     28|| '''Code''' || '''Name'''         || 
     29|| 200        || OK                 || 
     30|| 301        || Moved Permanently  || 
     31|| 401        || Not Authorised     || 
     32|| 404        || Not Found          || 
     33|| 409        || Conflict           ||