wordnik 4.06.01 → 4.06.02

data/api_docs/word.json

@@ -1 +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"}]}]}
+{"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","allowableValues":"false,true","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","allowableValues":"false,true","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","allowableValues":"false,true","paramType":"query"},{"name":"includeSuggestions","description":"Return suggestions (for correct spelling, case variants, etc.)","required":false,"dataType":"string","allowableValues":"false,true","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","allowableValues":"false,true","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":"sortBy","description":"Specifies a sort parameter","required":false,"dataType":"string","allowableValues":"quality","paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"},{"name":"username","description":"User to scope the request to","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[wordList]","errorResponses":[{"reason":"Invalid word supplied","code":400},{"reason":"Supplied user does not exist","code":404}],"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","allowableValues":"false,true","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","allowableValues":"false,true","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"},{"name":"limit","description":"Maximum number of results to return","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","allowableValues":"false,true","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","allowableValues":"ahd,webster,wiktionary","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":"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}/audioInternal","description":"","operations":[{"parameters":[{"name":"word","description":"audio object to update","required":false,"dataType":"string","paramType":"path"},{"description":"Updated metadata.","required":false,"dataType":"audioObject","internalDescription":"Only updates the comment and duration fields","paramType":"body"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"condition":"any"}],"category":"AudioInfo","summary":"Internal method to update an audio object","suggestedName":"updateAudioInternal","deprecated":false,"open":false,"httpMethod":"PUT"}]},{"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":"duration","required":false,"paramType":"double"},{"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"}]}]}