| Resource | Method | Description |
|---|---|---|
| http://www.example.com/api/v1/dictionaries | Getting list of available dictionaries in JSON. Getting list of available dictionaries in XML. | |
| http://www.example.com/api/v1/dictionaries/{dictCode} | Getting single dictionary information in JSON. Getting single dictionary information in XML. | |
| http://www.example.com/api/v1/dictionaries/{dictCode}/entries | Unused Unused | |
| http://www.example.com/api/v1/dictionaries/{dictCode}/entries/{entryId} | Getting entry information with content in specified format in JSON. Getting entry information with content in specified format in XML. | |
| http://www.example.com/api/v1/dictionaries/{dictCode}/entries/{entryId}/relatedentries | Getting all linked entries in same or other dictionaries in XML. Getting all linked entries in same or other dictionaries in JSON. | |
| http://www.example.com/api/v1/dictionaries/{dictCode}/entries/{entryId}/nearbyentries | Getting preceding and following entries of current entry in same dictionary in JSON. Getting preceding and following entries of current entry in same dictionary in XML. | |
| http://www.example.com/api/v1/dictionaries/{dictCode}/entries/{entryId}/pronunciations | Getting all pronunciations of the selected entry in JSON. Getting all pronunciations of the selected entry in XML. | |
| http://www.example.com/api/v1/dictionaries/{dictCode}/autocomplete | ||
| http://www.example.com/api/v1/dictionaries/{dictCode}/search | Getting first page of results in JSON. Getting first page of results in XML. | |
| http://www.example.com/api/v1/dictionaries/{dictCode}/search/first | Getting first matching result in JSON. Getting first matching result in XML. | |
| http://www.example.com/api/v1/dictionaries/{dictCode}/search/didyoumean | Getting all suggestions for the given word in JSON Getting all suggestions for the given word in XML | |
| http://www.example.com/api/v1/dictionaries/{dictCode}/topics | Getting all topics in JSON Getting all topics in XML | |
| http://www.example.com/api/v1/dictionaries/{dictCode}/topics/{thesaurusName} | Unused Unused | |
| http://www.example.com/api/v1/dictionaries/{dictCode}/topics/{thesaurusName}/{topicId} | Getting topic information with subtopic and linked entries in JSON. Getting topic information with subtopic and linked entries in XML. | |
| http://www.example.com/api/v1/dictionaries/{dictCode}/wordoftheday | Getting full entry for Word of the day in JSON. Getting full entry for Word of the day in XML. | |
| http://www.example.com/api/v1/dictionaries/{dictCode}/wordoftheday/preview | Getting short version for the Word of the day in JSON. Getting short version for the Word of the day in XML. | |
| http://www.example.com/api/v1/quizzes | Get Quizzes configuration. | |
| http://www.example.com/api/v1/quizzes/composite | Return a {@link org.json.JSONArray} containing {@link org.json.JSONObject} representing a {@link RestCompositeQuiz}. | |
| http://www.example.com/api/v1/quizzes/image | Get all quiz entry ids. | |
| http://www.example.com/api/v1/quizzes/image/categories | Get the image quizzes categories. | |
| http://www.example.com/api/v1/quizzes/image/categories/{categoryId} | Get the category resource. | |
| http://www.example.com/api/v1/quizzes/image/categories/{categoryId}/{level} | Get the category level info. | |
| http://www.example.com/api/v1/quizzes/image/categories/{categoryId}/{level}/{quizEntryId} | ||
| http://www.example.com/api/v1/quizzes/grammar | Get all grammar quiz entry ids. | |
| http://www.example.com/api/v1/quizzes/grammar/{entryId} | ||
| http://www.example.com/api/v1/quizzes/search | Search quizzes (only in categories) | |
| http://www.example.com/api/v1/documentation/html | REST API documentation in HTML format. | |
| http://www.example.com/api/v1/documentation/wadl | REST API documentation in XML format. | |
| http://www.example.com/api/v1/key/callLimit | Getting call limt informations for current used key in JSON. Getting call limt informations for current used key in XML. | |
| http://www.example.com/api/v1/wordoftheday | Getting full entry for Word of the day in JSON. Getting full entry for Word of the day in XML. | |
| http://www.example.com/api/v1/wordoftheday/preview | Getting short version for the Word of the day in JSON. Getting short version for the Word of the day in XML. |
| GET | httpGet() |
Getting entry information with content in specified format in JSON.
| dictCode | string | dictionary code find in dictionaries list |
| entryId | string | entry id can be retrieve in search result, topics entries or word of the day preview |
| format | string | can be "html" or "xml" (defaults is "html"). |
| application/json; qs=1 |
| GET | httpGetXml() |
Getting entry information with content in specified format in XML.
| dictCode | string | dictionary code find in dictionaries list |
| entryId | string | entry id can be retrieve in search result, topics entries or word of the day preview |
| format | string | can be "html" or "xml" (defaults is "html"). |
| application/xml; qs=.5 |
| GET | httpGetNearbyEntries() |
Getting preceding and following entries of current entry in same dictionary in JSON.
| dictCode | string | dictionary code find in dictionaries list |
| entryId | string | entry id can be retrieve in search result, topics entries or word of the day preview |
| entrynumber | int | the number of results preceding/following the given entry [optional, 10 by default, maximum allowed 50] |
| application/json; qs=1 |
| GET | httpGetNearbyEntriesXml() |
Getting preceding and following entries of current entry in same dictionary in XML.
| dictCode | string | dictionary code find in dictionaries list |
| entryId | string | entry id can be retrieve in search result, topics entries or word of the day preview |
| entrynumber | int | the number of results preceding/following the given entry [optional, 10 by default, maximum allowed 50] |
| application/xml; qs=.5 |
| GET | httpGetPronunciations() |
Getting all pronunciations of the selected entry in JSON.
| dictCode | string | dictionary code find in dictionaries list |
| entryId | string | entry id can be retrieve in search result, topics entries or word of the day preview |
| lang | string | filter pronunciations list by language |
| format | string | specified pronunciations file format. can be "mp3" or "ogg" (defaults is "mp3"). |
| application/json; qs=1 |
| GET | httpGetPronunciationsXml() |
Getting all pronunciations of the selected entry in XML.
| dictCode | string | dictionary code find in dictionaries list |
| entryId | string | entry id can be retrieve in search result, topics entries or word of the day preview |
| lang | string | filter pronunciations list by language |
| format | string | specified pronunciations file format. can be "mp3" or "ogg" (defaults is "mp3"). |
| application/xml; qs=.5 |
| GET | httpGet() |
Getting first page of results in JSON.
| dictCode | string | dictionary code find in dictionaries list |
| q | string | Search terms |
| pagesize | int | the number of results per page to return |
| pageindex | int | the index of result page to return |
| application/json; qs=1 |
| GET | httpGetXml() |
Getting first page of results in XML.
| dictCode | string | dictionary code find in dictionaries list |
| q | string | Search terms |
| pagesize | int | the number of results per page to return |
| pageindex | int | the index of result page to return |
| application/xml; qs=.5 |
| GET | httpGetSpelling() |
Getting all suggestions for the given word in JSON
| dictCode | string | dictionary code find in dictionaries list |
| q | string | the word we are searching for |
| entrynumber | int | the number of Did you Mean results [optional, 10 by default, maximum allowed 10] |
| application/json; qs=1 |
| GET | httpGetSpellingXml() |
Getting all suggestions for the given word in XML
| dictCode | string | dictionary code find in dictionaries list |
| q | string | the word we are searching for |
| entrynumber | int | the number of Did you Mean results [optional, 10 by default, maximum allowed 10] |
| application/xml; qs=.5 |
| GET | httpGet() |
Getting topic information with subtopic and linked entries in JSON.
| dictCode | string | dictionary code find in dictionaries list |
| thesaurusName | string | the thesaurus name of the topic |
| topicId | string | the id of the topic |
| application/json; qs=1 |
| GET | httpGetXml() |
Getting topic information with subtopic and linked entries in XML.
| dictCode | string | dictionary code find in dictionaries list |
| thesaurusName | string | the thesaurus name of the topic |
| topicId | string | the id of the topic |
| application/xml; qs=.5 |
| GET | httpGet() |
Getting full entry for Word of the day in JSON.
| dictCode | string | dictionary code find in dictionaries list |
| day | string | date representation in ISO 8601 format date (YYYY-MM-DD, optional) |
| format | string | can be "html" or "xml" (optional) (defaults is "html") |
| application/json; qs=1 |
| GET | httpGetXml() |
Getting full entry for Word of the day in XML.
| dictCode | string | dictionary code find in dictionaries list |
| day | string | date representation in ISO 8601 format date (YYYY-MM-DD, optional) |
| format | string | can be "html" or "xml" (optional) (defaults is "html") |
| application/xml; qs=.5 |
| GET | httpGetPreview() |
Getting short version for the Word of the day in JSON.
| dictCode | string | dictionary code find in dictionaries list |
| day | string | date representation in ISO 8601 format date (YYYY-MM-DD, optional) |
| application/json; qs=1 |
| GET | httpGetPreviewXml() |
Getting short version for the Word of the day in XML.
| dictCode | string | dictionary code find in dictionaries list |
| day | string | date representation in ISO 8601 format date (YYYY-MM-DD, optional) |
| application/xml; qs=.5 |
Quizzes resource.
| GET | httpGet() |
Get Quizzes configuration.
| application/json; qs=1 |
Composite quizzes resource.
| GET | httpGet() |
Return a {@link org.json.JSONArray} containing {@link org.json.JSONObject} representing a {@link RestCompositeQuiz}.
| application/json; qs=1 |
| GET | httpGet() |
Get all quiz entry ids.
| application/json; qs=1 |
Quiz categories resource (without grammar quizzes)
| GET | httpGet() |
Get the image quizzes categories.
| application/json; qs=1 |
Quiz category level resource.
A Quiz entry resource.
Grammar quizzes resource.
| GET | httpGet() |
Get all grammar quiz entry ids.
| application/json; qs=1 |
| GET | httpGetHtmlDoc() |
REST API documentation in HTML format.
| text/html |
| GET | httpGetXmlDoc() |
REST API documentation in XML format.
| text/xml |
| GET | httpGetCallLimit() |
Getting call limt informations for current used key in JSON.
| application/json; qs=1 |
| GET | httpGetCallLimitXml() |
Getting call limt informations for current used key in XML.
| application/xml; qs=.5 |