{"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":"Array of 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]"}]}]}