Collection.AddField
  • 25 May 2021
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Collection.AddField

  • Dark
    Light
  • PDF

Description

Adds a field to the desired collection. This field is created with the default format of Text. This operation can only be performed on collections that are created by a user.

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 for the collection.
Name True string The name of the new field.
Description False string A description of the new field.

Responses

Name Type Description
Result string Success if the operation was successful.
FieldID numeric Unique identifier for the new field.

Sample request

curl -X GET "https://api.mozenda.com/rest?WebServiceKey=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&Service=Mozenda10&Operation=Collection.AddField&CollectionID=1001&Field=Col7&FieldDescription=My%20col7%20description"

Sample responses

XML

<?xmlversion="1.0"encoding="utf-8"?>
<CollectionAddField
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
	<Result>Success</Result>
	<FieldID>2259</FieldID>
</CollectionAddField>

JSON (add &ResponseFormat=JSON)

{
  "FieldID": 2259,
  "JsonResult": {
    "Command": "Collection.AddField",
    "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?