View Source

Command name: user_dictionary

Here is a list of all possible parameters and values that can be used with the user_dictionary command.

#	Parameter	Possible Values	Default value	Description
1	format	json xml	json	The response format for output data.
2	callback	callback function name		A callback function name that will be used to manipulate the JSON data received from the server. Such an approach enables sharing of data bypassing same-origin policy. It can be used only along with “format=json”.
3	action	create – Create a new user dictionary. rename – Rename an existing user dictionary. delete – Delete an existing user dictionary. addwords – Add new words to a specified user dictionary. deletewords – Remove words from a specified user dictionary. editword – Edit a word in a specified user dictionary. check – Check if a specified user dictionary exists on the server. getdict – Get content from a specified user dictionary (for JSON only).		An action that can be used to manipulate a user dictionary.

Here is a list of all possible parameters and values that can be used with the user_dictionary action parameter.

#	Action parameter	Parameters	Possible values	Description
1	create	name	name of a new user dictionary	Create a new user dictionary.
1	create	wordlist	comma-separated words which will be added to a new dictionary	Create a new user dictionary.
2	delete	name	name of a selected user dictionary	Delete a selected user dictionary.
3	rename	name	name of a selected user dictionary	Rename a specified dictionary and sets a new name.
3	rename	new_name	a new name for a chosen user dictionary	Rename a specified dictionary and sets a new name.
4	check	name	name of a chosen user dictionary	Check if a specified user dictionary exists on the server.
5	getdict	name	name of a required user dictionary	Request content of a specified user dictionary. The getdict action is available only for the JSON format.
6	addwords	name	name of a chosen user dictionary	Add new words to a specified user dictionary.
6		word	a new word which will be added to a specified user dictionary	Add new words to a specified user dictionary.
		wordlist	a list of coma-separated words (also possible to add just one word)
7	deletewords	name	name of a chosen user dictionary	Remove words from a specified user dictionary.
7		word	word which will be removed from a specified user dictionary	Remove words from a specified user dictionary.
		wordlist	a list of coma-separated words (also possible to remove just one word)
8	editword	name	name of a chosen user dictionary	Replace a word in a specified user dictionary with a new one.
		word	word which will be edited
		new_word	a new word which replaces a word picked for editing

Example 1 [GET]: Create user dictionary (Output in XML)

https://svc.webspellchecker.net/api?cmd=user_dictionary&format=xml&action=create&name=user_dictionary&wordlist=SCAYT,SpellCheckAsYouType,WSC,WebSpellChecker,WProofreader&customerid=[your-service-id]

Parameters:

Command: user_dictionary
Action: create
Name: user_dictionary
Wordlist: SCAYT, SpellCheckAsYouType, WSC, WebSpellChecker, WProofreader
Format: XML

Request response:

<user_dictionary>
	<name>user_dictionary</name>
	<action>create</action>
	<wordlist>
		<word>SCAYT</word>
		<word>SpellCheckAsYouType</word>
		<word>WSC</word>
		<word>WebSpellChecker</word>
		<word>WProofreader</word>
	</wordlist>
	<modificationTime>1571762101</modificationTime>
</user_dictionary>

Example 2 [GET]: Get user dictionary content (Output in JSON)

https://svc.webspellchecker.net/api?cmd=user_dictionary&format=json&action=getdict&name=user_dictionary&customerid=[your-service-id]

Parameters:

Command: user_dictionary
Action: getdict
Name: user_dictionary
Format: json

Request response:

{
    "name": "user_dictionary",
    "action": "getdict",
    "wordlist": [
        "SCAYT",
        "SpellCheckAsYouType",
        "WSC",
        "WebSpellChecker",
        "WProofreader"
    ],
    "modificationTime": 1571762101
}

The GET request size is 2048 symbols.

Example 3 [POST]: Get user dictionary content (Output in JSON)

Using the same request and parameters as described in example 4.2 but form it as a POST request.

https://svc.webspellchecker.net/api?

cmd=user_dictionary&format=json&action=getdict&name=user_dictionary&customerid=[your-service-id]

Request response:

{
    "name": "user_dictionary",
    "action": "getdict",
    "wordlist": [
        "SCAYT",
        "SpellCheckAsYouType",
        "WSC",
        "WebSpellChecker",
        "WProofreader"
    ],
    "modificationTime": 1571762101
}