wordnik 4.06.00 → 4.06.01

data/.gitignore

@@ -1,6 +1,4 @@
 pkg/*
 *.gem
 .bundle
-USAGE.md
-api_docs/*
-lib/wordnik/resource_modules/*
+USAGE.md

data/api_docs/account.json

@@ -0,0 +1 @@
+{"endPoints":[{"path":"/account.{format}/authenticate/{username}","description":"","operations":[{"parameters":[{"name":"username","description":"A confirmed Wordnik username","required":true,"dataType":"string","paramType":"path"},{"name":"password","description":"The user's password","required":true,"dataType":"string","paramType":"query"}],"response":[{"valueType":"AuthenticationToken","errorResponses":[{"reason":"Account not available.","code":403},{"reason":"User not found.","code":404}],"condition":"any"}],"category":"Authentication","summary":"Authenticates a User","suggestedName":"authenticate","deprecated":false,"open":false,"httpMethod":"GET"},{"parameters":[{"name":"username","description":"A confirmed Wordnik username","required":true,"dataType":"string","paramType":"path"},{"description":"The user's password","required":true,"dataType":"string","paramType":"body"}],"response":[{"valueType":"AuthenticationToken","errorResponses":[{"reason":"Account not available.","code":403},{"reason":"User not found.","code":404}],"condition":"any"}],"category":"Authentication","summary":"Authenticates a user","suggestedName":"authenticatePost","deprecated":false,"open":false,"httpMethod":"POST"}]},{"path":"/account.{format}/logout","description":"","operations":[{"parameters":[{"name":"auth_token","description":"auth_token of logged-in user","required":true,"dataType":"string","paramType":"header"}],"response":[{"valueType":"void","condition":"any"}],"category":"Authentication","summary":"Logs out a user","suggestedName":"logout","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/account","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":"/account.{format}/wordLists","description":"","operations":[{"parameters":[{"name":"api_key","description":"API Key","required":true,"dataType":"string","paramType":"header"},{"name":"auth_token","description":"auth_token of logged-in user","required":true,"dataType":"string","paramType":"header"},{"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[wordList]","errorResponses":[{"reason":"Not authenticated.","code":403},{"reason":"User account not found.","code":404}],"condition":"any"}],"category":"WordLists","summary":"Fetches WordList objects for the logged-in user.","suggestedName":"getWordListsForCurrentUser","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/account.{format}/forgotPassword/{username}","description":"","operations":[{"parameters":[{"name":"username","description":"Username","required":true,"dataType":"string","paramType":"path"}],"response":[{"valueType":"String","errorResponses":[{"reason":"User is Facebook Connected","code":400},{"reason":"User not found","code":404}],"condition":"any"}],"category":"AccountManagement","summary":"Authenticates a User","suggestedName":"getForgotPassword","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/account.{format}/resetPassword/{hashcode}","description":"","operations":[{"parameters":[{"name":"hashcode","description":"Password reset code","required":true,"dataType":"string","paramType":"path"}],"response":[{"valueType":"user","errorResponses":[{"reason":"Invalid code supplied.","code":400},{"reason":"User not found or code invalid.","code":404}],"condition":"any"}],"category":"AccountManagement","summary":"Fetches a User by code","suggestedName":"resetPassword","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/account.{format}/apiAccountApplication","description":"","operations":[{"parameters":[{"description":"API Application Info","required":true,"dataType":"apiApplication","paramType":"body"}],"response":[{"valueType":"ApiResponse","errorResponses":[{"reason":"Account not available.","code":403},{"reason":"User not found.","code":404}],"condition":"any"}],"category":"ApiAccount","summary":"Creates an API account application.","suggestedName":"createApiAccount","deprecated":false,"open":false,"httpMethod":"POST"}]},{"path":"/account.{format}/regenerateApiToken","description":"","operations":[{"parameters":[{"name":"api_key","description":"API Key","required":true,"dataType":"string","paramType":"header"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid token supplied.","code":400}],"condition":"any"}],"category":"ApiAccount","summary":"Regenerates an API Token.  Currently not supported or tested.","suggestedName":"createApiAccount","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/account.{format}/apiTokenStatus","description":"","operations":[{"parameters":[{"name":"api_key","description":"Wordnik authentication token","required":true,"dataType":"string","paramType":"header"},{"name":"api_key","description":"Wordnik authentication token","required":false,"dataType":"string","paramAccess":"internal","paramType":"query"}],"response":[{"valueType":"ApiTokenStatus","errorResponses":[{"reason":"No token supplied.","code":400},{"reason":"No API account with supplied token.","code":404}],"condition":"any"}],"category":"ApiAccount","summary":"Returns usage statistics for the API account.","suggestedName":"getApiTokenStatus","deprecated":false,"open":true,"httpMethod":"GET"}]},{"path":"/account.{format}/logVisit","description":"","operations":[{"parameters":[{"name":"userId","description":"User ID to track data for","required":false,"dataType":"string","paramType":"query"},{"name":"userGuid","description":"User's persistent GUID","required":false,"dataType":"string","paramType":"query"},{"name":"userSessionId","description":"User's session ID","required":false,"dataType":"string","paramType":"query"},{"name":"userIpAddress","description":"User IP address","required":false,"dataType":"string","paramType":"query"},{"name":"serverIp","description":"Server IP address","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"String","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"No activation code available.","code":404}],"condition":"any"}],"category":"Activity","summary":"Logs a VisitAction for the user","suggestedName":"logVisitForUser","deprecated":false,"open":false,"notes":"Requires a valid auth_token to be set.","httpMethod":"POST"}]},{"path":"/account.{format}/activationCode/{username}","description":"","operations":[{"parameters":[{"name":"username","description":"Username","required":true,"dataType":"string","paramType":"path"}],"response":[{"valueType":"String","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"No activation code available.","code":404}],"condition":"any"}],"category":"Activation","summary":"Returns an activation code given a username","suggestedName":"getActivationCodeForUser","deprecated":false,"open":false,"notes":"If an activation code is not available, will return null.","httpMethod":"GET"}]},{"path":"/account.{format}/activate","description":"","operations":[{"parameters":[{"description":"Activation Code","required":true,"dataType":"string","paramType":"body"}],"response":[{"valueType":"user","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"No activation code found.","code":404}],"condition":"any"}],"category":"Activation","summary":"Activates an account.","suggestedName":"activateUser","deprecated":false,"open":false,"httpMethod":"POST"}]},{"path":"/account.{format}/usernameAvailable/{username}","description":"","operations":[{"parameters":[{"name":"username","description":"Username","required":true,"dataType":"string","paramType":"path"}],"response":[{"valueType":"ApiResponse","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"No activation code available.","code":404}],"condition":"any"}],"category":"Activation","summary":"Returns an ApiResponse indicating whether or not a username is available","suggestedName":"getUsernameAvailable","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/account.{format}/user","description":"","operations":[{"parameters":[{"name":"api_key","description":"API Key","required":true,"dataType":"string","paramType":"header"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","paramType":"header"}],"response":[{"valueType":"user","errorResponses":[{"reason":"Not logged in.","code":403},{"reason":"User not found.","code":404}],"condition":"any"}],"category":"UserInfo","summary":"Returns the logged-in User","suggestedName":"getLoggedInUser","deprecated":false,"open":false,"notes":"Requires a valid auth_token to be set.","httpMethod":"GET"}]},{"path":"/account.{format}/profile","description":"","operations":[{"parameters":[{"name":"api_key","description":"API Key","required":true,"dataType":"string","paramType":"header"},{"name":"auth_token","description":"auth_token of logged-in user","required":true,"dataType":"string","paramType":"header"}],"response":[{"valueType":"UserProfile","errorResponses":[{"reason":"Not logged in.","code":403},{"reason":"User not found.","code":404}],"condition":"any"}],"category":"UserInfo","summary":"Returns profile info for the logged-in user","suggestedName":"getLoggedInUserProfile","deprecated":false,"open":false,"notes":"Requires a valid auth_token to be set.","httpMethod":"GET"}]},{"path":"/account.{format}/settings","description":"","operations":[{"parameters":[{"name":"api_key","description":"API Key","required":true,"dataType":"string","paramType":"header"},{"name":"auth_token","description":"auth_token of logged-in user","required":true,"dataType":"string","paramType":"header"}],"response":[{"valueType":"UserSettings","errorResponses":[{"reason":"Not logged in.","code":403},{"reason":"User not found.","code":404}],"condition":"any"}],"category":"UserInfo","summary":"Returns logged-in User Settings","suggestedName":"getLoggedInUserSettings","deprecated":false,"open":false,"notes":"Requires a valid auth_token to be set.","httpMethod":"GET"}]},{"path":"/account.{format}/trackingInfo","description":"","operations":[{"parameters":[{"name":"api_key","description":"API Key","required":true,"dataType":"string","paramType":"header"},{"name":"auth_token","description":"auth_token of logged-in user","required":true,"dataType":"string","paramType":"header"}],"response":[{"valueType":"UserTrackingInfo","errorResponses":[{"reason":"Not logged in.","code":403},{"reason":"User not found.","code":404}],"condition":"any"}],"category":"UserInfo","summary":"Returns logged-in User TrackingInfo.","suggestedName":"getLoggedInUserTrackingInfo","deprecated":false,"open":false,"notes":"Requires a valid auth_token to be set.","httpMethod":"GET"}]}],"models":[{"name":"error","fields":[{"name":"reason","required":false,"paramType":"string"},{"name":"code","required":false,"paramType":"int"}]},{"name":"UserHandle","fields":[{"name":"webService","required":false,"paramType":"int"},{"name":"handle","required":false,"paramType":"string"}]},{"name":"object","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"fields","required":false,"paramType":"List[parameter]"},{"name":"uniqueFieldName","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":"ApiResponse","fields":[{"name":"message","required":false,"paramType":"string"},{"name":"type","required":false,"paramType":"string"}]},{"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":"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":"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":"doc","fields":[{"name":"endPoints","required":false,"paramType":"List[endpoint]"},{"name":"models","required":false,"paramType":"List[object]"}]},{"name":"UserSettings","fields":[{"name":"userId","required":false,"paramType":"long"},{"name":"bossURL","required":false,"paramType":"string"}]},{"name":"ApiTokenStatus","fields":[{"name":"token","required":false,"paramType":"string"},{"name":"expiresInMillis","required":false,"paramType":"long"},{"name":"totalRequests","required":false,"paramType":"long"},{"name":"remainingCalls","required":false,"paramType":"long"},{"name":"resetsInMillis","required":false,"paramType":"long"}]},{"name":"AuthenticationToken","fields":[{"name":"token","required":false,"paramType":"string"},{"name":"userId","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":"endpoint","fields":[{"name":"path","required":false,"paramType":"string"},{"name":"description","required":false,"paramType":"string"},{"name":"operations","required":false,"paramType":"List[operation]"}]},{"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"}]}]}

data/api_docs/corpus.json

@@ -0,0 +1 @@
+{"endPoints":[{"path":"/corpus.{format}/recentViews","description":"","operations":[{"parameters":[{"name":"limit","description":"Limits results","required":false,"dataType":"string","paramType":"query"},{"name":"humanOnly","description":"Returns results only from human visitors","required":false,"dataType":"string","paramType":"query"},{"name":"sortByFrequency","description":"Sorts results by frequency","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[wordResult]","errorResponses":[{"reason":"No data available","code":404}],"condition":"any"}],"category":"RecentViews","summary":"Fetches recent views from the website.","suggestedName":"getRecentViews","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/corpus.{format}/words/{statsType}/{object}","description":"","operations":[{"parameters":[{"name":"statsType","description":"Stats type to fetch","required":false,"dataType":"string","paramType":"path"},{"name":"object","description":"Object identifier","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"}],"response":[{"valueType":"List[wordFrequency]","errorResponses":[{"reason":"Invalid dimension for WordFrequency data or Object Identifier not found.","code":400}],"condition":"any"}],"category":"Stats","summary":"Gets WordFrequency data","suggestedName":"getWordFrequencies","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/corpus.{format}/dictionaryStats","description":"","operations":[{"parameters":[{"name":"sourceDictionary","description":"Dictionary name to fetch stats for","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"dictionaryStats","errorResponses":[{"reason":"Invalid dictionary name supplied.","code":404}],"condition":"any"}],"category":"Stats","summary":"Gets Dictionary Statistics data","suggestedName":"getWordFrequencies","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/corpus.{format}/firstUsed","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[basicWordUsage]","errorResponses":[{"reason":"No data found for corpus.","code":404}],"condition":"any"}],"category":"Stats","summary":"Gets Dictionary Statistics data","suggestedName":"getWordFrequencies","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/corpus","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":"/corpus.{format}/totalDocumentCount","description":"","operations":[{"response":[{"valueType":"long","errorResponses":[{"reason":"No data available","code":404}],"condition":"any"}],"category":"CorpusCounters","summary":"Returns the count of documents in the Corpus.","suggestedName":"getTotalDocumentCount","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/corpus.{format}/processText","description":"","operations":[{"parameters":[{"description":"Text body to process.","required":false,"dataType":"string","paramType":"body"},{"name":"split","description":"Tells the processor to split multiple sentences from the input.  Default is true.","required":false,"dataType":"string","paramType":"query"},{"name":"rank","description":"Flag to invoke the ranking logic.  Default is false.","required":false,"dataType":"string","paramAccess":"internal","paramType":"query"}],"response":[{"valueType":"List[sentence]","errorResponses":[{"reason":"Invalid text supplied.","code":400}],"condition":"any"}],"category":"TextProcessing","summary":"Processes text input.","suggestedName":"processText","deprecated":false,"open":false,"notes":"Returns tagged and processed text based on the input string.","httpMethod":"POST"}]},{"path":"/corpus.{format}/punctuationFactor","description":"","operations":[{"response":[{"valueType":"punctuationFactor","errorResponses":[{"reason":"No data available.","code":404}],"condition":"any"}],"category":"TextProcessing","summary":"Returns corpus-wide PunctuationFactor.","suggestedName":"getPunctuationFactor","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/corpus.{format}/phraseFeedback","description":"","operations":[{"parameters":[{"description":"Phrase to store.","required":false,"dataType":"string","paramType":"body"}],"response":[{"valueType":"List[sentence]","errorResponses":[{"reason":"Invalid phrase supplied.","code":400}],"condition":"any"}],"category":"TextProcessing","summary":"Receives info on phrases which should be captured","suggestedName":"getPunctuationFactor","deprecated":false,"open":false,"httpMethod":"POST"}]},{"path":"/corpus.{format}/documentStats","description":"","operations":[{"parameters":[{"name":"documentStatsType","description":"Type of statistics to return","required":false,"dataType":"string","paramType":"query"},{"name":"id","description":"ID of statistics type to return.","required":false,"dataType":"string","paramType":"query"},{"name":"split","description":"Flag to invoke the ranking logic.  Default is false.","required":false,"dataType":"string","paramAccess":"internal","paramType":"query"}],"response":[{"valueType":"basicDocumentStats","errorResponses":[{"reason":"Invalid stats type supplied.","code":400}],"condition":"any"}],"category":"Stats","summary":"Returns document-level stats.","suggestedName":"getDocumentStats","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/corpus.{format}/words","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[wordFrequency]","errorResponses":[{"reason":"No corpus frequency data available.","code":400}],"condition":"any"}],"category":"Stats","summary":"Gets corpus-level WordFrequency","suggestedName":"getCorpusWordFrequencies","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/corpus.{format}/dymInternal/{wordstring}","description":"","operations":[{"parameters":[{"name":"wordstring","description":"Returns results only from human visitors","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"relationshipMap","errorResponses":[{"reason":"No data available.","code":404},{"reason":"Invalid word supplied.","code":400}],"condition":"any"}],"category":"Unused","summary":"Returns word relationships.","suggestedName":"getDym","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/corpus.{format}/recentListedWords","description":"","operations":[{"parameters":[{"name":"limit","description":"Maximun results to return","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[wordListingHistory]","errorResponses":[{"reason":"No data available","code":404}],"condition":"any"}],"category":"RecentListedWords","summary":"Returns recently listed words.","suggestedName":"getRecentListedWords","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/corpus.{format}/contextualLookup","description":"","operations":[{"parameters":[{"name":"word","description":"Word of interest","required":false,"dataType":"string","paramType":"query"},{"name":"contextString","description":"Sentence word appears in","required":false,"dataType":"string","paramType":"query"},{"name":"title","description":"Word of interest","required":false,"dataType":"string","paramType":"query"},{"name":"metadataId","description":"Word of interest","required":false,"dataType":"string","paramType":"query"},{"name":"partnerId","description":"Partner Id","required":false,"dataType":"string","paramType":"query"},{"name":"sourceUrl","description":"Document source URL","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"contextualLookupResponse","errorResponses":[{"reason":"No data available","code":404}],"condition":"any"}],"category":"ContextualLookup","summary":"Mock method to return Contextual Lookup info.","suggestedName":"getMockContextualLookupInfo","deprecated":false,"open":false,"notes":"Internal Only","httpMethod":"GET"},{"parameters":[{"name":"category","description":"Filters response by category","required":false,"dataType":"contextualLookupRequest","paramType":"query"}],"response":[{"valueType":"contextualLookupResponse","errorResponses":[{"reason":"No data available","code":404}],"condition":"any"}],"category":"ContextualLookup","summary":"Fetches ContextualLookup info.","suggestedName":"getContextualLookupInfo","deprecated":false,"open":false,"httpMethod":"POST"}]},{"path":"/corpus.{format}/totalWordCount","description":"","operations":[{"response":[{"valueType":"long","errorResponses":[{"reason":"No data available","code":404}],"condition":"any"}],"category":"CorpusCounters","summary":"Returns the count of tokens in the Corpus.","suggestedName":"getTotalTokensCount","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/corpus.{format}/sentenceCount","description":"","operations":[{"response":[{"valueType":"long","errorResponses":[{"reason":"No data available","code":404}],"condition":"any"}],"category":"CorpusCounters","summary":"Returns the count of sentences in the Corpus.","suggestedName":"getTotalSentencesCount","deprecated":false,"open":false,"httpMethod":"GET"}]}],"models":[{"name":"sentence","fields":[{"name":"id","required":false,"paramType":"long"},{"name":"scoredWord","required":false,"wrapperName":"scoredWords","paramType":"List[scoredWord]"},{"name":"display","required":false,"paramType":"string"},{"name":"documentMetadataId","required":false,"paramType":"long"},{"name":"rating","required":false,"paramType":"int"}]},{"name":"wordFrequency","fields":[{"name":"count","required":false,"paramType":"long"},{"name":"wordstring","required":false,"paramType":"string"}]},{"name":"error","fields":[{"name":"reason","required":false,"paramType":"string"},{"name":"code","required":false,"paramType":"int"}]},{"name":"relationshipMap","fields":[{"name":"sourceWordstring","required":false,"paramType":"string"},{"name":"suggestion","required":false,"wrapperName":"suggestions","paramType":"List[suggestion]"}]},{"name":"punctuationFactor","fields":[{"name":"totalCount","required":false,"paramType":"long"},{"name":"wordId","required":false,"paramType":"long"},{"name":"periodCount","required":false,"paramType":"long"},{"name":"exclamationPointCount","required":false,"paramType":"long"},{"name":"questionMarkCount","required":false,"paramType":"long"}]},{"name":"lookupExample","fields":[{"name":"uRL","required":false,"paramType":"string"},{"name":"sourceName","required":false,"paramType":"string"},{"name":"exampleString","required":false,"paramType":"string"}]},{"name":"long","fields":[{"name":"value","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":"basicWordUsage","fields":[{"name":"year","required":false,"paramType":"integer"},{"name":"wordstring","required":false,"paramType":"string"},{"name":"documentId","required":false,"paramType":"long"},{"name":"sentenceId","required":false,"paramType":"long"}]},{"name":"wordListingHistory","fields":[{"name":"wordString","required":false,"paramType":"string"},{"name":"wordId","required":false,"paramType":"long"},{"name":"listingCount","required":false,"paramType":"long"}]},{"name":"dictionaryStats","fields":[{"name":"dictionaryName","required":false,"paramType":"string"},{"name":"wordCount","required":false,"paramType":"int"},{"name":"defintionCount","required":false,"paramType":"int"},{"name":"exampleCount","required":false,"paramType":"int"},{"name":"textPronunciationCount","required":false,"paramType":"int"},{"name":"wordsWithRelationship","required":false,"paramType":"Map[string,integer]"},{"name":"relationshipLinks","required":false,"paramType":"Map[string,integer]"}]},{"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":"wordResult","fields":[{"name":"count","required":false,"paramType":"long"},{"name":"wordstring","required":false,"paramType":"string"}]},{"name":"doc","fields":[{"name":"endPoints","required":false,"paramType":"List[endpoint]"},{"name":"models","required":false,"paramType":"List[object]"}]},{"name":"scoredWord","fields":[{"name":"id","required":false,"paramType":"long"},{"name":"wordType","required":false,"paramType":"string"},{"name":"position","required":false,"paramType":"int"},{"name":"word","required":false,"paramType":"string"},{"name":"score","required":false,"paramType":"float"},{"name":"sentenceId","required":false,"paramType":"long"},{"name":"partOfSpeech","required":false,"paramType":"string"}]},{"name":"contextualLookupResponse","fields":[{"name":"examples","required":false,"wrapperName":"lookupExamples","paramType":"List[lookupExample]"},{"name":"wordstring","required":false,"paramType":"string"}]},{"name":"basicDocumentStats","fields":[{"name":"key","required":false,"paramType":"string"},{"name":"type","required":false,"paramType":"string"},{"name":"sentencesCount","required":false,"paramType":"long"},{"name":"documentsCount","required":false,"paramType":"long"},{"name":"tokensCount","required":false,"paramType":"long"},{"name":"uniqueWordsCount","required":false,"paramType":"long"},{"name":"wordsCount","required":false,"paramType":"long"},{"name":"firstUsedWordsCount","required":false,"paramType":"long"},{"name":"viableSentencesCount","required":false,"paramType":"long"},{"name":"uniqueBiGramsCount","required":false,"paramType":"long"}]},{"name":"suggestion","fields":[{"name":"type","required":false,"paramType":"int"},{"name":"wordstring","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/document.json

@@ -0,0 +1 @@
+{"endPoints":[{"path":"/document.{format}/id/{document_id}/words","description":"","operations":[{"parameters":[{"name":"document_id","description":"Document ID to fetch frequency data 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"}],"response":[{"valueType":"List[wordFrequency]","errorResponses":[{"reason":"Invalid Content Provider code supplied.","code":400},{"reason":"No activation code available.","code":404}],"condition":"any"}],"category":"DocumentAccess","summary":"Fetches Document objects by Content Provider code.","suggestedName":"getWordFrequencies","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/document.{format}/{contentProvider}/documents","description":"","operations":[{"parameters":[{"name":"contentProvider","description":"Partner Code to fetch for.","required":false,"dataType":"string","paramType":"path"},{"name":"filterByWordScore","description":"Filter document model by word scores.","required":false,"dataType":"string","paramType":"query"},{"name":"minWordScore","description":"Minimum word score to return.","required":false,"dataType":"string","paramType":"query"},{"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[documentModel]","errorResponses":[{"reason":"Invalid Content Provider code supplied.","code":404}],"condition":"any"}],"category":"DocumentAccess","summary":"Fetches examples for a specific provider matching a criteria.","suggestedName":"getGlossaries","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/document","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":"/document.{format}/provider/{provider}","description":"","operations":[{"parameters":[{"name":"provider","description":"Username","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"}],"response":[{"valueType":"List[documentMetadata]","errorResponses":[{"reason":"Invalid Content Provider code supplied.","code":400},{"reason":"No activation code available.","code":404}],"condition":"any"}],"category":"DocumentAccess","summary":"Fetches Document objects by Content Provider code.","suggestedName":"getDocumentsByContentProvider","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/document.{format}/{id}/metadata","description":"","operations":[{"parameters":[{"name":"id","description":"Document ID","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"documentMetadata","errorResponses":[{"reason":"Invalid document ID supplied.","code":400},{"reason":"No activation code available.","code":404}],"condition":"any"}],"category":"DocumentAccess","summary":"Fetches Document objects by document identifier.","suggestedName":"getMetadataById","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/document.{format}/{id}/model","description":"","operations":[{"parameters":[{"name":"scores","description":"Return word scores","required":false,"dataType":"string","paramType":"query"},{"name":"id","description":"Document ID","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"documentModel","errorResponses":[{"reason":"Invalid Content Provider code supplied.","code":400},{"reason":"No activation code available.","code":404}],"condition":"any"}],"category":"DocumentAccess","summary":"Fetches Document objects by id.","suggestedName":"getModelById","deprecated":false,"open":false,"httpMethod":"GET"}]}],"models":[{"name":"wordFrequency","fields":[{"name":"count","required":false,"paramType":"long"},{"name":"wordstring","required":false,"paramType":"string"}]},{"name":"sentence","fields":[{"name":"id","required":false,"paramType":"long"},{"name":"scoredWord","required":false,"wrapperName":"scoredWords","paramType":"List[scoredWord]"},{"name":"display","required":false,"paramType":"string"},{"name":"documentMetadataId","required":false,"paramType":"long"},{"name":"rating","required":false,"paramType":"int"}]},{"name":"extendedMetadata","fields":[{"name":"documentMetadataId","required":false,"paramType":"long"},{"name":"isbn","required":false,"paramType":"string"},{"name":"issn","required":false,"paramType":"string"},{"name":"lccn","required":false,"paramType":"string"},{"name":"sourceFileSize","required":false,"paramType":"long"}]},{"name":"error","fields":[{"name":"reason","required":false,"paramType":"string"},{"name":"code","required":false,"paramType":"int"}]},{"name":"documentModel","fields":[{"name":"documentMetadata","required":false,"paramType":"documentMetadata"},{"name":"basicDocumentStats","required":false,"paramType":"basicDocumentStats"},{"name":"wordFrequency","required":false,"wrapperName":"wordFrequencies","paramType":"List[wordFrequency]"},{"name":"sentence","required":false,"wrapperName":"sentences","paramType":"List[sentence]"},{"name":"biGramFrequency","required":false,"wrapperName":"bigramFrequencies","paramType":"List[biGramFrequency]"}]},{"name":"biGramFrequency","fields":[{"name":"count","required":false,"paramType":"long"},{"name":"mi","required":false,"paramType":"double"},{"name":"wlmi","required":false,"paramType":"double"},{"name":"bigram","required":false,"paramType":"bigram"}]},{"name":"author","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"id","required":false,"paramType":"long"},{"name":"description","required":false,"paramType":"string"},{"name":"createdAt","required":false,"paramType":"Date"},{"name":"authorType","required":false,"paramType":"authorType"},{"name":"uniqueName","required":false,"paramType":"string"}]},{"name":"contentType","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"id","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":"bigram","fields":[{"name":"count","required":false,"paramType":"long"},{"name":"gram1","required":false,"paramType":"string"},{"name":"gram2","required":false,"paramType":"string"},{"name":"mi","required":false,"paramType":"double"},{"name":"wlmi","required":false,"paramType":"double"}]},{"name":"yearType","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"id","required":false,"paramType":"int"}]},{"name":"documentMetadata","fields":[{"name":"id","required":false,"paramType":"long"},{"name":"year","required":false,"paramType":"integer"},{"name":"contentType","required":false,"paramType":"contentType"},{"name":"provider","required":false,"paramType":"contentProvider"},{"name":"tag","required":false,"wrapperName":"tags","paramType":"List[string]"},{"name":"title","required":false,"paramType":"string"},{"name":"rating","required":false,"paramType":"double"},{"name":"medium","required":false,"paramType":"documentMedium"},{"name":"sourceUrl","required":false,"paramType":"string"},{"name":"createdAt","required":false,"paramType":"Date"},{"name":"stats","required":false,"paramType":"basicDocumentStats"},{"name":"date","required":false,"paramType":"Date"},{"name":"classification","required":false,"paramType":"subjectClassificationType"},{"name":"yearType","required":false,"paramType":"yearType"},{"name":"primaryAuthor","required":false,"paramType":"string"},{"name":"primaryAuthorType","required":false,"paramType":"authorType"},{"name":"primaryAuthorId","required":false,"paramType":"long"},{"name":"guid","required":false,"paramType":"string"},{"name":"extendedMetadata","required":false,"paramType":"extendedMetadata"},{"name":"author","required":false,"wrapperName":"authors","paramType":"List[author]"},{"name":"expirationDate","required":false,"paramType":"Date"}]},{"name":"documentMedium","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"id","required":false,"paramType":"int"}]},{"name":"subjectClassificationType","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"id","required":false,"paramType":"int"}]},{"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":"contentProvider","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"id","required":false,"paramType":"int"}]},{"name":"authorType","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":"scoredWord","fields":[{"name":"id","required":false,"paramType":"long"},{"name":"wordType","required":false,"paramType":"string"},{"name":"position","required":false,"paramType":"int"},{"name":"word","required":false,"paramType":"string"},{"name":"score","required":false,"paramType":"float"},{"name":"sentenceId","required":false,"paramType":"long"},{"name":"partOfSpeech","required":false,"paramType":"string"}]},{"name":"basicDocumentStats","fields":[{"name":"key","required":false,"paramType":"string"},{"name":"type","required":false,"paramType":"string"},{"name":"sentencesCount","required":false,"paramType":"long"},{"name":"documentsCount","required":false,"paramType":"long"},{"name":"tokensCount","required":false,"paramType":"long"},{"name":"uniqueWordsCount","required":false,"paramType":"long"},{"name":"wordsCount","required":false,"paramType":"long"},{"name":"firstUsedWordsCount","required":false,"paramType":"long"},{"name":"viableSentencesCount","required":false,"paramType":"long"},{"name":"uniqueBiGramsCount","required":false,"paramType":"long"}]},{"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/partners.json

@@ -0,0 +1 @@
+{"endPoints":[{"path":"/partners.{format}/{contentProvider}/glossaries","description":"","operations":[{"parameters":[{"name":"contentProvider","description":"Partner Code to create for.","required":false,"dataType":"string","paramType":"path"},{"description":"Glossary to create","required":false,"dataType":"Glossary","paramType":"body"}],"response":[{"valueType":"Glossary","errorResponses":[{"reason":"Invalid Glossary supplied.","code":400},{"reason":"Invalid Content Provider code supplied.","code":404}],"condition":"any"}],"category":"PartnersGlossary","summary":"Creates a glossary for the Content Provider.","suggestedName":"createGlossary","deprecated":false,"open":false,"httpMethod":"POST"},{"parameters":[{"name":"contentProvider","description":"Partner Code to fetch for.","required":false,"dataType":"string","paramType":"path"},{"name":"includeDrafts","description":"Includes unpublished Glossaries","required":false,"dataType":"string","paramType":"query"},{"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[Glossary]","errorResponses":[{"reason":"Invalid Content Provider code supplied.","code":404}],"condition":"any"}],"category":"PartnersGlossary","summary":"Fetches glossaries for the specified Provider.","suggestedName":"getGlossaries","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/partners.{format}/{contentProvider}/glossary/{permalinkId}","description":"","operations":[{"parameters":[{"name":"contentProvider","description":"Partner Code to fetch for.","required":false,"dataType":"string","paramType":"path"},{"name":"permalinkId","description":"Permalink of Glossary to fetch.","required":false,"dataType":"string","paramType":"path"},{"name":"version","description":"Version to fetch","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"Glossary","errorResponses":[{"reason":"Invalid Content Provider code supplied.","code":404}],"condition":"any"}],"category":"PartnersGlossary","summary":"Fetches a glossary for the specified Provider.","suggestedName":"getGlossary","deprecated":false,"open":false,"httpMethod":"GET"},{"parameters":[{"name":"contentProvider","description":"Partner Code to update for.","required":false,"dataType":"string","paramType":"path"},{"name":"permalinkId","description":"Permalink of Glossary to fetch.","required":false,"dataType":"string","paramType":"path"},{"name":"version","description":"Version to fetch","required":false,"dataType":"string","paramType":"query"},{"description":"Updated Glossary","required":false,"dataType":"Glossary","paramType":"body"}],"response":[{"valueType":"Glossary","errorResponses":[{"reason":"Invalid Content Provider code supplied.","code":404}],"condition":"any"}],"category":"PartnersGlossary","summary":"Updates a Glossaryfor the specified Provider.","suggestedName":"updateGlossary","deprecated":false,"open":false,"httpMethod":"PUT"},{"parameters":[{"name":"contentProvider","description":"Partner Code to delete for.","required":false,"dataType":"string","paramType":"path"},{"name":"permalinkId","description":"Permalink of Glossary to delete.","required":false,"dataType":"string","paramType":"path"},{"name":"version","description":"Version to delete","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid Content Provider code supplied.","code":404}],"condition":"any"}],"category":"PartnersGlossary","summary":"Deletes a single Glossary.","suggestedName":"deleteGlossary","deprecated":false,"open":false,"httpMethod":"DELETE"}]},{"path":"/partners","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":"/partners.{format}/{contentProvider}/glossary/{permalinkId}/entries","description":"","operations":[{"parameters":[{"name":"contentProvider","description":"Partner Code to fetch for.","required":false,"dataType":"string","paramType":"path"},{"name":"permalinkId","description":"Permalink of Glossary.","required":false,"dataType":"string","paramType":"path"},{"name":"version","description":"Specific Glossary version to fetch Entries for","required":false,"dataType":"string","paramType":"query"},{"name":"startsWith","description":"Word pattern to fetch with.","required":false,"dataType":"string","paramType":"query"},{"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[GlossaryEntry]","errorResponses":[{"reason":"Invalid Content Provider code supplied.","code":404}],"condition":"any"}],"category":"PartnersGlossary","summary":"Fetches GlossaryEntry objects for the specified Glossary.","suggestedName":"getGlossaryEntries","deprecated":false,"open":false,"httpMethod":"GET"},{"parameters":[{"name":"contentProvider","description":"Partner Code to add to.","required":false,"dataType":"string","paramType":"path"},{"name":"permalinkId","description":"Permalink of Glossary.","required":false,"dataType":"string","paramType":"path"},{"name":"version","description":"Specific Glossary version to fetch Entries for","required":false,"dataType":"string","paramType":"query"},{"description":"Glossary Entries to add","required":false,"dataType":"GlossaryEntry[]","paramType":"body"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid Content Provider code supplied.","code":404}],"condition":"any"}],"category":"PartnersGlossary","summary":"Adds GlossaryEntry objects for the specified Glossary.","suggestedName":"addGlossaryEntry","deprecated":false,"open":false,"httpMethod":"POST"}]},{"path":"/partners.{format}/{contentProvider}/glossary/{permalinkId}/publish","description":"","operations":[{"parameters":[{"name":"contentProvider","description":"Partner Code for Glossary.","required":false,"dataType":"string","paramType":"path"},{"name":"permalinkId","description":"Permalink of Glossary to publish.","required":false,"dataType":"string","paramType":"path"},{"name":"version","description":"Version to publish.","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid Content Provider code","code":400},{"reason":"Invalid Permalink ID supplied.","code":404}],"condition":"any"}],"category":"PartnersGlossary","summary":"Publishes a Glossary.","suggestedName":"publishGlossary","deprecated":false,"open":false,"httpMethod":"POST"}]},{"path":"/partners.{format}/{contentProvider}/glossary/{permalinkId}/clone","description":"","operations":[{"parameters":[{"name":"contentProvider","description":"Partner Code for Glossary.","required":false,"dataType":"string","paramType":"path"},{"name":"permalinkId","description":"Permalink of Glossary to version.","required":false,"dataType":"string","paramType":"path"},{"name":"version","description":"New version number to assign.","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"Glossary","errorResponses":[{"reason":"Invalid Content Provider code","code":400},{"reason":"Invalid Permalink ID supplied.","code":404}],"condition":"any"}],"category":"PartnersGlossary","summary":"Creates a new version of a Glossary.","suggestedName":"createVersion","deprecated":false,"open":false,"httpMethod":"POST"}]},{"path":"/partners.{format}/{contentProvider}/glossary/{permalinkId}/entries/{word}","description":"","operations":[{"parameters":[{"name":"contentProvider","description":"Partner Code to delete from.","required":false,"dataType":"string","paramType":"path"},{"name":"permalinkId","description":"Permalink of Glossary.","required":false,"dataType":"string","paramType":"path"},{"name":"word","description":"Word to remove.","required":false,"dataType":"string","paramType":"path"},{"name":"version","description":"Specific Glossary version to fetch Entries for","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid word being removed.","code":400},{"reason":"Invalid Content Provider code supplied.","code":404}],"condition":"any"}],"category":"PartnersGlossary","summary":"Removes a GlossaryEntry object from the specified Glossary.","suggestedName":"deleteGlossaryEntry","deprecated":false,"open":false,"httpMethod":"DELETE"}]},{"path":"/partners.{format}/{contentProvider}/glossary/{permalinkId}/deleteEntries","description":"","operations":[{"parameters":[{"name":"contentProvider","description":"Partner Code to delete from.","required":false,"dataType":"string","paramType":"path"},{"name":"permalinkId","description":"Permalink of Glossary.","required":false,"dataType":"string","paramType":"path"},{"description":"Words to remove.","required":false,"dataType":"StringValue[]","paramType":"body"},{"name":"version","description":"Specific Glossary version to remove Entries from","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid word being removed.","code":400},{"reason":"Invalid Content Provider code supplied.","code":404}],"condition":"any"}],"category":"PartnersGlossary","summary":"Removes a GlossaryEntry object from the specified Glossary.","suggestedName":"deleteGlossaryEntries","deprecated":false,"open":false,"httpMethod":"POST"}]}],"models":[{"name":"error","fields":[{"name":"reason","required":false,"paramType":"string"},{"name":"code","required":false,"paramType":"int"}]},{"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":"contentProvider","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"id","required":false,"paramType":"int"}]},{"name":"Glossary","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"id","required":false,"paramType":"long"},{"name":"version","required":false,"paramType":"double"},{"name":"status","required":false,"paramType":"glossaryStatus"},{"name":"description","required":false,"paramType":"string"},{"name":"permalinkId","required":false,"paramType":"string"},{"name":"contentProvider","required":false,"paramType":"contentProvider"},{"name":"createdAt","required":false,"paramType":"Date"},{"name":"publishedDate","required":false,"paramType":"Date"},{"name":"updatedAt","required":false,"paramType":"Date"},{"name":"totalEntries","required":false,"paramType":"int"}]},{"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":"GlossaryEntry","fields":[{"name":"url","required":false,"paramType":"string"},{"name":"wordstring","required":false,"paramType":"string"},{"name":"example","required":false,"paramType":"string"},{"name":"title","required":false,"paramType":"string"},{"name":"note","required":false,"paramType":"string"},{"name":"glossaryId","required":false,"paramType":"long"},{"name":"noteType","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":"glossaryStatus","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"id","required":false,"paramType":"int"}]}]}

data/api_docs/tag.json

@@ -0,0 +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"}]}]}

data/api_docs/user.json

@@ -0,0 +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"}]}]}

data/api_docs/users.json

@@ -0,0 +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"}]}]}

data/api_docs/word.json

@@ -0,0 +1 @@
+{"endPoints":[{"path":"/word.{format}/{word}/entries","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return","required":true,"dataType":"string","paramType":"path"},{"name":"tags","description":"Return XML tags in response","required":false,"dataType":"string","paramType":"query"},{"name":"sourceDictionary","description":"Get from a single dictionary. Valid options: ahd, century, wiktionary, webster, and wordnet.","required":false,"dataType":"string","paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"},{"name":"etymologies","description":"Return etymologies","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[entry]","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"condition":"any"}],"category":"DictionaryInfo","summary":"Return entries for a word","suggestedName":"getEntries","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/word.{format}/{word}/examples","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return examples for","required":true,"dataType":"string","paramType":"path"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"},{"name":"includeDuplicates","description":"Show duplicate examples from different sources","required":false,"dataType":"string","paramType":"query"},{"name":"contentProvider","description":"Return results from a specific ContentProvider","required":false,"dataType":"string","paramType":"query"},{"name":"useCanonical","description":"If true will try to return the correct word root ('cats' -> 'cat'). If false returns exactly what was requested.","required":false,"dataType":"string","paramType":"query"},{"name":"internalDataStore","description":"Specify the internal storage engine.","required":false,"dataType":"string","paramAccess":"internal","paramType":"query"},{"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":"exampleSearchResults","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"condition":"any"}],"category":"Examples","summary":"Returns examples for a word","suggestedName":"getExamples","deprecated":false,"open":false,"httpMethod":"GET"},{"parameters":[{"name":"word","description":"Word to fetch examples for","required":true,"dataType":"string","paramType":"path"},{"description":"Search definition object","required":false,"dataType":"ExampleSearchQuery","paramType":"body"},{"name":"internalDataStore","description":"Specify the internal storage engine.","required":false,"dataType":"string","paramAccess":"internal","paramType":"query"}],"response":[{"valueType":"exampleSearchResults","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"condition":"any"}],"category":"Examples","summary":"Fetches examples for a word","suggestedName":"getExamplesPost","deprecated":false,"open":false,"httpMethod":"POST"}]},{"path":"/word.{format}/{word}/wordForms","description":"","operations":[{"parameters":[{"name":"word","description":"Word to add forms for","required":false,"dataType":"string","paramType":"path"},{"description":"RelationshipMapWord to add","required":false,"dataType":"suggestion","paramType":"body"},{"name":"canonical","description":"Make this the Canonical form of the word.","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No results.","code":404}],"condition":"any"}],"category":"WordDetails","summary":"Adds a Relationship Map to a word","suggestedName":"addWordForm","deprecated":false,"open":false,"httpMethod":"POST"},{"parameters":[{"name":"word","description":"Word to fetch forms for","required":true,"dataType":"string","paramType":"path"},{"name":"useCanonical","description":"If true will try to return a correct word root ('cats' -> 'cat'). If false returns exactly what was requested.","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"relationshipMap","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No results.","code":404}],"condition":"any"}],"category":"WordDetails","summary":"Returns other forms of a word","suggestedName":"getWordForms","deprecated":false,"open":false,"httpMethod":"GET"},{"parameters":[{"name":"word","description":"Word to delete forms from","required":false,"dataType":"string","paramType":"path"},{"name":"type","description":"Relationship type to delete","required":false,"dataType":"string","paramType":"query"},{"name":"word","description":"Target word to remove relationship from.","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No results.","code":404}],"condition":"any"}],"category":"WordDetails","summary":"Deletes a relationship from a word","suggestedName":"deleteWordForm","deprecated":false,"open":false,"httpMethod":"DELETE"}]},{"path":"/word.{format}/{word}","description":"","operations":[{"parameters":[{"name":"word","description":"String value of WordObject to return","required":true,"dataType":"string","paramType":"path"},{"name":"useCanonical","description":"If true will try to return the correct word root ('cats' -> 'cat'). If false returns exactly what was requested.","required":false,"dataType":"string","paramType":"query"},{"name":"includeSuggestions","description":"Return suggestions (for correct spelling, case variants, etc.)","required":false,"dataType":"string","paramType":"query"},{"name":"shouldCreate","description":"Create word if not existing","required":false,"dataType":"string","paramAccess":"internal","paramType":"query"}],"response":[{"valueType":"wordObject","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"condition":"any"}],"category":"WordDetails","summary":"Given a word as a string, returns the WordObject that represents it","suggestedName":"getWord","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/word.{format}/{word}/definitions","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return definitions for","required":true,"dataType":"string","paramType":"path"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"},{"name":"partOfSpeech","description":"CSV list of part-of-speech types","required":false,"dataType":"string","allowableValues":"noun,adjective,verb,adverb,interjection,pronoun,preposition,abbreviation,affix,article,auxiliary-verb,conjunction,definite-article,family-name,given-name,idiom,imperative,noun-plural,noun-posessive,past-participle,phrasal-prefix,proper-noun,proper-noun-plural,proper-noun-posessive,suffix,verb-intransitive,verb-transitive","paramType":"query"},{"name":"includeRelated","description":"Return related words with definitions","required":false,"dataType":"string","allowableValues":"true,false","paramType":"query"},{"name":"sourceDictionaries","description":"Gets from dictionaries in the supplied order of precedence","required":false,"dataType":"string","allowableValues":"ahd, century, wiktionary, webster, wordnet","paramType":"query"},{"name":"useCanonical","description":"If true will try to return the correct word root ('cats' -> 'cat'). If false returns exactly what was requested.","required":false,"dataType":"string","allowableValues":"false,true","paramType":"query"},{"name":"includeTags","description":"Return a closed set of XML tags in response","required":false,"dataType":"string","allowableValues":"false,true","paramType":"query"}],"response":[{"valueType":"List[definition]","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No definitions found.","code":404}],"condition":"any"}],"category":"DictionaryInfo","summary":"Return definitions for a word","suggestedName":"getDefinitions","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/word.{format}/{word}/stats","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return stats for","required":false,"dataType":"string","paramType":"path"},{"name":"useCanonical","description":"If true will try to return the correct word root ('cats' -> 'cat'). If false returns exactly what was requested.","required":false,"dataType":"string","paramType":"query"},{"name":"detailed","description":"Return detailed usage info","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"wordStats","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No stats available.","code":404}],"condition":"any"}],"category":"Statistics","summary":"Returns word statistics","suggestedName":"getWordStats","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/word","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":"/word.{format}/{word}/topExample","description":"","operations":[{"parameters":[{"name":"word","description":"Word to fetch examples for","required":true,"dataType":"string","paramType":"path"},{"name":"contentProvider","description":"Return results from a specific ContentProvider","required":false,"dataType":"string","paramType":"query"},{"name":"useCanonical","description":"If true will try to return the correct word root ('cats' -> 'cat'). If false returns exactly what was requested.","required":false,"dataType":"string","paramType":"query"},{"name":"internalDataStore","description":"Specify the internal storage engine.","required":false,"dataType":"string","paramAccess":"internal","paramType":"query"}],"response":[{"valueType":"example","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"condition":"any"}],"category":"Examples","summary":"Returns a top example for a word","suggestedName":"getTopExample","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/word.{format}/{word}/punctuationFactor","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return","required":true,"dataType":"string","paramType":"path"},{"name":"caseSensitive","description":"Input is case sensitive","required":false,"dataType":"string","paramAccess":"internal","paramType":"query"},{"name":"useCanonical","description":"Use the canonical form of the word.","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"punctuationFactor","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No results.","code":404}],"condition":"any"}],"category":"DeprecatedApis","summary":"Fetches other forms of a word","suggestedName":"getPunctuationFactor","deprecated":false,"open":false,"notes":"Deprecated","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/contextualLookup","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return definitions for","required":true,"dataType":"string","paramType":"path"},{"name":"sentence","description":"The sentence in which the word occurs","required":true,"dataType":"string","paramType":"query"},{"name":"offset","defaultValue":"-1","description":"The start character offset of the word in the given sentence","required":false,"dataType":"int","allowableValues":"0 to 4096","paramType":"query"},{"name":"expandTerms","description":"Expand context terms using related words","required":false,"dataType":"string","allowableValues":"true,false","paramType":"query"},{"name":"includeSourceDictionaries","description":"Only include these comma-delimited source dictionaries","required":false,"dataType":"string","allowableValues":"ahd, century, wiktionary, webster, wordnet","paramType":"query"},{"name":"excludeSourceDictionaries","description":"Exclude these comma-delimited source dictionaries","required":false,"dataType":"string","allowableValues":"ahd, century, wiktionary, webster, wordnet","paramType":"query"},{"name":"skip","defaultValue":"0","description":"Results to skip","required":false,"dataType":"string","allowableValues":"0 to 1000","paramType":"query"},{"name":"limit","defaultValue":"10","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":"1 to 1000","paramType":"query"}],"response":[{"valueType":"DefinitionSearchResults","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"condition":"any"}],"category":"DictionaryInfo","summary":"Returns definitions for a word based on the sentence in which it is found","suggestedName":"contextualLookup","deprecated":false,"open":false,"notes":"Use the offset parameter when the word occurs more than once in the sentence","httpMethod":"GET"},{"parameters":[{"name":"word","description":"Word to return definitions for","required":true,"dataType":"string","paramType":"path"},{"description":"The sentence in which the word occurs","required":true,"dataType":"string","paramType":"body"},{"name":"offset","defaultValue":"-1","description":"The start character offset of the word in the given sentence","required":false,"dataType":"int","allowableValues":"0 to 4096","paramType":"query"},{"name":"expandTerms","description":"Expand context terms using related words","required":false,"dataType":"string","allowableValues":"true,false","paramType":"query"},{"name":"includeSourceDictionaries","description":"Only include these comma-delimited source dictionaries","required":false,"dataType":"string","allowableValues":"ahd, century, wiktionary, webster, wordnet","paramType":"query"},{"name":"excludeSourceDictionaries","description":"Exclude these comma-delimited source dictionaries","required":false,"dataType":"string","allowableValues":"ahd, century, wiktionary, webster, wordnet","paramType":"query"},{"name":"skip","defaultValue":"0","description":"Results to skip","required":false,"dataType":"string","allowableValues":"0 to 1000","paramType":"query"},{"name":"limit","defaultValue":"10","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":"1 to 1000","paramType":"query"}],"response":[{"valueType":"DefinitionSearchResults","errorResponses":[{"reason":"Invalid term supplied.","code":400}],"condition":"any"}],"category":"DictionaryInfo","summary":"Returns definitions for a word based on the sentence in which it is found","suggestedName":"contextualLookupPost","deprecated":false,"open":false,"notes":"Use the offset parameter when the word occurs more than once in the sentence","httpMethod":"POST"}]},{"path":"/word.{format}/{word}/commentCount","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get comment count for.","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"long","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"Word not found.","code":404}],"condition":"any"}],"category":"Comments","summary":"Returns the number of comments on a word","suggestedName":"getCommentCount","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/word.{format}/{word}/related","description":"","operations":[{"parameters":[{"name":"word","description":"Word for which to return related words","required":true,"dataType":"string","paramType":"path"},{"name":"partOfSpeech","description":"CSV list of part-of-speech types","required":false,"dataType":"string","allowableValues":"noun,adjective,verb,adverb,interjection,pronoun,preposition,abbreviation,affix,article,auxiliary-verb,conjunction,definite-article,family-name,given-name,idiom,imperative,noun-plural,noun-posessive,past-participle,phrasal-prefix,proper-noun,proper-noun-plural,proper-noun-posessive,suffix,verb-intransitive,verb-transitive","paramType":"query"},{"name":"sourceDictionary","description":"Get data from a single dictionary","required":false,"dataType":"string","allowableValues":"ahd, century, wiktionary, webster, wordnet","paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"},{"name":"useCanonical","description":"If true will try to return the correct word root ('cats' -> 'cat'). If false returns exactly what was requested.","required":false,"dataType":"string","allowableValues":"false,true","paramType":"query"},{"name":"type","description":"Relationship type","required":false,"dataType":"string","allowableValues":"synonym,antonym,variant,equivalent,cross-reference,related-word,rhyme,form,etymologically-related-term,hypernym,hyponym,inflected-form,primary,same-context,verb-form,verb-stem,unknown","paramType":"query"}],"response":[{"valueType":"List[related]","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No definitions found.","code":404}],"condition":"any"}],"category":"DictionaryInfo","summary":"Return related words (thesaurus data) for a word","suggestedName":"getRelatedWords","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/word.{format}/{word}/listedIn","description":"","operations":[{"parameters":[{"name":"word","description":"Word to fetch WordLists 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[wordList]","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"condition":"any"}],"category":"WordListMethods","summary":"Returns WordLists containing a word","suggestedName":"getListedIn","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/word.{format}/{word}/listedInCount","description":"","operations":[{"parameters":[{"name":"word","description":"Word to fetch count for","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"long","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"Word not found.","code":404}],"condition":"any"}],"category":"WordListMethods","summary":"Returns a count of lists a word appears in","suggestedName":"getListedInCount","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/word.{format}/{word}/firstListedIn","description":"","operations":[{"parameters":[{"name":"word","description":"Word to fetch a WordList for","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"wordList","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"Word not found.","code":404}],"condition":"any"}],"category":"WordListMethods","summary":"Returns the first WordList a word appeared in","suggestedName":"getFirstListedIn","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/word.{format}/{word}/firstListedBy","description":"","operations":[{"parameters":[{"name":"word","description":"Word to fetch a User for","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"user","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"Word not found.","code":404}],"condition":"any"}],"category":"WordListMethods","summary":"Returns the first User to list a particular word","suggestedName":"getFirstListedBy","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/word.{format}/{word}/pronunciations","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get pronunciations for","required":true,"dataType":"string","paramType":"path"},{"name":"useCanonical","description":"If true will try to return a correct word root ('cats' -> 'cat'). If false returns exactly what was requested.","required":false,"dataType":"string","paramType":"query"},{"name":"sourceDictionary","description":"Get from a single dictionary.","required":false,"dataType":"string","allowableValues":"ahd,century,cmu,macmillan,wiktionary,webster,wordnet","paramType":"query"},{"name":"typeFormat","description":"Text pronunciation type","required":false,"dataType":"string","allowableValues":"ahd,arpabet,gcide-diacritical,IPA","paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[textPron]","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"condition":"any"}],"category":"WordDetails","summary":"Returns text pronunciations for a given word","suggestedName":"getTextPronunciations","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/word.{format}/{word}/images/flickr","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get flickr images for.","required":false,"dataType":"string","paramType":"path"},{"name":"size","description":"Image size","required":false,"dataType":"string","allowableValues":"thumb,small,med,lg,orig","paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[photo]","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"condition":"any"}],"category":"WordDetails","summary":"Returns Flickr images for a word","suggestedName":"getFlickrImages","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/word.{format}/{word}/scrabbleScore","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get scrabble score for.","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"long","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No scrabble score found.","code":404}],"condition":"any"}],"category":"WordDetails","summary":"Returns the Scrabble score for a word","suggestedName":"getScrabbleScore","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/word.{format}/{word}/citations","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get citations for.","required":false,"dataType":"string","paramType":"path"},{"name":"useCanonical","description":"If true will try to return a correct word root ('cats' -> 'cat'). If false returns exactly what was requested.","required":false,"dataType":"string","paramType":"query"},{"name":"sourceDictionary","description":"Get from a single dictionary. Valid options: ahd, century, wiktionary, webster, and wordnet.","required":false,"dataType":"string","paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[citation]","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"condition":"any"}],"category":"WordDetails","summary":"Returns citations for a word","suggestedName":"getCitations","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/word.{format}/{word}/hyphenation","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get syllables for","required":true,"dataType":"string","paramType":"path"},{"name":"useCanonical","description":"If true will try to return a correct word root ('cats' -> 'cat'). If false returns exactly what was requested.","required":false,"dataType":"string","paramType":"query"},{"name":"sourceDictionary","description":"Get from a single dictionary. Valid options: ahd, century, wiktionary, webster, and wordnet.","required":false,"dataType":"string","paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[syllable]","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"condition":"any"}],"category":"WordDetails","summary":"Returns syllable information for a word","suggestedName":"getHyphenation","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/word.{format}/{word}/unigramCountInternal","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get unigram count for.","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"long","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"condition":"any"}],"category":"WordDetails","summary":"Returns syllable information for a word","suggestedName":"getUnigramCountInternal","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/word.{format}/{word}/phrasesInternal","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get bigrams for.","required":false,"dataType":"string","paramType":"path"},{"name":"gamma","description":"Gamma filter","required":false,"dataType":"string","paramType":"query"},{"name":"minWlmi","description":"WLMI Limit","required":false,"dataType":"string","paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[bigram]","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"condition":"any"}],"category":"WordDetails","summary":"Returns Bigrams for the given word","suggestedName":"getBigramsInternal","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/word.{format}/{word}/lookupCount","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get Bigrams for","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"long","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"Word not found.","code":404}],"condition":"any"}],"category":"WordDetails","summary":"Returns the number of times a word has been viewed","suggestedName":"getLookupCount","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/word.{format}/{word}/tags","description":"","operations":[{"parameters":[{"name":"word","description":"Word to fetch Tags on","required":false,"dataType":"string","paramType":"path"},{"name":"useCanonical","description":"Use the canonical form of the word.","required":false,"dataType":"string","paramType":"query"},{"name":"username","description":"Restrict to a particular user","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[tag]","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"condition":"any"}],"category":"Tags","summary":"Fetches tags for a word","suggestedName":"getTagsOnWord","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/word.{format}/{word}/tagCount","description":"","operations":[{"parameters":[{"name":"word","description":"Word to fetch Tag count on","required":false,"dataType":"string","paramType":"path"},{"name":"useCanonical","description":"Use the canonical form of the word.","required":false,"dataType":"string","paramType":"query"},{"name":"username","description":"Restrict to a particular user","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"long","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"condition":"any"}],"category":"Tags","summary":"Fetches tag count for a word","suggestedName":"getTagCountOnWord","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/word.{format}/{word}/tag","description":"","operations":[{"parameters":[{"name":"word","description":"Word to add a Tag to","required":false,"dataType":"string","paramType":"path"},{"name":"tags","description":"CSV list of tags to add.","required":false,"dataType":"string","paramType":"query"},{"name":"username","description":"Add tag on behalf of a particular user","required":false,"dataType":"string","paramAccess":"internal","paramType":"query"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"condition":"any"}],"category":"Tags","summary":"Adds a tag to a word","suggestedName":"addTagToWord","deprecated":false,"open":false,"httpMethod":"POST"},{"parameters":[{"name":"word","description":"Word to add a Tag to","required":false,"dataType":"string","paramType":"path"},{"name":"tags","description":"CSV list of tags to remove.","required":false,"dataType":"string","paramType":"query"},{"name":"username","description":"Remove tag on behalf of a particular user","required":false,"dataType":"string","paramAccess":"internal","paramType":"query"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"condition":"any"}],"category":"Tags","summary":"Removes a tag from a word","suggestedName":"deleteTagFromWord","deprecated":false,"open":false,"httpMethod":"DELETE"}]},{"path":"/word.{format}/{word}/frequency","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return","required":true,"dataType":"string","paramType":"path"},{"name":"caseSensitive","description":"Input is case sensitive","required":false,"dataType":"string","paramAccess":"internal","paramType":"query"},{"name":"useCanonical","description":"If true will try to return the correct word root ('cats' -> 'cat'). If false returns exactly what was requested.","required":false,"dataType":"string","paramType":"query"},{"name":"startYear","description":"Starting Year","required":false,"dataType":"string","paramType":"query"},{"name":"endYear","description":"Ending Year","required":false,"dataType":"string","paramType":"query"},{"name":"includeErrorBars","description":"Get error bar data","required":false,"dataType":"string","paramAccess":"internal","paramType":"query"}],"response":[{"valueType":"frequencySummary","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No results.","code":404}],"condition":"any"},{"valueType":"frequencySummaryE","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No results.","code":404}],"condition":"errorBars=true"}],"category":"Statistics","summary":"Returns word usage over time","suggestedName":"getWordFrequency","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/word.{format}/{word}/firstUsed","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return first usage for","required":false,"dataType":"string","paramType":"path"},{"name":"useCanonical","description":"Use the canonical form of the word.","required":false,"dataType":"string","paramType":"query"},{"name":"detailed","description":"Return detailed usage info","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"detailedWordUsage","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"condition":"detailed=true"},{"valueType":"basicWordUsage","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"condition":"detailed=false"}],"category":"Statistics","summary":"Returns first usage of a word","suggestedName":"getFirstUsageOfWord","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/word.{format}/{word}/wordView","description":"","operations":[{"parameters":[{"name":"word","description":"Word to record a word view for","required":false,"dataType":"string","paramType":"path"},{"name":"userId","description":"ID of the user viewing the word","required":false,"dataType":"string","paramType":"query"},{"name":"userGuid","description":"Tracking ID for the user","required":false,"dataType":"string","paramType":"query"},{"name":"userSessionId","description":"Session ID for the user","required":false,"dataType":"string","paramType":"query"},{"name":"serverIp","description":"Internal IP address of the web server","required":false,"dataType":"string","paramType":"query"},{"name":"pageName","description":"Page being viewed","required":false,"dataType":"string","paramType":"query"},{"name":"method","description":"Method of the word view","required":false,"dataType":"string","paramType":"query"},{"name":"userAgent","description":"Browser user agent","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"condition":"any"}],"category":"Statistics","summary":"Records a word view from the website","suggestedName":"addWordView","deprecated":false,"open":false,"httpMethod":"POST"}]},{"path":"/word.{format}/{word}/isFavorite","description":"","operations":[{"parameters":[{"name":"word","description":"Word to check","required":false,"dataType":"string","paramType":"path"},{"name":"useCanonical","description":"Use the canonical form of the word.","required":false,"dataType":"string","paramType":"query"},{"name":"userName","description":"Check for a particular user","required":true,"dataType":"string","paramAccess":"internal","paramType":"query"}],"response":[{"valueType":"BooleanValue","errorResponses":[{"reason":"Invalid word supplied","code":400},{"reason":"No user found","code":404}],"condition":"any"}],"category":"Favorites","summary":"Checks to see if a word is a user's favorite","suggestedName":"isFavorite","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/word.{format}/{word}/favoriteCount","description":"","operations":[{"parameters":[{"name":"word","description":"Word to check","required":false,"dataType":"string","paramType":"path"},{"name":"useCanonical","description":"Use the canonical form of the word.","required":false,"dataType":"string","paramType":"query"},{"name":"userName","description":"Check for a particular user","required":false,"dataType":"string","paramAccess":"internal","paramType":"query"}],"response":[{"valueType":"long","errorResponses":[{"reason":"Invalid word supplied","code":400},{"reason":"No user found","code":404}],"condition":"any"}],"category":"Favorites","summary":"Returns the number of times a word has been Favorited","suggestedName":"getFavoriteCount","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/word.{format}/{word}/favorite","description":"","operations":[{"parameters":[{"name":"word","description":"Word to favorite","required":false,"dataType":"string","paramType":"path"},{"name":"userName","description":"Add as favorite on behalf of a particular user","required":false,"dataType":"string","paramAccess":"internal","paramType":"query"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No user found","code":404}],"condition":"any"}],"category":"Favorites","summary":"Favorites a Word for a user","suggestedName":"addWordToFavorites","deprecated":false,"open":false,"httpMethod":"POST"},{"parameters":[{"name":"word","description":"Word to remove","required":false,"dataType":"string","paramType":"path"},{"name":"userName","description":"Remove on behalf of a particular user","required":false,"dataType":"string","paramAccess":"internal","paramType":"query"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid word supplied or no user found.","code":400}],"condition":"any"}],"category":"Favorites","summary":"Removes a Word from a user's Favorites","suggestedName":"deleteFromFavorites","deprecated":false,"open":false,"httpMethod":"DELETE"}]},{"path":"/word.{format}/{word}/phrases","description":"","operations":[{"parameters":[{"name":"word","description":"Word to fetch phrases for","required":true,"dataType":"string","paramType":"path"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"},{"name":"wlmi","description":"Minimum WLMI for the phrase","required":false,"dataType":"string","paramType":"query"},{"name":"useCanonical","description":"If true will try to return the correct word root ('cats' -> 'cat'). If false returns exactly what was requested.","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[bigram]","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"condition":"any"}],"category":"Examples","summary":"Fetches bi-gram phrases for a word","suggestedName":"getPhrases","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/word.{format}/{word}/etymologies","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return","required":false,"dataType":"string","paramType":"path"},{"name":"sourceDictionary","description":"Get etymologies from a single dictionary. Options are ahd or century.","required":false,"dataType":"string","paramType":"query"},{"name":"useCanonical","description":"If true will try to return the correct word root ('cats' -> 'cat'). If false returns exactly what was requested.","required":false,"dataType":"string","paramType":"query"},{"name":"type","description":"Etymology type","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"String","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No definitions found.","code":404}],"condition":"any"}],"category":"DictionaryInfo","summary":"Fetches etymology data","suggestedName":"getEtymologies","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/word.{format}/{word}/otherFormsInternal","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return","required":false,"dataType":"string","paramType":"path"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"},{"name":"minFrequency","description":"Minimum corpus frequency","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[otherForms]","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"condition":"any"}],"category":"DeprecatedApis","summary":"Fetches other forms of a word","suggestedName":"getOtherFormsInternal","deprecated":false,"open":false,"notes":"Deprecated","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/wordRelationshipInternal","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return","required":false,"dataType":"string","paramType":"path"},{"description":"Relationship to add","required":false,"dataType":"relatedData","paramType":"body"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No results.","code":404}],"condition":"any"}],"category":"DeprecatedApis","summary":"Adds a word relationship","suggestedName":"addWordRelationshipInternal","deprecated":false,"open":false,"notes":"Deprecated","httpMethod":"POST"}]},{"path":"/word.{format}/{word}/comments","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return Comments for","required":false,"dataType":"string","paramType":"path"},{"name":"sortOrder","defaultValue":"descending","description":"Direction to sort by","required":false,"dataType":"string","allowableValues":"ascending,descending","paramType":"query"},{"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":"Invalid word supplied.","code":400}],"condition":"any"}],"category":"Comments","summary":"Fetches comments on a Word","suggestedName":"getCommentsOnWord","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/word.{format}/{word}/comment/{commentId}","description":"","operations":[{"parameters":[{"name":"word","description":"Word to fetch Comment for.","required":false,"dataType":"string","paramType":"path"},{"name":"commentId","description":"ID of Comment to fetch.","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"comment","errorResponses":[{"reason":"Invalid word or Comment supplied.","code":400},{"reason":"Word or commentor not found.","code":404}],"condition":"any"}],"category":"Comments","summary":"Fetches a Comment by ID","suggestedName":"deleteCommentOnWord","deprecated":false,"open":false,"httpMethod":"GET"},{"parameters":[{"name":"word","description":"Word to update Comment on.","required":false,"dataType":"string","paramType":"path"},{"name":"commentId","description":"Updated Comment.","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid word or Comment supplied.","code":400},{"reason":"Word or commentor not found.","code":404}],"condition":"any"}],"category":"Comments","summary":"Deletes an existing word comment","suggestedName":"deleteCommentByIdOnWord","deprecated":false,"open":false,"httpMethod":"DELETE"}]},{"path":"/word.{format}/{word}/comment","description":"","operations":[{"parameters":[{"name":"word","description":"Word to add Comment to.","required":false,"dataType":"string","paramType":"path"},{"description":"Comment to add.","required":false,"dataType":"comment","paramType":"body"}],"response":[{"valueType":"comment","errorResponses":[{"reason":"Invalid word or Comment supplied.","code":400},{"reason":"Word or commentor not found.","code":404}],"condition":"any"}],"category":"Comments","summary":"Adds a comment to a word","suggestedName":"commentOnWord","deprecated":false,"open":false,"httpMethod":"POST"},{"parameters":[{"name":"word","description":"Word to update Comment on.","required":false,"dataType":"string","paramType":"path"},{"description":"Updated Comment.","required":false,"dataType":"comment","paramType":"body"}],"response":[{"valueType":"comment","errorResponses":[{"reason":"Invalid word or Comment supplied.","code":400},{"reason":"Word or commentor not found.","code":404}],"condition":"any"}],"category":"Comments","summary":"Updates an existing word comment","suggestedName":"updateCommentOnWord","deprecated":false,"open":false,"httpMethod":"PUT"}]},{"path":"/word.{format}/{word}/audio","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get audio for.","required":true,"dataType":"string","paramType":"path"},{"name":"useCanonical","description":"Use the canonical form of the word.","required":false,"dataType":"string","paramType":"query"},{"name":"v3Format","description":"Use the V3 api.","required":false,"dataType":"string","paramAccess":"internal","paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[audioFile]","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"condition":"any"}],"category":"AudioInfo","summary":"Fetches audio metadata for a word.","suggestedName":"getAudio","deprecated":false,"open":false,"notes":"The metadata includes a time-expiring fileUrl which allows reading the audio file directly from the API.  Currently only audio pronunciations from the American Heritage Dictionary in mp3 format are supported.","httpMethod":"GET"},{"parameters":[{"name":"word","description":"Word to add audio to.","required":false,"dataType":"string","paramType":"path"},{"description":"AudioPon metadata to add.","required":false,"dataType":"audioObject","paramType":"body"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"condition":"any"}],"category":"AudioInfo","summary":"Creates AudioPron metadata","suggestedName":"addAudio","deprecated":false,"open":false,"httpMethod":"POST"}]},{"path":"/word.{format}/{word}/audio/{audio_id}","description":"","operations":[{"parameters":[{"name":"word","description":"Word to delete audio from.","required":false,"dataType":"string","paramType":"path"},{"name":"audio_id","description":"AudioPon metadata to add.","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"Unauthorized.","code":401}],"condition":"any"}],"category":"AudioInfo","summary":"Deletes an AudioPron","suggestedName":"deleteAudio","deprecated":false,"open":false,"httpMethod":"DELETE"}]}],"models":[{"name":"BooleanValue","fields":[{"name":"value","required":false,"paramType":"boolean"}]},{"name":"note","fields":[{"name":"noteType","description":"Contains the type of note","required":false,"allowableValues":"x, y, z","internalDescription":"Need to replace x, y z","paramAccess":"open","paramType":"string"},{"name":"pos","required":false,"paramType":"int"},{"name":"value","required":false,"paramType":"string"},{"name":"appliesTo","required":false,"paramType":"List[string]"}]},{"name":"long","fields":[{"name":"value","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":"header","fields":[{"name":"type","required":false,"paramType":"type"},{"name":"position","required":false,"paramType":"integer"},{"name":"word","required":false,"paramType":"string"},{"name":"textPron","required":false,"wrapperName":"textProns","paramType":"List[textPron]"},{"name":"partOfSpeech","required":false,"paramType":"string"},{"name":"note","required":false,"wrapperName":"notes","paramType":"List[note]"},{"name":"syllable","required":false,"wrapperName":"syllables","paramType":"List[syllable]"},{"name":"sourceDictionary","required":false,"paramType":"string"},{"name":"homograph","required":false,"paramType":"string"},{"name":"derivativeSense","required":false,"paramType":"string"},{"name":"derivedFrom","required":false,"paramType":"string"},{"name":"etymologyXml","required":false,"paramType":"string"}]},{"name":"contentProvider","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"id","required":false,"paramType":"int"}]},{"name":"frequency","fields":[{"name":"year","required":false,"paramType":"int"},{"name":"count","required":false,"paramType":"long"}]},{"name":"doc","fields":[{"name":"endPoints","required":false,"paramType":"List[endpoint]"},{"name":"models","required":false,"paramType":"List[object]"}]},{"name":"frequencySummary","fields":[{"name":"word","required":false,"paramType":"string"},{"name":"totalCount","required":false,"paramType":"long"},{"name":"frequency","required":false,"paramType":"List[frequency]"},{"name":"unknownYearCount","required":false,"paramType":"int"}]},{"name":"detailedWordUsage","fields":[{"name":"wordstring","required":false,"paramType":"string"},{"name":"sentence","required":false,"paramType":"sentence"},{"name":"metadata","required":false,"paramType":"documentMetadata"}]},{"name":"citation","fields":[{"name":"source","required":false,"paramType":"string"},{"name":"cite","required":false,"paramType":"string"}]},{"name":"audioType","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"id","required":false,"paramType":"int"}]},{"name":"otherForms","fields":[{"name":"id","required":false,"paramType":"long"},{"name":"wordString","required":false,"paramType":"string"},{"name":"totalCount","required":false,"paramType":"long"},{"name":"plain","required":false,"paramType":"string"},{"name":"wordId","required":false,"paramType":"long"}]},{"name":"endpoint","fields":[{"name":"path","required":false,"paramType":"string"},{"name":"description","required":false,"paramType":"string"},{"name":"operations","required":false,"paramType":"List[operation]"}]},{"name":"facet","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"facetValue","required":false,"wrapperName":"facetValues","paramType":"List[facetValue]"}]},{"name":"wordObject","fields":[{"name":"word","required":false,"paramType":"string"},{"name":"vulgar","required":false,"paramType":"string"}]},{"name":"relationshipMap","fields":[{"name":"sourceWordstring","required":false,"paramType":"string"},{"name":"suggestion","required":false,"wrapperName":"suggestions","paramType":"List[suggestion]"}]},{"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":"exampleSearchResults","fields":[{"name":"facet","required":false,"wrapperName":"facets","paramType":"List[facet]"},{"name":"example","required":false,"wrapperName":"examples","paramType":"List[example]"}]},{"name":"partOfSpeech","fields":[{"name":"roots","required":false,"paramType":"List[root]"}]},{"name":"sizes","fields":[{"name":"size","required":false,"paramType":"List[size]"}]},{"name":"Label","fields":[{"name":"type","required":false,"paramType":"string"},{"name":"text","required":false,"paramType":"string"}]},{"name":"audioFile","fields":[{"name":"id","required":true,"paramType":"long"},{"name":"description","required":false,"paramType":"string"},{"name":"word","required":false,"paramType":"string"},{"name":"createdBy","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":"fileUrl","required":false,"paramType":"string"},{"name":"audioType","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":"DefinitionSearchResults","fields":[{"name":"totalResults","required":false,"paramType":"int"},{"name":"result","required":false,"wrapperName":"results","paramType":"List[definition]"}]},{"name":"frequencyElement","fields":[{"name":"year","required":false,"paramType":"int"},{"name":"lowerWisker","required":false,"paramType":"double"},{"name":"upperWisker","required":false,"paramType":"double"},{"name":"lowerBox","required":false,"paramType":"double"},{"name":"upperBox","required":false,"paramType":"double"}]},{"name":"tag","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"id","required":false,"paramType":"long"},{"name":"count","required":false,"paramType":"long"}]},{"name":"example","fields":[{"name":"year","required":false,"paramType":"integer"},{"name":"provider","required":false,"paramType":"contentProvider"},{"name":"url","required":false,"paramType":"string"},{"name":"word","required":false,"paramType":"string"},{"name":"text","required":false,"paramType":"string"},{"name":"title","required":false,"paramType":"string"},{"name":"rating","required":false,"paramType":"float"},{"name":"exampleId","required":false,"paramType":"long"},{"name":"documentId","required":false,"paramType":"long"}]},{"name":"definition","fields":[{"name":"exampleUsage","required":false,"wrapperName":"exampleUses","paramType":"List[ExampleUsage]"},{"name":"word","required":false,"paramType":"string"},{"name":"text","required":false,"paramType":"string"},{"name":"textPron","required":false,"wrapperName":"textProns","paramType":"List[textPron]"},{"name":"score","required":false,"paramType":"float"},{"name":"partOfSpeech","required":false,"paramType":"string"},{"name":"note","required":false,"wrapperName":"notes","paramType":"List[note]"},{"name":"citation","required":false,"wrapperName":"citations","paramType":"List[citation]"},{"name":"relWord","required":false,"wrapperName":"relatedWords","paramType":"List[related]"},{"name":"sourceDictionary","required":false,"paramType":"string"},{"name":"label","required":false,"wrapperName":"labels","paramType":"List[Label]"},{"name":"sequence","required":false,"paramType":"string"},{"name":"seqString","required":false,"paramType":"string"},{"name":"extendedText","required":false,"paramType":"string"}]},{"name":"photo","fields":[{"name":"id","required":false,"paramType":"long"},{"name":"owner","required":false,"paramType":"string"},{"name":"server","required":false,"paramType":"int"},{"name":"title","required":false,"paramType":"string"},{"name":"ownername","required":false,"paramType":"string"},{"name":"secret","required":false,"paramType":"string"},{"name":"farm","required":false,"paramType":"int"},{"name":"ispublic","required":false,"paramType":"int"},{"name":"isfriend","required":false,"paramType":"int"},{"name":"isfamily","required":false,"paramType":"int"},{"name":"ownerLink","required":false,"paramType":"string"},{"name":"linkUri","required":false,"paramType":"string"},{"name":"size","required":false,"paramType":"size"}]},{"name":"basicWordUsage","fields":[{"name":"year","required":false,"paramType":"integer"},{"name":"wordstring","required":false,"paramType":"string"},{"name":"documentId","required":false,"paramType":"long"},{"name":"sentenceId","required":false,"paramType":"long"}]},{"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":"ExampleUsage","fields":[{"name":"text","required":false,"paramType":"string"}]},{"name":"entry","fields":[{"name":"id","required":false,"paramType":"long"},{"name":"header","required":false,"paramType":"header"},{"name":"word","required":false,"paramType":"string"},{"name":"note","required":false,"wrapperName":"notes","paramType":"List[note]"},{"name":"definition","required":false,"wrapperName":"definitions","paramType":"List[definition]"},{"name":"syll","required":false,"wrapperName":"syllabified","paramType":"List[syllable]"},{"name":"relWord","required":false,"wrapperName":"relatedWords","paramType":"List[related]"},{"name":"sourceDictionary","required":false,"paramType":"string"}]},{"name":"scoredWord","fields":[{"name":"id","required":false,"paramType":"long"},{"name":"wordType","required":false,"paramType":"string"},{"name":"position","required":false,"paramType":"int"},{"name":"word","required":false,"paramType":"string"},{"name":"score","required":false,"paramType":"float"},{"name":"sentenceId","required":false,"paramType":"long"},{"name":"partOfSpeech","required":false,"paramType":"string"}]},{"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":"facetValue","fields":[{"name":"value","required":false,"paramType":"string"},{"name":"count","required":false,"paramType":"long"}]},{"name":"sentence","fields":[{"name":"id","required":false,"paramType":"long"},{"name":"scoredWord","required":false,"wrapperName":"scoredWords","paramType":"List[scoredWord]"},{"name":"display","required":false,"paramType":"string"},{"name":"documentMetadataId","required":false,"paramType":"long"},{"name":"rating","required":false,"paramType":"int"}]},{"name":"error","fields":[{"name":"reason","required":false,"paramType":"string"},{"name":"code","required":false,"paramType":"int"}]},{"name":"type","fields":[{"name":"typeId","required":false,"paramType":"int"},{"name":"text","required":false,"paramType":"string"},{"name":"enteredAt","required":false,"paramType":"string"},{"name":"mapping","required":false,"paramType":"long"}]},{"name":"punctuationFactor","fields":[{"name":"totalCount","required":false,"paramType":"long"},{"name":"wordId","required":false,"paramType":"long"},{"name":"periodCount","required":false,"paramType":"long"},{"name":"exclamationPointCount","required":false,"paramType":"long"},{"name":"questionMarkCount","required":false,"paramType":"long"}]},{"name":"bigram","fields":[{"name":"count","required":false,"paramType":"long"},{"name":"gram1","required":false,"paramType":"string"},{"name":"gram2","required":false,"paramType":"string"},{"name":"mi","required":false,"paramType":"double"},{"name":"wlmi","required":false,"paramType":"double"}]},{"name":"related","fields":[{"name":"word","required":false,"wrapperName":"words","paramType":"List[string]"},{"name":"relationshipType","required":false,"paramType":"string"},{"name":"label1","required":false,"paramType":"string"},{"name":"label2","required":false,"paramType":"string"},{"name":"label3","required":false,"paramType":"string"},{"name":"label4","required":false,"paramType":"string"},{"name":"gram","required":false,"paramType":"string"}]},{"name":"documentMetadata","fields":[{"name":"id","required":false,"paramType":"long"},{"name":"year","required":false,"paramType":"integer"},{"name":"contentType","required":false,"paramType":"contentType"},{"name":"provider","required":false,"paramType":"contentProvider"},{"name":"tag","required":false,"wrapperName":"tags","paramType":"List[string]"},{"name":"title","required":false,"paramType":"string"},{"name":"rating","required":false,"paramType":"double"},{"name":"medium","required":false,"paramType":"documentMedium"},{"name":"sourceUrl","required":false,"paramType":"string"},{"name":"createdAt","required":false,"paramType":"Date"},{"name":"stats","required":false,"paramType":"basicDocumentStats"},{"name":"date","required":false,"paramType":"Date"},{"name":"classification","required":false,"paramType":"subjectClassificationType"},{"name":"yearType","required":false,"paramType":"yearType"},{"name":"primaryAuthor","required":false,"paramType":"string"},{"name":"primaryAuthorType","required":false,"paramType":"authorType"},{"name":"primaryAuthorId","required":false,"paramType":"long"},{"name":"guid","required":false,"paramType":"string"},{"name":"extendedMetadata","required":false,"paramType":"extendedMetadata"},{"name":"author","required":false,"wrapperName":"authors","paramType":"List[author]"},{"name":"expirationDate","required":false,"paramType":"Date"}]},{"name":"frequencySummaryE","fields":[{"name":"elements","required":false,"paramType":"List[frequencyElement]"}]},{"name":"wordStats","fields":[{"name":"wordstring","required":false,"paramType":"string"},{"name":"sentencesCount","required":false,"paramType":"long"},{"name":"documentsCount","required":false,"paramType":"long"},{"name":"frequencyStats","required":false,"paramType":"frequencyStats"},{"name":"dictionaryStats","required":false,"paramType":"Map[string,dictionaryWordStats]"},{"name":"partOfSpeechStats","required":false,"paramType":"Map[string,integer]"}]},{"name":"syllable","fields":[{"name":"type","required":false,"paramType":"string"},{"name":"seq","required":false,"paramType":"int"},{"name":"text","required":false,"paramType":"string"}]},{"name":"textPron","fields":[{"name":"id","required":false,"paramType":"long"},{"name":"seq","required":false,"paramType":"int"},{"name":"raw","required":false,"paramType":"string"},{"name":"rawType","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":"frequencyStats","fields":[{"name":"contentProvider","required":false,"paramType":"Map[integer,long]"},{"name":"contentType","required":false,"paramType":"Map[integer,long]"},{"name":"medium","required":false,"paramType":"Map[integer,long]"},{"name":"subject","required":false,"paramType":"Map[integer,long]"},{"name":"yearWise","required":false,"paramType":"Map[integer,long]"},{"name":"corpusCount","required":false,"paramType":"long"},{"name":"author","required":false,"paramType":"Map[long,long]"}]},{"name":"suggestion","fields":[{"name":"type","required":false,"paramType":"int"},{"name":"wordstring","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"}]}]}

data/api_docs/wordList.json

@@ -0,0 +1 @@
+{"endPoints":[{"path":"/wordList.{format}/{wordListId}","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to update","required":true,"dataType":"string","paramType":"path"},{"description":"Updated WordList","required":false,"dataType":"wordList","paramType":"body"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","paramType":"header"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"Not Authorized to update WordList","code":403},{"reason":"WordList not found","code":404}],"condition":"any"}],"category":"WordListInfo","summary":"Updates an existing WordList","suggestedName":"updateWordList","deprecated":false,"open":false,"httpMethod":"PUT"},{"parameters":[{"name":"wordListId","description":"ID of WordList to delete","required":true,"dataType":"string","paramType":"path"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","paramType":"header"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"Not Authorized to delete WordList","code":403},{"reason":"WordList not found","code":404}],"condition":"any"}],"category":"WordListInfo","summary":"Deletes an existing WordList","suggestedName":"deleteWordList","deprecated":false,"open":false,"httpMethod":"DELETE"},{"parameters":[{"name":"wordListId","description":"ID of WordList to fetch","required":true,"dataType":"string","paramType":"path"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","paramType":"header"}],"response":[{"valueType":"wordList","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"Not Authorized to access WordList","code":403},{"reason":"WordList not found","code":404}],"condition":"any"}],"category":"WordListInfo","summary":"Fetches a WordList by ID","suggestedName":"getWordListById","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/wordList.{format}/{wordListId}/words","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to user","required":true,"dataType":"string","paramType":"path"},{"name":"username","description":"Username to add words on behalf of","required":false,"dataType":"string","paramAccess":"internal","paramType":"query"},{"description":"Words to add to WordList","required":false,"dataType":"StringValue[]","paramType":"body"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","paramType":"header"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"Not Authorized to access WordList","code":403},{"reason":"WordList not found","code":404}],"condition":"any"}],"category":"WordListInfo","summary":"Adds words to a WordList","suggestedName":"addWordsToWordList","deprecated":false,"open":false,"httpMethod":"POST"},{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":true,"dataType":"string","paramType":"path"},{"name":"sortBy","description":"Field to sort by","required":false,"dataType":"string","allowableValues":"createDate,alpha","paramType":"query"},{"name":"sortOrder","description":"Direction to sort","required":false,"dataType":"string","allowableValues":"asc,desc","paramType":"query"},{"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":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","paramType":"header"}],"response":[{"valueType":"List[wordListWord]","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"Not Authorized to access WordList","code":403},{"reason":"WordList not found","code":404}],"condition":"any"}],"category":"WordListInfo","summary":"Fetches words in a WordList","suggestedName":"getWordListWords","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/wordList","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":"/wordList.{format}/{wordListId}/isFavorite","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to check","required":false,"dataType":"string","paramType":"path"},{"name":"username","description":"Username to check for Favorite status","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"BooleanValue","errorResponses":[{"reason":"Invalid ID supplied.","code":400},{"reason":"Not Authorized to favorite WordList.","code":403},{"reason":"WordList not found.","code":404}],"condition":"any"}],"category":"WordListFavorites","summary":"Checks to see if a WordList has been favorited for a user","suggestedName":"isFavoriteWordList","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/wordList.{format}/{wordListId}/favorite","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to fetch","required":false,"dataType":"string","paramType":"path"},{"name":"username","description":"Username to favorite on behalf of","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid ID supplied.","code":400},{"reason":"Not Authorized to favorite WordList.","code":403},{"reason":"WordList not found.","code":404}],"condition":"any"}],"category":"WordListFavorites","summary":"Favorites a WordList for a User","suggestedName":"favoriteWordList","deprecated":false,"open":false,"httpMethod":"POST"},{"parameters":[{"name":"wordListId","description":"ID of WordList to fetch","required":false,"dataType":"string","paramType":"path"},{"name":"username","description":"Username to unfavorite on behalf of","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid ID supplied.","code":400},{"reason":"Not Authorized to favorite WordList.","code":403},{"reason":"WordList not found.","code":404}],"condition":"any"}],"category":"WordListFavorites","summary":"Unfavorites a WordList for a User","suggestedName":"unFavoriteWordList","deprecated":false,"open":false,"httpMethod":"DELETE"}]},{"path":"/wordList.{format}/{wordListId}/tags","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":false,"dataType":"string","paramType":"path"},{"name":"username","description":"Username to get Tags for","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[tag]","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"WordList not found.","code":404}],"condition":"any"}],"category":"WordListTags","summary":"Fetches Tags on a WordList","suggestedName":"getWordListTags","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/wordList.{format}/{wordListId}/tagCount","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":false,"dataType":"string","paramType":"path"},{"name":"username","description":"Username to get Tags for","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"long","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"WordList not found.","code":404}],"condition":"any"}],"category":"WordListTags","summary":"Fetches Tag count on a WordList","suggestedName":"getWordListTagCount","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/wordList.{format}/{wordListId}/tag","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":false,"dataType":"string","paramType":"path"},{"name":"username","description":"Username to add Tags for","required":false,"dataType":"string","paramType":"query"},{"name":"tags","description":"Tags to add","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"WordList not found.","code":404}],"condition":"any"}],"category":"WordListTags","summary":"Adds a Tag on a WordList","suggestedName":"addWordListTag","deprecated":false,"open":false,"httpMethod":"POST"},{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":false,"dataType":"string","paramType":"path"},{"name":"username","description":"Username to delete Tags for","required":false,"dataType":"string","paramType":"query"},{"name":"tags","description":"Tags to add","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"WordList not found.","code":404}],"condition":"any"}],"category":"WordListTags","summary":"Adds a Tag on a WordList","suggestedName":"deleteWordListTag","deprecated":false,"open":false,"httpMethod":"DELETE"}]},{"path":"/wordList.{format}/{wordListId}/comments","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","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":"Direction to sort","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[comment]","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"WordList not found.","code":404}],"condition":"any"}],"category":"WordListComments","summary":"Fetches comments on a WordList","suggestedName":"getWordListComments","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/wordList.{format}/{wordListId}/comment","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":false,"dataType":"string","paramType":"path"},{"description":"Comment to add","required":false,"dataType":"comment","paramType":"body"}],"response":[{"valueType":"comment","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"Not Authorized to access WordList.","code":403},{"reason":"WordList not found.","code":404}],"condition":"any"}],"category":"WordListComments","summary":"Adds a Comment on a WordList","suggestedName":"addCommentToWordList","deprecated":false,"open":false,"httpMethod":"POST"},{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":false,"dataType":"string","paramType":"path"},{"description":"Updated Comment","required":false,"dataType":"comment","paramType":"body"}],"response":[{"valueType":"comment","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"Not Authorized to access WordList.","code":403},{"reason":"WordList not found.","code":404}],"condition":"any"}],"category":"WordListComments","summary":"Updates a Comment on a WordList","suggestedName":"updateCommentOnWordList","deprecated":false,"open":false,"httpMethod":"PUT"}]},{"path":"/wordList.{format}/{wordListId}/comment/{commentId}","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":false,"dataType":"string","paramType":"path"},{"name":"commentId","description":"Comment ID to fetch","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"comment","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"WordList or Comment not found.","code":404}],"condition":"any"}],"category":"WordListComments","summary":"Fetches a WordList comment by ID","suggestedName":"getWordListCommentById","deprecated":false,"open":false,"httpMethod":"GET"},{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":false,"dataType":"string","paramType":"path"},{"name":"commentId","description":"Comment ID to delete","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"WordList or Comment not found.","code":404}],"condition":"any"}],"category":"WordListComments","summary":"Deletes a WordList comment by ID","suggestedName":"deleteWordListCommentById","deprecated":false,"open":false,"httpMethod":"DELETE"}]},{"path":"/wordList.{format}/{wordListId}/commentCount","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"long","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"WordList not found.","code":404}],"condition":"any"}],"category":"WordListComments","summary":"Fetches WordList Comment count","suggestedName":"getWordListCommentCount","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/wordList.{format}/{wordListId}/deleteWords","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":true,"dataType":"string","paramType":"path"},{"name":"username","description":"Username to remove words on behalf of","required":false,"dataType":"string","paramAccess":"internal","paramType":"query"},{"description":"Words to remove from WordList","required":false,"dataType":"StringValue[]","paramType":"body"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","paramType":"header"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"Not Authorized to modify WordList","code":403},{"reason":"WordList not found","code":404}],"condition":"any"}],"category":"WordListInfo","summary":"Removes words from a WordList","suggestedName":"deleteWordsFromWordList","deprecated":false,"open":false,"httpMethod":"POST"}]},{"path":"/wordList.{format}/{wordListId}/wordsCount","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":false,"dataType":"string","paramType":"path"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","paramType":"header"}],"response":[{"valueType":"long","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"Not Authorized to access WordList","code":403},{"reason":"WordList not found","code":404}],"condition":"any"}],"category":"WordListInfo","summary":"Gets a count of Words in a WordList","suggestedName":"getWordListWordsCount","deprecated":false,"open":false,"httpMethod":"GET"}]}],"models":[{"name":"BooleanValue","fields":[{"name":"value","required":false,"paramType":"boolean"}]},{"name":"error","fields":[{"name":"reason","required":false,"paramType":"string"},{"name":"code","required":false,"paramType":"int"}]},{"name":"tag","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"id","required":false,"paramType":"long"},{"name":"count","required":false,"paramType":"long"}]},{"name":"wordListWord","fields":[{"name":"userId","required":false,"paramType":"long"},{"name":"word","required":false,"paramType":"string"},{"name":"createdAt","required":false,"paramType":"Date"},{"name":"username","required":false,"paramType":"string"},{"name":"numberCommentsOnWord","required":false,"paramType":"long"},{"name":"numberLists","required":false,"paramType":"long"}]},{"name":"long","fields":[{"name":"value","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":"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":"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":"doc","fields":[{"name":"endPoints","required":false,"paramType":"List[endpoint]"},{"name":"models","required":false,"paramType":"List[object]"}]},{"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":"endpoint","fields":[{"name":"path","required":false,"paramType":"string"},{"name":"description","required":false,"paramType":"string"},{"name":"operations","required":false,"paramType":"List[operation]"}]}]}

data/api_docs/wordLists.json

@@ -0,0 +1 @@
+{"endPoints":[{"path":"/wordLists.{format}/find/{searchString}","description":"","operations":[{"parameters":[{"name":"searchString","description":"Results to skip","required":false,"dataType":"string","paramType":"path"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[wordList]","errorResponses":[{"reason":"Not authenticated.","code":403}],"condition":"any"}],"category":"WordLists","summary":"Fetches WordList objects by name.","suggestedName":"findByName","deprecated":false,"open":false,"notes":"The term supplied is effectively given a wildcard before and after so 'cat' becomes '%cat%'","httpMethod":"GET"}]},{"path":"/wordLists.{format}","description":"","operations":[{"parameters":[{"description":"WordList to create","required":false,"dataType":"wordList","paramType":"body"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","paramType":"header"}],"response":[{"valueType":"wordList","errorResponses":[{"reason":"Invalid WordList supplied or mandatory fields are missing.","code":400},{"reason":"Not authenticated.","code":403},{"reason":"WordList owner not found.","code":404}],"condition":"any"}],"category":"WordLists","summary":"Creates a WordList.","suggestedName":"createWordList","deprecated":false,"open":false,"httpMethod":"POST"},{"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":"/wordLists.{format}/mostCommentedOn","description":"","operations":[{"parameters":[{"name":"dayInterval","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[commentSummary]","errorResponses":[{"reason":"Not authenticated.","code":403}],"condition":"any"}],"category":"WordLists","summary":"Fetches a CommentSummary for WordList objects.","suggestedName":"findMostCommentedOn","deprecated":false,"open":false,"notes":"The CommentSummary is sorted by comment count, descending","httpMethod":"GET"}]},{"path":"/wordLists.{format}/recentLists","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"},{"name":"type","description":"WordListType to filter by","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[wordList]","errorResponses":[{"reason":"Not authenticated.","code":403}],"condition":"any"}],"category":"WordLists","summary":"Fetches recently created WordList objects.","suggestedName":"findRecentLists","deprecated":false,"open":false,"httpMethod":"GET"}]}],"models":[{"name":"error","fields":[{"name":"reason","required":false,"paramType":"string"},{"name":"code","required":false,"paramType":"int"}]},{"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":"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":"doc","fields":[{"name":"endPoints","required":false,"paramType":"List[endpoint]"},{"name":"models","required":false,"paramType":"List[object]"}]},{"name":"commentSummary","fields":[{"name":"objectType","required":false,"paramType":"string"},{"name":"totalCount","required":false,"paramType":"long"},{"name":"objectName","required":false,"paramType":"string"},{"name":"countInInterval","required":false,"paramType":"long"},{"name":"intervalInMilliseconds","required":false,"paramType":"long"},{"name":"objectDisplayName","required":false,"paramType":"string"}]},{"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/words.json

@@ -0,0 +1 @@
+{"endPoints":[{"path":"/words.{format}/search","description":"","operations":[{"parameters":[{"name":"allowRegex","defaultValue":"false","description":"Search term is a Regular Expression","required":false,"dataType":"string","allowableValues":"true | false","paramAccess":"internal","paramType":"query"},{"name":"query","description":"Search term","required":true,"dataType":"string","paramType":"query"},{"name":"caseSensitive","defaultValue":"true","description":"Search case sensitive","required":false,"dataType":"string","allowableValues":"true | false","paramType":"query"},{"name":"includePartOfSpeech","description":"Only include these comma-delimited parts of speech","required":false,"dataType":"string","paramType":"query"},{"name":"excludePartOfSpeech","description":"Exclude these comma-delimited parts of speech","required":false,"dataType":"string","paramType":"query"},{"name":"minCorpusCount","defaultValue":"5","description":"Minimum corpus frequency for terms","required":false,"dataType":"string","allowableValues":"non-negative integer","paramType":"query"},{"name":"maxCorpusCount","description":"Maximum corpus frequency for terms","required":false,"dataType":"string","allowableValues":"non-negative integer","paramType":"query"},{"name":"minDictionaryCount","defaultValue":"1","description":"Minimum number of dictionary entries","required":false,"dataType":"string","allowableValues":"non-negative integer","paramType":"query"},{"name":"maxDictionaryCount","description":"Maximum dictionary count","required":false,"dataType":"string","allowableValues":"non-negative integer","paramType":"query"},{"name":"minLength","defaultValue":"1","description":"Minimum word length","required":false,"dataType":"string","allowableValues":"0 to 1024","paramType":"query"},{"name":"maxLength","description":"Maximum word length","required":false,"dataType":"string","allowableValues":"0 to 1024","paramType":"query"},{"name":"minLexicalityRating","defaultValue":"0","description":"Minimum lexicality","required":false,"dataType":"string","allowableValues":"0 to 100","paramAccess":"internal","paramType":"query"},{"name":"maxLexicalityRating","defaultValue":"0","description":"Maximum lexicality","required":false,"dataType":"string","allowableValues":"0 to 100","paramAccess":"internal","paramType":"query"},{"name":"skip","defaultValue":"0","description":"Results to skip","required":false,"dataType":"string","allowableValues":"0 to 1000","paramType":"query"},{"name":"limit","defaultValue":"10","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":"1 to 1000","paramType":"query"}],"response":[{"valueType":"List[wordFrequency]","errorResponses":[{"reason":"Invalid term supplied.","code":400},{"reason":"No results.","code":404}],"condition":"any"}],"category":"WordDetails","summary":"Searches words.","suggestedName":"searchWords","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/words.{format}/wordOfTheDayList/{permalink}","description":"","operations":[{"parameters":[{"name":"permalink","description":"ID of WordOfTheDayList","required":false,"dataType":"string","paramType":"path"},{"name":"includeAll","description":"Returns future WordOfTheDay items","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"wordOfTheDayList","errorResponses":[{"reason":"Invalid id supplied","code":400},{"reason":"WordOfTheDayList not found","code":404}],"condition":"any"}],"category":"WordOfTheDayList","summary":"Fetches a WordOfTheDayList by ID","suggestedName":"getWordOfTheDayList","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/words.{format}/wordOfTheDay","description":"","operations":[{"parameters":[{"name":"date","description":"Fetches by date in yyyy-MM-dd","required":false,"dataType":"string","paramType":"query"},{"name":"category","description":"Filters response by category","required":false,"dataType":"string","paramType":"query"},{"name":"creator","description":"Filters response by username","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"WordOfTheDay","errorResponses":[{"reason":"No data available","code":404}],"condition":"any"}],"category":"WordOfTheDay","summary":"Returns a specific WordOfTheDay","suggestedName":"getWordOfTheDay","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/words","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":"/words.{format}/searchDefinitions","description":"","operations":[{"parameters":[{"name":"query","description":"Search term","required":true,"dataType":"string","paramType":"query"},{"name":"definedWordSearchTerm","description":"Defined word search term","required":false,"dataType":"string","paramType":"query"},{"name":"includeSourceDictionaries","description":"Only include these comma-delimited source dictionaries","required":false,"dataType":"string","allowableValues":"ahd, century, wiktionary, webster, wordnet","paramType":"query"},{"name":"excludeSourceDictionaries","description":"Exclude these comma-delimited source dictionaries","required":false,"dataType":"string","allowableValues":"ahd, century, wiktionary, webster, wordnet","paramType":"query"},{"name":"includePartOfSpeech","description":"Only include these comma-delimited parts of speech","required":false,"dataType":"string","paramType":"query"},{"name":"excludePartOfSpeech","description":"Exclude these comma-delimited parts of speech","required":false,"dataType":"string","paramType":"query"},{"name":"minCorpusCount","defaultValue":"5","description":"Minimum corpus frequency for terms","required":false,"dataType":"string","allowableValues":"non-negative integer","paramType":"query"},{"name":"maxCorpusCount","description":"Maximum corpus frequency for terms","required":false,"dataType":"string","allowableValues":"non-negative integer","paramType":"query"},{"name":"minLength","defaultValue":"1","description":"Minimum word length","required":false,"dataType":"string","allowableValues":"0 to 1024","paramType":"query"},{"name":"maxLength","description":"Maximum word length","required":false,"dataType":"string","allowableValues":"0 to 1024","paramType":"query"},{"name":"expandTerms","description":"Expand terms","required":false,"dataType":"string","allowableValues":"synonym,hypernym","paramType":"query"},{"name":"wordTypes","description":"Word types","required":false,"dataType":"string","allowableValues":"word,multi-word-unit","paramType":"query"},{"name":"returnWordsOnly","defaultValue":"false","description":"Return words only","required":false,"dataType":"string","allowableValues":"false,true","paramAccess":"internal","paramType":"query"},{"name":"includeTags","defaultValue":"false","description":"Return a closed set of XML tags in response","required":false,"dataType":"string","allowableValues":"false,true","paramType":"query"},{"name":"useTagsForRanking","defaultValue":"true","description":"Use user tags, dictionary labels and hypernyms for ranking","required":false,"dataType":"string","allowableValues":"false,true","paramAccess":"internal","paramType":"query"},{"name":"sortBy","description":"Attribute to sort by","required":false,"dataType":"string","allowableValues":"alpha,count,length","paramType":"query"},{"name":"sortOrder","description":"Sort direction","required":false,"dataType":"string","allowableValues":"asc,desc","paramType":"query"},{"name":"skip","defaultValue":"0","description":"Results to skip","required":false,"dataType":"string","allowableValues":"0 to 1000","paramType":"query"},{"name":"limit","defaultValue":"10","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":"1 to 1000","paramType":"query"}],"response":[{"valueType":"DefinitionSearchResults","errorResponses":[{"reason":"Invalid term supplied.","code":400}],"condition":"any"}],"category":"WordDetails","summary":"Searches definitions.","suggestedName":"searchDefinitions","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/words.{format}/searchEntries","description":"","operations":[{"parameters":[{"name":"query","description":"Search term","required":true,"dataType":"string","paramType":"query"},{"name":"skip","defaultValue":"0","description":"Results to skip","required":false,"dataType":"string","allowableValues":"0 to 1000","paramType":"query"},{"name":"limit","defaultValue":"10","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":"1 to 1000","paramType":"query"}],"response":[{"valueType":"EntrySearchResults","errorResponses":[{"reason":"Invalid term supplied.","code":400}],"condition":"any"}],"category":"WordDetails","summary":"Searches dictionary entries.","suggestedName":"searchEntries","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/words.{format}/frequency","description":"","operations":[{"response":[{"valueType":"frequencySummary","errorResponses":[{"reason":"No data found.","code":404}],"condition":"any"}],"category":"WordDetails","summary":"Fetches corpus-level word frequency","suggestedName":"getFrequency","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/words.{format}/surfaceForms","description":"","operations":[{"parameters":[{"name":"term","description":"Word to get surface forms for.","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"String","errorResponses":[{"reason":"Invalid term supplied.","code":400}],"condition":"any"}],"category":"WordDetails","summary":"Fetches surface forms of a word","suggestedName":"getSurfaceForms","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/words.{format}/id/{id}","description":"","operations":[{"parameters":[{"name":"id","description":"ID of word","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"wordObject","errorResponses":[{"reason":"Invalid ID supplied.","code":400},{"reason":"No word found.","code":404}],"condition":"any"}],"category":"WordDetails","summary":"Fetches a word by ID","suggestedName":"getWordById","deprecated":false,"open":false,"notes":"Deprecated.","httpMethod":"GET"}]},{"path":"/words.{format}/wordOfTheDay/range","description":"","operations":[{"parameters":[{"name":"category","description":"Filters response by category","required":false,"dataType":"string","paramType":"query"},{"name":"creator","description":"Filters response by username","required":false,"dataType":"string","paramType":"query"},{"name":"provider","description":"Filters response by ContentProvider","required":false,"dataType":"string","paramType":"query"},{"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[WordOfTheDay]","errorResponses":[{"reason":"No data available","code":404}],"condition":"any"}],"category":"WordOfTheDay","summary":"Returns a WordOfTheDay range","suggestedName":"getWordOfTheDayRange","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/words.{format}/canonicalForms","description":"","operations":[{"parameters":[{"name":"term","description":"Word to get canonical forms for.","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"String","errorResponses":[{"reason":"Invalid term supplied.","code":400}],"condition":"any"}],"category":"WordDetails","summary":"Fetches canonical forms of a word","suggestedName":"getCanonicalForms","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/words.{format}/search/{query}","description":"","operations":[{"parameters":[{"name":"allowRegex","defaultValue":"false","description":"Search query is a Regular Expression","required":false,"dataType":"string","allowableValues":"true | false","paramAccess":"internal","paramType":"query"},{"name":"query","description":"Search query","required":true,"dataType":"string","paramType":"path"},{"name":"caseSensitive","defaultValue":"true","description":"Search case sensitive","required":false,"dataType":"string","allowableValues":"true | false","paramType":"query"},{"name":"includePartOfSpeech","description":"Only include these comma-delimited parts of speech","required":false,"dataType":"string","paramType":"query"},{"name":"excludePartOfSpeech","description":"Exclude these comma-delimited parts of speech","required":false,"dataType":"string","paramType":"query"},{"name":"minCorpusCount","defaultValue":"5","description":"Minimum corpus frequency for terms","required":false,"dataType":"string","allowableValues":"non-negative integer","paramType":"query"},{"name":"maxCorpusCount","description":"Maximum corpus frequency for terms","required":false,"dataType":"string","allowableValues":"non-negative integer","paramType":"query"},{"name":"minDictionaryCount","defaultValue":"1","description":"Minimum number of dictionary entries","required":false,"dataType":"string","allowableValues":"non-negative integer","paramType":"query"},{"name":"maxDictionaryCount","description":"Maximum dictionary count","required":false,"dataType":"string","allowableValues":"non-negative integer","paramType":"query"},{"name":"minLength","defaultValue":"1","description":"Minimum word length","required":false,"dataType":"string","allowableValues":"0 to 1024","paramType":"query"},{"name":"maxLength","description":"Maximum word length","required":false,"dataType":"string","allowableValues":"0 to 1024","paramType":"query"},{"name":"minLexicalityRating","defaultValue":"0","description":"Minimum lexicality","required":false,"dataType":"string","allowableValues":"0 to 100","paramAccess":"internal","paramType":"query"},{"name":"maxLexicalityRating","defaultValue":"0","description":"Maximum lexicality","required":false,"dataType":"string","allowableValues":"0 to 100","paramAccess":"internal","paramType":"query"},{"name":"skip","defaultValue":"0","description":"Results to skip","required":false,"dataType":"string","allowableValues":"0 to 1000","paramType":"query"},{"name":"limit","defaultValue":"10","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":"1 to 1000","paramType":"query"}],"response":[{"valueType":"wordSearchResults","errorResponses":[{"reason":"Invalid query supplied.","code":400}],"condition":"any"}],"category":"WordDetails","summary":"Searches words.","suggestedName":"searchWordsNew","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/words.{format}/randomWords","description":"","operations":[{"parameters":[{"name":"hasDictionaryDef","description":"Only return words with dictionary definitions","required":false,"dataType":"string","paramType":"query"},{"name":"includePartOfSpeech","description":"CSV part-of-speech values to include","required":false,"dataType":"string","paramType":"query"},{"name":"excludePartOfSpeech","description":"CSV part-of-speech values to exclude","required":false,"dataType":"string","paramType":"query"},{"name":"minCorpusCount","description":"Minimum corpus frequency for terms (integer)","required":false,"dataType":"string","paramType":"query"},{"name":"maxCorpusCount","description":"Maximum corpus frequency for terms (integer)","required":false,"dataType":"string","paramType":"query"},{"name":"minDictionaryCount","description":"Minimum dictionary count (integer)","required":false,"dataType":"string","paramType":"query"},{"name":"maxDictionaryCount","description":"Maximum dictionary count (integer)","required":false,"dataType":"string","paramType":"query"},{"name":"minLength","description":"Minimum word length (characters)","required":false,"dataType":"string","paramType":"query"},{"name":"maxLength","description":"Maximum word length (characters)","required":false,"dataType":"string","paramType":"query"},{"name":"minLexicalityRating","description":"Minimum lexicality","required":false,"dataType":"string","paramAccess":"internal","paramType":"query"},{"name":"maxLexicalityRating","description":"Maximum lexicality","required":false,"dataType":"string","paramAccess":"internal","paramType":"query"},{"name":"sortBy","description":"Attribute to sort by","required":false,"dataType":"string","allowableValues":"alpha,count","paramType":"query"},{"name":"sortOrder","description":"Sort direction","required":false,"dataType":"string","allowableValues":"asc,desc","paramType":"query"},{"name":"limit","description":"Maximum number of results to return (integer)","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[wordObject]","errorResponses":[{"reason":"Invalid term supplied.","code":400},{"reason":"No results.","code":404}],"condition":"any"}],"category":"WordDetails","summary":"Returns an array of random WordObjects, in the format specified by the URL","suggestedName":"getRandomWords","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/words.{format}/randomWord","description":"","operations":[{"parameters":[{"name":"hasDictionaryDef","defaultValue":"true","description":"Only return words with dictionary definitions","required":false,"dataType":"string","paramType":"query"},{"name":"includePartOfSpeech","description":"CSV part-of-speech values to include","required":false,"dataType":"string","paramType":"query"},{"name":"excludePartOfSpeech","description":"CSV part-of-speech values to exclude","required":false,"dataType":"string","paramType":"query"},{"name":"minCorpusCount","description":"Minimum corpus frequency for terms","required":false,"dataType":"string","paramType":"query"},{"name":"maxCorpusCount","description":"Maximum corpus frequency for terms","required":false,"dataType":"string","paramType":"query"},{"name":"minDictionaryCount","description":"Minimum dictionary count","required":false,"dataType":"string","paramType":"query"},{"name":"maxDictionaryCount","description":"Maximum dictionary count","required":false,"dataType":"string","paramType":"query"},{"name":"minLength","description":"Minimum word length","required":false,"dataType":"string","paramType":"query"},{"name":"maxLength","description":"Maximum word length","required":false,"dataType":"string","paramType":"query"},{"name":"minLexicalityRating","description":"Minimum lexicality","required":false,"dataType":"string","paramAccess":"internal","paramType":"query"},{"name":"maxLexicalityRating","description":"Maximum lexicality","required":false,"dataType":"string","paramAccess":"internal","paramType":"query"}],"response":[{"valueType":"wordObject","errorResponses":[{"reason":"No word found.","code":404}],"condition":"any"}],"category":"WordDetails","summary":"Returns a single random WordObject, in the format specified by the URL","suggestedName":"getRandomWord","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/words.{format}/examples","description":"","operations":[{"parameters":[{"description":"Words to fetch examples for","required":false,"dataType":"String[]","paramType":"body"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[example]","errorResponses":[{"reason":"Invalid words to search with.","code":400}],"condition":"any"}],"category":"WordDetails","summary":"Fetches examples for multiple words.","suggestedName":"getExamplesForWords","deprecated":false,"open":false,"httpMethod":"POST"}]},{"path":"/words.{format}/mostCommentedOn","description":"","operations":[{"parameters":[{"name":"dayInterval","description":"Number of days to consider","required":false,"dataType":"string","paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[commentSummary]","errorResponses":[{"reason":"Invalid time interval.","code":400}],"condition":"any"}],"category":"WordDetails","summary":"Fetches words most commented on.","suggestedName":"getWordsMostCommentedOn","deprecated":false,"open":false,"notes":"Set the dayInterval to determine the time frame.","httpMethod":"GET"}]},{"path":"/words.{format}/firstUsed/{statsType}/{object}","description":"","operations":[{"parameters":[{"name":"statsType","description":"DocumentStatsType dimension to filter by","required":false,"dataType":"string","paramType":"path"},{"name":"object","description":"Identifier of DocumentStatsType object","required":false,"dataType":"string","paramType":"path"},{"name":"detailed","description":"Return detailed data","required":false,"dataType":"string","paramType":"query"},{"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[detailedWordUsage]","errorResponses":[{"reason":"Invalid time interval.","code":400}],"condition":"any"},{"valueType":"List[basicWordUsage]","errorResponses":[{"reason":"Invalid time interval.","code":400}],"condition":"any"}],"category":"WordDetails","summary":"Fetches words most commented on.","suggestedName":"getWordsMostCommentedOn","deprecated":false,"open":false,"notes":"Set the dayInterval to determine the time frame.","httpMethod":"GET"}]},{"path":"/words.{format}/wordOfTheDayList/{permalink}/invite","description":"","operations":[{"parameters":[{"name":"permalink","description":"ID of WordOfTheDayList","required":false,"dataType":"string","paramType":"path"},{"description":"Invitation to send","required":false,"dataType":"wotdListInvitation","paramType":"body"}],"response":[{"valueType":"void","errorResponses":[{"reason":"User is not eligible to send invitations","code":400},{"reason":"WordOfTheDayList not found.","code":404}],"condition":"any"}],"category":"WordOfTheDayList","summary":"Invites users to a WordOfTheDayList","suggestedName":"inviteToWordOfTheDayList","deprecated":false,"open":false,"notes":"A user can invite up to 20 people in a single day. The users being invited will be checked to see if they have opted out of email communications","httpMethod":"POST"}]},{"path":"/words.{format}/wordOfTheDayLists/recent","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[wordOfTheDayList]","errorResponses":[{"reason":"No WordOfTheDayLists found.","code":404}],"condition":"any"}],"category":"WordOfTheDayList","summary":"Fetches recently created WordOfTheDayLists","suggestedName":"getRecentWordOfTheDayLists","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/words.{format}/wordOfTheDayList/{permalink}/{specifier}","description":"","operations":[{"parameters":[{"name":"permalink","description":"ID of WordOfTheDayList","required":false,"dataType":"string","paramType":"path"},{"name":"specifier","description":"Specifier for the item to fetch.  Either 'current' or a date.","required":false,"dataType":"string","paramType":"path"},{"name":"includeExtraHtml","description":"Include extra HTML if available","required":false,"dataType":"string","paramAccess":"internal","paramType":"query"}],"response":[{"valueType":"WordOfTheDay","errorResponses":[{"reason":"Invalid id supplied","code":400},{"reason":"WordOfTheDayList not found","code":404}],"condition":"any"}],"category":"WordOfTheDayList","summary":"Fetches a WordOfTheDayList by ID","suggestedName":"getWordOfTheDayListItem","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/words.{format}/wordOfTheDayLists","description":"","operations":[{"parameters":[{"name":"containsWord","description":"Lists must contain a specific word","required":false,"dataType":"string","paramType":"query"},{"name":"subscriberCount","description":"Lists must have the specified number of subscribers","required":false,"dataType":"string","paramType":"query"},{"name":"itemCount","description":"Lists must have the specified number of items","required":true,"dataType":"string","paramType":"query"},{"name":"includeAll","description":"Returns future WordOfTheDay items","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[wordOfTheDayList]","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"condition":"any"}],"category":"WordOfTheDayList","summary":"Fetches an array of WordOfTheDayList basd on a criteria","suggestedName":"getWordOfTheDayListsContainingWord","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/words.{format}/wordOfTheDayLists/subscriptionProcess","description":"","operations":[{"parameters":[{"name":"date","description":"Date string to fetch for.","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"String","errorResponses":[{"reason":"Invalid date format supplied.","code":400}],"condition":"any"}],"category":"WordOfTheDayList","summary":"Returns whether or not a subscription process has been run.","suggestedName":"getWordOfTheDayListSubscriptionProcessStatus","deprecated":false,"open":false,"notes":"Uses the current server time (day resolution) as the default date to check for, optionally a dateString can be supplied for a specific date to check for.","httpMethod":"GET"}]},{"path":"/words.{format}/wordOfTheDayList/{permalink}/subscription","description":"","operations":[{"parameters":[{"name":"auth_token","description":"auth_token of logged-in user","required":true,"dataType":"string","paramType":"header"},{"name":"permalink","description":"ID of WordOfTheDayList","required":false,"dataType":"string","paramType":"path"},{"name":"medium","description":"Medium to subscribe with","required":false,"dataType":"string","paramType":"query"},{"description":"Username to subscribe","required":false,"dataType":"string","paramType":"body"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"Not authorized to subscribe","code":403},{"reason":"WordOfTheDayList or User not found","code":404}],"condition":"any"}],"category":"WordOfTheDayList","summary":"Subscribes a user to a WordOfTheDayList","suggestedName":"subscribeToList","deprecated":false,"open":false,"httpMethod":"POST"}]},{"path":"/words.{format}/wordOfTheDayLists/{date}","description":"","operations":[{"parameters":[{"name":"date","description":"ID of WordOfTheDayList","required":false,"dataType":"string","paramType":"path"},{"name":"includeAll","description":"Returns future WordOfTheDay items","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[WordOfTheDay]","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"WordOfTheDayList or User not found","code":404}],"condition":"any"}],"category":"WordOfTheDayList","summary":"Fetches WordOfTheDay objects for a specific date","suggestedName":"getWordOfTheDayListsForDate","deprecated":false,"open":false,"httpMethod":"GET"}]}],"models":[{"name":"EntrySearchResult","fields":[{"name":"definition","required":false,"wrapperName":"definitions","paramType":"List[definition]"},{"name":"sourceDictionary","required":false,"paramType":"string"},{"name":"headWord","required":false,"paramType":"string"},{"name":"entryId","required":false,"paramType":"long"}]},{"name":"commentSummary","fields":[{"name":"objectType","required":false,"paramType":"string"},{"name":"totalCount","required":false,"paramType":"long"},{"name":"objectName","required":false,"paramType":"string"},{"name":"countInInterval","required":false,"paramType":"long"},{"name":"intervalInMilliseconds","required":false,"paramType":"long"},{"name":"objectDisplayName","required":false,"paramType":"string"}]},{"name":"object","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"fields","required":false,"paramType":"List[parameter]"},{"name":"uniqueFieldName","required":false,"paramType":"string"}]},{"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":"example","fields":[{"name":"year","required":false,"paramType":"integer"},{"name":"provider","required":false,"paramType":"contentProvider"},{"name":"url","required":false,"paramType":"string"},{"name":"word","required":false,"paramType":"string"},{"name":"text","required":false,"paramType":"string"},{"name":"title","required":false,"paramType":"string"},{"name":"rating","required":false,"paramType":"float"},{"name":"exampleId","required":false,"paramType":"long"},{"name":"documentId","required":false,"paramType":"long"}]},{"name":"WordSearchResult","fields":[{"name":"count","required":false,"paramType":"long"},{"name":"word","required":false,"paramType":"string"},{"name":"lexicality","required":false,"paramType":"double"}]},{"name":"definition","fields":[{"name":"exampleUsage","required":false,"wrapperName":"exampleUses","paramType":"List[ExampleUsage]"},{"name":"word","required":false,"paramType":"string"},{"name":"text","required":false,"paramType":"string"},{"name":"textPron","required":false,"wrapperName":"textProns","paramType":"List[textPron]"},{"name":"score","required":false,"paramType":"float"},{"name":"partOfSpeech","required":false,"paramType":"string"},{"name":"note","required":false,"wrapperName":"notes","paramType":"List[note]"},{"name":"citation","required":false,"wrapperName":"citations","paramType":"List[citation]"},{"name":"relWord","required":false,"wrapperName":"relatedWords","paramType":"List[related]"},{"name":"sourceDictionary","required":false,"paramType":"string"},{"name":"label","required":false,"wrapperName":"labels","paramType":"List[Label]"},{"name":"sequence","required":false,"paramType":"string"},{"name":"seqString","required":false,"paramType":"string"},{"name":"extendedText","required":false,"paramType":"string"}]},{"name":"category","fields":[{"name":"name","required":false,"paramType":"string"}]},{"name":"basicWordUsage","fields":[{"name":"year","required":false,"paramType":"integer"},{"name":"wordstring","required":false,"paramType":"string"},{"name":"documentId","required":false,"paramType":"long"},{"name":"sentenceId","required":false,"paramType":"long"}]},{"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":"frequency","fields":[{"name":"year","required":false,"paramType":"int"},{"name":"count","required":false,"paramType":"long"}]},{"name":"contentProvider","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":"frequencySummary","fields":[{"name":"word","required":false,"paramType":"string"},{"name":"totalCount","required":false,"paramType":"long"},{"name":"frequency","required":false,"paramType":"List[frequency]"},{"name":"unknownYearCount","required":false,"paramType":"int"}]},{"name":"detailedWordUsage","fields":[{"name":"wordstring","required":false,"paramType":"string"},{"name":"sentence","required":false,"paramType":"sentence"},{"name":"metadata","required":false,"paramType":"documentMetadata"}]},{"name":"scoredWord","fields":[{"name":"id","required":false,"paramType":"long"},{"name":"wordType","required":false,"paramType":"string"},{"name":"position","required":false,"paramType":"int"},{"name":"word","required":false,"paramType":"string"},{"name":"score","required":false,"paramType":"float"},{"name":"sentenceId","required":false,"paramType":"long"},{"name":"partOfSpeech","required":false,"paramType":"string"}]},{"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":"wordFrequency","fields":[{"name":"count","required":false,"paramType":"long"},{"name":"wordstring","required":false,"paramType":"string"}]},{"name":"sentence","fields":[{"name":"id","required":false,"paramType":"long"},{"name":"scoredWord","required":false,"wrapperName":"scoredWords","paramType":"List[scoredWord]"},{"name":"display","required":false,"paramType":"string"},{"name":"documentMetadataId","required":false,"paramType":"long"},{"name":"rating","required":false,"paramType":"int"}]},{"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":"documentMetadata","fields":[{"name":"id","required":false,"paramType":"long"},{"name":"year","required":false,"paramType":"integer"},{"name":"contentType","required":false,"paramType":"contentType"},{"name":"provider","required":false,"paramType":"contentProvider"},{"name":"tag","required":false,"wrapperName":"tags","paramType":"List[string]"},{"name":"title","required":false,"paramType":"string"},{"name":"rating","required":false,"paramType":"double"},{"name":"medium","required":false,"paramType":"documentMedium"},{"name":"sourceUrl","required":false,"paramType":"string"},{"name":"createdAt","required":false,"paramType":"Date"},{"name":"stats","required":false,"paramType":"basicDocumentStats"},{"name":"date","required":false,"paramType":"Date"},{"name":"classification","required":false,"paramType":"subjectClassificationType"},{"name":"yearType","required":false,"paramType":"yearType"},{"name":"primaryAuthor","required":false,"paramType":"string"},{"name":"primaryAuthorType","required":false,"paramType":"authorType"},{"name":"primaryAuthorId","required":false,"paramType":"long"},{"name":"guid","required":false,"paramType":"string"},{"name":"extendedMetadata","required":false,"paramType":"extendedMetadata"},{"name":"author","required":false,"wrapperName":"authors","paramType":"List[author]"},{"name":"expirationDate","required":false,"paramType":"Date"}]},{"name":"partOfSpeech","fields":[{"name":"roots","required":false,"paramType":"List[root]"}]},{"name":"wordSearchResults","fields":[{"name":"totalResults","required":false,"paramType":"int"},{"name":"searchResult","required":false,"wrapperName":"searchResults","paramType":"List[WordSearchResult]"}]},{"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":"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":"DefinitionSearchResults","fields":[{"name":"totalResults","required":false,"paramType":"int"},{"name":"result","required":false,"wrapperName":"results","paramType":"List[definition]"}]},{"name":"SubscriptionStatus","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"id","required":false,"paramType":"int"}]},{"name":"EntrySearchResults","fields":[{"name":"totalResults","required":false,"paramType":"int"},{"name":"searchResult","required":false,"wrapperName":"searchResults","paramType":"List[EntrySearchResult]"}]},{"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/lib/wordnik/resource_modules/account.rb

@@ -0,0 +1,486 @@
+# HEY HACKER! THIS IS AN AUTO-GENERATED FILE.
+# So don't bother editing it. To see how it's built, take a look at the Rakefile
+
+module AccountMethods
+
+  # Authenticates a User
+  #
+  def authenticate(username, *args)
+    http_method = :get
+    path = '/account/authenticate/{username}'
+    path.sub!('{username}', username.to_s)
+
+    # Ruby turns all key-value arguments at the end into a single hash
+    # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
+    # becomes {:limit => 10, :part_of_speech => 'verb'}
+    last_arg = args.pop if args.last.is_a?(Hash)
+    last_arg = args.pop if args.last.is_a?(Array)
+    last_arg ||= {}
+
+    # Look for a kwarg called :request_only, whose presence indicates
+    # that we want the request itself back, not the response body
+    if last_arg.is_a?(Hash) && last_arg[:request_only].present?
+      request_only = true
+      last_arg.delete(:request_only)
+    end
+
+    params = last_arg
+    body ||= {}
+    request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
+    request_only ? request : request.response.body
+  end
+
+  # Authenticates a user
+  #
+  def authenticate_post(username, body, *args)
+    http_method = :post
+    path = '/account/authenticate/{username}'
+    path.sub!('{username}', username.to_s)
+
+    # Ruby turns all key-value arguments at the end into a single hash
+    # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
+    # becomes {:limit => 10, :part_of_speech => 'verb'}
+    last_arg = args.pop if args.last.is_a?(Hash)
+    last_arg = args.pop if args.last.is_a?(Array)
+    last_arg ||= {}
+
+    # Look for a kwarg called :request_only, whose presence indicates
+    # that we want the request itself back, not the response body
+    if last_arg.is_a?(Hash) && last_arg[:request_only].present?
+      request_only = true
+      last_arg.delete(:request_only)
+    end
+
+    params = last_arg
+    body ||= {}
+    request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
+    request_only ? request : request.response.body
+  end
+
+  # Logs out a user
+  #
+  def logout(*args)
+    http_method = :get
+    path = '/account/logout'
+
+    # Ruby turns all key-value arguments at the end into a single hash
+    # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
+    # becomes {:limit => 10, :part_of_speech => 'verb'}
+    last_arg = args.pop if args.last.is_a?(Hash)
+    last_arg = args.pop if args.last.is_a?(Array)
+    last_arg ||= {}
+
+    # Look for a kwarg called :request_only, whose presence indicates
+    # that we want the request itself back, not the response body
+    if last_arg.is_a?(Hash) && last_arg[:request_only].present?
+      request_only = true
+      last_arg.delete(:request_only)
+    end
+
+    params = last_arg
+    body ||= {}
+    request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
+    request_only ? request : request.response.body
+  end
+
+  # Returns information about API parameters
+  #
+  def get_help(*args)
+    http_method = :get
+    path = '/account'
+
+    # Ruby turns all key-value arguments at the end into a single hash
+    # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
+    # becomes {:limit => 10, :part_of_speech => 'verb'}
+    last_arg = args.pop if args.last.is_a?(Hash)
+    last_arg = args.pop if args.last.is_a?(Array)
+    last_arg ||= {}
+
+    # Look for a kwarg called :request_only, whose presence indicates
+    # that we want the request itself back, not the response body
+    if last_arg.is_a?(Hash) && last_arg[:request_only].present?
+      request_only = true
+      last_arg.delete(:request_only)
+    end
+
+    params = last_arg
+    body ||= {}
+    request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
+    request_only ? request : request.response.body
+  end
+
+  # Fetches WordList objects for the logged-in user.
+  #
+  def get_word_lists_for_current_user(*args)
+    http_method = :get
+    path = '/account/wordLists'
+
+    # Ruby turns all key-value arguments at the end into a single hash
+    # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
+    # becomes {:limit => 10, :part_of_speech => 'verb'}
+    last_arg = args.pop if args.last.is_a?(Hash)
+    last_arg = args.pop if args.last.is_a?(Array)
+    last_arg ||= {}
+
+    # Look for a kwarg called :request_only, whose presence indicates
+    # that we want the request itself back, not the response body
+    if last_arg.is_a?(Hash) && last_arg[:request_only].present?
+      request_only = true
+      last_arg.delete(:request_only)
+    end
+
+    params = last_arg
+    body ||= {}
+    request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
+    request_only ? request : request.response.body
+  end
+
+  # Authenticates a User
+  #
+  def get_forgot_password(username, *args)
+    http_method = :get
+    path = '/account/forgotPassword/{username}'
+    path.sub!('{username}', username.to_s)
+
+    # Ruby turns all key-value arguments at the end into a single hash
+    # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
+    # becomes {:limit => 10, :part_of_speech => 'verb'}
+    last_arg = args.pop if args.last.is_a?(Hash)
+    last_arg = args.pop if args.last.is_a?(Array)
+    last_arg ||= {}
+
+    # Look for a kwarg called :request_only, whose presence indicates
+    # that we want the request itself back, not the response body
+    if last_arg.is_a?(Hash) && last_arg[:request_only].present?
+      request_only = true
+      last_arg.delete(:request_only)
+    end
+
+    params = last_arg
+    body ||= {}
+    request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
+    request_only ? request : request.response.body
+  end
+
+  # Fetches a User by code
+  #
+  def reset_password(hashcode, *args)
+    http_method = :get
+    path = '/account/resetPassword/{hashcode}'
+    path.sub!('{hashcode}', hashcode.to_s)
+
+    # Ruby turns all key-value arguments at the end into a single hash
+    # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
+    # becomes {:limit => 10, :part_of_speech => 'verb'}
+    last_arg = args.pop if args.last.is_a?(Hash)
+    last_arg = args.pop if args.last.is_a?(Array)
+    last_arg ||= {}
+
+    # Look for a kwarg called :request_only, whose presence indicates
+    # that we want the request itself back, not the response body
+    if last_arg.is_a?(Hash) && last_arg[:request_only].present?
+      request_only = true
+      last_arg.delete(:request_only)
+    end
+
+    params = last_arg
+    body ||= {}
+    request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
+    request_only ? request : request.response.body
+  end
+
+  # Creates an API account application.
+  #
+  def create_api_account(body, *args)
+    http_method = :post
+    path = '/account/apiAccountApplication'
+
+    # Ruby turns all key-value arguments at the end into a single hash
+    # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
+    # becomes {:limit => 10, :part_of_speech => 'verb'}
+    last_arg = args.pop if args.last.is_a?(Hash)
+    last_arg = args.pop if args.last.is_a?(Array)
+    last_arg ||= {}
+
+    # Look for a kwarg called :request_only, whose presence indicates
+    # that we want the request itself back, not the response body
+    if last_arg.is_a?(Hash) && last_arg[:request_only].present?
+      request_only = true
+      last_arg.delete(:request_only)
+    end
+
+    params = last_arg
+    body ||= {}
+    request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
+    request_only ? request : request.response.body
+  end
+
+  # Regenerates an API Token.  Currently not supported or tested.
+  #
+  def create_api_account(*args)
+    http_method = :get
+    path = '/account/regenerateApiToken'
+
+    # Ruby turns all key-value arguments at the end into a single hash
+    # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
+    # becomes {:limit => 10, :part_of_speech => 'verb'}
+    last_arg = args.pop if args.last.is_a?(Hash)
+    last_arg = args.pop if args.last.is_a?(Array)
+    last_arg ||= {}
+
+    # Look for a kwarg called :request_only, whose presence indicates
+    # that we want the request itself back, not the response body
+    if last_arg.is_a?(Hash) && last_arg[:request_only].present?
+      request_only = true
+      last_arg.delete(:request_only)
+    end
+
+    params = last_arg
+    body ||= {}
+    request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
+    request_only ? request : request.response.body
+  end
+
+  # Returns usage statistics for the API account.
+  #
+  def get_api_token_status(*args)
+    http_method = :get
+    path = '/account/apiTokenStatus'
+
+    # Ruby turns all key-value arguments at the end into a single hash
+    # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
+    # becomes {:limit => 10, :part_of_speech => 'verb'}
+    last_arg = args.pop if args.last.is_a?(Hash)
+    last_arg = args.pop if args.last.is_a?(Array)
+    last_arg ||= {}
+
+    # Look for a kwarg called :request_only, whose presence indicates
+    # that we want the request itself back, not the response body
+    if last_arg.is_a?(Hash) && last_arg[:request_only].present?
+      request_only = true
+      last_arg.delete(:request_only)
+    end
+
+    params = last_arg
+    body ||= {}
+    request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
+    request_only ? request : request.response.body
+  end
+
+  # Logs a VisitAction for the user
+  # Requires a valid auth_token to be set.
+  #
+  def log_visit_for_user(*args)
+    http_method = :post
+    path = '/account/logVisit'
+
+    # Ruby turns all key-value arguments at the end into a single hash
+    # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
+    # becomes {:limit => 10, :part_of_speech => 'verb'}
+    last_arg = args.pop if args.last.is_a?(Hash)
+    last_arg = args.pop if args.last.is_a?(Array)
+    last_arg ||= {}
+
+    # Look for a kwarg called :request_only, whose presence indicates
+    # that we want the request itself back, not the response body
+    if last_arg.is_a?(Hash) && last_arg[:request_only].present?
+      request_only = true
+      last_arg.delete(:request_only)
+    end
+
+    params = last_arg
+    body ||= {}
+    request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
+    request_only ? request : request.response.body
+  end
+
+  # Returns an activation code given a username
+  # If an activation code is not available, will return null.
+  #
+  def get_activation_code_for_user(username, *args)
+    http_method = :get
+    path = '/account/activationCode/{username}'
+    path.sub!('{username}', username.to_s)
+
+    # Ruby turns all key-value arguments at the end into a single hash
+    # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
+    # becomes {:limit => 10, :part_of_speech => 'verb'}
+    last_arg = args.pop if args.last.is_a?(Hash)
+    last_arg = args.pop if args.last.is_a?(Array)
+    last_arg ||= {}
+
+    # Look for a kwarg called :request_only, whose presence indicates
+    # that we want the request itself back, not the response body
+    if last_arg.is_a?(Hash) && last_arg[:request_only].present?
+      request_only = true
+      last_arg.delete(:request_only)
+    end
+
+    params = last_arg
+    body ||= {}
+    request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
+    request_only ? request : request.response.body
+  end
+
+  # Activates an account.
+  #
+  def activate_user(body, *args)
+    http_method = :post
+    path = '/account/activate'
+
+    # Ruby turns all key-value arguments at the end into a single hash
+    # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
+    # becomes {:limit => 10, :part_of_speech => 'verb'}
+    last_arg = args.pop if args.last.is_a?(Hash)
+    last_arg = args.pop if args.last.is_a?(Array)
+    last_arg ||= {}
+
+    # Look for a kwarg called :request_only, whose presence indicates
+    # that we want the request itself back, not the response body
+    if last_arg.is_a?(Hash) && last_arg[:request_only].present?
+      request_only = true
+      last_arg.delete(:request_only)
+    end
+
+    params = last_arg
+    body ||= {}
+    request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
+    request_only ? request : request.response.body
+  end
+
+  # Returns an ApiResponse indicating whether or not a username is available
+  #
+  def get_username_available(username, *args)
+    http_method = :get
+    path = '/account/usernameAvailable/{username}'
+    path.sub!('{username}', username.to_s)
+
+    # Ruby turns all key-value arguments at the end into a single hash
+    # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
+    # becomes {:limit => 10, :part_of_speech => 'verb'}
+    last_arg = args.pop if args.last.is_a?(Hash)
+    last_arg = args.pop if args.last.is_a?(Array)
+    last_arg ||= {}
+
+    # Look for a kwarg called :request_only, whose presence indicates
+    # that we want the request itself back, not the response body
+    if last_arg.is_a?(Hash) && last_arg[:request_only].present?
+      request_only = true
+      last_arg.delete(:request_only)
+    end
+
+    params = last_arg
+    body ||= {}
+    request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
+    request_only ? request : request.response.body
+  end
+
+  # Returns the logged-in User
+  # Requires a valid auth_token to be set.
+  #
+  def get_logged_in_user(*args)
+    http_method = :get
+    path = '/account/user'
+
+    # Ruby turns all key-value arguments at the end into a single hash
+    # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
+    # becomes {:limit => 10, :part_of_speech => 'verb'}
+    last_arg = args.pop if args.last.is_a?(Hash)
+    last_arg = args.pop if args.last.is_a?(Array)
+    last_arg ||= {}
+
+    # Look for a kwarg called :request_only, whose presence indicates
+    # that we want the request itself back, not the response body
+    if last_arg.is_a?(Hash) && last_arg[:request_only].present?
+      request_only = true
+      last_arg.delete(:request_only)
+    end
+
+    params = last_arg
+    body ||= {}
+    request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
+    request_only ? request : request.response.body
+  end
+
+  # Returns profile info for the logged-in user
+  # Requires a valid auth_token to be set.
+  #
+  def get_logged_in_user_profile(*args)
+    http_method = :get
+    path = '/account/profile'
+
+    # Ruby turns all key-value arguments at the end into a single hash
+    # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
+    # becomes {:limit => 10, :part_of_speech => 'verb'}
+    last_arg = args.pop if args.last.is_a?(Hash)
+    last_arg = args.pop if args.last.is_a?(Array)
+    last_arg ||= {}
+
+    # Look for a kwarg called :request_only, whose presence indicates
+    # that we want the request itself back, not the response body
+    if last_arg.is_a?(Hash) && last_arg[:request_only].present?
+      request_only = true
+      last_arg.delete(:request_only)
+    end
+
+    params = last_arg
+    body ||= {}
+    request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
+    request_only ? request : request.response.body
+  end
+
+  # Returns logged-in User Settings
+  # Requires a valid auth_token to be set.
+  #
+  def get_logged_in_user_settings(*args)
+    http_method = :get
+    path = '/account/settings'
+
+    # Ruby turns all key-value arguments at the end into a single hash
+    # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
+    # becomes {:limit => 10, :part_of_speech => 'verb'}
+    last_arg = args.pop if args.last.is_a?(Hash)
+    last_arg = args.pop if args.last.is_a?(Array)
+    last_arg ||= {}
+
+    # Look for a kwarg called :request_only, whose presence indicates
+    # that we want the request itself back, not the response body
+    if last_arg.is_a?(Hash) && last_arg[:request_only].present?
+      request_only = true
+      last_arg.delete(:request_only)
+    end
+
+    params = last_arg
+    body ||= {}
+    request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
+    request_only ? request : request.response.body
+  end
+
+  # Returns logged-in User TrackingInfo.
+  # Requires a valid auth_token to be set.
+  #
+  def get_logged_in_user_tracking_info(*args)
+    http_method = :get
+    path = '/account/trackingInfo'
+
+    # Ruby turns all key-value arguments at the end into a single hash
+    # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
+    # becomes {:limit => 10, :part_of_speech => 'verb'}
+    last_arg = args.pop if args.last.is_a?(Hash)
+    last_arg = args.pop if args.last.is_a?(Array)
+    last_arg ||= {}
+
+    # Look for a kwarg called :request_only, whose presence indicates
+    # that we want the request itself back, not the response body
+    if last_arg.is_a?(Hash) && last_arg[:request_only].present?
+      request_only = true
+      last_arg.delete(:request_only)
+    end
+
+    params = last_arg
+    body ||= {}
+    request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
+    request_only ? request : request.response.body
+  end
+
+end