api_docs/word.json in wordnik-4.06.15 vs api_docs/word.json in wordnik-4.07

- old
+ new

@@ -1 +1 @@ -{"resourcePath":"/word","apis":[{"path":"/word.{format}/{word}/entries","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"tags","description":"Return XML tags in response","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"sourceDictionary","description":"Get from a single dictionary. Valid options: ahd, century, wiktionary, webster, and wordnet.","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"etymologies","description":"Return etymologies","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Return entries for a word","responseTypeInternal":"com.wordnik.corpus.dictionary.entity.Entry","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getEntries","responseClass":"List[entry]","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/examples","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return examples for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"includeDuplicates","description":"Show duplicate examples from different sources","required":false,"dataType":"string","allowableValues":{"values":["false","true"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"contentProvider","description":"Return results from a specific ContentProvider","required":false,"dataType":"string","allowMultiple":false,"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":{"values":["false","true"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"internalDataStore","description":"Specify the internal storage engine.","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns examples for a word","responseTypeInternal":"com.wordnik.corpus.model.ExampleSearchResults","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getExamples","responseClass":"exampleSearchResults","httpMethod":"GET"},{"parameters":[{"name":"word","description":"Word to fetch examples for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"description":"Search definition object","required":false,"dataType":"ExampleSearchQuery","valueTypeInternal":"ExampleSearchQuery","allowMultiple":false,"paramType":"body"},{"name":"internalDataStore","description":"Specify the internal storage engine.","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Fetches examples for a word","responseTypeInternal":"com.wordnik.corpus.model.ExampleSearchResults","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getExamplesPost","responseClass":"exampleSearchResults","httpMethod":"POST"}]},{"path":"/word.{format}/{word}/wordForms","description":"","operations":[{"parameters":[{"name":"word","description":"Word to add forms for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"description":"RelationshipMapWord to add","required":false,"dataType":"suggestion","valueTypeInternal":"suggestion","allowMultiple":false,"paramType":"body"},{"name":"canonical","description":"Make this the Canonical form of the word.","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Adds a Relationship Map to a word","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No results.","code":404}],"nickname":"addWordForm","responseClass":"ok","httpMethod":"POST"},{"parameters":[{"name":"word","description":"Word to fetch forms for","required":true,"dataType":"string","allowMultiple":false,"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","allowMultiple":false,"paramType":"query"}],"summary":"Returns other forms of a word","responseTypeInternal":"com.wordnik.corpus.entity.RelationshipMap","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No results.","code":404}],"nickname":"getWordForms","responseClass":"relationshipMap","httpMethod":"GET"},{"parameters":[{"name":"word","description":"Word to delete forms from","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"type","description":"Relationship type to delete","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"word","description":"Target word to remove relationship from.","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Deletes a relationship from a word","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No results.","code":404}],"nickname":"deleteWordForm","responseClass":"ok","httpMethod":"DELETE"}]},{"path":"/word.{format}/{word}","description":"","operations":[{"parameters":[{"name":"word","description":"String value of WordObject to return","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"useCanonical","defaultValue":"false","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":{"values":["false","true"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"includeSuggestions","description":"Return suggestions (for correct spelling, case variants, etc.)","required":false,"dataType":"string","allowableValues":{"values":["false","true"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"shouldCreate","description":"Create word if not existing","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Given a word as a string, returns the WordObject that represents it","responseTypeInternal":"com.wordnik.corpus.entity.Word","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getWord","responseClass":"wordObject","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/definitions","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return definitions for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"partOfSpeech","description":"CSV list of part-of-speech types","required":false,"dataType":"string","allowableValues":{"values":["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"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"includeRelated","defaultValue":"false","description":"Return related words with definitions","required":false,"dataType":"string","allowableValues":{"values":["true","false"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"sourceDictionaries","description":"If 'all' is received, results are returned from all sources. If multiple values are received (e.g. 'century,wiktionary'), results are returned from the first specified dictionary that has definitions. If left blank, results are returned from the first dictionary that has definitions. By default, dictionaries are searched in this order: ahd, wiktionary, webster, century, wordnet","required":false,"dataType":"string","allowableValues":{"values":["all","ahd","century","wiktionary","webster","wordnet"],"valueType":"LIST"},"allowMultiple":true,"paramType":"query"},{"name":"useCanonical","defaultValue":"false","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":{"values":["false","true"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"includeTags","defaultValue":"false","description":"Return a closed set of XML tags in response","required":false,"dataType":"string","allowableValues":{"values":["false","true"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"}],"summary":"Return definitions for a word","responseTypeInternal":"com.wordnik.corpus.dictionary.entity.Definition","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No definitions found.","code":404}],"nickname":"getDefinitions","responseClass":"List[definition]","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/stats","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return stats for","required":true,"dataType":"string","allowMultiple":false,"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","allowMultiple":false,"paramType":"query"},{"name":"detailed","description":"Return detailed usage info","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"statsToInclude","description":"stats to include in the results","required":false,"dataType":"string","allowableValues":{"values":["ugc","frequency","dictionary","part_of_speech"],"valueType":"LIST"},"allowMultiple":true,"paramType":"query"}],"summary":"Returns word statistics","responseTypeInternal":"com.wordnik.corpus.stats.entity.WordStats","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No stats available.","code":404}],"nickname":"getWordStats","responseClass":"wordStats","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/topExample","description":"","operations":[{"parameters":[{"name":"word","description":"Word to fetch examples for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"contentProvider","description":"Return results from a specific ContentProvider","required":false,"dataType":"string","allowMultiple":false,"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":{"values":["false","true"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"internalDataStore","description":"Specify the internal storage engine.","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Returns a top example for a word","responseTypeInternal":"com.wordnik.corpus.model.Example","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getTopExample","responseClass":"example","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/contextualLookup","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return definitions for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"sentence","description":"The sentence in which the word occurs","required":true,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"offset","defaultValue":"-1","description":"The start character offset of the word in the given sentence","required":false,"dataType":"int","allowableValues":{"max":4096.0,"min":0.0,"valueType":"RANGE"},"allowMultiple":false,"paramType":"query"},{"name":"expandTerms","description":"Expand context terms using related words","required":false,"dataType":"string","allowableValues":{"values":["true","false"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"includeSourceDictionaries","description":"Only include these comma-delimited source dictionaries","required":false,"dataType":"string","allowableValues":{"values":["ahd"," century"," wiktionary"," webster"," wordnet"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"excludeSourceDictionaries","description":"Exclude these comma-delimited source dictionaries","required":false,"dataType":"string","allowableValues":{"values":["ahd"," century"," wiktionary"," webster"," wordnet"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"skip","defaultValue":"0","description":"Results to skip","required":false,"dataType":"string","allowableValues":{"max":1000.0,"min":0.0,"valueType":"RANGE"},"allowMultiple":false,"paramType":"query"},{"name":"limit","defaultValue":"10","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":{"max":1000.0,"min":1.0,"valueType":"RANGE"},"allowMultiple":false,"paramType":"query"}],"summary":"Returns definitions for a word based on the sentence in which it is found","responseTypeInternal":"com.wordnik.index.definition.DefinitionSearchResults","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"contextualLookup","responseClass":"DefinitionSearchResults","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","allowMultiple":false,"paramType":"path"},{"description":"The sentence in which the word occurs","required":true,"dataType":"string","allowMultiple":false,"paramType":"body"},{"name":"offset","defaultValue":"-1","description":"The start character offset of the word in the given sentence","required":false,"dataType":"int","allowableValues":{"max":4096.0,"min":0.0,"valueType":"RANGE"},"allowMultiple":false,"paramType":"query"},{"name":"expandTerms","description":"Expand context terms using related words","required":false,"dataType":"string","allowableValues":{"values":["true","false"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"includeSourceDictionaries","description":"Only include these comma-delimited source dictionaries","required":false,"dataType":"string","allowableValues":{"values":["ahd"," century"," wiktionary"," webster"," wordnet"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"excludeSourceDictionaries","description":"Exclude these comma-delimited source dictionaries","required":false,"dataType":"string","allowableValues":{"values":["ahd"," century"," wiktionary"," webster"," wordnet"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"skip","defaultValue":"0","description":"Results to skip","required":false,"dataType":"string","allowableValues":{"max":1000.0,"min":0.0,"valueType":"RANGE"},"allowMultiple":false,"paramType":"query"},{"name":"limit","defaultValue":"10","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":{"max":1000.0,"min":1.0,"valueType":"RANGE"},"allowMultiple":false,"paramType":"query"}],"summary":"Returns definitions for a word based on the sentence in which it is found","responseTypeInternal":"com.wordnik.index.definition.DefinitionSearchResults","errorResponses":[{"reason":"Invalid term supplied.","code":400}],"nickname":"contextualLookupPost","responseClass":"DefinitionSearchResults","notes":"Use the offset parameter when the word occurs more than once in the sentence","httpMethod":"POST"}]},{"path":"/word.{format}/{word}/lookupCount","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get Bigrams for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Returns the number of times a word has been viewed","responseTypeInternal":"com.wordnik.system.model.LongResult","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"Word not found.","code":404}],"nickname":"getLookupCount","responseClass":"long","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/commentCount","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get comment count for.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Returns the number of comments on a word","responseTypeInternal":"com.wordnik.system.model.LongResult","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"Word not found.","code":404}],"nickname":"getCommentCount","responseClass":"long","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/relatedWords","description":"","operations":[{"parameters":[{"name":"word","description":"Word to fetch relationships for","required":true,"dataType":"string","allowMultiple":false,"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":{"values":["false","true"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"relationshipTypes","description":"Limits the total results per type of relationship type","required":false,"dataType":"string","allowableValues":{"values":["synonym","antonym","variant","equivalent","cross-reference","related-word","rhyme","form","etymologically-related-term","hypernym","hyponym","inflected-form","primary","same-context","verb-form","verb-stem"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"limitPerRelationshipType","description":"Restrict to the supplied relatinship types","required":false,"dataType":"string","allowableValues":{"max":"Infinity","min":1.0,"valueType":"RANGE"},"allowMultiple":false,"paramType":"query"}],"summary":"Given a word as a string, returns relationships from the Word Graph","responseTypeInternal":"com.wordnik.corpus.dictionary.entity.Related","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getRelatedWords","responseClass":"List[related]","httpMethod":"GET"},{"parameters":[{"name":"username","description":"Username to add words on behalf of","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"word","description":"Word to add relationships for","required":true,"dataType":"string","allowMultiple":false,"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":{"values":["false","true"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"relationshipType","description":"The relationship type to add","required":false,"dataType":"string","allowableValues":{"values":["alternateSpelling","misspelling","slang","abbreviation","synonym","antonym","variant","equivalent","cross-reference","related-word","rhyme","form","etymologically-related-term","hypernym","hyponym","inflected-form","primary","same-context","verb-form","verb-stem"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"bidirectional","description":"Build bi-directional relationship","required":false,"dataType":"string","allowableValues":{"values":["false","true"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"description":"Words to add in CSV string","required":false,"dataType":"Array[com.wordnik.corpus.entity.Word]","valueTypeInternal":"com.wordnik.corpus.entity.Word","allowMultiple":true,"paramType":"body"}],"summary":"Adds relationships to the Word Graph","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid input word, relationship or target words supplied.","code":400}],"nickname":"addRelatedWords","responseClass":"ok","httpMethod":"POST"}]},{"path":"/word.{format}/{word}/listedIn","description":"","operations":[{"parameters":[{"name":"word","description":"Word to fetch WordLists for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"sortBy","description":"Specifies a sort parameter","required":false,"dataType":"string","allowableValues":{"values":["rating"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"username","description":"User to scope the request to","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns WordLists containing a word","responseTypeInternal":"com.wordnik.community.entity.WordList","errorResponses":[{"reason":"Invalid word supplied","code":400},{"reason":"Supplied user does not exist","code":404}],"nickname":"getListedIn","responseClass":"List[wordList]","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/listedInCount","description":"","operations":[{"parameters":[{"name":"word","description":"Word to fetch count for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Returns a count of lists a word appears in","responseTypeInternal":"com.wordnik.system.model.LongResult","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"Word not found.","code":404}],"nickname":"getListedInCount","responseClass":"long","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/firstListedIn","description":"","operations":[{"parameters":[{"name":"word","description":"Word to fetch a WordList for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Returns the first WordList a word appeared in","responseTypeInternal":"com.wordnik.community.entity.WordList","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"Word not found.","code":404}],"nickname":"getFirstListedIn","responseClass":"wordList","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/firstListedBy","description":"","operations":[{"parameters":[{"name":"word","description":"Word to fetch a User for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Returns the first User to list a particular word","responseTypeInternal":"com.wordnik.system.user.entity.User","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"Word not found.","code":404}],"nickname":"getFirstListedBy","responseClass":"user","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/pronunciations","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get pronunciations for","required":true,"dataType":"string","allowMultiple":false,"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":{"values":["false","true"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"sourceDictionary","description":"Get from a single dictionary.","required":false,"dataType":"string","allowableValues":{"values":["ahd","century","cmu","macmillan","wiktionary","webster","wordnet"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"typeFormat","description":"Text pronunciation type","required":false,"dataType":"string","allowableValues":{"values":["ahd","arpabet","gcide-diacritical","IPA"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns text pronunciations for a given word","responseTypeInternal":"com.wordnik.corpus.dictionary.entity.TextPron","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getTextPronunciations","responseClass":"List[textPron]","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/images/flickr","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get flickr images for.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"size","description":"Image size","required":false,"dataType":"string","allowableValues":{"values":["thumb","small","med","lg","orig"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns Flickr images for a word","responseTypeInternal":"com.wordnik.corpus.model.FlickrImage","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getFlickrImages","responseClass":"List[photo]","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/scrabbleScore","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get scrabble score for.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Returns the Scrabble score for a word","responseTypeInternal":"com.wordnik.system.model.LongResult","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No scrabble score found.","code":404}],"nickname":"getScrabbleScore","responseClass":"long","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/citations","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get citations for.","required":true,"dataType":"string","allowMultiple":false,"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":{"values":["false","true"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"sourceDictionary","description":"Get from a single dictionary. Valid options: ahd, century, wiktionary, webster, and wordnet.","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns citations for a word","responseTypeInternal":"com.wordnik.corpus.dictionary.entity.Citation","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getCitations","responseClass":"List[citation]","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/hyphenation","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get syllables for","required":true,"dataType":"string","allowMultiple":false,"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","allowMultiple":false,"paramType":"query"},{"name":"sourceDictionary","description":"Get from a single dictionary. Valid options: ahd, century, wiktionary, webster, and wordnet.","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns syllable information for a word","responseTypeInternal":"com.wordnik.corpus.dictionary.entity.Syllable","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getHyphenation","responseClass":"List[syllable]","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/unigramCountInternal","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get unigram count for.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Returns syllable information for a word","responseTypeInternal":"com.wordnik.system.model.LongResult","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getUnigramCountInternal","responseClass":"long","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/phrasesInternal","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get bigrams for.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"gamma","description":"Gamma filter","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"minWlmi","description":"WLMI Limit","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns Bigrams for the given word","responseTypeInternal":"com.wordnik.corpus.ngram.entity.Bigram","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getBigramsInternal","responseClass":"List[bigram]","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/tags","description":"","operations":[{"parameters":[{"name":"word","description":"Word to fetch Tags on","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"useCanonical","description":"Use the canonical form of the word.","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"username","description":"Restrict to a particular user","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches tags for a word","responseTypeInternal":"com.wordnik.community.entity.Tag","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getTagsOnWord","responseClass":"List[tag]","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/tagCount","description":"","operations":[{"parameters":[{"name":"word","description":"Word to fetch Tag count on","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"useCanonical","description":"Use the canonical form of the word.","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"username","description":"Restrict to a particular user","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches tag count for a word","responseTypeInternal":"com.wordnik.system.model.LongResult","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getTagCountOnWord","responseClass":"long","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/tag","description":"","operations":[{"parameters":[{"name":"word","description":"Word to add a Tag to","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"tags","description":"CSV list of tags to add.","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"username","description":"Add tag on behalf of a particular user","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Adds a tag to a word","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"addTagToWord","responseClass":"ok","httpMethod":"POST"},{"parameters":[{"name":"word","description":"Word to add a Tag to","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"tags","description":"CSV list of tags to remove.","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"username","description":"Remove tag on behalf of a particular user","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Removes a tag from a word","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"deleteTagFromWord","responseClass":"ok","httpMethod":"DELETE"}]},{"path":"/word.{format}/{word}/frequency","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"caseSensitive","description":"Input is case sensitive","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"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","allowMultiple":false,"paramType":"query"},{"name":"startYear","description":"Starting Year","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"endYear","description":"Ending Year","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"includeErrorBars","description":"Get error bar data","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Returns word usage over time","responseTypeInternal":"com.wordnik.corpus.entity.FrequencySummary","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No results.","code":404}],"nickname":"getWordFrequency","responseClass":"frequencySummary","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/firstUsed","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return first usage for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"useCanonical","description":"Use the canonical form of the word.","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"detailed","description":"Return detailed usage info","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns first usage of a word","responseTypeInternal":"com.wordnik.corpus.stats.entity.DetailedWordUsage","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getFirstUsageOfWord","responseClass":"detailedWordUsage","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/wordView","description":"","operations":[{"parameters":[{"name":"word","description":"Word to record a word view for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"userId","description":"ID of the user viewing the word","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"userGuid","description":"Tracking ID for the user","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"userSessionId","description":"Session ID for the user","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"serverIp","description":"Internal IP address of the web server","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"pageName","description":"Page being viewed","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"method","description":"Method of the word view","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"userAgent","description":"Browser user agent","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Records a word view from the website","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"addWordView","responseClass":"ok","httpMethod":"POST"}]},{"path":"/word.{format}/{word}/isFavorite","description":"","operations":[{"parameters":[{"name":"word","description":"Word to check","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"useCanonical","description":"Use the canonical form of the word.","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"userName","description":"Check for a particular user","required":true,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Checks to see if a word is a user's favorite","responseTypeInternal":"com.wordnik.system.model.BooleanValue","errorResponses":[{"reason":"Invalid word supplied","code":400},{"reason":"No user found","code":404}],"nickname":"isFavorite","responseClass":"BooleanValue","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/favoriteCount","description":"","operations":[{"parameters":[{"name":"word","description":"Word to check","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"useCanonical","description":"Use the canonical form of the word.","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"userName","description":"Check for a particular user","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Returns the number of times a word has been Favorited","responseTypeInternal":"com.wordnik.system.model.LongResult","errorResponses":[{"reason":"Invalid word supplied","code":400},{"reason":"No user found","code":404}],"nickname":"getFavoriteCount","responseClass":"long","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/favorite","description":"","operations":[{"parameters":[{"name":"word","description":"Word to favorite","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"userName","description":"Add as favorite on behalf of a particular user","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Favorites a Word for a user","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No user found","code":404}],"nickname":"addWordToFavorites","responseClass":"ok","httpMethod":"POST"},{"parameters":[{"name":"word","description":"Word to remove","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"userName","description":"Remove on behalf of a particular user","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Removes a Word from a user's Favorites","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid word supplied or no user found.","code":400}],"nickname":"deleteFromFavorites","responseClass":"ok","httpMethod":"DELETE"}]},{"path":"/word.{format}/{word}/phrases","description":"","operations":[{"parameters":[{"name":"word","description":"Word to fetch phrases for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"wlmi","description":"Minimum WLMI for the phrase","required":false,"dataType":"string","allowMultiple":false,"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":{"values":["false","true"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"}],"summary":"Fetches bi-gram phrases for a word","responseTypeInternal":"com.wordnik.corpus.ngram.entity.Bigram","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getPhrases","responseClass":"List[bigram]","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/related","description":"","operations":[{"parameters":[{"name":"word","description":"Word for which to return related words","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"partOfSpeech","description":"CSV list of part-of-speech types","required":false,"dataType":"string","allowableValues":{"values":["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"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"sourceDictionary","description":"Get data from a single dictionary","required":false,"dataType":"string","allowableValues":{"values":["ahd"," century"," wiktionary"," webster"," wordnet"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"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":{"values":["false","true"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"type","description":"Relationship type","required":false,"dataType":"string","allowableValues":{"values":["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"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"}],"summary":"Return related words (thesaurus data) for a word","responseTypeInternal":"com.wordnik.corpus.dictionary.entity.Related","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No definitions found.","code":404}],"nickname":"getRelated","responseClass":"List[related]","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/etymologies","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"sourceDictionary","description":"Get etymologies from a single dictionary. Options are ahd or century.","required":false,"dataType":"string","allowableValues":{"values":["ahd","webster","wiktionary"],"valueType":"LIST"},"allowMultiple":false,"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":{"values":["false","true"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"type","description":"Etymology type","required":false,"dataType":"string","allowableValues":{"values":["ahd","webster","wiktionary"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"}],"summary":"Fetches etymology data","responseTypeInternal":"String","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No definitions found.","code":404}],"nickname":"getEtymologies","responseClass":"String","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/comments","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return Comments for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"sortOrder","defaultValue":"descending","description":"Direction to sort by","required":false,"dataType":"string","allowableValues":{"values":["ascending","descending"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches comments on a Word","responseTypeInternal":"com.wordnik.community.entity.Comment","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getCommentsOnWord","responseClass":"List[comment]","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/comment/{commentId}","description":"","operations":[{"parameters":[{"name":"word","description":"Word to fetch Comment for.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"commentId","description":"ID of Comment to fetch.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Fetches a Comment by ID","responseTypeInternal":"com.wordnik.community.entity.Comment","errorResponses":[{"reason":"Invalid word or Comment supplied.","code":400},{"reason":"Word or commentor not found.","code":404}],"nickname":"getCommentOnWord","responseClass":"comment","httpMethod":"GET"},{"parameters":[{"name":"word","description":"Word to update Comment on.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"commentId","description":"Updated Comment.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Deletes an existing word comment","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid word or Comment supplied.","code":400},{"reason":"Word or commentor not found.","code":404}],"nickname":"deleteCommentByIdOnWord","responseClass":"ok","httpMethod":"DELETE"}]},{"path":"/word.{format}/{word}/comment","description":"","operations":[{"parameters":[{"name":"word","description":"Word to add Comment to.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"description":"Comment to add.","required":false,"dataType":"comment","valueTypeInternal":"comment","allowMultiple":false,"paramType":"body"}],"summary":"Adds a comment to a word","responseTypeInternal":"com.wordnik.community.entity.Comment","errorResponses":[{"reason":"Invalid word or Comment supplied.","code":400},{"reason":"Word or commentor not found.","code":404}],"nickname":"commentOnWord","responseClass":"comment","httpMethod":"POST"},{"parameters":[{"name":"word","description":"Word to update Comment on.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"description":"Updated Comment.","required":false,"dataType":"comment","valueTypeInternal":"comment","allowMultiple":false,"paramType":"body"}],"summary":"Updates an existing word comment","responseTypeInternal":"com.wordnik.community.entity.Comment","errorResponses":[{"reason":"Invalid word or Comment supplied.","code":400},{"reason":"Word or commentor not found.","code":404}],"nickname":"updateCommentOnWord","responseClass":"comment","httpMethod":"PUT"}]},{"path":"/word.{format}/{word}/audio","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get audio for.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"useCanonical","description":"Use the canonical form of the word.","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"v3Format","description":"Use the V3 api.","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches audio metadata for a word.","responseTypeInternal":"com.wordnik.community.entity.AudioFileMetadata","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getAudio","responseClass":"List[audioFile]","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":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"description":"AudioPon metadata to add.","required":false,"dataType":"audioObject","valueTypeInternal":"audioObject","allowMultiple":false,"paramType":"body"}],"summary":"Creates AudioPron metadata","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"addAudio","responseClass":"ok","httpMethod":"POST"}]},{"path":"/word.{format}/{word}/pronunciation/{pronId}","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get audio for.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"pronId","description":"Id to get audio for.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Fetches single audio pronunciation.","responseTypeInternal":"com.wordnik.community.entity.AudioFileMetadata","errorResponses":[{"reason":"Invalid pron id supplied.","code":400}],"nickname":"getPronunciation","responseClass":"audioFile","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"}]},{"path":"/word.{format}/{word}/audioInternal","description":"","operations":[{"parameters":[{"name":"word","description":"audio object to update","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"description":"Updated metadata.","required":false,"dataType":"audioObject","valueTypeInternal":"audioObject","allowMultiple":false,"paramType":"body"}],"summary":"Internal method to update an audio object","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"updateAudioInternal","responseClass":"ok","httpMethod":"PUT"}]},{"path":"/word.{format}/{word}/audio/{audio_id}","description":"","operations":[{"parameters":[{"name":"word","description":"Word to delete audio from.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"audio_id","description":"AudioPon metadata to add.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Deletes an AudioPron","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"Unauthorized.","code":401}],"nickname":"deleteAudio","responseClass":"ok","httpMethod":"DELETE"}]}],"models":{"User":{"properties":{"id":{"type":"long"},"username":{"type":"string"},"email":{"type":"string"},"status":{"type":"int"},"faceBookId":{"type":"string"},"userName":{"type":"string"},"displayName":{"type":"string"},"password":{"type":"string"}},"id":"user"},"Syllable":{"properties":{"text":{"type":"string"}},"id":"syllable"},"DocumentMetadata":{"properties":{"tags":{"type":"array","items":{"type":"string"}},"yearType":{"type":"yearType"},"expirationDate":{"type":"Date"},"extendedMetadata":{"type":"extendedMetadata"},"stats":{"type":"basicDocumentStats"},"provider":{"type":"contentProvider"},"contentType":{"type":"contentType"},"sourceUrl":{"type":"string"},"date":{"type":"Date"},"medium":{"type":"documentMedium"},"guid":{"type":"string"},"id":{"type":"long"},"authors":{"type":"array","items":{"$ref":"author"}},"title":{"type":"string"},"primaryAuthorType":{"type":"authorType"},"createdAt":{"type":"Date"},"classification":{"type":"subjectClassificationType"},"year":{"type":"integer"},"primaryAuthor":{"type":"string"},"rating":{"type":"double"},"primaryAuthorId":{"type":"long"}},"id":"documentMetadata"},"AudioType":{"properties":{"id":{"type":"int"},"name":{"type":"string"}},"id":"audioType"},"Type":{"properties":{"enteredAt":{"type":"string"},"text":{"type":"string"},"mapping":{"type":"long"},"typeId":{"type":"int"}},"id":"type"},"Facet":{"properties":{"facetValues":{"type":"array","items":{"$ref":"facetValue"}},"name":{"type":"string"}},"id":"facet"},"RelationshipMap":{"properties":{"sourceWordstring":{"type":"string"},"suggestions":{"type":"array","items":{"$ref":"suggestion"}}},"id":"relationshipMap"},"WordObject":{"properties":{"id":{"type":"long","required":true},"word":{"type":"string"},"vulgar":{"type":"string"}},"id":"wordObject"},"WordUGCStats":{"properties":{"listedInCount":{"type":"long"},"favoriteCount":{"type":"long"},"lookupCount":{"type":"long"},"commentCount":{"type":"long"},"tagCount":{"type":"long"}},"id":"wordUGCStats"},"ExampleSearchResults":{"properties":{"facets":{"type":"array","items":{"$ref":"facet"}},"examples":{"type":"array","items":{"$ref":"example"}}},"id":"exampleSearchResults"},"Example":{"properties":{"id":{"type":"long"},"exampleId":{"type":"long"},"title":{"type":"string"},"text":{"type":"string"},"score":{"type":"scoredWord"},"sentence":{"type":"sentence"},"word":{"type":"string"},"provider":{"type":"contentProvider"},"year":{"type":"integer"},"rating":{"type":"float"},"documentId":{"type":"long"},"url":{"type":"string"}},"id":"example"},"Header":{"properties":{"sourceDictionary":{"type":"string"},"homograph":{"type":"string"},"derivedFrom":{"type":"string"},"type":{"type":"type"},"attributionUrl":{"type":"string"},"attributionText":{"type":"string"},"syllables":{"type":"array","items":{"$ref":"syllable"}},"word":{"type":"string"},"etymologyXml":{"type":"string"},"notes":{"type":"array","items":{"$ref":"note"}},"textProns":{"type":"array","items":{"$ref":"textPron"}},"derivativeSense":{"type":"string"},"partOfSpeech":{"type":"string"}},"id":"header"},"BooleanValue":{"properties":{"value":{"type":"boolean"}},"id":"BooleanValue"},"Tag":{"properties":{"count":{"type":"long"},"name":{"type":"string"}},"id":"tag"},"AudioFile":{"properties":{"attributionUrl":{"type":"string"},"commentCount":{"type":"int"},"voteCount":{"type":"integer"},"fileUrl":{"type":"string"},"audioType":{"type":"string"},"id":{"type":"long","required":true},"duration":{"type":"double"},"attributionText":{"type":"string"},"createdBy":{"type":"string"},"description":{"type":"string"},"createdAt":{"type":"Date"},"voteWeightedAverage":{"type":"float"},"voteAverage":{"type":"float"},"word":{"type":"string"}},"id":"audioFile"},"Bigram":{"properties":{"count":{"type":"long"},"gram2":{"type":"string"},"gram1":{"type":"string"},"wlmi":{"type":"double"},"mi":{"type":"double"}},"id":"bigram"},"Frequency":{"properties":{"count":{"type":"long"},"year":{"type":"int"}},"id":"frequency"},"TextPron":{"properties":{"raw":{"type":"string"},"rawType":{"type":"string"}},"id":"textPron"},"Long":{"properties":{"value":{"type":"long"}},"id":"long"},"WordList":{"properties":{"updatedAt":{"type":"Date"},"id":{"type":"long","required":true},"username":{"type":"string"},"permalink":{"type":"string"},"lastActivityAt":{"type":"Date"},"createdAt":{"type":"Date"},"description":{"type":"string"},"userId":{"type":"long"},"name":{"type":"string"},"numberWordsInList":{"type":"long"},"type":{"type":"string"}},"id":"wordList"},"Entry":{"properties":{"sourceDictionary":{"type":"string"},"attributionText":{"type":"string"},"relatedWords":{"type":"array","items":{"$ref":"related"}},"word":{"type":"string"},"definitions":{"type":"array","items":{"$ref":"definition"}},"attributionUrl":{"type":"string"},"notes":{"type":"array","items":{"$ref":"note"}},"syllabified":{"type":"array","items":{"$ref":"syllable"}},"header":{"type":"header"}},"id":"entry"},"Comment":{"properties":{"id":{"type":"string"},"updatedAt":{"type":"Date"},"body":{"type":"string"},"approved":{"type":"boolean"},"disemvoweled":{"type":"boolean"},"commentedOn":{"type":"string"},"createdAt":{"type":"Date"},"commentedBy":{"type":"string"},"commentedById":{"type":"long"},"objectType":{"type":"string"}},"id":"comment"},"Suggestion":{"properties":{"type":{"type":"int"},"wordstring":{"type":"string"}},"id":"suggestion"},"DetailedWordUsage":{"properties":{"sentence":{"type":"sentence"},"wordstring":{"type":"string"},"metadata":{"type":"documentMetadata"}},"id":"detailedWordUsage"},"DefinitionSearchResults":{"properties":{"results":{"type":"array","items":{"$ref":"definition"}},"totalResults":{"type":"int"}},"id":"DefinitionSearchResults"},"Note":{"properties":{"appliesTo":{"type":"array","items":{"type":"string"}},"value":{"type":"string"}},"id":"note"},"Related":{"properties":{"words":{"type":"array","items":{"type":"string"}}},"id":"related"},"FacetValue":{"properties":{"count":{"type":"long"},"value":{"type":"string"}},"id":"facetValue"},"Photo":{"properties":{"ownerLink":{"type":"string"},"linkUri":{"type":"string"},"size":{"type":"size"}},"id":"photo"},"ScoredWord":{"properties":{"position":{"type":"int"},"id":{"type":"long"},"docTermCount":{"type":"int"},"lemma":{"type":"string"},"wordType":{"type":"string"},"score":{"type":"float"},"sentenceId":{"type":"long"},"word":{"type":"string"},"stopword":{"type":"boolean"},"baseWordScore":{"type":"double"},"partOfSpeech":{"type":"string"}},"id":"scoredWord"},"Citation":{"properties":{"cite":{"type":"string"},"source":{"type":"string"}},"id":"citation"},"FrequencyStats":{"properties":{"author":{"type":"Map[long,long]"},"subject":{"type":"Map[integer,long]"},"contentProvider":{"type":"Map[integer,long]"},"contentType":{"type":"Map[integer,long]"},"corpusCount":{"type":"long"},"yearWise":{"type":"Map[integer,long]"},"medium":{"type":"Map[integer,long]"}},"id":"frequencyStats"},"Category":{"properties":{"id":{"type":"long","required":true},"name":{"type":"string"}},"id":"category"},"WordStats":{"properties":{"dictionaryStats":{"type":"Map[string,dictionaryWordStats]"},"documentsCount":{"type":"long"},"ugcStats":{"type":"wordUGCStats"},"sentencesCount":{"type":"long"},"frequencyStats":{"type":"frequencyStats"},"partOfSpeechStats":{"type":"Map[string,integer]"},"wordstring":{"type":"string"}},"id":"wordStats"},"Sizes":{"properties":{"size":{"type":"array","items":{"$ref":"size"}}},"id":"sizes"},"String":{"properties":{"name":{"type":"string"},"ordinal":{"type":"int"}},"id":"string"},"Root":{"properties":{"id":{"type":"long","required":true},"name":{"type":"string"},"categories":{"type":"array","items":{"$ref":"category"}}},"id":"root"},"Sentence":{"properties":{"hasScoredWords":{"type":"boolean"},"id":{"type":"long"},"scoredWords":{"type":"array","items":{"$ref":"scoredWord"}},"display":{"type":"string"},"rating":{"type":"int"},"documentMetadataId":{"type":"long"}},"id":"sentence"},"ContentProvider":{"properties":{"id":{"type":"int"},"name":{"type":"string"}},"id":"contentProvider"},"Label":{"properties":{"text":{"type":"string"}},"id":"Label"},"PartOfSpeech":{"properties":{"roots":{"type":"array","items":{"$ref":"root"}},"storageAbbr":{"type":"array","items":{"type":"string"}},"allCategories":{"type":"array","items":{"$ref":"category"}}},"id":"partOfSpeech"},"Definition":{"properties":{"extendedText":{"type":"string"},"text":{"type":"string"},"sourceDictionary":{"type":"string"},"citations":{"type":"array","items":{"$ref":"citation"}},"labels":{"type":"array","items":{"$ref":"Label"}},"score":{"type":"float"},"exampleUses":{"type":"array","items":{"$ref":"ExampleUsage"}},"attributionUrl":{"type":"string"},"seqString":{"type":"string"},"attributionText":{"type":"string"},"relatedWords":{"type":"array","items":{"$ref":"related"}},"word":{"type":"string"},"notes":{"type":"array","items":{"$ref":"note"}},"textProns":{"type":"array","items":{"$ref":"textPron"}},"partOfSpeech":{"type":"string"}},"id":"definition"},"FrequencySummary":{"properties":{"unknownYearCount":{"type":"int"},"totalCount":{"type":"long"},"frequencyString":{"type":"string"},"word":{"type":"string"},"frequency":{"type":"array","items":{"$ref":"frequency"}}},"id":"frequencySummary"}},"basePath":"http://api.wordnik.com/v4","swaggerVersion":"1.1-SNAPSHOT","apiVersion":"4.0"} +{"resourcePath":"/word","apis":[{"path":"/word.{format}/{word}/entries","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"tags","description":"Return XML tags in response","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"sourceDictionary","description":"Get from a single dictionary. Valid options: ahd, century, wiktionary, webster, and wordnet.","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"etymologies","description":"Return etymologies","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Return entries for a word","httpMethod":"GET","responseTypeInternal":"com.wordnik.corpus.dictionary.entity.Entry","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getEntries","responseClass":"List[entry]"}]},{"path":"/word.{format}/{word}/examples","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return examples for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"includeDuplicates","description":"Show duplicate examples from different sources","required":false,"allowableValues":{"values":["false","true"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"contentProvider","description":"Return results from a specific ContentProvider","required":false,"dataType":"string","allowMultiple":false,"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,"allowableValues":{"values":["false","true"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"internalDataStore","description":"Specify the internal storage engine.","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns examples for a word","httpMethod":"GET","responseTypeInternal":"com.wordnik.corpus.model.ExampleSearchResults","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getExamples","responseClass":"exampleSearchResults"},{"parameters":[{"name":"word","description":"Word to fetch examples for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"description":"Search definition object","required":false,"dataType":"ExampleSearchQuery","valueTypeInternal":"com.wordnik.index.example.ExampleSearchQuery","allowMultiple":false,"paramType":"body"},{"name":"internalDataStore","description":"Specify the internal storage engine.","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Fetches examples for a word","httpMethod":"POST","responseTypeInternal":"com.wordnik.corpus.model.ExampleSearchResults","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getExamplesPost","responseClass":"exampleSearchResults"}]},{"path":"/word.{format}/{word}/wordForms","description":"","operations":[{"parameters":[{"name":"word","description":"Word to fetch forms for","required":true,"dataType":"string","allowMultiple":false,"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","allowMultiple":false,"paramType":"query"}],"summary":"Returns other forms of a word","httpMethod":"GET","responseTypeInternal":"com.wordnik.corpus.entity.RelationshipMap","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No results.","code":404}],"nickname":"getWordForms","responseClass":"relationshipMap"}]},{"path":"/word.{format}/{word}","description":"","operations":[{"parameters":[{"name":"word","description":"String value of WordObject to return","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"useCanonical","defaultValue":"false","description":"If true will try to return the correct word root ('cats' -> 'cat'). If false returns exactly what was requested.","required":false,"allowableValues":{"values":["false","true"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"includeSuggestions","description":"Return suggestions (for correct spelling, case variants, etc.)","required":false,"allowableValues":{"values":["false","true"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"shouldCreate","description":"Create word if not existing","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Given a word as a string, returns the WordObject that represents it","httpMethod":"GET","responseTypeInternal":"com.wordnik.corpus.entity.Word","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getWord","responseClass":"wordObject"}]},{"path":"/word.{format}/{word}/definitions","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return definitions for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"partOfSpeech","description":"CSV list of part-of-speech types","required":false,"allowableValues":{"values":["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"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"includeRelated","defaultValue":"false","description":"Return related words with definitions","required":false,"allowableValues":{"values":["true","false"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"sourceDictionaries","description":"If 'all' is received, results are returned from all sources. If multiple values are received (e.g. 'century,wiktionary'), results are returned from the first specified dictionary that has definitions. If left blank, results are returned from the first dictionary that has definitions. By default, dictionaries are searched in this order: ahd, wiktionary, webster, century, wordnet","required":false,"allowableValues":{"values":["all","ahd","century","wiktionary","webster","wordnet"],"valueType":"LIST"},"dataType":"string","allowMultiple":true,"paramType":"query"},{"name":"useCanonical","defaultValue":"false","description":"If true will try to return the correct word root ('cats' -> 'cat'). If false returns exactly what was requested.","required":false,"allowableValues":{"values":["false","true"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"includeTags","defaultValue":"false","description":"Return a closed set of XML tags in response","required":false,"allowableValues":{"values":["false","true"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Return definitions for a word","httpMethod":"GET","responseTypeInternal":"com.wordnik.corpus.dictionary.entity.Definition","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No definitions found.","code":404}],"nickname":"getDefinitions","responseClass":"List[definition]"}]},{"path":"/word.{format}/{word}/stats","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return stats for","required":true,"dataType":"string","allowMultiple":false,"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","allowMultiple":false,"paramType":"query"},{"name":"detailed","description":"Return detailed usage info","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"statsToInclude","description":"stats to include in the results","required":false,"allowableValues":{"values":["ugc","frequency","dictionary","part_of_speech"],"valueType":"LIST"},"dataType":"string","allowMultiple":true,"paramType":"query"}],"summary":"Returns word statistics","httpMethod":"GET","responseTypeInternal":"com.wordnik.corpus.stats.entity.WordStats","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No stats available.","code":404}],"nickname":"getWordStats","responseClass":"wordStats"}]},{"path":"/word.{format}/{word}/topExample","description":"","operations":[{"parameters":[{"name":"word","description":"Word to fetch examples for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"contentProvider","description":"Return results from a specific ContentProvider","required":false,"dataType":"string","allowMultiple":false,"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,"allowableValues":{"values":["false","true"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"internalDataStore","description":"Specify the internal storage engine.","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Returns a top example for a word","httpMethod":"GET","responseTypeInternal":"com.wordnik.corpus.model.Example","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getTopExample","responseClass":"example"}]},{"path":"/word.{format}/{word}/lookupCount","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get Bigrams for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Returns the number of times a word has been viewed","httpMethod":"GET","responseTypeInternal":"com.wordnik.system.model.LongResult","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"Word not found.","code":404}],"nickname":"getLookupCount","responseClass":"long"}]},{"path":"/word.{format}/{word}/commentCount","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get comment count for.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Returns the number of comments on a word","httpMethod":"GET","responseTypeInternal":"com.wordnik.system.model.LongResult","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"Word not found.","code":404}],"nickname":"getCommentCount","responseClass":"long"}]},{"path":"/word.{format}/{word}/relatedWords","description":"","operations":[{"parameters":[{"name":"word","description":"Word to fetch relationships for","required":true,"dataType":"string","allowMultiple":false,"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,"allowableValues":{"values":["false","true"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"relationshipTypes","description":"Limits the total results per type of relationship type","required":false,"allowableValues":{"values":["synonym","antonym","variant","equivalent","cross-reference","related-word","rhyme","form","etymologically-related-term","hypernym","hyponym","inflected-form","primary","same-context","verb-form","verb-stem"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limitPerRelationshipType","description":"Restrict to the supplied relatinship types","required":false,"allowableValues":{"max":"Infinity","min":1.0,"valueType":"RANGE"},"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Given a word as a string, returns relationships from the Word Graph","httpMethod":"GET","responseTypeInternal":"com.wordnik.corpus.dictionary.entity.Related","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getRelatedWords","responseClass":"List[related]"}]},{"path":"/word.{format}/{word}/listedIn","description":"","operations":[{"parameters":[{"name":"word","description":"Word to fetch WordLists for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"sortBy","description":"Specifies a sort parameter","required":false,"allowableValues":{"values":["rating"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"username","description":"User to scope the request to","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns WordLists containing a word","httpMethod":"GET","responseTypeInternal":"com.wordnik.community.entity.WordList","errorResponses":[{"reason":"Invalid word supplied","code":400},{"reason":"Supplied user does not exist","code":404}],"nickname":"getListedIn","responseClass":"List[wordList]"}]},{"path":"/word.{format}/{word}/listedInCount","description":"","operations":[{"parameters":[{"name":"word","description":"Word to fetch count for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Returns a count of lists a word appears in","httpMethod":"GET","responseTypeInternal":"com.wordnik.system.model.LongResult","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"Word not found.","code":404}],"nickname":"getListedInCount","responseClass":"long"}]},{"path":"/word.{format}/{word}/firstListedIn","description":"","operations":[{"parameters":[{"name":"word","description":"Word to fetch a WordList for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Returns the first WordList a word appeared in","httpMethod":"GET","responseTypeInternal":"com.wordnik.community.entity.WordList","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"Word not found.","code":404}],"nickname":"getFirstListedIn","responseClass":"wordList"}]},{"path":"/word.{format}/{word}/firstListedBy","description":"","operations":[{"parameters":[{"name":"word","description":"Word to fetch a User for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Returns the first User to list a particular word","httpMethod":"GET","responseTypeInternal":"com.wordnik.system.user.entity.User","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"Word not found.","code":404}],"nickname":"getFirstListedBy","responseClass":"user"}]},{"path":"/word.{format}/{word}/pronunciations","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get pronunciations for","required":true,"dataType":"string","allowMultiple":false,"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,"allowableValues":{"values":["false","true"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"sourceDictionary","description":"Get from a single dictionary.","required":false,"allowableValues":{"values":["ahd","century","cmu","macmillan","wiktionary","webster","wordnet"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"typeFormat","description":"Text pronunciation type","required":false,"allowableValues":{"values":["ahd","arpabet","gcide-diacritical","IPA"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns text pronunciations for a given word","httpMethod":"GET","responseTypeInternal":"com.wordnik.corpus.dictionary.entity.TextPron","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getTextPronunciations","responseClass":"List[textPron]"}]},{"path":"/word.{format}/{word}/images/flickr","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get flickr images for.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"size","description":"Image size","required":false,"allowableValues":{"values":["thumb","small","med","lg","orig"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns Flickr images for a word","httpMethod":"GET","responseTypeInternal":"com.wordnik.corpus.model.FlickrImage","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getFlickrImages","responseClass":"List[photo]"}]},{"path":"/word.{format}/{word}/scrabbleScore","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get scrabble score for.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Returns the Scrabble score for a word","httpMethod":"GET","responseTypeInternal":"com.wordnik.system.model.LongResult","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No scrabble score found.","code":404}],"nickname":"getScrabbleScore","responseClass":"long"}]},{"path":"/word.{format}/{word}/citations","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get citations for.","required":true,"dataType":"string","allowMultiple":false,"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,"allowableValues":{"values":["false","true"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"sourceDictionary","description":"Get from a single dictionary. Valid options: ahd, century, wiktionary, webster, and wordnet.","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns citations for a word","httpMethod":"GET","responseTypeInternal":"com.wordnik.corpus.dictionary.entity.Citation","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getCitations","responseClass":"List[citation]"}]},{"path":"/word.{format}/{word}/hyphenation","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get syllables for","required":true,"dataType":"string","allowMultiple":false,"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","allowMultiple":false,"paramType":"query"},{"name":"sourceDictionary","description":"Get from a single dictionary. Valid options: ahd, century, wiktionary, webster, and wordnet.","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns syllable information for a word","httpMethod":"GET","responseTypeInternal":"com.wordnik.corpus.dictionary.entity.Syllable","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getHyphenation","responseClass":"List[syllable]"}]},{"path":"/word.{format}/{word}/unigramCountInternal","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get unigram count for.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Returns syllable information for a word","httpMethod":"GET","responseTypeInternal":"com.wordnik.system.model.LongResult","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getUnigramCountInternal","responseClass":"long"}]},{"path":"/word.{format}/{word}/phrasesInternal","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get bigrams for.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"gamma","description":"Gamma filter","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"minWlmi","description":"WLMI Limit","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns Bigrams for the given word","httpMethod":"GET","responseTypeInternal":"com.wordnik.corpus.ngram.entity.Bigram","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getBigramsInternal","responseClass":"List[bigram]"}]},{"path":"/word.{format}/{word}/tags","description":"","operations":[{"parameters":[{"name":"word","description":"Word to fetch Tags on","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"useCanonical","description":"Use the canonical form of the word.","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"username","description":"Restrict to a particular user","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches tags for a word","httpMethod":"GET","responseTypeInternal":"com.wordnik.community.entity.Tag","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getTagsOnWord","responseClass":"List[tag]"}]},{"path":"/word.{format}/{word}/tagCount","description":"","operations":[{"parameters":[{"name":"word","description":"Word to fetch Tag count on","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"useCanonical","description":"Use the canonical form of the word.","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"username","description":"Restrict to a particular user","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches tag count for a word","httpMethod":"GET","responseTypeInternal":"com.wordnik.system.model.LongResult","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getTagCountOnWord","responseClass":"long"}]},{"path":"/word.{format}/{word}/tag","description":"","operations":[{"parameters":[{"name":"word","description":"Word to add a Tag to","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"tags","description":"CSV list of tags to add.","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"username","description":"Add tag on behalf of a particular user","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Adds a tag to a word","httpMethod":"POST","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"addTagToWord","responseClass":"ok"},{"parameters":[{"name":"word","description":"Word to add a Tag to","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"tags","description":"CSV list of tags to remove.","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"username","description":"Remove tag on behalf of a particular user","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Removes a tag from a word","httpMethod":"DELETE","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"deleteTagFromWord","responseClass":"ok"}]},{"path":"/word.{format}/{word}/frequency","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"caseSensitive","description":"Input is case sensitive","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"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","allowMultiple":false,"paramType":"query"},{"name":"startYear","description":"Starting Year","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"endYear","description":"Ending Year","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"includeErrorBars","description":"Get error bar data","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Returns word usage over time","httpMethod":"GET","responseTypeInternal":"com.wordnik.corpus.entity.FrequencySummary","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No results.","code":404}],"nickname":"getWordFrequency","responseClass":"frequencySummary"}]},{"path":"/word.{format}/{word}/firstUsed","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return first usage for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"useCanonical","description":"Use the canonical form of the word.","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"detailed","description":"Return detailed usage info","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns first usage of a word","httpMethod":"GET","responseTypeInternal":"com.wordnik.corpus.stats.entity.DetailedWordUsage","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getFirstUsageOfWord","responseClass":"detailedWordUsage"}]},{"path":"/word.{format}/{word}/wordView","description":"","operations":[{"parameters":[{"name":"word","description":"Word to record a word view for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"userId","description":"ID of the user viewing the word","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"userGuid","description":"Tracking ID for the user","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"userSessionId","description":"Session ID for the user","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"serverIp","description":"Internal IP address of the web server","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"pageName","description":"Page being viewed","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"method","description":"Method of the word view","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"userAgent","description":"Browser user agent","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Records a word view from the website","httpMethod":"POST","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"addWordView","responseClass":"ok"}]},{"path":"/word.{format}/{word}/isFavorite","description":"","operations":[{"parameters":[{"name":"word","description":"Word to check","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"useCanonical","description":"Use the canonical form of the word.","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"userName","description":"Check for a particular user","required":true,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Checks to see if a word is a user's favorite","httpMethod":"GET","responseTypeInternal":"com.wordnik.system.model.BooleanValue","errorResponses":[{"reason":"Invalid word supplied","code":400},{"reason":"No user found","code":404}],"nickname":"isFavorite","responseClass":"BooleanValue"}]},{"path":"/word.{format}/{word}/favoriteCount","description":"","operations":[{"parameters":[{"name":"word","description":"Word to check","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"useCanonical","description":"Use the canonical form of the word.","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"userName","description":"Check for a particular user","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Returns the number of times a word has been Favorited","httpMethod":"GET","responseTypeInternal":"com.wordnik.system.model.LongResult","errorResponses":[{"reason":"Invalid word supplied","code":400},{"reason":"No user found","code":404}],"nickname":"getFavoriteCount","responseClass":"long"}]},{"path":"/word.{format}/{word}/favorite","description":"","operations":[{"parameters":[{"name":"word","description":"Word to favorite","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"userName","description":"Add as favorite on behalf of a particular user","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Favorites a Word for a user","httpMethod":"POST","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No user found","code":404}],"nickname":"addWordToFavorites","responseClass":"ok"},{"parameters":[{"name":"word","description":"Word to remove","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"userName","description":"Remove on behalf of a particular user","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Removes a Word from a user's Favorites","httpMethod":"DELETE","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid word supplied or no user found.","code":400}],"nickname":"deleteFromFavorites","responseClass":"ok"}]},{"path":"/word.{format}/{word}/phrases","description":"","operations":[{"parameters":[{"name":"word","description":"Word to fetch phrases for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"wlmi","description":"Minimum WLMI for the phrase","required":false,"dataType":"string","allowMultiple":false,"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,"allowableValues":{"values":["false","true"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches bi-gram phrases for a word","httpMethod":"GET","responseTypeInternal":"com.wordnik.corpus.ngram.entity.Bigram","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getPhrases","responseClass":"List[bigram]"}]},{"path":"/word.{format}/{word}/related","description":"","operations":[{"parameters":[{"name":"word","description":"Word for which to return related words","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"partOfSpeech","description":"CSV list of part-of-speech types","required":false,"allowableValues":{"values":["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"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"sourceDictionary","description":"Get data from a single dictionary","required":false,"allowableValues":{"values":["ahd"," century"," wiktionary"," webster"," wordnet"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"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,"allowableValues":{"values":["false","true"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"type","description":"Relationship type","required":false,"allowableValues":{"values":["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"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Return related words (thesaurus data) for a word","httpMethod":"GET","responseTypeInternal":"com.wordnik.corpus.dictionary.entity.Related","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No definitions found.","code":404}],"nickname":"getRelated","responseClass":"List[related]"}]},{"path":"/word.{format}/{word}/etymologies","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"sourceDictionary","description":"Get etymologies from a single dictionary. Options are ahd or century.","required":false,"allowableValues":{"values":["ahd","webster","wiktionary"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"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,"allowableValues":{"values":["false","true"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"type","description":"Etymology type","required":false,"allowableValues":{"values":["ahd","webster","wiktionary"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches etymology data","httpMethod":"GET","responseTypeInternal":"String","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No definitions found.","code":404}],"nickname":"getEtymologies","responseClass":"String"}]},{"path":"/word.{format}/{word}/comments","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return Comments for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"sortOrder","defaultValue":"descending","description":"Direction to sort by","required":false,"allowableValues":{"values":["ascending","descending"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches comments on a Word","httpMethod":"GET","responseTypeInternal":"com.wordnik.community.entity.Comment","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getCommentsOnWord","responseClass":"List[comment]"}]},{"path":"/word.{format}/{word}/comment/{commentId}","description":"","operations":[{"parameters":[{"name":"word","description":"Word to fetch Comment for.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"commentId","description":"ID of Comment to fetch.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Fetches a Comment by ID","httpMethod":"GET","responseTypeInternal":"com.wordnik.community.entity.Comment","errorResponses":[{"reason":"Invalid word or Comment supplied.","code":400},{"reason":"Word or commentor not found.","code":404}],"nickname":"getCommentOnWord","responseClass":"comment"},{"parameters":[{"name":"word","description":"Word to update Comment on.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"commentId","description":"Updated Comment.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Deletes an existing word comment","httpMethod":"DELETE","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid word or Comment supplied.","code":400},{"reason":"Word or commentor not found.","code":404}],"nickname":"deleteCommentByIdOnWord","responseClass":"ok"}]},{"path":"/word.{format}/{word}/comment","description":"","operations":[{"parameters":[{"name":"word","description":"Word to add Comment to.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"description":"Comment to add.","required":false,"dataType":"comment","valueTypeInternal":"com.wordnik.community.entity.Comment","allowMultiple":false,"paramType":"body"}],"summary":"Adds a comment to a word","httpMethod":"POST","responseTypeInternal":"com.wordnik.community.entity.Comment","errorResponses":[{"reason":"Invalid word or Comment supplied.","code":400},{"reason":"Word or commentor not found.","code":404}],"nickname":"commentOnWord","responseClass":"comment"},{"parameters":[{"name":"word","description":"Word to update Comment on.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"description":"Updated Comment.","required":false,"dataType":"comment","valueTypeInternal":"com.wordnik.community.entity.Comment","allowMultiple":false,"paramType":"body"}],"summary":"Updates an existing word comment","httpMethod":"PUT","responseTypeInternal":"com.wordnik.community.entity.Comment","errorResponses":[{"reason":"Invalid word or Comment supplied.","code":400},{"reason":"Word or commentor not found.","code":404}],"nickname":"updateCommentOnWord","responseClass":"comment"}]},{"path":"/word.{format}/{word}/audio","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get audio for.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"useCanonical","description":"Use the canonical form of the word.","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"v3Format","description":"Use the V3 api.","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches audio metadata for a word.","httpMethod":"GET","responseTypeInternal":"com.wordnik.community.entity.AudioFileMetadata","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getAudio","responseClass":"List[audioFile]","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."},{"parameters":[{"name":"word","description":"Word to add audio to.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"description":"AudioPon metadata to add.","required":false,"dataType":"audioObject","valueTypeInternal":"com.wordnik.community.entity.AudioPron","allowMultiple":false,"paramType":"body"}],"summary":"Creates AudioPron metadata","httpMethod":"POST","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"addAudio","responseClass":"ok"}]},{"path":"/word.{format}/{word}/pronunciation/{pronId}","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get audio for.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"pronId","description":"Id to get audio for.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Fetches single audio pronunciation.","httpMethod":"GET","responseTypeInternal":"com.wordnik.community.entity.AudioFileMetadata","errorResponses":[{"reason":"Invalid pron id supplied.","code":400}],"nickname":"getPronunciation","responseClass":"audioFile","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."}]},{"path":"/word.{format}/{word}/audioInternal","description":"","operations":[{"parameters":[{"name":"word","description":"audio object to update","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"description":"Updated metadata.","required":false,"dataType":"audioObject","valueTypeInternal":"com.wordnik.community.entity.AudioPron","allowMultiple":false,"paramType":"body"}],"summary":"Internal method to update an audio object","httpMethod":"PUT","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"updateAudioInternal","responseClass":"ok"}]},{"path":"/word.{format}/{word}/audio/{audio_id}","description":"","operations":[{"parameters":[{"name":"word","description":"Word to delete audio from.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"audio_id","description":"AudioPon metadata to add.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Deletes an AudioPron","httpMethod":"DELETE","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"Unauthorized.","code":401}],"nickname":"deleteAudio","responseClass":"ok"}]}],"apiVersion":"4.0","swaggerVersion":"1.1-SNAPSHOT","basePath":"http://api.wordnik.com/v4","models":{"User":{"properties":{"id":{"type":"long"},"username":{"type":"string"},"email":{"type":"string"},"status":{"type":"int"},"faceBookId":{"type":"string"},"userName":{"type":"string"},"displayName":{"type":"string"},"password":{"type":"string"}},"id":"user"},"AudioObject":{"properties":{"recordId":{"type":"string"},"audioFileType":{"type":"audioType"},"filePath":{"type":"string"},"type":{"type":"audioType"},"id":{"type":"long"},"duration":{"type":"double"},"createdBy":{"type":"string"},"description":{"type":"string"},"createdAt":{"type":"Date"},"userId":{"type":"long"},"audioFileId":{"type":"long"},"streamPath":{"type":"string"},"wordstring":{"type":"string"}},"id":"audioObject"},"Syllable":{"properties":{"text":{"type":"string"}},"id":"syllable"},"DocumentMetadata":{"properties":{"tags":{"type":"array","items":{"type":"string"}},"yearType":{"type":"yearType"},"expirationDate":{"type":"Date"},"extendedMetadata":{"type":"extendedMetadata"},"stats":{"type":"basicDocumentStats"},"provider":{"type":"contentProvider"},"contentType":{"type":"contentType"},"sourceUrl":{"type":"string"},"date":{"type":"Date"},"medium":{"type":"documentMedium"},"guid":{"type":"string"},"id":{"type":"long"},"authors":{"type":"array","items":{"$ref":"author"}},"title":{"type":"string"},"primaryAuthorType":{"type":"authorType"},"createdAt":{"type":"Date"},"classification":{"type":"subjectClassificationType"},"year":{"type":"integer"},"primaryAuthor":{"type":"string"},"rating":{"type":"double"},"primaryAuthorId":{"type":"long"}},"id":"documentMetadata"},"AudioType":{"properties":{"id":{"type":"int"},"name":{"type":"string"}},"id":"audioType"},"Type":{"properties":{"enteredAt":{"type":"string"},"text":{"type":"string"},"mapping":{"type":"long"},"typeId":{"type":"int"}},"id":"type"},"Facet":{"properties":{"facetValues":{"type":"array","items":{"$ref":"facetValue"}},"name":{"type":"string"}},"id":"facet"},"RelationshipMap":{"properties":{"sourceWordstring":{"type":"string"},"suggestions":{"type":"array","items":{"$ref":"suggestion"}}},"id":"relationshipMap"},"WordObject":{"properties":{"id":{"type":"long","required":true},"word":{"type":"string"},"vulgar":{"type":"string"}},"id":"wordObject"},"WordUGCStats":{"properties":{"listedInCount":{"type":"long"},"favoriteCount":{"type":"long"},"lookupCount":{"type":"long"},"commentCount":{"type":"long"},"tagCount":{"type":"long"}},"id":"wordUGCStats"},"ExampleSearchResults":{"properties":{"facets":{"type":"array","items":{"$ref":"facet"}},"examples":{"type":"array","items":{"$ref":"example"}}},"id":"exampleSearchResults"},"Example":{"properties":{"id":{"type":"long"},"exampleId":{"type":"long"},"title":{"type":"string"},"text":{"type":"string"},"score":{"type":"scoredWord"},"sentence":{"type":"sentence"},"word":{"type":"string"},"provider":{"type":"contentProvider"},"year":{"type":"integer"},"rating":{"type":"float"},"documentId":{"type":"long"},"url":{"type":"string"}},"id":"example"},"Header":{"properties":{"sourceDictionary":{"type":"string"},"homograph":{"type":"string"},"derivedFrom":{"type":"string"},"type":{"type":"type"},"attributionUrl":{"type":"string"},"attributionText":{"type":"string"},"syllables":{"type":"array","items":{"$ref":"syllable"}},"word":{"type":"string"},"etymologyXml":{"type":"string"},"notes":{"type":"array","items":{"$ref":"note"}},"textProns":{"type":"array","items":{"$ref":"textPron"}},"derivativeSense":{"type":"string"},"partOfSpeech":{"type":"string"}},"id":"header"},"BooleanValue":{"properties":{"value":{"type":"boolean"}},"id":"BooleanValue"},"Tag":{"properties":{"count":{"type":"long"},"name":{"type":"string"}},"id":"tag"},"AudioFile":{"properties":{"attributionUrl":{"type":"string"},"commentCount":{"type":"int"},"voteCount":{"type":"integer"},"fileUrl":{"type":"string"},"audioType":{"type":"string"},"id":{"type":"long","required":true},"duration":{"type":"double"},"attributionText":{"type":"string"},"createdBy":{"type":"string"},"description":{"type":"string"},"createdAt":{"type":"Date"},"voteWeightedAverage":{"type":"float"},"voteAverage":{"type":"float"},"word":{"type":"string"}},"id":"audioFile"},"ExampleSearchQuery":{"properties":{"limit":{"type":"int"},"returnFacets":{"type":"boolean"},"dateRange":{"type":"string"},"endDateInclusive":{"type":"boolean"},"subject":{"type":"string"},"endDate":{"type":"Date"},"contentType":{"type":"string"},"beginDate":{"type":"Date"},"skip":{"type":"int"},"medium":{"type":"string"},"beginDateInclusive":{"type":"boolean"},"wordType":{"type":"string"},"contentProvider":{"type":"string"},"year":{"type":"int"},"wordString":{"type":"string"},"filter":{"type":"string"},"partOfSpeech":{"type":"string"}},"id":"ExampleSearchQuery"},"Bigram":{"properties":{"count":{"type":"long"},"gram2":{"type":"string"},"gram1":{"type":"string"},"wlmi":{"type":"double"},"mi":{"type":"double"}},"id":"bigram"},"Frequency":{"properties":{"count":{"type":"long"},"year":{"type":"int"}},"id":"frequency"},"TextPron":{"properties":{"raw":{"type":"string"},"rawType":{"type":"string"}},"id":"textPron"},"Long":{"properties":{"value":{"type":"long"}},"id":"long"},"WordList":{"properties":{"updatedAt":{"type":"Date"},"id":{"type":"long","required":true},"username":{"type":"string"},"permalink":{"type":"string"},"lastActivityAt":{"type":"Date"},"createdAt":{"type":"Date"},"description":{"type":"string"},"userId":{"type":"long"},"name":{"type":"string"},"numberWordsInList":{"type":"long"},"type":{"type":"string"}},"id":"wordList"},"Entry":{"properties":{"sourceDictionary":{"type":"string"},"attributionText":{"type":"string"},"relatedWords":{"type":"array","items":{"$ref":"related"}},"word":{"type":"string"},"definitions":{"type":"array","items":{"$ref":"definition"}},"attributionUrl":{"type":"string"},"notes":{"type":"array","items":{"$ref":"note"}},"syllabified":{"type":"array","items":{"$ref":"syllable"}},"header":{"type":"header"}},"id":"entry"},"Comment":{"properties":{"id":{"type":"string"},"updatedAt":{"type":"Date"},"body":{"type":"string"},"approved":{"type":"boolean"},"disemvoweled":{"type":"boolean"},"commentedOn":{"type":"string"},"createdAt":{"type":"Date"},"commentedBy":{"type":"string"},"commentedById":{"type":"long"},"objectType":{"type":"string"}},"id":"comment"},"Suggestion":{"properties":{"type":{"type":"int"},"wordstring":{"type":"string"}},"id":"suggestion"},"DetailedWordUsage":{"properties":{"sentence":{"type":"sentence"},"wordstring":{"type":"string"},"metadata":{"type":"documentMetadata"}},"id":"detailedWordUsage"},"Note":{"properties":{"appliesTo":{"type":"array","items":{"type":"string"}},"value":{"type":"string"}},"id":"note"},"Related":{"properties":{"words":{"type":"array","items":{"type":"string"}}},"id":"related"},"FacetValue":{"properties":{"count":{"type":"long"},"value":{"type":"string"}},"id":"facetValue"},"Photo":{"properties":{"ownerLink":{"type":"string"},"linkUri":{"type":"string"},"size":{"type":"size"}},"id":"photo"},"ScoredWord":{"properties":{"position":{"type":"int"},"id":{"type":"long"},"docTermCount":{"type":"int"},"lemma":{"type":"string"},"wordType":{"type":"string"},"score":{"type":"float"},"sentenceId":{"type":"long"},"word":{"type":"string"},"stopword":{"type":"boolean"},"baseWordScore":{"type":"double"},"partOfSpeech":{"type":"string"}},"id":"scoredWord"},"Citation":{"properties":{"cite":{"type":"string"},"source":{"type":"string"}},"id":"citation"},"FrequencyStats":{"properties":{"author":{"type":"Map[long,long]"},"subject":{"type":"Map[integer,long]"},"contentProvider":{"type":"Map[integer,long]"},"contentType":{"type":"Map[integer,long]"},"corpusCount":{"type":"long"},"yearWise":{"type":"Map[integer,long]"},"medium":{"type":"Map[integer,long]"}},"id":"frequencyStats"},"Category":{"properties":{"id":{"type":"long","required":true},"name":{"type":"string"}},"id":"category"},"WordStats":{"properties":{"dictionaryStats":{"type":"Map[string,dictionaryWordStats]"},"documentsCount":{"type":"long"},"ugcStats":{"type":"wordUGCStats"},"sentencesCount":{"type":"long"},"frequencyStats":{"type":"frequencyStats"},"partOfSpeechStats":{"type":"Map[string,integer]"},"wordstring":{"type":"string"}},"id":"wordStats"},"Sizes":{"properties":{"size":{"type":"array","items":{"$ref":"size"}}},"id":"sizes"},"String":{"properties":{"name":{"type":"string"},"ordinal":{"type":"int"}},"id":"string"},"Root":{"properties":{"id":{"type":"long","required":true},"name":{"type":"string"},"categories":{"type":"array","items":{"$ref":"category"}}},"id":"root"},"Sentence":{"properties":{"hasScoredWords":{"type":"boolean"},"id":{"type":"long"},"scoredWords":{"type":"array","items":{"$ref":"scoredWord"}},"display":{"type":"string"},"rating":{"type":"int"},"documentMetadataId":{"type":"long"}},"id":"sentence"},"ContentProvider":{"properties":{"id":{"type":"int"},"name":{"type":"string"}},"id":"contentProvider"},"Label":{"properties":{"text":{"type":"string"}},"id":"Label"},"ExampleDataStore":{"properties":{"id":{"type":"int"},"name":{"type":"string"}},"id":"ExampleDataStore"},"PartOfSpeech":{"properties":{"roots":{"type":"array","items":{"$ref":"root"}},"storageAbbr":{"type":"array","items":{"type":"string"}},"allCategories":{"type":"array","items":{"$ref":"category"}}},"id":"partOfSpeech"},"Definition":{"properties":{"extendedText":{"type":"string"},"text":{"type":"string"},"sourceDictionary":{"type":"string"},"citations":{"type":"array","items":{"$ref":"citation"}},"labels":{"type":"array","items":{"$ref":"Label"}},"score":{"type":"float"},"exampleUses":{"type":"array","items":{"$ref":"ExampleUsage"}},"attributionUrl":{"type":"string"},"seqString":{"type":"string"},"attributionText":{"type":"string"},"relatedWords":{"type":"array","items":{"$ref":"related"}},"word":{"type":"string"},"notes":{"type":"array","items":{"$ref":"note"}},"textProns":{"type":"array","items":{"$ref":"textPron"}},"partOfSpeech":{"type":"string"}},"id":"definition"},"FrequencySummary":{"properties":{"unknownYearCount":{"type":"int"},"totalCount":{"type":"long"},"frequencyString":{"type":"string"},"word":{"type":"string"},"frequency":{"type":"array","items":{"$ref":"frequency"}}},"id":"frequencySummary"}}} \ No newline at end of file