wordnik 4.06.01 → 4.06.02

data/api_docs/tag.json

@@ -1 +1 @@
-{"endPoints":[{"path":"/tag","description":"","operations":[{"response":[{"valueType":"doc","errorResponses":[{"reason":"No data available","code":404}],"condition":"any"}],"category":"Help","summary":"Returns information about API parameters","suggestedName":"getHelp","deprecated":false,"open":true,"httpMethod":"GET"}]},{"path":"/tag.{format}/{tag}/word","description":"","operations":[{"parameters":[{"name":"tag","description":"Tag to fetch words for","required":false,"dataType":"string","paramType":"path"},{"name":"userName","description":"Username to restrict results to","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[wordObject]","errorResponses":[{"reason":"Invalid Tag supplied.","code":400},{"reason":"User not found to filter by.","code":404}],"condition":"any"}],"category":"Words","summary":"Fetches Words with a specific Tag.","suggestedName":"getWordsTagged","deprecated":false,"open":false,"httpMethod":"GET"}]}],"models":[{"name":"error","fields":[{"name":"reason","required":false,"paramType":"string"},{"name":"code","required":false,"paramType":"int"}]},{"name":"wordObject","fields":[{"name":"word","required":false,"paramType":"string"},{"name":"vulgar","required":false,"paramType":"string"}]},{"name":"response","fields":[{"name":"valueType","required":false,"paramType":"string"},{"name":"errorResponses","required":false,"paramType":"List[error]"},{"name":"occurs","required":false,"paramType":"string"},{"name":"condition","required":false,"paramType":"string"}]},{"name":"parameter","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"defaultValue","required":false,"paramType":"string"},{"name":"description","required":false,"paramType":"string"},{"name":"required","required":false,"paramType":"boolean"},{"name":"dataType","required":false,"paramType":"string"},{"name":"allowableValues","required":false,"paramType":"string"},{"name":"wrapperName","required":false,"paramType":"string"},{"name":"internalDescription","required":false,"paramType":"string"},{"name":"paramAccess","required":false,"paramType":"string"},{"name":"paramType","required":false,"paramType":"string"}]},{"name":"doc","fields":[{"name":"endPoints","required":false,"paramType":"List[endpoint]"},{"name":"models","required":false,"paramType":"List[object]"}]},{"name":"object","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"fields","required":false,"paramType":"List[parameter]"},{"name":"uniqueFieldName","required":false,"paramType":"string"}]},{"name":"endpoint","fields":[{"name":"path","required":false,"paramType":"string"},{"name":"description","required":false,"paramType":"string"},{"name":"operations","required":false,"paramType":"List[operation]"}]},{"name":"operation","fields":[{"name":"parameters","required":false,"paramType":"List[parameter]"},{"name":"response","required":false,"paramType":"List[response]"},{"name":"category","required":false,"paramType":"string"},{"name":"summary","required":false,"paramType":"string"},{"name":"suggestedName","required":false,"paramType":"string"},{"name":"deprecated","required":false,"paramType":"boolean"},{"name":"open","required":false,"paramType":"boolean"},{"name":"notes","required":false,"paramType":"string"},{"name":"httpMethod","required":false,"paramType":"string"}]}]}
+{"endPoints":[{"path":"/tag","description":"","operations":[{"response":[{"valueType":"doc","errorResponses":[{"reason":"No data available","code":404}],"condition":"any"}],"category":"Help","summary":"Returns information about API parameters","suggestedName":"getHelp","deprecated":false,"open":true,"httpMethod":"GET"}]},{"path":"/tag.{format}/{tag}/word","description":"","operations":[{"parameters":[{"name":"tag","description":"Tag to fetch words for","required":false,"dataType":"string","paramType":"path"},{"name":"userName","description":"Username to restrict results to","required":false,"dataType":"string","paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[wordObject]","errorResponses":[{"reason":"Invalid Tag supplied.","code":400},{"reason":"User not found to filter by.","code":404}],"condition":"any"}],"category":"Words","summary":"Fetches Words with a specific Tag.","suggestedName":"getWordsTagged","deprecated":false,"open":false,"httpMethod":"GET"}]}],"models":[{"name":"error","fields":[{"name":"reason","required":false,"paramType":"string"},{"name":"code","required":false,"paramType":"int"}]},{"name":"wordObject","fields":[{"name":"word","required":false,"paramType":"string"},{"name":"vulgar","required":false,"paramType":"string"}]},{"name":"response","fields":[{"name":"valueType","required":false,"paramType":"string"},{"name":"errorResponses","required":false,"paramType":"List[error]"},{"name":"occurs","required":false,"paramType":"string"},{"name":"condition","required":false,"paramType":"string"}]},{"name":"parameter","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"defaultValue","required":false,"paramType":"string"},{"name":"description","required":false,"paramType":"string"},{"name":"required","required":false,"paramType":"boolean"},{"name":"dataType","required":false,"paramType":"string"},{"name":"allowableValues","required":false,"paramType":"string"},{"name":"wrapperName","required":false,"paramType":"string"},{"name":"internalDescription","required":false,"paramType":"string"},{"name":"paramAccess","required":false,"paramType":"string"},{"name":"paramType","required":false,"paramType":"string"}]},{"name":"doc","fields":[{"name":"endPoints","required":false,"paramType":"List[endpoint]"},{"name":"models","required":false,"paramType":"List[object]"}]},{"name":"object","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"fields","required":false,"paramType":"List[parameter]"},{"name":"uniqueFieldName","required":false,"paramType":"string"}]},{"name":"endpoint","fields":[{"name":"path","required":false,"paramType":"string"},{"name":"description","required":false,"paramType":"string"},{"name":"operations","required":false,"paramType":"List[operation]"}]},{"name":"operation","fields":[{"name":"parameters","required":false,"paramType":"List[parameter]"},{"name":"response","required":false,"paramType":"List[response]"},{"name":"category","required":false,"paramType":"string"},{"name":"summary","required":false,"paramType":"string"},{"name":"suggestedName","required":false,"paramType":"string"},{"name":"deprecated","required":false,"paramType":"boolean"},{"name":"open","required":false,"paramType":"boolean"},{"name":"notes","required":false,"paramType":"string"},{"name":"httpMethod","required":false,"paramType":"string"}]}]}

data/api_docs/user.json

