{"resourcePath":"/wordList","apis":[{"path":"/wordList.{format}/{wordListId}","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to update","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"description":"Updated WordList","required":false,"dataType":"wordList","valueTypeInternal":"com.wordnik.community.entity.WordList","allowMultiple":false,"paramType":"body"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","allowMultiple":false,"paramType":"header"}],"summary":"Updates an existing WordList","httpMethod":"PUT","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"Not Authorized to update WordList","code":403},{"reason":"WordList not found","code":404}],"nickname":"updateWordList","responseClass":"ok"},{"parameters":[{"name":"wordListId","description":"ID of WordList to delete","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","allowMultiple":false,"paramType":"header"}],"summary":"Deletes an existing WordList","httpMethod":"DELETE","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"Not Authorized to delete WordList","code":403},{"reason":"WordList not found","code":404}],"nickname":"deleteWordList","responseClass":"ok"},{"parameters":[{"name":"wordListId","description":"ID of WordList to fetch","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","allowMultiple":false,"paramType":"header"}],"summary":"Fetches a WordList by ID","httpMethod":"GET","responseTypeInternal":"com.wordnik.community.entity.WordList","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"Not Authorized to access WordList","code":403},{"reason":"WordList not found","code":404}],"nickname":"getWordListById","responseClass":"wordList"}]},{"path":"/wordList.{format}/{wordListId}/words","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to user","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"username","description":"Username to add words on behalf of","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"description":"Array of words to add to WordList","required":false,"dataType":"Array[StringValue]","valueTypeInternal":"com.wordnik.resource.StringValue","allowMultiple":false,"paramType":"body"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","allowMultiple":false,"paramType":"header"}],"summary":"Adds words to a WordList","httpMethod":"POST","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"Not Authorized to access WordList","code":403},{"reason":"WordList not found","code":404}],"nickname":"addWordsToWordList","responseClass":"ok"},{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"sortBy","defaultValue":"createDate","description":"Field to sort by","required":false,"allowableValues":{"values":["createDate","alpha"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"sortOrder","defaultValue":"desc","description":"Direction to sort","required":false,"allowableValues":{"values":["asc","desc"],"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"},{"name":"populateWordActivity","description":"If set to false word activity info (comment count and number of word list where word is used) will not be populated. Defaut value is true","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","allowMultiple":false,"paramType":"header"}],"summary":"Fetches words in a WordList","httpMethod":"GET","responseTypeInternal":"com.wordnik.community.entity.ListedWord","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"Not Authorized to access WordList","code":403},{"reason":"WordList not found","code":404}],"nickname":"getWordListWords","responseClass":"List[wordListWord]"}]},{"path":"/wordList.{format}/{wordListId}/isFavorite","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to check","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"username","description":"Username to check for Favorite status","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Checks to see if a WordList has been favorited for a user","httpMethod":"GET","responseTypeInternal":"com.wordnik.system.model.BooleanValue","errorResponses":[{"reason":"Invalid ID supplied.","code":400},{"reason":"Not Authorized to favorite WordList.","code":403},{"reason":"WordList not found.","code":404}],"nickname":"isFavoriteWordList","responseClass":"BooleanValue"}]},{"path":"/wordList.{format}/{wordListId}/favorite","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to fetch","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"username","description":"Username to favorite on behalf of","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Favorites a WordList for a User","httpMethod":"POST","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid ID supplied.","code":400},{"reason":"Not Authorized to favorite WordList.","code":403},{"reason":"WordList not found.","code":404}],"nickname":"favoriteWordList","responseClass":"ok"},{"parameters":[{"name":"wordListId","description":"ID of WordList to fetch","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"username","description":"Username to unfavorite on behalf of","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Unfavorites a WordList for a User","httpMethod":"DELETE","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid ID supplied.","code":400},{"reason":"Not Authorized to favorite WordList.","code":403},{"reason":"WordList not found.","code":404}],"nickname":"unFavoriteWordList","responseClass":"ok"}]},{"path":"/wordList.{format}/{wordListId}/tags","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"username","description":"Username to get Tags for","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches Tags on a WordList","httpMethod":"GET","responseTypeInternal":"com.wordnik.community.entity.Tag","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"WordList not found.","code":404}],"nickname":"getWordListTags","responseClass":"List[tag]"}]},{"path":"/wordList.{format}/{wordListId}/tagCount","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"username","description":"Username to get Tags for","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches Tag count on a WordList","httpMethod":"GET","responseTypeInternal":"com.wordnik.system.model.LongResult","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"WordList not found.","code":404}],"nickname":"getWordListTagCount","responseClass":"long"}]},{"path":"/wordList.{format}/{wordListId}/tag","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"username","description":"Username to add Tags for","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"tags","description":"Tags to add","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Adds a Tag on a WordList","httpMethod":"POST","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"WordList not found.","code":404}],"nickname":"addWordListTag","responseClass":"ok"},{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"username","description":"Username to delete Tags for","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"tags","description":"Tags to delete","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Deletes a tag on a WordList","httpMethod":"DELETE","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"WordList not found.","code":404}],"nickname":"deleteWordListTag","responseClass":"ok"}]},{"path":"/wordList.{format}/{wordListId}/comments","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"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"},{"name":"sortOrder","description":"Direction to sort","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches comments on a WordList","httpMethod":"GET","responseTypeInternal":"com.wordnik.community.entity.Comment","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"WordList not found.","code":404}],"nickname":"getWordListComments","responseClass":"List[comment]"}]},{"path":"/wordList.{format}/{wordListId}/comment","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","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 on a WordList","httpMethod":"POST","responseTypeInternal":"com.wordnik.community.entity.Comment","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"Not Authorized to access WordList.","code":403},{"reason":"WordList not found.","code":404}],"nickname":"addCommentToWordList","responseClass":"comment"},{"parameters":[{"name":"wordListId","description":"ID of WordList to use","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 a Comment on a WordList","httpMethod":"PUT","responseTypeInternal":"com.wordnik.community.entity.Comment","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"Not Authorized to access WordList.","code":403},{"reason":"WordList not found.","code":404}],"nickname":"updateCommentOnWordList","responseClass":"comment"}]},{"path":"/wordList.{format}/{wordListId}/comment/{commentId}","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"commentId","description":"Comment ID to fetch","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Fetches a WordList comment by ID","httpMethod":"GET","responseTypeInternal":"com.wordnik.community.entity.Comment","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"WordList or Comment not found.","code":404}],"nickname":"getWordListCommentById","responseClass":"comment"},{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"commentId","description":"Comment ID to delete","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Deletes a WordList comment by ID","httpMethod":"DELETE","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"WordList or Comment not found.","code":404}],"nickname":"deleteWordListCommentById","responseClass":"ok"}]},{"path":"/wordList.{format}/{wordListId}/commentCount","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Fetches WordList Comment count","httpMethod":"GET","responseTypeInternal":"com.wordnik.system.model.LongResult","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"WordList not found.","code":404}],"nickname":"getWordListCommentCount","responseClass":"long"}]},{"path":"/wordList.{format}/{wordListId}/deleteWords","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"username","description":"Username to remove words on behalf of","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"description":"Words to remove from WordList","required":false,"dataType":"Array[StringValue]","valueTypeInternal":"com.wordnik.resource.StringValue","allowMultiple":false,"paramType":"body"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","allowMultiple":false,"paramType":"header"}],"summary":"Removes words from a WordList","httpMethod":"POST","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"Not Authorized to modify WordList","code":403},{"reason":"WordList not found","code":404}],"nickname":"deleteWordsFromWordList","responseClass":"ok"}]},{"path":"/wordList.{format}/{wordListId}/wordsCount","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","allowMultiple":false,"paramType":"header"}],"summary":"Gets a count of Words in a WordList","httpMethod":"GET","responseTypeInternal":"com.wordnik.system.model.LongResult","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"Not Authorized to access WordList","code":403},{"reason":"WordList not found","code":404}],"nickname":"getWordListWordsCount","responseClass":"long"}]}],"apiVersion":"4.0","swaggerVersion":"1.1-SNAPSHOT","basePath":"http://api.wordnik.com/v4","models":{"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"},"BooleanValue":{"properties":{"value":{"type":"boolean"}},"id":"BooleanValue"},"String":{"properties":{"name":{"type":"string"},"ordinal":{"type":"int"}},"id":"string"},"Tag":{"properties":{"count":{"type":"long"},"name":{"type":"string"}},"id":"tag"},"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"},"WordListWord":{"properties":{"id":{"type":"long","required":true},"username":{"type":"string"},"createdAt":{"type":"Date"},"numberCommentsOnWord":{"type":"long"},"userId":{"type":"long"},"word":{"type":"string"},"numberLists":{"type":"long"}},"id":"wordListWord"},"StringValue":{"properties":{"word":{"type":"string"}},"id":"StringValue"}}}