Contents x
Collection.SetUniqueFields
  • 25 May 2021
  • 1 Minute to read
  • Contributors
  • Print
  • Dark
    Light
  • PDF
Contents

Collection.SetUniqueFields

  • Updated on 25 May 2021
  • 1 Minute to read
  • Contributors
  • Print
  • Dark
    Light
  • PDF

Description

Sets the unique fields on the collection.

URL parameters

URL parameter ordering

The URL parameters below are listed in the order they should be entered in the API URL.

Name Required Type Description
CollectionID True numeric Unique identifier of the collection.
Fields True string Comma-separated list of field names to be set as unique.

Responses

Name Type Description
Result string Success if the operation was successful.
DuplicateItemsRemoved numeric The number of duplicate items removed.

Sample Request

curl -X GET 'https://api.mozenda.com/rest?WebServiceKey=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&Service=Mozenda10&Operation=Collection.SetUniqueFields&CollectionID=1052&Fields=Col1,Col2,Col3'

Sample responses

XML

<?xml version="1.0" encoding="utf-8" ?>
<CollectionSetUniqueFieldsResponse
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
	<Result>Success</Result>
	<DuplicateItemsRemoved>0</DuplicateItemsRemoved>
</CollectionSetUniqueFieldsResponse>

JSON (add &ResponseFormat=JSON)

{
    "DuplicateItemsRemoved": 0,
    "JsonResult": {
        "Command": "Collection.SetUniqueFields",
        "AutoLoggedIn": false,
        "WebConsoleKey": "",
        "Result": "Success",
        "ErrorCode": "",
        "ErrorDescription": "",
        "ErrorList": [],
        "ExecutionTime": {
            "Ticks": 0,
            "Days": 0,
            "Hours": 0,
            "Milliseconds": 0,
            "Minutes": 0,
            "Seconds": 0,
            "TotalDays": 0,
            "TotalHours": 0,
            "TotalMilliseconds": 0,
            "TotalMinutes": 0,
            "TotalSeconds": 0
        }
    }
}
Was this article helpful?
What's Next