Get rules (getrules)

List style guide rules, optionally filtered by rule ID.

List style guide rules.

Request

See HTTP API Overview.

Parameters

Parameter	Type	Required	Default	Notes
cmd	string	Yes	style_guide	Command name.
action	string	Yes	getrules	Action name.
collection	string	Yes		A name of the collection in which rules are stored.
lang	string	No		Language scope to list rules for (example: en_US or en). By default returns all rules from every language.
rule	string	No		One rule ID, or a comma-separated list of rule IDs. Filter is applied within the selected lang.

Behavior

• Without lang: lists of all the rules under client id.

• Without rule: returns all rules for the selected lang, grouped by style guide.

• With collection: returns all rules for selected collection

• With rule: returns only the matching rule(s) for the selected lang.

Response

Multiple rule objects are returned.

See Response schema.

Errors

See

• Errors.

• Validation & limits

Examples

1) Get all the rules:

Example (JSON body)

Request URL (on-premises)

http(s)://server_entry_point/?cmd=style_guide&access_key=<your-access-key>&action=getrules

Request URL (Cloud)

https://svc.webspellchecker.net/api?cmd=style_guide&access_key=<your-access-key>&serviceid=<your-service-id>&action=getrules

Request CURL (on-premises)

curl -G "http(s)://server_entry_point" \
  --data-urlencode 'cmd=style_guide' \
  --data-urlencode 'access_key=<your-access-key>' \
  --data-urlencode 'action=getrules'

Request CURL (Cloud)

curl -G "https://svc.webspellchecker.net/api" \
  --data-urlencode 'cmd=style_guide' \
  --data-urlencode 'access_key=<your-access-key>' \
  --data-urlencode 'serviceid=<your-service-id>' \
  --data-urlencode 'action=getrules'

---

Response

{
    "message": "Rules retrieved.",
    "result": [
        {
            "state": true,
            "language": "",
            "id": {
                "category": "STYLE_GUIDE",
                "collection": "style guide",
                "rule": "STYLE_16591413123912100174"
            },
            "patterns": [
                "testtexttobereplaced"
            ],
            "suggestions": [
                "TestTextToBeReplaced"
            ],
            "description": "example",
            "context_include": [],
            "context_exclude": []
        },
        {
            "state": true,
            "language": "en_US",
            "id": {
                "category": "STYLE_GUIDE",
                "collection": "style guide",
                "rule": "STYLE_5933619761905272220"
            },
            "patterns": [
                "webspellchecker"
            ],
            "suggestions": [
                "WebSpellChecker"
            ],
            "description": "",
            "context_include": [],
            "context_exclude": []
        }
    ]
}

Example (XML body)

Request URL (on-premises)

http(s)://server_entry_point/?cmd=style_guide&access_key=<your-access-key>&action=getrules&format=xml

Request URL (Cloud)

https://svc.webspellchecker.net/api?cmd=style_guide&access_key=<your-access-key>&serviceid=<your-service-id>&action=getrules&format=xml

Request CURL (on-premises)

curl -G "http(s)://server_entry_point" \
  --data-urlencode 'cmd=style_guide' \
  --data-urlencode 'access_key=<your-access-key>' \
  --data-urlencode 'action=getrules' \
  --data-urlencode 'format=xml'

Request CURL (Cloud)

curl -G "https://svc.webspellchecker.net/api" \
  --data-urlencode 'cmd=style_guide' \
  --data-urlencode 'access_key=<your-access-key>' \
  --data-urlencode 'serviceid=<your-service-id>' \
  --data-urlencode 'action=getrules' \
  --data-urlencode 'format=xml'

---

Response

<message>Rules retrieved.</message>

