Collection.AddItem

Description

Adds an item to a collection with the values specified.

It is also possible to add items in bulk by attaching XML or JSON to the request. This option should be used whenever a large number of items needs to be inserted all at once.

URL parameters

Request body (optional)

The fields and values of the rows you want to add in bulk. You can format these in XML or in JSON.

XML

<ItemList>
	<Item>
		<Field1>Value1</Field1>
		<Field2>Value2</Field2>
	</Item>
	<Item>
		<Field1>Value3</Field1>
		<Field2>Value4</Field2>
	</Item>
</ItemList>

JSON

[
  { "Field1": "Value1", "Field2": "Value2" },
  { "Field1": "Value3", "Field2": "Value4" }
]

Responses

Sample requests

GET with fields and values specified in the URL

curl -X GET 'https://api.mozenda.com/rest?WebServiceKey=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&Service=Mozenda10&Operation=Collection.AddItem&CollectionID=1001&Field.FirstName=John&Field.LastName=Smith'

POST - XML body

curl -X POST 'https://api.mozenda.com/rest?WebServiceKey=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&Service=Mozenda10&Operation=Collection.AddItem&CollectionID=1001'
-F 'file=@/path/to/file.xml'

POST - JSON body

curl -X POST 'https://api.mozenda.com/rest?WebServiceKey=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&Service=Mozenda10&Operation=Collection.AddItem&CollectionID=1001'
-d '[{"Field1": "Value1", "Field2": "Value2"}, {"Field1":"Value11", "Field2": "Value22"}]'

Sample responses

XML

<?xmlversion="1.0"encoding="utf-8"?>
<CollectionAddItemResponse
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
	<Result>Success</Result>
	<ItemID>1098</ItemID> <!--ItemID is returned only when using the GET call  to add a single row-->
</CollectionAddItemResponse>

JSON (add &ResponseFormat=JSON)

{
  "JsonResult": {
    "Command": "Collection.AddItem",
    "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
    }
  }
}