View.GetSorting
  • 14 May 2024
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

View.GetSorting

  • Dark
    Light
  • PDF

Article summary

Description

Returns the current sorting configuration for the view.

URL parameters

NameRequiredTypeDescription
ViewIDTruenumericUnique identifier for the view.

Responses

NameTypeDescription
ResultstringSuccess if the operations was successful.
SortSortObject representing the sorting options.

Sample request

curl -X GET 'https://api.mozenda.com/rest?WebServiceKey=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&Service=Mozenda10&Operation=View.GetSorting&ViewID=1103'

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>
  <SortList>
    <Sort>
      <ViewSortID>1140</ViewSortID>
      <FieldID>91709</FieldID>
      <IsAscending>True</IsAscending>
    </Sort>
  </SortList>
</ApiResponse>

JSON (add &ResponseFormat=JSON)

{
    "Sort": [
        {
            "ViewSortID": 1140,
            "FieldID": 91709,
            "IsAscending": true
        }
    ],
    "JsonResult": {
        "Command": "View.GetSorting",
        "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