View.Add

  • Updated on May 14, 2024
  • Published on May 25, 2021
  • 1 minute(s) read
  • vL
 Prev Next

Description

Adds a view to a 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.
Name True string The name of the new view.
Description False string A description for the new view.

Responses

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

Sample request

curl -X GET 'https://api.mozenda.com/rest?WebServiceKey=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&Service=Mozenda10&Operation=View.Add&CollectionID=1091&Name=RetailStores'

Sample responses

XML

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

JSON (add &ResponseFormat=JSON)

{
    "ViewID": 5613,
    "JsonResult": {
        "Command": "View.Add",
        "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
        }
    }
}