View.SetSorting
  • 25 May 2021
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

View.SetSorting

  • Dark
    Light
  • PDF

Article Summary

Description

Sets the sorting configuration for the view.

Existing rules replaced

Setting a new sorting method will replace any existing rules for sorting, not add to them.

URL parameters

URL parameter ordering

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

NameRequiredTypeDescription
ViewIDTruenumericUnique identifier of the view.
FieldsFalsestringComma-separated; sort method defaults to ascending unless desc is specified, see request sample below.

Responses

NameTypeDescription
ResultstringSuccess if the operation was successful.

Sample request

curl -X GET "https://api.mozenda.com/rest?WebServiceKey=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&Service=Mozenda10&Operation=View.SetSortings&ViewID=1111&Fields=TVTitle,Season%20desc&ResponseFormat=JSON"

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>
</ApiResponse>

JSON (add &ResponseFormat=JSON)

{
  "JsonResult": {
    "Command": "View.SetSorting",
    "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?