Response schema

Success envelope and rule object schema for the Style guide API.

This API returns a consistent success envelope.

Success

The success response always has two top-level fields:

Field	Type	Notes
message	string	Human-readable result of the action.
result	array	Always an array of objects. Can contain: - multiple rules items - multiple collection items - be empty.

Rule item response example:

JSON

{
  "message": "Rule added.",
  "result": [
    {
      "state": true,
      "language": "en_US",
      "id": {
        "category": "STYLE_GUIDE",
        "collection": "style guide",
        "rule": "STYLE_5933619761905272220"
      },
      "patterns": ["webspellchecker"],
      "suggestions": ["WebSpellChecker"],
      "description": "The company name should be spelled in the mixed case.",
      "context_include": [],
      "context_exclude": []
    }
  ]
}

XML

<message>Rule added.</message>

<result>
  <rule>
    <state>true</state>
    <language>en_US</language>
    <id>
      <category>STYLE_GUIDE</category>
      <rule>STYLE_5933619761905272220</rule>
    </id>
    <patterns>
      <patterns>webspellchecker</patterns>
    </patterns>
    <suggestions>
      <suggestions>WebSpellChecker</suggestions>
    </suggestions>
    <description>The company name should be spelled in the mixed case.</description>
    <context_include/>
    <context_exclude/>
  </rule>
</result>

Collection item response example:

JSON

{
  "message": "Collection added.",
  "result": [
    {
      "language": "en_US",
      "collection": "My really-new collection",
      "category": "MY_REALLY-NEW_COLLECTION"
    }
  ]
}

Notes

• result is always an array.

• The array can contain: - one or more rule objects - one or more collection objects

Success messages

The message value depends on action.

Action	Message
addrule	Rule added.
editrule	Rule updated.
deleterule, deleterules	Rule(s) deleted.
getrules	Rules retrieved.
addcollection	Collection added.
deletecollection	Collection deleted.
editcollection	Collection updated.
getcollections	Collection(s) retrieved.

Rule object

language is the rule language scope.

It matches the request lang value (common, en, en_US, etc).

Fields

Field	Type (JSON)	Notes
id	object	Rule identifier.
id.category	string	Category name / namespace.
id.rule	string	Unique rule ID.
state	boolean	true means enabled.
language	string	Same scope as request lang (common, en, en_US, …).
patterns	array of strings	Patterns to match.
suggestions	array of strings	Replacement suggestions. Can be empty.
description	string	Optional explanatory message.
context_include	array of strings	Additional context required for match. Can be empty.
context_exclude	array of strings	Context that blocks a match. Can be empty.

Collection object

language is the collection language scope.

It matches the request lang value (common, en, en_US, etc).

Fields

Field	Type (JSON)	Notes
language	string	Same scope as request lang (common, en, en_US, …).
collection	string	Provided collection name with request parameter.
category	string	Category name / namespace created from collection value.

Errors

Errors use the standard HTTP API error format.

See HTTP API Overview.