@@ -1 +1 @@
-{"endPoints":[{"path":"/user.{format}/{username}/wordOfTheDayList","description":"","operations":[{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","paramType":"path"},{"name":"includeAll","description":"Include future words (owner-only)","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"wordOfTheDayList","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"No WordOfTheDayList available","code":404}],"condition":"any"}],"category":"WordOfTheDayList","summary":"Returns a user's WordOfTheDayList","suggestedName":"getWordOfTheDayList","deprecated":false,"open":false,"httpMethod":"GET"},{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","paramType":"path"},{"description":"WordOfTheDayList to create, provided in the format specified by the URL","required":true,"dataType":"wordOfTheDayList","paramType":"body"}],"response":[{"valueType":"wordOfTheDayList","errorResponses":[{"reason":"User already has a list or list is invalid","code":400},{"reason":"User not found","code":404}],"condition":"any"}],"category":"WordOfTheDayList","summary":"Creates a WordOfTheDayList","suggestedName":"createWordOfTheDayList","deprecated":false,"open":false,"notes":"A user can have only one WordOfTheDayList.","httpMethod":"POST"},{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","paramType":"path"},{"description":"Updated WordOfTheDayList data in the format specified by the URL","required":true,"dataType":"wordOfTheDayList","paramType":"body"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"Not authorized to perform update","code":403},{"reason":"No WordOfTheDayList available","code":404}],"condition":"any"}],"category":"WordOfTheDayList","summary":"Updates a user's WordOfTheDayList","suggestedName":"updateWordOfTheDayList","deprecated":false,"open":false,"httpMethod":"PUT"}]},{"path":"/user.{format}/{username}/wordOfTheDayList/{permalink}","description":"","operations":[{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","paramType":"path"},{"name":"permalink","description":"Permalink of WordOfTheDayList to delete","required":true,"dataType":"string","paramType":"path"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"Not authorized to perform update","code":403},{"reason":"No WordOfTheDayList available","code":404}],"condition":"any"}],"category":"WordOfTheDayList","summary":"Deletes a user's WordOfTheDayList","suggestedName":"updateWordOfTheDayList","deprecated":false,"open":false,"httpMethod":"DELETE"},{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","paramType":"path"},{"name":"permalink","description":"Permalink of the WordOfTheDayList to add the WordOfTheDay to","required":true,"dataType":"string","paramType":"path"},{"description":"WordOfTheDay to add, in the format specified by the URL","required":true,"dataType":"WordOfTheDay","paramType":"body"}],"response":[{"valueType":"void","errorResponses":[{"reason":"WordOfTheDay already scheduled on this date","code":400},{"reason":"Not authorized to perform modification","code":403},{"reason":"No WordOfTheDayList available to add to","code":404}],"condition":"any"}],"category":"WordOfTheDayList","summary":"Adds a WordOfTheDay to a user's WordOfTheDayList","suggestedName":"updateItemInWordOfTheDayList","deprecated":false,"open":false,"httpMethod":"PUT"}]},{"path":"/user.{format}/{username}/profile","description":"","operations":[{"parameters":[{"name":"username","description":"Username to fetch profile for.","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"UserProfile","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"condition":"any"}],"category":"UserInfo","summary":"Returns a UserProfile","suggestedName":"getUserProfile","deprecated":false,"open":false,"httpMethod":"GET"},{"parameters":[{"name":"username","description":"Username to fetch profile for.","required":false,"dataType":"string","paramType":"path"},{"description":"Updated UserProfile.","required":false,"dataType":"UserProfile","paramType":"body"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"condition":"any"}],"category":"UserInfo","summary":"Updates a UserProfile","suggestedName":"updateUserProfile","deprecated":false,"open":false,"httpMethod":"PUT"}]},{"path":"/user.{format}/{username}/trackingInfo","description":"","operations":[{"parameters":[{"name":"username","description":"Username to fetch tracking info for.","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"UserTrackingInfo","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"condition":"any"}],"category":"UserInfo","summary":"Returns a user's tracking info","suggestedName":"getUserTrackingInfo","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/user.{format}/{username}","description":"","operations":[{"parameters":[{"name":"username","description":"Username to update.","required":false,"dataType":"string","paramType":"path"},{"description":"Updated User object.","required":false,"dataType":"user","paramType":"body"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid username supplied or username/email already in use.","code":400},{"reason":"User not found","code":404}],"condition":"any"}],"category":"UserInfo","summary":"Updates a User","suggestedName":"updateUser","deprecated":false,"open":false,"httpMethod":"PUT"},{"parameters":[{"name":"username","description":"Username to get.","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"user","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found","code":404}],"condition":"any"}],"category":"UserInfo","summary":"Fetches a User","suggestedName":"getUser","deprecated":false,"open":false,"httpMethod":"GET"},{"parameters":[{"name":"username","description":"Username to update.","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid username supplied or username/email already in use.","code":400},{"reason":"User not found","code":404}],"condition":"any"}],"category":"UserInfo","summary":"Deletes a User","suggestedName":"deleteUser","deprecated":false,"open":false,"httpMethod":"DELETE"}]},{"path":"/user.{format}/{username}/wordOfTheDayList/{permalink}/add","description":"","operations":[{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","paramType":"path"},{"name":"permalink","description":"WordOfTheDayList to modify","required":true,"dataType":"string","paramType":"path"},{"description":"WordOfTheDay to add","required":true,"dataType":"WordOfTheDay","paramType":"body"}],"response":[{"valueType":"void","errorResponses":[{"reason":"WordOfTheDay already scheduled on this date","code":400},{"reason":"Not authorized to perform modification","code":403},{"reason":"No WordOfTheDayList available to add to","code":404}],"condition":"any"}],"category":"WordOfTheDayList","summary":"Adds an item to a user's WordOfTheDayList","suggestedName":"addWordToWordOfTheDayList","deprecated":false,"open":false,"httpMethod":"PUT"}]},{"path":"/user.{format}/{username}/wordOfTheDayList/{permalink}/{wordToDelete}","description":"","operations":[{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","paramType":"path"},{"name":"permalink","description":"Permalink of WordOfTheDayList to delete a word from","required":true,"dataType":"string","paramType":"path"},{"name":"wordToDelete","description":"Word to delete","required":true,"dataType":"string","paramType":"path"}],"response":[{"valueType":"void","errorResponses":[{"reason":"WordOfTheDay already scheduled on this date","code":400},{"reason":"Not authorized to perform modification","code":403},{"reason":"No WordOfTheDayList available to add to","code":404}],"condition":"any"}],"category":"WordOfTheDayList","summary":"Deletes a specific word from a user's WordOfTheDayList","suggestedName":"deleteWordFromWordOfTheDayList","deprecated":false,"open":false,"httpMethod":"DELETE"}]},{"path":"/user.{format}/{username}/wordOfTheDay/{date}","description":"","operations":[{"parameters":[{"name":"username","description":"Username of the WordOfTheDay owner","required":true,"dataType":"string","paramType":"path"},{"name":"date","description":"Date of the WordOfTheDay to retrieve (yyyy-MM-dd) format","required":true,"dataType":"string","paramType":"path"},{"name":"includeAll","description":"Include WordOfTheDay items for future dates (owner-only)","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"WordOfTheDay","errorResponses":[{"reason":"Invalid username or dateString supplied","code":400},{"reason":"User not found or no list available","code":404}],"condition":"any"}],"category":"WordOfTheDayList","summary":"Returns the WordOfTheDay for a given user on a given date","suggestedName":"getWordOfTheDayByDate","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/user.{format}/{username}/wordLists","description":"","operations":[{"parameters":[{"name":"username","description":"Username to fetch WordLists for.","required":false,"dataType":"string","paramType":"path"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"},{"name":"sortBy","required":true,"dataType":"string","paramType":"query"},{"name":"sortOrder","required":true,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[wordList]","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found","code":404}],"condition":"any"}],"category":"UserWordLists","summary":"Gets WordLists for a User.","suggestedName":"getUserWordLists","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/user.{format}/{username}/wordListsCount","description":"","operations":[{"parameters":[{"name":"username","description":"Username to fetch WordLists for.","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"long","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found","code":404}],"condition":"any"}],"category":"UserWordLists","summary":"Gets the count of WordLists for a User.","suggestedName":"getUserWordListCount","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/user.{format}/{username}/settings","description":"","operations":[{"parameters":[{"name":"username","description":"Username to fetch settings for.","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"UserSettings","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"condition":"any"}],"category":"UserInfo","summary":"Returns a user's settings","suggestedName":"getUserSettings","deprecated":false,"open":false,"httpMethod":"GET"},{"parameters":[{"name":"username","description":"Username to fetch profile for.","required":false,"dataType":"string","paramType":"path"},{"description":"Updated UserSettings.","required":false,"dataType":"UserSettings","paramType":"body"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"condition":"any"}],"category":"UserInfo","summary":"Updates a user's settings","suggestedName":"updateUserSettings","deprecated":false,"open":false,"httpMethod":"PUT"}]},{"path":"/user.{format}/{username}/apiKey","description":"","operations":[{"parameters":[{"name":"username","description":"Username to fetch api key for.","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"Principal","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404},{"reason":"API key not found","code":409}],"condition":"any"}],"category":"UserInfo","summary":"Returns the API key for the specified user","suggestedName":"getApiKeyForUser","deprecated":false,"open":false,"notes":"Use the super user API key for getting this information or auth token of the user who is requesting the API key","httpMethod":"GET"}]},{"path":"/user.{format}/{username}/comment","description":"","operations":[{"parameters":[{"name":"username","description":"Username to comment on.","required":false,"dataType":"string","paramType":"path"},{"description":"Comment to save.","required":false,"dataType":"comment","paramType":"body"}],"response":[{"valueType":"comment","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"condition":"any"}],"category":"UgcInfo","summary":"Adds a Comment on a User","suggestedName":"commentOnUser","deprecated":false,"open":false,"httpMethod":"POST"},{"parameters":[{"name":"username","description":"Username with Comment.","required":false,"dataType":"string","paramType":"path"},{"description":"Updated Comment.","required":false,"dataType":"comment","paramType":"body"}],"response":[{"valueType":"comment","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"condition":"any"}],"category":"UgcInfo","summary":"Updates a Comment on a User","suggestedName":"updateCommentOnUser","deprecated":false,"open":false,"httpMethod":"PUT"}]},{"path":"/user.{format}/{username}/comment/{commentId}","description":"","operations":[{"parameters":[{"name":"username","description":"Username with Comment.","required":false,"dataType":"string","paramType":"path"},{"name":"commentId","description":"Updated Comment.","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"condition":"any"}],"category":"UgcInfo","summary":"Deletes a Comment on a User","suggestedName":"deleteCommentOnUser","deprecated":false,"open":false,"httpMethod":"DELETE"},{"parameters":[{"name":"username","description":"Username with Comment.","required":false,"dataType":"string","paramType":"path"},{"name":"commentId","description":"Comment ID.","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"comment","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"condition":"any"}],"category":"UgcInfo","summary":"Fetches a comment by ID","suggestedName":"getCommentOnUserById","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/user.{format}/{username}/commentsOnCount","description":"","operations":[{"parameters":[{"name":"username","description":"Username to get count for.","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"long","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"condition":"any"}],"category":"UgcInfo","summary":"Returns a count of Comments on a user","suggestedName":"getCommentsOnUserCount","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/user.{format}/{username}/commentsByCount","description":"","operations":[{"parameters":[{"name":"username","description":"Username to get count by.","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"long","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"condition":"any"}],"category":"UgcInfo","summary":"Returns a count of Comments by a user","suggestedName":"getCommentsByUserCount","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/user.{format}/{username}/commentsBy","description":"","operations":[{"parameters":[{"name":"username","description":"Username to get count by.","required":false,"dataType":"string","paramType":"path"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"},{"name":"sortOrder","description":"Sort order","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[comment]","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"condition":"any"}],"category":"UgcInfo","summary":"Returns Comments by a user","suggestedName":"getCommentsByUser","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/user.{format}/{username}/commentsOnUser","description":"","operations":[{"parameters":[{"name":"username","description":"Username to get count by.","required":false,"dataType":"string","paramType":"path"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"},{"name":"sortOrder","description":"Sort order","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[comment]","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"condition":"any"}],"category":"UgcInfo","summary":"Returns Comments on a user","suggestedName":"getCommentsOnUser","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/user.{format}/{username}/ugcSummary","description":"","operations":[{"parameters":[{"name":"username","description":"Username to get statistics for.","required":false,"dataType":"string","paramType":"path"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"},{"name":"sortOrder","description":"Sort order","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"UgcSummary","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"condition":"any"}],"category":"UgcInfo","summary":"Returns UgcSummary info a user","suggestedName":"getUgcSummaryForUser","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/user.{format}/{user}/tagHistory","description":"","operations":[{"parameters":[{"name":"user","description":"User to fetch History for","required":false,"dataType":"string","paramType":"path"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[userTagHistory]","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found to filter by.","code":404}],"condition":"any"}],"category":"Tags","summary":"Fetches TagHistory for a User.","suggestedName":"getUserTagHistory","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/user.{format}/{user}/tags","description":"","operations":[{"parameters":[{"name":"user","description":"User to fetch Tags for","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"List[tag]","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found to filter by.","code":404}],"condition":"any"}],"category":"Tags","summary":"Fetches Tags by a User.","suggestedName":"getUserTags","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/user.{format}/{user}/tagCount","description":"","operations":[{"parameters":[{"name":"user","description":"User to fetch Tag count for","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"long","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found.","code":404}],"condition":"any"}],"category":"Tags","summary":"Fetches the count of Tags created by a User.","suggestedName":"getUserTagCount","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/user.{format}/{user}/subscriptions","description":"","operations":[{"parameters":[{"name":"user","description":"User to fetch subscriptions for","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"List[SubscriptionType]","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"Not authorized to fetch subscriptions.","code":403},{"reason":"User not found.","code":404}],"condition":"any"}],"category":"Subscriptions","summary":"Fetches all subscriptions for a User.","suggestedName":"getSubscriptions","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/user.{format}/{user}/subscriptions/{objectType}/{objectIdentifier}","description":"","operations":[{"parameters":[{"name":"user","description":"User to add subscriptions to","required":false,"dataType":"string","paramType":"path"},{"name":"objectType","description":"Object Type","required":false,"dataType":"string","paramType":"path"},{"name":"objectIdentifier","description":"Object Identifier","required":false,"dataType":"string","paramType":"path"},{"name":"medium","description":"Subscription medium","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"Not authorized to subscribe user to WordOfTheDayList.","code":403},{"reason":"User not found to filter by.","code":404}],"condition":"any"}],"category":"Subscriptions","summary":"Subscribes to an object.","suggestedName":"addSubscription","deprecated":false,"open":false,"httpMethod":"POST"},{"parameters":[{"name":"user","description":"User to add subscriptions to","required":false,"dataType":"string","paramType":"path"},{"name":"objectType","description":"Object Type","required":false,"dataType":"string","paramType":"path"},{"name":"objectIdentifier","description":"Object Identifier","required":false,"dataType":"string","paramType":"path"},{"name":"medium","description":"Subscription medium","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"Not authorized to subscribe user to WordOfTheDayList.","code":403},{"reason":"User not found to filter by.","code":404}],"condition":"any"}],"category":"Subscriptions","summary":"Deletes a subscription to an object.","suggestedName":"removeSubscription","deprecated":false,"open":false,"httpMethod":"DELETE"}]},{"path":"/user.{format}/{user}/favorites/words","description":"","operations":[{"parameters":[{"name":"user","description":"User to fetch Favorite Words for","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"List[wordObject]","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found to filter by.","code":404}],"condition":"any"}],"category":"Favorites","summary":"Fetches Favorite Words for a user.","suggestedName":"getUserFavoriteWords","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/user.{format}/{user}/favorites/wordCount","description":"","operations":[{"parameters":[{"name":"user","description":"User to fetch Favorite Words for","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"long","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found to filter by.","code":404}],"condition":"any"}],"category":"Favorites","summary":"Fetches favorite word count for a user.","suggestedName":"getUserFavoriteCount","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/user.{format}/{user}/favorites/wordLists","description":"","operations":[{"parameters":[{"name":"user","description":"User to fetch Favorite WordLists for","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"List[wordList]","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found to filter by.","code":404}],"condition":"any"}],"category":"Favorites","summary":"Fetches Favorite WordLists for a user.","suggestedName":"getUserFavoriteWordLists","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/user.{format}/{user}/favorites/wordListCount","description":"","operations":[{"parameters":[{"name":"user","description":"User to fetch Favorite WordList count for","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"long","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found to filter by.","code":404}],"condition":"any"}],"category":"Favorites","summary":"Fetches Favorite WordList count for a user.","suggestedName":"getUserFavoriteWordListsCount","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/user.{format}/{user}/searches","description":"","operations":[{"parameters":[{"name":"user","description":"User to fetch History for","required":false,"dataType":"string","paramType":"path"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[recentLookup]","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found to filter by.","code":404}],"condition":"any"}],"category":"Activity","summary":"Fetches SearchHistory for a User.","suggestedName":"getUserSearchHistory","deprecated":false,"open":false,"httpMethod":"GET"},{"parameters":[{"name":"user","description":"User to remove search history for","required":false,"dataType":"string","paramType":"path"},{"name":"word","description":"Word to delete","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[recentLookup]","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found.","code":404}],"condition":"any"}],"category":"Activity","summary":"Fetches SearchHistory for a User.","suggestedName":"removeUserSearchHistoryItem","deprecated":false,"open":false,"httpMethod":"DELETE"}]},{"path":"/user.{format}/{user}/totalSearches","description":"","operations":[{"parameters":[{"name":"user","description":"User to retrieve search count for","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"long","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found.","code":404}],"condition":"any"}],"category":"Activity","summary":"Fetches the total search count for a User.","suggestedName":"getUserSearchHistoryCount","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/user.{format}/{user}/pronunciations","description":"","operations":[{"parameters":[{"name":"user","description":"User to retrieve search count for","required":false,"dataType":"string","paramType":"path"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[audioObject]","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found.","code":404}],"condition":"any"}],"category":"Activity","summary":"Fetches the total search count for a User.","suggestedName":"getUserPronunciations","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/user.{format}/{user}/activitystream","description":"","operations":[{"parameters":[{"name":"user","description":"User to retrieve search count for","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"long","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found.","code":404}],"condition":"any"}],"category":"Activity","summary":"Fetches the total search count for a User.","suggestedName":"getUserActivityStream","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/user","description":"","operations":[{"response":[{"valueType":"doc","errorResponses":[{"reason":"No data available","code":404}],"condition":"any"}],"category":"Help","summary":"Returns information about API parameters","suggestedName":"getHelp","deprecated":false,"open":true,"httpMethod":"GET"}]}],"models":[{"name":"Principal","fields":[{"name":"id","required":false,"paramType":"long"},{"name":"type","required":false,"paramType":"int"},{"name":"token","required":false,"paramType":"string"},{"name":"wordnikUserId","required":false,"paramType":"long"}]},{"name":"tag","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"id","required":false,"paramType":"long"},{"name":"count","required":false,"paramType":"long"}]},{"name":"userTagHistory","fields":[{"name":"id","required":false,"paramType":"long"},{"name":"tag","required":false,"paramType":"string"},{"name":"userId","required":false,"paramType":"long"},{"name":"wordstring","required":false,"paramType":"string"},{"name":"wordId","required":false,"paramType":"long"},{"name":"tagDate","required":false,"paramType":"Date"},{"name":"tagId","required":false,"paramType":"long"}]},{"name":"object","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"fields","required":false,"paramType":"List[parameter]"},{"name":"uniqueFieldName","required":false,"paramType":"string"}]},{"name":"long","fields":[{"name":"value","required":false,"paramType":"long"}]},{"name":"wordOfTheDayList","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"id","required":true,"paramType":"string"},{"name":"description","required":false,"paramType":"string"},{"name":"category","required":false,"paramType":"string"},{"name":"createdBy","required":false,"paramType":"string"},{"name":"items","required":false,"paramType":"List[WordOfTheDay]"},{"name":"subscriberCount","required":false,"paramType":"int"},{"name":"subscriptionStatus","required":false,"paramType":"string"},{"name":"createdAt","required":false,"paramType":"Date"},{"name":"commentCount","required":false,"paramType":"int"},{"name":"voteCount","required":false,"paramType":"integer"},{"name":"voteAverage","required":false,"paramType":"float"},{"name":"voteWeightedAverage","required":false,"paramType":"float"},{"name":"itemCount","required":false,"paramType":"int"},{"name":"firstItemDate","required":false,"paramType":"Date"},{"name":"lastItemDate","required":false,"paramType":"Date"},{"name":"subscriptionSchedule","required":false,"paramType":"string"},{"name":"subscriptionNamespace","required":false,"paramType":"string"},{"name":"subscriptionIdentifier","required":false,"paramType":"string"}]},{"name":"category","fields":[{"name":"name","required":false,"paramType":"string"}]},{"name":"SubscriptionType","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"items","required":false,"paramType":"List[SubscriptionItem]"}]},{"name":"response","fields":[{"name":"valueType","required":false,"paramType":"string"},{"name":"errorResponses","required":false,"paramType":"List[error]"},{"name":"occurs","required":false,"paramType":"string"},{"name":"condition","required":false,"paramType":"string"}]},{"name":"contentProvider","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"id","required":false,"paramType":"int"}]},{"name":"audioType","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"id","required":false,"paramType":"int"}]},{"name":"doc","fields":[{"name":"endPoints","required":false,"paramType":"List[endpoint]"},{"name":"models","required":false,"paramType":"List[object]"}]},{"name":"root","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"categories","required":false,"paramType":"List[category]"}]},{"name":"audioType","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"id","required":false,"paramType":"int"}]},{"name":"SimpleDefinition","fields":[{"name":"text","required":false,"paramType":"string"},{"name":"partOfSpeech","required":false,"paramType":"string"},{"name":"note","required":false,"paramType":"string"},{"name":"source","required":false,"paramType":"string"}]},{"name":"endpoint","fields":[{"name":"path","required":false,"paramType":"string"},{"name":"description","required":false,"paramType":"string"},{"name":"operations","required":false,"paramType":"List[operation]"}]},{"name":"operation","fields":[{"name":"parameters","required":false,"paramType":"List[parameter]"},{"name":"response","required":false,"paramType":"List[response]"},{"name":"category","required":false,"paramType":"string"},{"name":"summary","required":false,"paramType":"string"},{"name":"suggestedName","required":false,"paramType":"string"},{"name":"deprecated","required":false,"paramType":"boolean"},{"name":"open","required":false,"paramType":"boolean"},{"name":"notes","required":false,"paramType":"string"},{"name":"httpMethod","required":false,"paramType":"string"}]},{"name":"error","fields":[{"name":"reason","required":false,"paramType":"string"},{"name":"code","required":false,"paramType":"int"}]},{"name":"wordObject","fields":[{"name":"word","required":false,"paramType":"string"},{"name":"vulgar","required":false,"paramType":"string"}]},{"name":"UserHandle","fields":[{"name":"webService","required":false,"paramType":"int"},{"name":"handle","required":false,"paramType":"string"}]},{"name":"SubscriptionItem","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"medium","required":false,"paramType":"string"},{"name":"createdAt","required":false,"paramType":"Date"}]},{"name":"comment","fields":[{"name":"objectType","required":false,"paramType":"string"},{"name":"objectId","required":false,"paramType":"long"},{"name":"commentedBy","required":false,"paramType":"string"},{"name":"createdAt","required":false,"paramType":"Date"},{"name":"updatedAt","required":false,"paramType":"Date"},{"name":"commentedOn","required":false,"paramType":"string"},{"name":"id","required":false,"paramType":"string"},{"name":"body","required":false,"paramType":"string"}]},{"name":"UserTrackingInfo","fields":[{"name":"userId","required":false,"paramType":"long"},{"name":"signupIPAddress","required":false,"paramType":"string"},{"name":"noOfLogins","required":false,"paramType":"int"},{"name":"signupDate","required":false,"paramType":"Date"},{"name":"lastUpdatedDate","required":false,"paramType":"Date"},{"name":"lastLoginDate","required":false,"paramType":"Date"}]},{"name":"partOfSpeech","fields":[{"name":"roots","required":false,"paramType":"List[root]"}]},{"name":"recentLookup","fields":[{"name":"wordstring","required":false,"paramType":"string"},{"name":"createdAt","required":false,"paramType":"Date"}]},{"name":"UserProfile","fields":[{"name":"location","required":false,"paramType":"string"},{"name":"userId","required":false,"paramType":"long"},{"name":"firstName","required":false,"paramType":"string"},{"name":"lastName","required":false,"paramType":"string"},{"name":"bio","required":false,"paramType":"string"},{"name":"siteUrl","required":false,"paramType":"string"},{"name":"leastFavoriteWord","required":false,"paramType":"string"},{"name":"mostFavoriteWord","required":false,"paramType":"string"},{"name":"onomaTopoeiaWord","required":false,"paramType":"string"},{"name":"seekingWord","required":false,"paramType":"string"},{"name":"youWord","required":false,"paramType":"string"},{"name":"userHandles","required":false,"paramType":"List[UserHandle]"},{"name":"siteName","required":false,"paramType":"string"}]},{"name":"parameter","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"defaultValue","required":false,"paramType":"string"},{"name":"description","required":false,"paramType":"string"},{"name":"required","required":false,"paramType":"boolean"},{"name":"dataType","required":false,"paramType":"string"},{"name":"allowableValues","required":false,"paramType":"string"},{"name":"wrapperName","required":false,"paramType":"string"},{"name":"internalDescription","required":false,"paramType":"string"},{"name":"paramAccess","required":false,"paramType":"string"},{"name":"paramType","required":false,"paramType":"string"}]},{"name":"wordList","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"id","required":false,"paramType":"long"},{"name":"type","required":false,"paramType":"string"},{"name":"description","required":false,"paramType":"string"},{"name":"userId","required":false,"paramType":"long"},{"name":"permalink","required":false,"paramType":"string"},{"name":"createdAt","required":false,"paramType":"Date"},{"name":"username","required":false,"paramType":"string"},{"name":"updatedAt","required":false,"paramType":"Date"},{"name":"numberWordsInList","required":false,"paramType":"long"}]},{"name":"WordOfTheDay","fields":[{"name":"id","required":true,"paramType":"long"},{"name":"category","required":false,"paramType":"string"},{"name":"example","required":false,"wrapperName":"examples","paramType":"List[SimpleExample]"},{"name":"word","required":false,"paramType":"string"},{"name":"createdBy","required":false,"paramType":"string"},{"name":"definition","required":false,"wrapperName":"definitions","paramType":"List[SimpleDefinition]"},{"name":"contentProvider","required":false,"paramType":"contentProvider"},{"name":"createdAt","required":false,"paramType":"Date"},{"name":"publishDate","required":false,"paramType":"Date"},{"name":"parentId","required":false,"paramType":"string"},{"name":"note","required":false,"paramType":"string"},{"name":"htmlExtra","required":false,"paramType":"string"}]},{"name":"SubscriptionStatus","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"id","required":false,"paramType":"int"}]},{"name":"UserSettings","fields":[{"name":"userId","required":false,"paramType":"long"},{"name":"bossURL","required":false,"paramType":"string"}]},{"name":"UgcSummary","fields":[{"name":"userId","required":false,"paramType":"long"},{"name":"ugcCounters","required":false,"paramType":"Map[string,long]"},{"name":"ugcLabels","required":false,"paramType":"Map[string,string]"},{"name":"ugcEvents","required":false,"paramType":"Map[string,Date]"}]},{"name":"audioObject","fields":[{"name":"id","required":false,"paramType":"long"},{"name":"type","required":false,"paramType":"audioType"},{"name":"description","required":false,"paramType":"string"},{"name":"userId","required":false,"paramType":"long"},{"name":"wordstring","required":false,"paramType":"string"},{"name":"createdBy","required":false,"paramType":"string"},{"name":"createdAt","required":false,"paramType":"Date"},{"name":"wordId","required":false,"paramType":"long"},{"name":"filePath","required":false,"paramType":"string"},{"name":"recordId","required":false,"paramType":"string"},{"name":"audioFileType","required":false,"paramType":"audioType"},{"name":"audioFileId","required":false,"paramType":"long"},{"name":"streamPath","required":false,"paramType":"string"}]},{"name":"user","fields":[{"name":"id","description":"Unique idenitifier for a user","required":false,"paramType":"long"},{"name":"displayName","description":"Display name","required":false,"paramType":"string"},{"name":"status","description":"Account status","required":false,"allowableValues":"0,1,2,3","paramType":"int"},{"name":"password","required":false,"paramType":"string"},{"name":"userName","description":"User name","required":false,"paramType":"string"},{"name":"email","description":"Email address","required":false,"paramType":"string"},{"name":"faceBookId","description":"Facebook ID","required":false,"paramType":"string"}]},{"name":"SimpleExample","fields":[{"name":"url","required":false,"paramType":"string"},{"name":"text","required":false,"paramType":"string"},{"name":"title","required":false,"paramType":"string"},{"name":"id","required":false,"paramType":"long"}]}]}
+{"endPoints":[{"path":"/user.{format}/{username}/wordOfTheDayList","description":"","operations":[{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","paramType":"path"},{"name":"includeAll","description":"Include future words (owner-only)","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"wordOfTheDayList","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"No WordOfTheDayList available","code":404}],"condition":"any"}],"category":"WordOfTheDayList","summary":"Returns a user's WordOfTheDayList","suggestedName":"getWordOfTheDayList","deprecated":false,"open":false,"httpMethod":"GET"},{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","paramType":"path"},{"description":"WordOfTheDayList to create, provided in the format specified by the URL","required":true,"dataType":"wordOfTheDayList","paramType":"body"}],"response":[{"valueType":"wordOfTheDayList","errorResponses":[{"reason":"User already has a list or list is invalid","code":400},{"reason":"User not found","code":404}],"condition":"any"}],"category":"WordOfTheDayList","summary":"Creates a WordOfTheDayList","suggestedName":"createWordOfTheDayList","deprecated":false,"open":false,"notes":"A user can have only one WordOfTheDayList.","httpMethod":"POST"},{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","paramType":"path"},{"description":"Updated WordOfTheDayList data in the format specified by the URL","required":true,"dataType":"wordOfTheDayList","paramType":"body"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"Not authorized to perform update","code":403},{"reason":"No WordOfTheDayList available","code":404}],"condition":"any"}],"category":"WordOfTheDayList","summary":"Updates a user's WordOfTheDayList","suggestedName":"updateWordOfTheDayList","deprecated":false,"open":false,"httpMethod":"PUT"}]},{"path":"/user.{format}/{username}/wordOfTheDayList/{permalink}","description":"","operations":[{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","paramType":"path"},{"name":"permalink","description":"Permalink of WordOfTheDayList to delete","required":true,"dataType":"string","paramType":"path"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"Not authorized to perform update","code":403},{"reason":"No WordOfTheDayList available","code":404}],"condition":"any"}],"category":"WordOfTheDayList","summary":"Deletes a user's WordOfTheDayList","suggestedName":"updateWordOfTheDayList","deprecated":false,"open":false,"httpMethod":"DELETE"},{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","paramType":"path"},{"name":"permalink","description":"Permalink of the WordOfTheDayList to add the WordOfTheDay to","required":true,"dataType":"string","paramType":"path"},{"description":"WordOfTheDay to add, in the format specified by the URL","required":true,"dataType":"WordOfTheDay","paramType":"body"}],"response":[{"valueType":"void","errorResponses":[{"reason":"WordOfTheDay already scheduled on this date","code":400},{"reason":"Not authorized to perform modification","code":403},{"reason":"No WordOfTheDayList available to add to","code":404}],"condition":"any"}],"category":"WordOfTheDayList","summary":"Adds a WordOfTheDay to a user's WordOfTheDayList","suggestedName":"updateItemInWordOfTheDayList","deprecated":false,"open":false,"httpMethod":"PUT"}]},{"path":"/user.{format}/{username}/profile","description":"","operations":[{"parameters":[{"name":"username","description":"Username to fetch profile for.","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"UserProfile","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"condition":"any"}],"category":"UserInfo","summary":"Returns a UserProfile","suggestedName":"getUserProfile","deprecated":false,"open":false,"httpMethod":"GET"},{"parameters":[{"name":"username","description":"Username to fetch profile for.","required":false,"dataType":"string","paramType":"path"},{"description":"Updated UserProfile.","required":false,"dataType":"UserProfile","paramType":"body"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"condition":"any"}],"category":"UserInfo","summary":"Updates a UserProfile","suggestedName":"updateUserProfile","deprecated":false,"open":false,"httpMethod":"PUT"}]},{"path":"/user.{format}/{username}/trackingInfo","description":"","operations":[{"parameters":[{"name":"username","description":"Username to fetch tracking info for.","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"UserTrackingInfo","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"condition":"any"}],"category":"UserInfo","summary":"Returns a user's tracking info","suggestedName":"getUserTrackingInfo","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/user.{format}/{username}","description":"","operations":[{"parameters":[{"name":"username","description":"Username to update.","required":false,"dataType":"string","paramType":"path"},{"description":"Updated User object.","required":false,"dataType":"user","paramType":"body"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid username supplied or username/email already in use.","code":400},{"reason":"User not found","code":404}],"condition":"any"}],"category":"UserInfo","summary":"Updates a User","suggestedName":"updateUser","deprecated":false,"open":false,"httpMethod":"PUT"},{"parameters":[{"name":"username","description":"Username to get.","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"user","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found","code":404}],"condition":"any"}],"category":"UserInfo","summary":"Fetches a User","suggestedName":"getUser","deprecated":false,"open":false,"httpMethod":"GET"},{"parameters":[{"name":"username","description":"Username to update.","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid username supplied or username/email already in use.","code":400},{"reason":"User not found","code":404}],"condition":"any"}],"category":"UserInfo","summary":"Deletes a User","suggestedName":"deleteUser","deprecated":false,"open":false,"httpMethod":"DELETE"}]},{"path":"/user.{format}/{username}/wordOfTheDayList/{permalink}/add","description":"","operations":[{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","paramType":"path"},{"name":"permalink","description":"WordOfTheDayList to modify","required":true,"dataType":"string","paramType":"path"},{"description":"WordOfTheDay to add","required":true,"dataType":"WordOfTheDay","paramType":"body"}],"response":[{"valueType":"void","errorResponses":[{"reason":"WordOfTheDay already scheduled on this date","code":400},{"reason":"Not authorized to perform modification","code":403},{"reason":"No WordOfTheDayList available to add to","code":404}],"condition":"any"}],"category":"WordOfTheDayList","summary":"Adds an item to a user's WordOfTheDayList","suggestedName":"addWordToWordOfTheDayList","deprecated":false,"open":false,"httpMethod":"PUT"}]},{"path":"/user.{format}/{username}/wordOfTheDayList/{permalink}/{wordToDelete}","description":"","operations":[{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","paramType":"path"},{"name":"permalink","description":"Permalink of WordOfTheDayList to delete a word from","required":true,"dataType":"string","paramType":"path"},{"name":"wordToDelete","description":"Word to delete","required":true,"dataType":"string","paramType":"path"}],"response":[{"valueType":"void","errorResponses":[{"reason":"WordOfTheDay already scheduled on this date","code":400},{"reason":"Not authorized to perform modification","code":403},{"reason":"No WordOfTheDayList available to add to","code":404}],"condition":"any"}],"category":"WordOfTheDayList","summary":"Deletes a specific word from a user's WordOfTheDayList","suggestedName":"deleteWordFromWordOfTheDayList","deprecated":false,"open":false,"httpMethod":"DELETE"}]},{"path":"/user.{format}/{username}/wordOfTheDay/{date}","description":"","operations":[{"parameters":[{"name":"username","description":"Username of the WordOfTheDay owner","required":true,"dataType":"string","paramType":"path"},{"name":"date","description":"Date of the WordOfTheDay to retrieve (yyyy-MM-dd) format","required":true,"dataType":"string","paramType":"path"},{"name":"includeAll","description":"Include WordOfTheDay items for future dates (owner-only)","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"WordOfTheDay","errorResponses":[{"reason":"Invalid username or dateString supplied","code":400},{"reason":"User not found or no list available","code":404}],"condition":"any"}],"category":"WordOfTheDayList","summary":"Returns the WordOfTheDay for a given user on a given date","suggestedName":"getWordOfTheDayByDate","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/user.{format}/{username}/wordLists","description":"","operations":[{"parameters":[{"name":"username","description":"Username to fetch WordLists for.","required":false,"dataType":"string","paramType":"path"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"},{"name":"sortBy","defaultValue":"createDate","description":"Field to sort by","required":false,"dataType":"string","allowableValues":"alpha,createDate","paramType":"query"},{"name":"sortOrder","defaultValue":"desc","description":"Direction to sort","required":false,"dataType":"string","allowableValues":"asc,desc","paramType":"query"}],"response":[{"valueType":"List[wordList]","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found","code":404}],"condition":"any"}],"category":"UserWordLists","summary":"Gets WordLists for a User.","suggestedName":"getUserWordLists","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/user.{format}/{username}/wordListsCount","description":"","operations":[{"parameters":[{"name":"username","description":"Username to fetch WordLists for.","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"long","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found","code":404}],"condition":"any"}],"category":"UserWordLists","summary":"Gets the count of WordLists for a User.","suggestedName":"getUserWordListCount","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/user.{format}/{username}/settings","description":"","operations":[{"parameters":[{"name":"username","description":"Username to fetch settings for.","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"UserSettings","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"condition":"any"}],"category":"UserInfo","summary":"Returns a user's settings","suggestedName":"getUserSettings","deprecated":false,"open":false,"httpMethod":"GET"},{"parameters":[{"name":"username","description":"Username to fetch profile for.","required":false,"dataType":"string","paramType":"path"},{"description":"Updated UserSettings.","required":false,"dataType":"UserSettings","paramType":"body"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"condition":"any"}],"category":"UserInfo","summary":"Updates a user's settings","suggestedName":"updateUserSettings","deprecated":false,"open":false,"httpMethod":"PUT"}]},{"path":"/user.{format}/{username}/apiKey","description":"","operations":[{"parameters":[{"name":"username","description":"Username to fetch api key for.","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"Principal","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404},{"reason":"API key not found","code":409}],"condition":"any"}],"category":"UserInfo","summary":"Returns the API key for the specified user","suggestedName":"getApiKeyForUser","deprecated":false,"open":false,"notes":"Use the super user API key for getting this information or auth token of the user who is requesting the API key","httpMethod":"GET"}]},{"path":"/user.{format}/{username}/comment","description":"","operations":[{"parameters":[{"name":"username","description":"Username to comment on.","required":false,"dataType":"string","paramType":"path"},{"description":"Comment to save.","required":false,"dataType":"comment","paramType":"body"}],"response":[{"valueType":"comment","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"condition":"any"}],"category":"UgcInfo","summary":"Adds a Comment on a User","suggestedName":"commentOnUser","deprecated":false,"open":false,"httpMethod":"POST"},{"parameters":[{"name":"username","description":"Username with Comment.","required":false,"dataType":"string","paramType":"path"},{"description":"Updated Comment.","required":false,"dataType":"comment","paramType":"body"}],"response":[{"valueType":"comment","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"condition":"any"}],"category":"UgcInfo","summary":"Updates a Comment on a User","suggestedName":"updateCommentOnUser","deprecated":false,"open":false,"httpMethod":"PUT"}]},{"path":"/user.{format}/{username}/comment/{commentId}","description":"","operations":[{"parameters":[{"name":"username","description":"Username with Comment.","required":false,"dataType":"string","paramType":"path"},{"name":"commentId","description":"Updated Comment.","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"condition":"any"}],"category":"UgcInfo","summary":"Deletes a Comment on a User","suggestedName":"deleteCommentOnUser","deprecated":false,"open":false,"httpMethod":"DELETE"},{"parameters":[{"name":"username","description":"Username with Comment.","required":false,"dataType":"string","paramType":"path"},{"name":"commentId","description":"Comment ID.","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"comment","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"condition":"any"}],"category":"UgcInfo","summary":"Fetches a comment by ID","suggestedName":"getCommentOnUserById","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/user.{format}/{username}/commentsOnCount","description":"","operations":[{"parameters":[{"name":"username","description":"Username to get count for.","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"long","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"condition":"any"}],"category":"UgcInfo","summary":"Returns a count of Comments on a user","suggestedName":"getCommentsOnUserCount","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/user.{format}/{username}/commentsByCount","description":"","operations":[{"parameters":[{"name":"username","description":"Username to get count by.","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"long","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"condition":"any"}],"category":"UgcInfo","summary":"Returns a count of Comments by a user","suggestedName":"getCommentsByUserCount","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/user.{format}/{username}/commentsBy","description":"","operations":[{"parameters":[{"name":"username","description":"Username to get count by.","required":false,"dataType":"string","paramType":"path"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"},{"name":"sortOrder","description":"Sort order","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[comment]","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"condition":"any"}],"category":"UgcInfo","summary":"Returns Comments by a user","suggestedName":"getCommentsByUser","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/user.{format}/{username}/commentsOnUser","description":"","operations":[{"parameters":[{"name":"username","description":"Username to get count by.","required":false,"dataType":"string","paramType":"path"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"},{"name":"sortOrder","description":"Sort order","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[comment]","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"condition":"any"}],"category":"UgcInfo","summary":"Returns Comments on a user","suggestedName":"getCommentsOnUser","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/user.{format}/{username}/ugcSummary","description":"","operations":[{"parameters":[{"name":"username","description":"Username to get statistics for.","required":false,"dataType":"string","paramType":"path"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"},{"name":"sortOrder","description":"Sort order","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"UgcSummary","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"condition":"any"}],"category":"UgcInfo","summary":"Returns UgcSummary info a user","suggestedName":"getUgcSummaryForUser","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/user.{format}/{user}/tagHistory","description":"","operations":[{"parameters":[{"name":"user","description":"User to fetch History for","required":false,"dataType":"string","paramType":"path"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[userTagHistory]","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found to filter by.","code":404}],"condition":"any"}],"category":"Tags","summary":"Fetches TagHistory for a User.","suggestedName":"getUserTagHistory","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/user.{format}/{user}/tags","description":"","operations":[{"parameters":[{"name":"user","description":"User to fetch Tags for","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"List[tag]","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found to filter by.","code":404}],"condition":"any"}],"category":"Tags","summary":"Fetches Tags by a User.","suggestedName":"getUserTags","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/user.{format}/{user}/tagCount","description":"","operations":[{"parameters":[{"name":"user","description":"User to fetch Tag count for","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"long","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found.","code":404}],"condition":"any"}],"category":"Tags","summary":"Fetches the count of Tags created by a User.","suggestedName":"getUserTagCount","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/user.{format}/{user}/subscriptions","description":"","operations":[{"parameters":[{"name":"user","description":"User to fetch subscriptions for","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"List[SubscriptionType]","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"Not authorized to fetch subscriptions.","code":403},{"reason":"User not found.","code":404}],"condition":"any"}],"category":"Subscriptions","summary":"Fetches all subscriptions for a User.","suggestedName":"getSubscriptions","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/user.{format}/{user}/subscriptions/{objectType}/{objectIdentifier}","description":"","operations":[{"parameters":[{"name":"user","description":"User to add subscriptions to","required":false,"dataType":"string","paramType":"path"},{"name":"objectType","description":"Object Type","required":false,"dataType":"string","paramType":"path"},{"name":"objectIdentifier","description":"Object Identifier","required":false,"dataType":"string","paramType":"path"},{"name":"medium","description":"Subscription medium","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"Not authorized to subscribe user to WordOfTheDayList.","code":403},{"reason":"User not found to filter by.","code":404}],"condition":"any"}],"category":"Subscriptions","summary":"Subscribes to an object.","suggestedName":"addSubscription","deprecated":false,"open":false,"httpMethod":"POST"},{"parameters":[{"name":"user","description":"User to add subscriptions to","required":false,"dataType":"string","paramType":"path"},{"name":"objectType","description":"Object Type","required":false,"dataType":"string","paramType":"path"},{"name":"objectIdentifier","description":"Object Identifier","required":false,"dataType":"string","paramType":"path"},{"name":"medium","description":"Subscription medium","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"Not authorized to subscribe user to WordOfTheDayList.","code":403},{"reason":"User not found to filter by.","code":404}],"condition":"any"}],"category":"Subscriptions","summary":"Deletes a subscription to an object.","suggestedName":"removeSubscription","deprecated":false,"open":false,"httpMethod":"DELETE"}]},{"path":"/user.{format}/{user}/favorites/words","description":"","operations":[{"parameters":[{"name":"user","description":"User to fetch Favorite Words for","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"List[wordObject]","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found to filter by.","code":404}],"condition":"any"}],"category":"Favorites","summary":"Fetches Favorite Words for a user.","suggestedName":"getUserFavoriteWords","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/user.{format}/{user}/favorites/wordCount","description":"","operations":[{"parameters":[{"name":"user","description":"User to fetch Favorite Words for","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"long","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found to filter by.","code":404}],"condition":"any"}],"category":"Favorites","summary":"Fetches favorite word count for a user.","suggestedName":"getUserFavoriteCount","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/user.{format}/{user}/favorites/wordLists","description":"","operations":[{"parameters":[{"name":"user","description":"User to fetch Favorite WordLists for","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"List[wordList]","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found to filter by.","code":404}],"condition":"any"}],"category":"Favorites","summary":"Fetches Favorite WordLists for a user.","suggestedName":"getUserFavoriteWordLists","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/user.{format}/{user}/favorites/wordListCount","description":"","operations":[{"parameters":[{"name":"user","description":"User to fetch Favorite WordList count for","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"long","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found to filter by.","code":404}],"condition":"any"}],"category":"Favorites","summary":"Fetches Favorite WordList count for a user.","suggestedName":"getUserFavoriteWordListsCount","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/user.{format}/{user}/searches","description":"","operations":[{"parameters":[{"name":"user","description":"User to fetch History for","required":false,"dataType":"string","paramType":"path"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[recentLookup]","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found to filter by.","code":404}],"condition":"any"}],"category":"Activity","summary":"Fetches SearchHistory for a User.","suggestedName":"getUserSearchHistory","deprecated":false,"open":false,"httpMethod":"GET"},{"parameters":[{"name":"user","description":"User to remove search history for","required":false,"dataType":"string","paramType":"path"},{"name":"word","description":"Word to delete","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[recentLookup]","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found.","code":404}],"condition":"any"}],"category":"Activity","summary":"Fetches SearchHistory for a User.","suggestedName":"removeUserSearchHistoryItem","deprecated":false,"open":false,"httpMethod":"DELETE"}]},{"path":"/user.{format}/{user}/totalSearches","description":"","operations":[{"parameters":[{"name":"user","description":"User to retrieve search count for","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"long","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found.","code":404}],"condition":"any"}],"category":"Activity","summary":"Fetches the total search count for a User.","suggestedName":"getUserSearchHistoryCount","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/user.{format}/{user}/pronunciations","description":"","operations":[{"parameters":[{"name":"user","description":"User to retrieve search count for","required":false,"dataType":"string","paramType":"path"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[audioObject]","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found.","code":404}],"condition":"any"}],"category":"Activity","summary":"Fetches the total search count for a User.","suggestedName":"getUserPronunciations","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/user.{format}/{user}/activitystream","description":"","operations":[{"parameters":[{"name":"user","description":"User to retrieve search count for","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"long","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found.","code":404}],"condition":"any"}],"category":"Activity","summary":"Fetches the total search count for a User.","suggestedName":"getUserActivityStream","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/user","description":"","operations":[{"response":[{"valueType":"doc","errorResponses":[{"reason":"No data available","code":404}],"condition":"any"}],"category":"Help","summary":"Returns information about API parameters","suggestedName":"getHelp","deprecated":false,"open":true,"httpMethod":"GET"}]}],"models":[{"name":"Principal","fields":[{"name":"id","required":false,"paramType":"long"},{"name":"type","required":false,"paramType":"int"},{"name":"token","required":false,"paramType":"string"},{"name":"wordnikUserId","required":false,"paramType":"long"}]},{"name":"tag","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"id","required":false,"paramType":"long"},{"name":"count","required":false,"paramType":"long"}]},{"name":"userTagHistory","fields":[{"name":"id","required":false,"paramType":"long"},{"name":"tag","required":false,"paramType":"string"},{"name":"userId","required":false,"paramType":"long"},{"name":"wordstring","required":false,"paramType":"string"},{"name":"wordId","required":false,"paramType":"long"},{"name":"tagDate","required":false,"paramType":"Date"},{"name":"tagId","required":false,"paramType":"long"}]},{"name":"object","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"fields","required":false,"paramType":"List[parameter]"},{"name":"uniqueFieldName","required":false,"paramType":"string"}]},{"name":"long","fields":[{"name":"value","required":false,"paramType":"long"}]},{"name":"wordOfTheDayList","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"id","required":true,"paramType":"string"},{"name":"description","required":false,"paramType":"string"},{"name":"category","required":false,"paramType":"string"},{"name":"createdBy","required":false,"paramType":"string"},{"name":"items","required":false,"paramType":"List[WordOfTheDay]"},{"name":"subscriberCount","required":false,"paramType":"int"},{"name":"subscriptionStatus","required":false,"paramType":"string"},{"name":"createdAt","required":false,"paramType":"Date"},{"name":"commentCount","required":false,"paramType":"int"},{"name":"voteCount","required":false,"paramType":"integer"},{"name":"voteAverage","required":false,"paramType":"float"},{"name":"voteWeightedAverage","required":false,"paramType":"float"},{"name":"itemCount","required":false,"paramType":"int"},{"name":"firstItemDate","required":false,"paramType":"Date"},{"name":"lastItemDate","required":false,"paramType":"Date"},{"name":"subscriptionSchedule","required":false,"paramType":"string"},{"name":"subscriptionNamespace","required":false,"paramType":"string"},{"name":"subscriptionIdentifier","required":false,"paramType":"string"}]},{"name":"category","fields":[{"name":"name","required":false,"paramType":"string"}]},{"name":"SubscriptionType","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"items","required":false,"paramType":"List[SubscriptionItem]"}]},{"name":"response","fields":[{"name":"valueType","required":false,"paramType":"string"},{"name":"errorResponses","required":false,"paramType":"List[error]"},{"name":"occurs","required":false,"paramType":"string"},{"name":"condition","required":false,"paramType":"string"}]},{"name":"contentProvider","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"id","required":false,"paramType":"int"}]},{"name":"audioType","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"id","required":false,"paramType":"int"}]},{"name":"doc","fields":[{"name":"endPoints","required":false,"paramType":"List[endpoint]"},{"name":"models","required":false,"paramType":"List[object]"}]},{"name":"root","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"categories","required":false,"paramType":"List[category]"}]},{"name":"audioType","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"id","required":false,"paramType":"int"}]},{"name":"SimpleDefinition","fields":[{"name":"text","required":false,"paramType":"string"},{"name":"partOfSpeech","required":false,"paramType":"string"},{"name":"note","required":false,"paramType":"string"},{"name":"source","required":false,"paramType":"string"}]},{"name":"endpoint","fields":[{"name":"path","required":false,"paramType":"string"},{"name":"description","required":false,"paramType":"string"},{"name":"operations","required":false,"paramType":"List[operation]"}]},{"name":"operation","fields":[{"name":"parameters","required":false,"paramType":"List[parameter]"},{"name":"response","required":false,"paramType":"List[response]"},{"name":"category","required":false,"paramType":"string"},{"name":"summary","required":false,"paramType":"string"},{"name":"suggestedName","required":false,"paramType":"string"},{"name":"deprecated","required":false,"paramType":"boolean"},{"name":"open","required":false,"paramType":"boolean"},{"name":"notes","required":false,"paramType":"string"},{"name":"httpMethod","required":false,"paramType":"string"}]},{"name":"error","fields":[{"name":"reason","required":false,"paramType":"string"},{"name":"code","required":false,"paramType":"int"}]},{"name":"wordObject","fields":[{"name":"word","required":false,"paramType":"string"},{"name":"vulgar","required":false,"paramType":"string"}]},{"name":"UserHandle","fields":[{"name":"webService","required":false,"paramType":"int"},{"name":"handle","required":false,"paramType":"string"}]},{"name":"SubscriptionItem","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"medium","required":false,"paramType":"string"},{"name":"createdAt","required":false,"paramType":"Date"}]},{"name":"comment","fields":[{"name":"objectType","required":false,"paramType":"string"},{"name":"objectId","required":false,"paramType":"long"},{"name":"commentedBy","required":false,"paramType":"string"},{"name":"createdAt","required":false,"paramType":"Date"},{"name":"updatedAt","required":false,"paramType":"Date"},{"name":"commentedOn","required":false,"paramType":"string"},{"name":"id","required":false,"paramType":"string"},{"name":"body","required":false,"paramType":"string"}]},{"name":"UserTrackingInfo","fields":[{"name":"userId","required":false,"paramType":"long"},{"name":"signupIPAddress","required":false,"paramType":"string"},{"name":"noOfLogins","required":false,"paramType":"int"},{"name":"signupDate","required":false,"paramType":"Date"},{"name":"lastUpdatedDate","required":false,"paramType":"Date"},{"name":"lastLoginDate","required":false,"paramType":"Date"}]},{"name":"partOfSpeech","fields":[{"name":"roots","required":false,"paramType":"List[root]"}]},{"name":"recentLookup","fields":[{"name":"wordstring","required":false,"paramType":"string"},{"name":"createdAt","required":false,"paramType":"Date"}]},{"name":"UserProfile","fields":[{"name":"location","required":false,"paramType":"string"},{"name":"userId","required":false,"paramType":"long"},{"name":"firstName","required":false,"paramType":"string"},{"name":"lastName","required":false,"paramType":"string"},{"name":"bio","required":false,"paramType":"string"},{"name":"siteUrl","required":false,"paramType":"string"},{"name":"leastFavoriteWord","required":false,"paramType":"string"},{"name":"mostFavoriteWord","required":false,"paramType":"string"},{"name":"onomaTopoeiaWord","required":false,"paramType":"string"},{"name":"seekingWord","required":false,"paramType":"string"},{"name":"youWord","required":false,"paramType":"string"},{"name":"userHandles","required":false,"paramType":"List[UserHandle]"},{"name":"siteName","required":false,"paramType":"string"}]},{"name":"parameter","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"defaultValue","required":false,"paramType":"string"},{"name":"description","required":false,"paramType":"string"},{"name":"required","required":false,"paramType":"boolean"},{"name":"dataType","required":false,"paramType":"string"},{"name":"allowableValues","required":false,"paramType":"string"},{"name":"wrapperName","required":false,"paramType":"string"},{"name":"internalDescription","required":false,"paramType":"string"},{"name":"paramAccess","required":false,"paramType":"string"},{"name":"paramType","required":false,"paramType":"string"}]},{"name":"wordList","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"id","required":false,"paramType":"long"},{"name":"type","required":false,"paramType":"string"},{"name":"description","required":false,"paramType":"string"},{"name":"userId","required":false,"paramType":"long"},{"name":"permalink","required":false,"paramType":"string"},{"name":"createdAt","required":false,"paramType":"Date"},{"name":"username","required":false,"paramType":"string"},{"name":"updatedAt","required":false,"paramType":"Date"},{"name":"numberWordsInList","required":false,"paramType":"long"}]},{"name":"WordOfTheDay","fields":[{"name":"id","required":true,"paramType":"long"},{"name":"category","required":false,"paramType":"string"},{"name":"example","required":false,"wrapperName":"examples","paramType":"List[SimpleExample]"},{"name":"word","required":false,"paramType":"string"},{"name":"createdBy","required":false,"paramType":"string"},{"name":"definition","required":false,"wrapperName":"definitions","paramType":"List[SimpleDefinition]"},{"name":"contentProvider","required":false,"paramType":"contentProvider"},{"name":"createdAt","required":false,"paramType":"Date"},{"name":"publishDate","required":false,"paramType":"Date"},{"name":"parentId","required":false,"paramType":"string"},{"name":"note","required":false,"paramType":"string"},{"name":"htmlExtra","required":false,"paramType":"string"}]},{"name":"SubscriptionStatus","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"id","required":false,"paramType":"int"}]},{"name":"UserSettings","fields":[{"name":"userId","required":false,"paramType":"long"},{"name":"bossURL","required":false,"paramType":"string"}]},{"name":"UgcSummary","fields":[{"name":"userId","required":false,"paramType":"long"},{"name":"ugcCounters","required":false,"paramType":"Map[string,long]"},{"name":"ugcLabels","required":false,"paramType":"Map[string,string]"},{"name":"ugcEvents","required":false,"paramType":"Map[string,Date]"}]},{"name":"audioObject","fields":[{"name":"id","required":false,"paramType":"long"},{"name":"type","required":false,"paramType":"audioType"},{"name":"description","required":false,"paramType":"string"},{"name":"duration","required":false,"paramType":"double"},{"name":"userId","required":false,"paramType":"long"},{"name":"wordstring","required":false,"paramType":"string"},{"name":"createdBy","required":false,"paramType":"string"},{"name":"createdAt","required":false,"paramType":"Date"},{"name":"wordId","required":false,"paramType":"long"},{"name":"filePath","required":false,"paramType":"string"},{"name":"recordId","required":false,"paramType":"string"},{"name":"audioFileType","required":false,"paramType":"audioType"},{"name":"audioFileId","required":false,"paramType":"long"},{"name":"streamPath","required":false,"paramType":"string"}]},{"name":"user","fields":[{"name":"id","description":"Unique idenitifier for a user","required":false,"paramType":"long"},{"name":"displayName","description":"Display name","required":false,"paramType":"string"},{"name":"status","description":"Account status","required":false,"allowableValues":"0,1,2,3","paramType":"int"},{"name":"password","required":false,"paramType":"string"},{"name":"userName","description":"User name","required":false,"paramType":"string"},{"name":"email","description":"Email address","required":false,"paramType":"string"},{"name":"faceBookId","description":"Facebook ID","required":false,"paramType":"string"}]},{"name":"SimpleExample","fields":[{"name":"url","required":false,"paramType":"string"},{"name":"text","required":false,"paramType":"string"},{"name":"title","required":false,"paramType":"string"},{"name":"id","required":false,"paramType":"long"}]}]}

data/api_docs/users.json

@@ -1 +1 @@
-{"endPoints":[{"path":"/users.{format}/pronunciations","description":"","operations":[{"parameters":[{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[audioObject]","errorResponses":[{"reason":"No data available","code":404}],"condition":"any"}],"category":"Users","summary":"Fetches recent AudioPron objects","suggestedName":"getRecentPronunciations","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/users","description":"","operations":[{"response":[{"valueType":"doc","errorResponses":[{"reason":"No data available","code":404}],"condition":"any"}],"category":"Help","summary":"Returns information about API parameters","suggestedName":"getHelp","deprecated":false,"open":true,"httpMethod":"GET"},{"parameters":[{"name":"signupIP","description":"Client IP address","required":false,"dataType":"string","paramType":"query"},{"name":"password","description":"Password","required":false,"dataType":"string","paramType":"query"},{"description":"User to create","required":false,"dataType":"user","paramType":"body"}],"response":[{"valueType":"user","errorResponses":[{"reason":"Invalid User or User parameters supplied.","code":400}],"condition":"any"}],"category":"Users","summary":"Creates a User","suggestedName":"createUser","deprecated":false,"open":false,"httpMethod":"POST"}]},{"path":"/users.{format}/id/{id}","description":"","operations":[{"parameters":[{"name":"id","description":"User ID to filter by","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"user","errorResponses":[{"reason":"User not found.","code":404}],"condition":"any"}],"category":"Users","summary":"Fetches a User by ID","suggestedName":"getUserById","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/users.{format}/facebook/{facebookId}","description":"","operations":[{"parameters":[{"name":"facebookId","description":"Facebook ID to filter by","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"user","errorResponses":[{"reason":"User not found.","code":404}],"condition":"any"}],"category":"Users","summary":"Fetches a User by Facebook ID","suggestedName":"getByFacebookId","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/users.{format}/favorites","description":"","operations":[{"parameters":[{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[wordObject]","errorResponses":[{"reason":"No data available","code":404}],"condition":"any"}],"category":"Users","summary":"Fetches recent Favorite Word objects.","suggestedName":"getRecentFavorites","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/users.{format}/comments","description":"","operations":[{"parameters":[{"name":"skip","description":"Results to skip","required":false,"dataType":"string","paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[comment]","errorResponses":[{"reason":"No data available","code":404}],"condition":"any"}],"category":"Users","summary":"Fetches recent Comment objects","suggestedName":"getRecentComments","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/users.{format}/listedMostWords","description":"","operations":[{"parameters":[{"name":"dayInterval","description":"Interval in days to compute from","required":false,"dataType":"string","paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[UserSummary]","errorResponses":[{"reason":"No data available","code":404}],"condition":"any"}],"category":"Users","summary":"Fetches info on Users who listed most words","suggestedName":"getUsersWhoListedMostWords","deprecated":false,"open":false,"httpMethod":"GET"}]}],"models":[{"name":"wordObject","fields":[{"name":"word","required":false,"paramType":"string"},{"name":"vulgar","required":false,"paramType":"string"}]},{"name":"error","fields":[{"name":"reason","required":false,"paramType":"string"},{"name":"code","required":false,"paramType":"int"}]},{"name":"object","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"fields","required":false,"paramType":"List[parameter]"},{"name":"uniqueFieldName","required":false,"paramType":"string"}]},{"name":"comment","fields":[{"name":"objectType","required":false,"paramType":"string"},{"name":"objectId","required":false,"paramType":"long"},{"name":"commentedBy","required":false,"paramType":"string"},{"name":"createdAt","required":false,"paramType":"Date"},{"name":"updatedAt","required":false,"paramType":"Date"},{"name":"commentedOn","required":false,"paramType":"string"},{"name":"id","required":false,"paramType":"string"},{"name":"body","required":false,"paramType":"string"}]},{"name":"response","fields":[{"name":"valueType","required":false,"paramType":"string"},{"name":"errorResponses","required":false,"paramType":"List[error]"},{"name":"occurs","required":false,"paramType":"string"},{"name":"condition","required":false,"paramType":"string"}]},{"name":"parameter","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"defaultValue","required":false,"paramType":"string"},{"name":"description","required":false,"paramType":"string"},{"name":"required","required":false,"paramType":"boolean"},{"name":"dataType","required":false,"paramType":"string"},{"name":"allowableValues","required":false,"paramType":"string"},{"name":"wrapperName","required":false,"paramType":"string"},{"name":"internalDescription","required":false,"paramType":"string"},{"name":"paramAccess","required":false,"paramType":"string"},{"name":"paramType","required":false,"paramType":"string"}]},{"name":"audioType","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"id","required":false,"paramType":"int"}]},{"name":"doc","fields":[{"name":"endPoints","required":false,"paramType":"List[endpoint]"},{"name":"models","required":false,"paramType":"List[object]"}]},{"name":"audioType","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"id","required":false,"paramType":"int"}]},{"name":"audioObject","fields":[{"name":"id","required":false,"paramType":"long"},{"name":"type","required":false,"paramType":"audioType"},{"name":"description","required":false,"paramType":"string"},{"name":"userId","required":false,"paramType":"long"},{"name":"wordstring","required":false,"paramType":"string"},{"name":"createdBy","required":false,"paramType":"string"},{"name":"createdAt","required":false,"paramType":"Date"},{"name":"wordId","required":false,"paramType":"long"},{"name":"filePath","required":false,"paramType":"string"},{"name":"recordId","required":false,"paramType":"string"},{"name":"audioFileType","required":false,"paramType":"audioType"},{"name":"audioFileId","required":false,"paramType":"long"},{"name":"streamPath","required":false,"paramType":"string"}]},{"name":"endpoint","fields":[{"name":"path","required":false,"paramType":"string"},{"name":"description","required":false,"paramType":"string"},{"name":"operations","required":false,"paramType":"List[operation]"}]},{"name":"UserSummary","fields":[{"name":"userId","required":false,"paramType":"long"},{"name":"userName","required":false,"paramType":"string"},{"name":"totalListedWordsCount","required":false,"paramType":"long"}]},{"name":"operation","fields":[{"name":"parameters","required":false,"paramType":"List[parameter]"},{"name":"response","required":false,"paramType":"List[response]"},{"name":"category","required":false,"paramType":"string"},{"name":"summary","required":false,"paramType":"string"},{"name":"suggestedName","required":false,"paramType":"string"},{"name":"deprecated","required":false,"paramType":"boolean"},{"name":"open","required":false,"paramType":"boolean"},{"name":"notes","required":false,"paramType":"string"},{"name":"httpMethod","required":false,"paramType":"string"}]},{"name":"user","fields":[{"name":"id","description":"Unique idenitifier for a user","required":false,"paramType":"long"},{"name":"displayName","description":"Display name","required":false,"paramType":"string"},{"name":"status","description":"Account status","required":false,"allowableValues":"0,1,2,3","paramType":"int"},{"name":"password","required":false,"paramType":"string"},{"name":"userName","description":"User name","required":false,"paramType":"string"},{"name":"email","description":"Email address","required":false,"paramType":"string"},{"name":"faceBookId","description":"Facebook ID","required":false,"paramType":"string"}]}]}
+{"endPoints":[{"path":"/users.{format}/pronunciations","description":"","operations":[{"parameters":[{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[audioObject]","errorResponses":[{"reason":"No data available","code":404}],"condition":"any"}],"category":"Users","summary":"Fetches recent AudioPron objects","suggestedName":"getRecentPronunciations","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/users","description":"","operations":[{"response":[{"valueType":"doc","errorResponses":[{"reason":"No data available","code":404}],"condition":"any"}],"category":"Help","summary":"Returns information about API parameters","suggestedName":"getHelp","deprecated":false,"open":true,"httpMethod":"GET"},{"parameters":[{"name":"signupIP","description":"Client IP address","required":false,"dataType":"string","paramType":"query"},{"name":"password","description":"Password","required":false,"dataType":"string","paramType":"query"},{"description":"User to create","required":false,"dataType":"user","paramType":"body"}],"response":[{"valueType":"user","errorResponses":[{"reason":"Invalid User or User parameters supplied.","code":400}],"condition":"any"}],"category":"Users","summary":"Creates a User","suggestedName":"createUser","deprecated":false,"open":false,"httpMethod":"POST"}]},{"path":"/users.{format}/id/{id}","description":"","operations":[{"parameters":[{"name":"id","description":"User ID to filter by","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"user","errorResponses":[{"reason":"User not found.","code":404}],"condition":"any"}],"category":"Users","summary":"Fetches a User by ID","suggestedName":"getUserById","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/users.{format}/facebook/{facebookId}","description":"","operations":[{"parameters":[{"name":"facebookId","description":"Facebook ID to filter by","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"user","errorResponses":[{"reason":"User not found.","code":404}],"condition":"any"}],"category":"Users","summary":"Fetches a User by Facebook ID","suggestedName":"getByFacebookId","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/users.{format}/favorites","description":"","operations":[{"parameters":[{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[wordObject]","errorResponses":[{"reason":"No data available","code":404}],"condition":"any"}],"category":"Users","summary":"Fetches recent Favorite Word objects.","suggestedName":"getRecentFavorites","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/users.{format}/comments","description":"","operations":[{"parameters":[{"name":"skip","description":"Results to skip","required":false,"dataType":"string","paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[comment]","errorResponses":[{"reason":"No data available","code":404}],"condition":"any"}],"category":"Users","summary":"Fetches recent Comment objects","suggestedName":"getRecentComments","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/users.{format}/listedMostWords","description":"","operations":[{"parameters":[{"name":"dayInterval","description":"Interval in days to compute from","required":false,"dataType":"string","paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[UserSummary]","errorResponses":[{"reason":"No data available","code":404}],"condition":"any"}],"category":"Users","summary":"Fetches info on Users who listed most words","suggestedName":"getUsersWhoListedMostWords","deprecated":false,"open":false,"httpMethod":"GET"}]}],"models":[{"name":"wordObject","fields":[{"name":"word","required":false,"paramType":"string"},{"name":"vulgar","required":false,"paramType":"string"}]},{"name":"error","fields":[{"name":"reason","required":false,"paramType":"string"},{"name":"code","required":false,"paramType":"int"}]},{"name":"object","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"fields","required":false,"paramType":"List[parameter]"},{"name":"uniqueFieldName","required":false,"paramType":"string"}]},{"name":"comment","fields":[{"name":"objectType","required":false,"paramType":"string"},{"name":"objectId","required":false,"paramType":"long"},{"name":"commentedBy","required":false,"paramType":"string"},{"name":"createdAt","required":false,"paramType":"Date"},{"name":"updatedAt","required":false,"paramType":"Date"},{"name":"commentedOn","required":false,"paramType":"string"},{"name":"id","required":false,"paramType":"string"},{"name":"body","required":false,"paramType":"string"}]},{"name":"response","fields":[{"name":"valueType","required":false,"paramType":"string"},{"name":"errorResponses","required":false,"paramType":"List[error]"},{"name":"occurs","required":false,"paramType":"string"},{"name":"condition","required":false,"paramType":"string"}]},{"name":"parameter","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"defaultValue","required":false,"paramType":"string"},{"name":"description","required":false,"paramType":"string"},{"name":"required","required":false,"paramType":"boolean"},{"name":"dataType","required":false,"paramType":"string"},{"name":"allowableValues","required":false,"paramType":"string"},{"name":"wrapperName","required":false,"paramType":"string"},{"name":"internalDescription","required":false,"paramType":"string"},{"name":"paramAccess","required":false,"paramType":"string"},{"name":"paramType","required":false,"paramType":"string"}]},{"name":"audioType","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"id","required":false,"paramType":"int"}]},{"name":"doc","fields":[{"name":"endPoints","required":false,"paramType":"List[endpoint]"},{"name":"models","required":false,"paramType":"List[object]"}]},{"name":"audioType","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"id","required":false,"paramType":"int"}]},{"name":"audioObject","fields":[{"name":"id","required":false,"paramType":"long"},{"name":"type","required":false,"paramType":"audioType"},{"name":"description","required":false,"paramType":"string"},{"name":"duration","required":false,"paramType":"double"},{"name":"userId","required":false,"paramType":"long"},{"name":"wordstring","required":false,"paramType":"string"},{"name":"createdBy","required":false,"paramType":"string"},{"name":"createdAt","required":false,"paramType":"Date"},{"name":"wordId","required":false,"paramType":"long"},{"name":"filePath","required":false,"paramType":"string"},{"name":"recordId","required":false,"paramType":"string"},{"name":"audioFileType","required":false,"paramType":"audioType"},{"name":"audioFileId","required":false,"paramType":"long"},{"name":"streamPath","required":false,"paramType":"string"}]},{"name":"endpoint","fields":[{"name":"path","required":false,"paramType":"string"},{"name":"description","required":false,"paramType":"string"},{"name":"operations","required":false,"paramType":"List[operation]"}]},{"name":"UserSummary","fields":[{"name":"userId","required":false,"paramType":"long"},{"name":"userName","required":false,"paramType":"string"},{"name":"totalListedWordsCount","required":false,"paramType":"long"}]},{"name":"operation","fields":[{"name":"parameters","required":false,"paramType":"List[parameter]"},{"name":"response","required":false,"paramType":"List[response]"},{"name":"category","required":false,"paramType":"string"},{"name":"summary","required":false,"paramType":"string"},{"name":"suggestedName","required":false,"paramType":"string"},{"name":"deprecated","required":false,"paramType":"boolean"},{"name":"open","required":false,"paramType":"boolean"},{"name":"notes","required":false,"paramType":"string"},{"name":"httpMethod","required":false,"paramType":"string"}]},{"name":"user","fields":[{"name":"id","description":"Unique idenitifier for a user","required":false,"paramType":"long"},{"name":"displayName","description":"Display name","required":false,"paramType":"string"},{"name":"status","description":"Account status","required":false,"allowableValues":"0,1,2,3","paramType":"int"},{"name":"password","required":false,"paramType":"string"},{"name":"userName","description":"User name","required":false,"paramType":"string"},{"name":"email","description":"Email address","required":false,"paramType":"string"},{"name":"faceBookId","description":"Facebook ID","required":false,"paramType":"string"}]}]}