wordnik 4.06.01 → 4.06.02

data/api_docs/wordList.json

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

data/api_docs/wordLists.json

@@ -1 +1 @@
-{"endPoints":[{"path":"/wordLists.{format}/find/{searchString}","description":"","operations":[{"parameters":[{"name":"searchString","description":"Results to skip","required":false,"dataType":"string","paramType":"path"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[wordList]","errorResponses":[{"reason":"Not authenticated.","code":403}],"condition":"any"}],"category":"WordLists","summary":"Fetches WordList objects by name.","suggestedName":"findByName","deprecated":false,"open":false,"notes":"The term supplied is effectively given a wildcard before and after so 'cat' becomes '%cat%'","httpMethod":"GET"}]},{"path":"/wordLists.{format}","description":"","operations":[{"parameters":[{"description":"WordList to create","required":false,"dataType":"wordList","paramType":"body"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","paramType":"header"}],"response":[{"valueType":"wordList","errorResponses":[{"reason":"Invalid WordList supplied or mandatory fields are missing.","code":400},{"reason":"Not authenticated.","code":403},{"reason":"WordList owner not found.","code":404}],"condition":"any"}],"category":"WordLists","summary":"Creates a WordList.","suggestedName":"createWordList","deprecated":false,"open":false,"httpMethod":"POST"},{"response":[{"valueType":"doc","errorResponses":[{"reason":"No data available","code":404}],"condition":"any"}],"category":"Help","summary":"Returns information about API parameters","suggestedName":"getHelp","deprecated":false,"open":true,"httpMethod":"GET"}]},{"path":"/wordLists.{format}/mostCommentedOn","description":"","operations":[{"parameters":[{"name":"dayInterval","description":"Results to skip","required":false,"dataType":"string","paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[commentSummary]","errorResponses":[{"reason":"Not authenticated.","code":403}],"condition":"any"}],"category":"WordLists","summary":"Fetches a CommentSummary for WordList objects.","suggestedName":"findMostCommentedOn","deprecated":false,"open":false,"notes":"The CommentSummary is sorted by comment count, descending","httpMethod":"GET"}]},{"path":"/wordLists.{format}/recentLists","description":"","operations":[{"parameters":[{"name":"skip","description":"Results to skip","required":false,"dataType":"string","paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"},{"name":"type","description":"WordListType to filter by","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[wordList]","errorResponses":[{"reason":"Not authenticated.","code":403}],"condition":"any"}],"category":"WordLists","summary":"Fetches recently created WordList objects.","suggestedName":"findRecentLists","deprecated":false,"open":false,"httpMethod":"GET"}]}],"models":[{"name":"error","fields":[{"name":"reason","required":false,"paramType":"string"},{"name":"code","required":false,"paramType":"int"}]},{"name":"response","fields":[{"name":"valueType","required":false,"paramType":"string"},{"name":"errorResponses","required":false,"paramType":"List[error]"},{"name":"occurs","required":false,"paramType":"string"},{"name":"condition","required":false,"paramType":"string"}]},{"name":"parameter","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"defaultValue","required":false,"paramType":"string"},{"name":"description","required":false,"paramType":"string"},{"name":"required","required":false,"paramType":"boolean"},{"name":"dataType","required":false,"paramType":"string"},{"name":"allowableValues","required":false,"paramType":"string"},{"name":"wrapperName","required":false,"paramType":"string"},{"name":"internalDescription","required":false,"paramType":"string"},{"name":"paramAccess","required":false,"paramType":"string"},{"name":"paramType","required":false,"paramType":"string"}]},{"name":"wordList","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"id","required":false,"paramType":"long"},{"name":"type","required":false,"paramType":"string"},{"name":"description","required":false,"paramType":"string"},{"name":"userId","required":false,"paramType":"long"},{"name":"permalink","required":false,"paramType":"string"},{"name":"createdAt","required":false,"paramType":"Date"},{"name":"username","required":false,"paramType":"string"},{"name":"updatedAt","required":false,"paramType":"Date"},{"name":"numberWordsInList","required":false,"paramType":"long"}]},{"name":"doc","fields":[{"name":"endPoints","required":false,"paramType":"List[endpoint]"},{"name":"models","required":false,"paramType":"List[object]"}]},{"name":"commentSummary","fields":[{"name":"objectType","required":false,"paramType":"string"},{"name":"totalCount","required":false,"paramType":"long"},{"name":"objectName","required":false,"paramType":"string"},{"name":"countInInterval","required":false,"paramType":"long"},{"name":"intervalInMilliseconds","required":false,"paramType":"long"},{"name":"objectDisplayName","required":false,"paramType":"string"}]},{"name":"object","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"fields","required":false,"paramType":"List[parameter]"},{"name":"uniqueFieldName","required":false,"paramType":"string"}]},{"name":"endpoint","fields":[{"name":"path","required":false,"paramType":"string"},{"name":"description","required":false,"paramType":"string"},{"name":"operations","required":false,"paramType":"List[operation]"}]},{"name":"operation","fields":[{"name":"parameters","required":false,"paramType":"List[parameter]"},{"name":"response","required":false,"paramType":"List[response]"},{"name":"category","required":false,"paramType":"string"},{"name":"summary","required":false,"paramType":"string"},{"name":"suggestedName","required":false,"paramType":"string"},{"name":"deprecated","required":false,"paramType":"boolean"},{"name":"open","required":false,"paramType":"boolean"},{"name":"notes","required":false,"paramType":"string"},{"name":"httpMethod","required":false,"paramType":"string"}]}]}
+{"endPoints":[{"path":"/wordLists.{format}/find/{searchString}","description":"","operations":[{"parameters":[{"name":"searchString","description":"String to search for","required":false,"dataType":"string","paramType":"path"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[wordList]","errorResponses":[{"reason":"Not authenticated.","code":403}],"condition":"any"}],"category":"WordLists","summary":"Fetches WordList objects by name.","suggestedName":"findByName","deprecated":false,"open":false,"notes":"The term supplied is effectively given a wildcard before and after so 'cat' becomes '%cat%'","httpMethod":"GET"}]},{"path":"/wordLists.{format}","description":"","operations":[{"parameters":[{"description":"WordList to create","required":false,"dataType":"wordList","paramType":"body"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","paramType":"header"}],"response":[{"valueType":"wordList","errorResponses":[{"reason":"Invalid WordList supplied or mandatory fields are missing.","code":400},{"reason":"Not authenticated.","code":403},{"reason":"WordList owner not found.","code":404}],"condition":"any"}],"category":"WordLists","summary":"Creates a WordList.","suggestedName":"createWordList","deprecated":false,"open":false,"httpMethod":"POST"},{"response":[{"valueType":"doc","errorResponses":[{"reason":"No data available","code":404}],"condition":"any"}],"category":"Help","summary":"Returns information about API parameters","suggestedName":"getHelp","deprecated":false,"open":true,"httpMethod":"GET"}]},{"path":"/wordLists.{format}/mostCommentedOn","description":"","operations":[{"parameters":[{"name":"dayInterval","description":"Interval in days","required":false,"dataType":"string","paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[commentSummary]","errorResponses":[{"reason":"Not authenticated.","code":403}],"condition":"any"}],"category":"WordLists","summary":"Fetches a CommentSummary for WordList objects.","suggestedName":"findMostCommentedOn","deprecated":false,"open":false,"notes":"The CommentSummary is sorted by comment count, descending","httpMethod":"GET"}]},{"path":"/wordLists.{format}/containing/{word}","description":"","operations":[{"parameters":[{"name":"word","description":"Word to find lists for","required":false,"dataType":"string","paramType":"path"},{"name":"username","description":"Username to add words on behalf of","required":false,"dataType":"string","paramAccess":"internal","paramType":"query"}],"response":[{"valueType":"List[wordList]","errorResponses":[{"reason":"Invalid word or username supplied.","code":400},{"reason":"Not authenticated.","code":403}],"condition":"any"}],"category":"WordLists","summary":"Fetches WordList objects containing a word.","suggestedName":"findContainingWord","deprecated":false,"open":false,"notes":"Results are scoped to the supplied user.","httpMethod":"GET"}]},{"path":"/wordLists.{format}/recentLists","description":"","operations":[{"parameters":[{"name":"skip","description":"Results to skip","required":false,"dataType":"string","paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"},{"name":"type","description":"WordListType to filter by","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[wordList]","errorResponses":[{"reason":"Not authenticated.","code":403}],"condition":"any"}],"category":"WordLists","summary":"Fetches recently created WordList objects.","suggestedName":"findRecentLists","deprecated":false,"open":false,"httpMethod":"GET"}]}],"models":[{"name":"error","fields":[{"name":"reason","required":false,"paramType":"string"},{"name":"code","required":false,"paramType":"int"}]},{"name":"response","fields":[{"name":"valueType","required":false,"paramType":"string"},{"name":"errorResponses","required":false,"paramType":"List[error]"},{"name":"occurs","required":false,"paramType":"string"},{"name":"condition","required":false,"paramType":"string"}]},{"name":"parameter","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"defaultValue","required":false,"paramType":"string"},{"name":"description","required":false,"paramType":"string"},{"name":"required","required":false,"paramType":"boolean"},{"name":"dataType","required":false,"paramType":"string"},{"name":"allowableValues","required":false,"paramType":"string"},{"name":"wrapperName","required":false,"paramType":"string"},{"name":"internalDescription","required":false,"paramType":"string"},{"name":"paramAccess","required":false,"paramType":"string"},{"name":"paramType","required":false,"paramType":"string"}]},{"name":"wordList","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"id","required":false,"paramType":"long"},{"name":"type","required":false,"paramType":"string"},{"name":"description","required":false,"paramType":"string"},{"name":"userId","required":false,"paramType":"long"},{"name":"permalink","required":false,"paramType":"string"},{"name":"createdAt","required":false,"paramType":"Date"},{"name":"username","required":false,"paramType":"string"},{"name":"updatedAt","required":false,"paramType":"Date"},{"name":"numberWordsInList","required":false,"paramType":"long"}]},{"name":"doc","fields":[{"name":"endPoints","required":false,"paramType":"List[endpoint]"},{"name":"models","required":false,"paramType":"List[object]"}]},{"name":"commentSummary","fields":[{"name":"objectType","required":false,"paramType":"string"},{"name":"totalCount","required":false,"paramType":"long"},{"name":"objectName","required":false,"paramType":"string"},{"name":"countInInterval","required":false,"paramType":"long"},{"name":"intervalInMilliseconds","required":false,"paramType":"long"},{"name":"objectDisplayName","required":false,"paramType":"string"}]},{"name":"object","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"fields","required":false,"paramType":"List[parameter]"},{"name":"uniqueFieldName","required":false,"paramType":"string"}]},{"name":"endpoint","fields":[{"name":"path","required":false,"paramType":"string"},{"name":"description","required":false,"paramType":"string"},{"name":"operations","required":false,"paramType":"List[operation]"}]},{"name":"operation","fields":[{"name":"parameters","required":false,"paramType":"List[parameter]"},{"name":"response","required":false,"paramType":"List[response]"},{"name":"category","required":false,"paramType":"string"},{"name":"summary","required":false,"paramType":"string"},{"name":"suggestedName","required":false,"paramType":"string"},{"name":"deprecated","required":false,"paramType":"boolean"},{"name":"open","required":false,"paramType":"boolean"},{"name":"notes","required":false,"paramType":"string"},{"name":"httpMethod","required":false,"paramType":"string"}]}]}

data/api_docs/words.json

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

data/lib/wordnik/request.rb

@@ -96,6 +96,11 @@ module Wordnik
       end
       @body = value
     end
+    
+    def outgoing_body
+      return self.body if self.body.is_a? String
+      self.body.to_json
+    end
   
     # Iterate over all params,
     # .. removing the ones that are part of the path itself.
@@ -147,21 +152,21 @@ module Wordnik
       when :post
         Typhoeus::Request.post(
           self.url_with_query_string,
-          :body => self.body.to_json,
+          :body => self.outgoing_body,
           :headers => self.headers.stringify_keys
         )
 
       when :put
         Typhoeus::Request.put(
           self.url_with_query_string,
-          :body => self.body.to_json,
+          :body => self.outgoing_body,
           :headers => self.headers.stringify_keys
         )
       
       when :delete
         Typhoeus::Request.delete(
           self.url_with_query_string,
-          :body => self.body.to_json,
+          :body => self.outgoing_body,
           :headers => self.headers.stringify_keys
         )
       end