<result>
	<rule>
		<state>true</state>
		<language/>
		<id>
			<category>STYLE_GUIDE</category>
			<collection>style guide</collection>
			<rule>STYLE_16591413123912100174</rule>
		</id>
		<patterns>
			<patterns>testtexttobereplaced</patterns>
		</patterns>
		<suggestions>
			<suggestions>TestTextToBeReplaced</suggestions>
		</suggestions>
		<description>example</description>
		<context_include/>
		<context_exclude/>
	</rule>
	<rule>
		<state>true</state>
		<language>en_US</language>
		<id>
			<category>STYLE_GUIDE</category>
			<collection>style guide</collection>
			<rule>STYLE_5933619761905272220</rule>
		</id>
		<patterns>
			<patterns>webspellchecker</patterns>
		</patterns>
		<suggestions>
			<suggestions>WebSpellChecker</suggestions>
		</suggestions>
		<description/>
		<context_include/>
		<context_exclude/>
	</rule>
</result>

2) Get all the rules of a specific collection:

Example (JSON body)

Request URL (on-premises)

http(s)://server_entry_point/?cmd=style_guide&access_key=<your-access-key>&action=getrules&lang=en_US&collection=A test-collection

Request URL (Cloud)

https://svc.webspellchecker.net/api?cmd=style_guide&access_key=<your-access-key>&serviceid=<your-service-id>&action=getrules&lang=en_US&collection=A test-collection

Request CURL (on-premises)

curl -G "http(s)://server_entry_point" \
  --data-urlencode 'cmd=style_guide' \
  --data-urlencode 'access_key=<your-access-key>' \
  --data-urlencode 'action=getrules' \
  --data-urlencode 'lang=en_US' \
  --data-urlencode 'collection=A test-collection'

Request CURL (Cloud)

curl -G "https://svc.webspellchecker.net/api" \
  --data-urlencode 'cmd=style_guide' \
  --data-urlencode 'access_key=<your-access-key>' \
  --data-urlencode 'serviceid=<your-service-id>' \
  --data-urlencode 'action=getrules' \
  --data-urlencode 'lang=en_US' \
  --data-urlencode 'collection=A test-collection'

---

Response

{
    "message": "Rules retrieved.",
    "result": [
        {
            "state": true,
            "language": "en_US",
            "id": {
                "category": "A_TEST-COLLECTION",
                "collection": "A test-collection",
                "rule": "A_5933619761905272220"
            },
            "patterns": [
                "webspellchecker"
            ],
            "suggestions": [
                "WebSpellChecker"
            ],
            "description": "",
            "context_include": [],
            "context_exclude": []
        },
        {
            "state": true,
            "language": "en_US",
            "id": {
                "category": "A_TEST-COLLECTION",
                "collection": "A test-collection",
                "rule": "A_6313242940900407355"
            },
            "patterns": [
                "replacethis"
            ],
            "suggestions": [
                "replace this"
            ],
            "description": "",
            "context_include": [],
            "context_exclude": []
        }
    ]
}

Example (XML body)

Request URL (on-premises)

http(s)://server_entry_point/?cmd=style_guide&access_key=<your-access-key>&action=getrules&lang=en_US&collection=A test-collection&format=xml

Request URL (Cloud)

https://svc.webspellchecker.net/api?cmd=style_guide&access_key=<your-access-key>&serviceid=<your-service-id>&action=getrules&lang=en_US&collection=A test-collection&format=xml

Request CURL (on-premises)

curl -G "http(s)://server_entry_point" \
  --data-urlencode 'cmd=style_guide' \
  --data-urlencode 'access_key=<your-access-key>' \
  --data-urlencode 'action=getrules' \
  --data-urlencode 'lang=en_US' \
  --data-urlencode 'collection=A test-collection' \
  --data-urlencode 'format=xml'

Request CURL (Cloud)

curl -G "https://svc.webspellchecker.net/api" \
  --data-urlencode 'cmd=style_guide' \
  --data-urlencode 'access_key=<your-access-key>' \
  --data-urlencode 'serviceid=<your-service-id>' \
  --data-urlencode 'action=getrules' \
  --data-urlencode 'lang=en_US' \
  --data-urlencode 'collection=A test-collection' \
  --data-urlencode 'format=xml'

---

Response

<message>Rules retrieved.</message>

