{"endPoints":[{"path":"/users.{format}/pronunciations","description":"","operations":[{"parameters":[{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[audioObject]","errorResponses":[{"reason":"No data available","code":404}],"condition":"any"}],"category":"Users","summary":"Fetches recent AudioPron objects","suggestedName":"getRecentPronunciations","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/users","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"},{"parameters":[{"name":"signupIP","description":"Client IP address","required":false,"dataType":"string","paramType":"query"},{"name":"password","description":"Password","required":false,"dataType":"string","paramType":"query"},{"description":"User to create","required":false,"dataType":"user","paramType":"body"}],"response":[{"valueType":"user","errorResponses":[{"reason":"Invalid User or User parameters supplied.","code":400}],"condition":"any"}],"category":"Users","summary":"Creates a User","suggestedName":"createUser","deprecated":false,"open":false,"httpMethod":"POST"}]},{"path":"/users.{format}/id/{id}","description":"","operations":[{"parameters":[{"name":"id","description":"User ID to filter by","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"user","errorResponses":[{"reason":"User not found.","code":404}],"condition":"any"}],"category":"Users","summary":"Fetches a User by ID","suggestedName":"getUserById","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/users.{format}/facebook/{facebookId}","description":"","operations":[{"parameters":[{"name":"facebookId","description":"Facebook ID to filter by","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"user","errorResponses":[{"reason":"User not found.","code":404}],"condition":"any"}],"category":"Users","summary":"Fetches a User by Facebook ID","suggestedName":"getByFacebookId","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/users.{format}/favorites","description":"","operations":[{"parameters":[{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[wordObject]","errorResponses":[{"reason":"No data available","code":404}],"condition":"any"}],"category":"Users","summary":"Fetches recent Favorite Word objects.","suggestedName":"getRecentFavorites","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/users.{format}/comments","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[comment]","errorResponses":[{"reason":"No data available","code":404}],"condition":"any"}],"category":"Users","summary":"Fetches recent Comment objects","suggestedName":"getRecentComments","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/users.{format}/listedMostWords","description":"","operations":[{"parameters":[{"name":"dayInterval","description":"Interval in days to compute from","required":false,"dataType":"string","paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[UserSummary]","errorResponses":[{"reason":"No data available","code":404}],"condition":"any"}],"category":"Users","summary":"Fetches info on Users who listed most words","suggestedName":"getUsersWhoListedMostWords","deprecated":false,"open":false,"httpMethod":"GET"}]}],"models":[{"name":"wordObject","fields":[{"name":"word","required":false,"paramType":"string"},{"name":"vulgar","required":false,"paramType":"string"}]},{"name":"error","fields":[{"name":"reason","required":false,"paramType":"string"},{"name":"code","required":false,"paramType":"int"}]},{"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":"audioType","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":"audioType","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"id","required":false,"paramType":"int"}]},{"name":"audioObject","fields":[{"name":"id","required":false,"paramType":"long"},{"name":"type","required":false,"paramType":"audioType"},{"name":"description","required":false,"paramType":"string"},{"name":"duration","required":false,"paramType":"double"},{"name":"userId","required":false,"paramType":"long"},{"name":"wordstring","required":false,"paramType":"string"},{"name":"createdBy","required":false,"paramType":"string"},{"name":"createdAt","required":false,"paramType":"Date"},{"name":"wordId","required":false,"paramType":"long"},{"name":"filePath","required":false,"paramType":"string"},{"name":"recordId","required":false,"paramType":"string"},{"name":"audioFileType","required":false,"paramType":"audioType"},{"name":"audioFileId","required":false,"paramType":"long"},{"name":"streamPath","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":"UserSummary","fields":[{"name":"userId","required":false,"paramType":"long"},{"name":"userName","required":false,"paramType":"string"},{"name":"totalListedWordsCount","required":false,"paramType":"long"}]},{"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":"user","fields":[{"name":"id","description":"Unique idenitifier for a user","required":false,"paramType":"long"},{"name":"displayName","description":"Display name","required":false,"paramType":"string"},{"name":"status","description":"Account status","required":false,"allowableValues":"0,1,2,3","paramType":"int"},{"name":"password","required":false,"paramType":"string"},{"name":"userName","description":"User name","required":false,"paramType":"string"},{"name":"email","description":"Email address","required":false,"paramType":"string"},{"name":"faceBookId","description":"Facebook ID","required":false,"paramType":"string"}]}]}