Get collections (getcollections)

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	getcollections	Action name.
collection	string	No		The name of the collection to be retrieved.
lang	string	No	common	Language scope to get the collections in (example: en_US or en).

Behavior

• Retrives a list of collections in the target lang scope.

• Returns the retrieved collections info in result.

Response

Single result object containing retrieved collection(s) with it's category and lang .

See Response schema.

Errors

See

• Errors.

• Validation & limits

Examples

1) Get all the collections

Example (JSON body)

Request URL (on-premises)

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

Request URL (Cloud)

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

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=getcollections'

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=getcollections'

---

Response

{
    "message": "Collection(s) retrieved.",
    "collection_limit": 250,
    "collection_usage": 4,
    "result": [
        {
            "language": "",
            "collection": "A common collection",
            "category": "A_COMMON_COLLECTION"
        },
        {
            "language": "",
            "collection": "style guide",
            "category": "STYLE_GUIDE"
        },
        {
            "language": "en_US",
            "collection": "A test-collection",
            "category": "A_TEST-COLLECTION"
        },
        {
            "language": "en_US",
            "collection": "style guide",
            "category": "STYLE_GUIDE"
        }
    ]
}

Example (XML body)

Request URL (on-premises)

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

Request URL (Cloud)

https://svc.webspellchecker.net/api?cmd=style_guide&access_key=<your-access-key>&serviceid=<your-service-id>&action=getcollections&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=getcollections' \
  --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=getcollections' \
  --data-urlencode 'format=xml'

---

Response

<collection_limit>250</collection_limit>
<collection_usage>4</collection_usage>

<result>
	<category>
		<language/>
		<collection>A common collection</collection>
		<category>A_COMMON_COLLECTION</category>
	</category>
	<category>
		<language/>
		<collection>style guide</collection>
		<category>STYLE_GUIDE</category>
	</category>
	<category>
		<language>en_US</language>
		<collection>A test-collection</collection>
		<category>A_TEST-COLLECTION</category>
	</category>
	<category>
		<language>en_US</language>
		<collection>style guide</collection>
		<category>STYLE_GUIDE</category>
	</category>
</result>

2) Get all the collections for a specific language

Example (JSON body)

Request URL (on-premises)

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

Request URL (Cloud)

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

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=getcollections' \
  --data-urlencode 'lang=en_US'

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=getcollections' \
  --data-urlencode 'lang=en_US'

---

Response

{
    "message": "Collection(s) retrieved.",
    "collection_limit": 250,
    "collection_usage": 4,
    "result": [
        {
            "language": "en_US",
            "collection": "A test-collection",
            "category": "A_TEST-COLLECTION"
        },
        {
            "language": "en_US",
            "collection": "style guide",
            "category": "STYLE_GUIDE"
        }
    ]
}

Example (XML body)

Request URL (on-premises)

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

Request URL (Cloud)

https://svc.webspellchecker.net/api?cmd=style_guide&access_key=<your-access-key>&serviceid=<your-service-id>&action=getcollections&lang=en_US&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=getcollections' \
  --data-urlencode 'lang=en_US' \
  --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=getcollections' \
  --data-urlencode 'lang=en_US' \
  --data-urlencode 'format=xml'

---

Response

<message>Collection(s) retrieved.</message>
<collection_limit>250</collection_limit>
<collection_usage>4</collection_usage>

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

3) Get a specific collection for a specific language

Example (JSON body)

Request URL (on-premises)

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

Request URL (Cloud)

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

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=getcollections' \
  --data-urlencode 'collection=A test-collection' \
  --data-urlencode 'lang=en_US'

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=getcollections' \
  --data-urlencode 'collection=A test-collection' \
  --data-urlencode 'lang=en_US'

---

Response

{
    "message": "Collection(s) retrieved.",
    "collection_limit": 250,
    "collection_usage": 4,
    "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=getcollections&collection=A test-collection&lang=en_US&format=xml

Request URL (Cloud)

https://svc.webspellchecker.net/api?cmd=style_guide&access_key=<your-access-key>&serviceid=<your-service-id>&action=getcollections&collection=A test-collection&lang=en_US&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=getcollections' \
  --data-urlencode 'collection=A test-collection' \
  --data-urlencode 'lang=en_US' \
  --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=getcollections' \
  --data-urlencode 'collection=A test-collection' \
  --data-urlencode 'lang=en_US' \
  --data-urlencode 'format=xml'

---

Response

<message>Collection(s) retrieved.</message>
<collection_limit>250</collection_limit>
<collection_usage>4</collection_usage>

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