NaNoWriMo API: A proposal

Background

The original NaNoWriMo wcapi (wordcount API) was designed by NewMexicoKid and firebus in 2005 for use on NaNoWriMo's xoops framework. It focused on providing information through XML. This was adapted and extended for use with the current drupal framework. Since that time, web 2.0 has continued to evolve and XML has generally been replaced by JSON for web APIs since JSON is lighterweight.

The intent of this page is to put forth a redesign and further extension of the wcapi to create a new nanoapi (NaNoWriMo API).

Historical/Existing use cases

wchistory - word count history

To get the wordcount history, use the following URL, using your numerical uid.

http://www.nanowrimo.org/modules/wordcount_api/wchistory/30837

You can find any user's uid by navigating to their profile page and examining the URL.

The wordcount history will be returned in a JSON structure:

   {
      "wchistory": {
         "uid": "30837",
         "error": "error message if applicable",
         "uname": "NewMexicoKid",
         "user_wordcount": "4200",
         "wordcounts": {
            "wcentry": {
               "wc": "4200",
               "wcdate"; "2011-11-04"
            }
            "wcentry": {
               "wc": "3805",
               "wcdate"; "2011-11-03"
            }
         }
      }
   }