<result>
	<rule>
		<state>true</state>
		<language>en_US</language>
		<id>
			<category>A_TEST-COLLECTION</category>
			<collection>A test-collection</collection>
			<rule>A_5933619761905272220</rule>
		</id>
		<patterns>
			<patterns>webspellchecker</patterns>
		</patterns>
		<suggestions>
			<suggestions>WebSpellChecker</suggestions>
		</suggestions>
		<description/>
		<context_include/>
		<context_exclude/>
	</rule>
	<rule>
		<state>true</state>
		<language>en_US</language>
		<id>
			<category>A_TEST-COLLECTION</category>
			<collection>A test-collection</collection>
			<rule>A_6313242940900407355</rule>
		</id>
		<patterns>
			<patterns>replacethis</patterns>
		</patterns>
		<suggestions>
			<suggestions>replace this</suggestions>
		</suggestions>
		<description/>
		<context_include/>
		<context_exclude/>
	</rule>
</result>

3) Get a specific rule:

Example (JSON body)

Request URL (on-premises)

http(s)://server_entry_point/?cmd=style_guide&access_key=<your-access-key>&action=getrules&rule=STYLE_16591413123912100174

Request URL (Cloud)

https://svc.webspellchecker.net/api?cmd=style_guide&access_key=<your-access-key>&serviceid=<your-service-id>&action=getrules&rule=STYLE_16591413123912100174

Request CURL (on-premises)

curl -G "http(s)://server_entry_point" \
  --data-urlencode 'cmd=style_guide' \
  --data-urlencode 'access_key=<your-access-key>' \
  --data-urlencode 'action=getrules' \
  --data-urlencode 'rule=STYLE_16591413123912100174'

Request CURL (Cloud)

curl -G "https://svc.webspellchecker.net/api" \
  --data-urlencode 'cmd=style_guide' \
  --data-urlencode 'access_key=<your-access-key>' \
  --data-urlencode 'serviceid=<your-service-id>' \
  --data-urlencode 'action=getrules' \
  --data-urlencode 'rule=STYLE_16591413123912100174'

---

Response

{
    "message": "Rules retrieved.",
    "result": [
        {
            "state": true,
            "language": "",
            "id": {
                "category": "STYLE_GUIDE",
                "collection": "style guide",
                "rule": "STYLE_16591413123912100174"
            },
            "patterns": [
                "testtexttobereplaced"
            ],
            "suggestions": [
                "TestTextToBeReplaced"
            ],
            "description": "example",
            "context_include": [],
            "context_exclude": []
        }
    ]
}

Example (XML body)

Request URL (on-premises)

http(s)://server_entry_point/?cmd=style_guide&access_key=<your-access-key>&action=getrules&rule=STYLE_16591413123912100174&format=xml

Request URL (Cloud)

https://svc.webspellchecker.net/api?cmd=style_guide&access_key=<your-access-key>&serviceid=<your-service-id>&action=getrules&rule=STYLE_16591413123912100174&format=xml

Request CURL (on-premises)

curl -G "http(s)://server_entry_point" \
  --data-urlencode 'cmd=style_guide' \
  --data-urlencode 'access_key=<your-access-key>' \
  --data-urlencode 'action=getrules' \
  --data-urlencode 'rule=STYLE_16591413123912100174' \
  --data-urlencode 'format=xml'

Request CURL (Cloud)

curl -G "https://svc.webspellchecker.net/api" \
  --data-urlencode 'cmd=style_guide' \
  --data-urlencode 'access_key=<your-access-key>' \
  --data-urlencode 'serviceid=<your-service-id>' \
  --data-urlencode 'action=getrules' \
  --data-urlencode 'rule=STYLE_16591413123912100174' \
  --data-urlencode 'format=xml'

---

Response

<message>Rules retrieved.</message>

<result>
	<rule>
		<state>true</state>
		<language/>
		<id>
			<category>STYLE_GUIDE</category>
			<collection>style guide</collection>
			<rule>STYLE_16591413123912100174</rule>
		</id>
		<patterns>
			<patterns>testtexttobereplaced</patterns>
		</patterns>
		<suggestions>
			<suggestions>TestTextToBeReplaced</suggestions>
		</suggestions>
		<description>example</description>
		<context_include/>
		<context_exclude/>
	</rule>
</result>