Add collection (addcollection)

Create a new style guide collection.

Request

Use the shared HTTP API endpoint and request formats.

See HTTP API Overview.

Parameters

Parameter	Type	Required	Default	Notes
cmd	string	Yes	style_guide	Command name.
action	string	Yes	addcollection	Action name.
collection	string	Yes		The name of the collection to be created.
lang	string	No	common	Language scope to create the collection in (example: en_US or en).

Behavior

• Creates a new collection in the target lang scope.

• Returns the created collection info in result.

Response

Single result object containing created collection with it's category and lang .

See Response schema.

Errors

See

• Errors.

• Validation & limits

Examples

Example (JSON body)

Request URL (on-premises)

http(s)://server_entry_point/?cmd=style_guide&access_key=<your-access-key>&action=addcollection&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=addcollection&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=addcollection' \
  --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=addcollection' \
  --data-urlencode 'lang=en_US' \
  --data-urlencode 'collection=A test-collection'

---

Response

{
    "message": "Collection added.",
    "collection_limit": 250,
    "collection_usage": 1,
    "result": [
        {
            "language": "en_US",
            "collection": "A test-collection",
            "category": "A_TEST-COLLECTION"
        }
    ]
}

Example (XML body)

Request URL (on-premises)

http(s)://server_entry_point/?cmd=style_guide&access_key=<your-access-key>&action=addcollection&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=addcollection&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=addcollection' \
  --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=addcollection' \
  --data-urlencode 'lang=en_US' \
  --data-urlencode 'collection=A test-collection' \
  --data-urlencode 'format=xml'

---

Response

<message>Collection added.</message>
<collection_limit>250</collection_limit>
<collection_usage>1</collection_usage>

<result>
	<category>
		<language>en_US</language>
		<collection>A test-collection</collection>
		<category>A_TEST-COLLECTION</category>
	</category>
</result>