Edit collection (editcollections)

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	editcollection	Action name.
collection	string	Yes		The name of an existing collection to be edited.
new_collection	string	Yes		A new name of the collection to be created.
lang	string	No	common	Language scope of existing collection to be edited (example: en_US or en).
new_lang	string	No	common	Language scope of a new collection to be created in (example: en_US or en).

Behavior

• Edits an existing collection in the target lang scope.

• Returns the edited collection info in result.

Response

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

See Response schema.

Errors

See

• Errors.

• Validation & limits

Examples

1) Rename collection

lang and new_lang remain the same, while collection and new_collection differ.

Example (JSON body)

Request URL (on-premises)

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

Request URL (Cloud)

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

---

Response

{
    "message": "Collection updated.",
    "collection_limit": 250,
    "collection_usage": 1,
    "result": [
        {
            "language": "en_US",
            "collection": "Renamed collection",
            "category": "RENAMED_COLLECTION"
        }
    ]
}

Example (XML body)

Request URL (on-premises)

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

Request URL (Cloud)

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

---

Response

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

<result>
	<category>
		<language>en_US</language>
		<collection>Renamed collection</collection>
		<category>RENAMED_COLLECTION</category>
	</category>
</result>

2) Change collection language

collection and new_collection remain the same, while lang and new_lang differ.

Example (JSON body)

Request URL (on-premises)

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

---

Response

{
    "message": "Collection updated.",
    "collection_limit": 250,
    "collection_usage": 1,
    "result": [
        {
            "language": "es_ES",
            "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=editcollection&lang=en_US&collection=A test-collection&new_lang=es_ES&new_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=editcollection&lang=en_US&collection=A test-collection&new_lang=es_ES&new_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=editcollection' \
  --data-urlencode 'lang=en_US' \
  --data-urlencode 'collection=A test-collection' \
  --data-urlencode 'new_lang=es_ES' \
  --data-urlencode 'new_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=editcollection' \
  --data-urlencode 'lang=en_US' \
  --data-urlencode 'collection=A test-collection' \
  --data-urlencode 'new_lang=es_ES' \
  --data-urlencode 'new_collection=A test-collection' \
  --data-urlencode 'format=xml'

---

Response

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

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

3) Change collection language and rename

Example (JSON body)

Request URL (on-premises)

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

Request URL (Cloud)

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

---

Response

{
    "message": "Collection updated.",
    "collection_limit": 250,
    "collection_usage": 1,
    "result": [
        {
            "language": "es_ES",
            "collection": "Renamed collection",
            "category": "RENAMED_COLLECTION"
        }
    ]
}

Example (XML body)

Request URL (on-premises)

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

Request URL (Cloud)

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

---

Response

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

<result>
	<category>
		<language>es_ES</language>
		<collection>Renamed collection</collection>
		<category>RENAMED_COLLECTION</category>
	</category>
</result>