PUT List/Category/Headings

• 3 minutes to read
 • 3 minutes to read 
PUT /api/v1/List/Category/Headings

Saves headings for the Category list.

Calls the List agent service SaveHeadingsFromListDefinition.

Request Headers

Parameter Name Description
Authorization Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Content-Type Content-type of the request body: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, application/json-patch+json, application/merge-patch+json
Accept Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json
Accept-Language Convert string references and multi-language values into a specified language (iso2) code.
SO-Language Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone Specify the timezone code that you would like date/time responses converted to.
SO-AppToken The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Request Body: entities

The headings to be saved.

Property Name Type Description
HeadingId Integer Primary key
Name String The visible heading
Tooltip String Tooltip or other description
Deleted Boolean True if the heading is marked as deleted
Rank Integer Rank order
UdListDefinitionId Integer The id of the list which this heading belongs to

Response:array

OK

Response Description
200 OK

Response body: array

Property Name Type Description
HeadingId int32 Primary key
Name string The visible heading
Tooltip string Tooltip or other description
Deleted bool True if the heading is marked as deleted
Rank int32 Rank order
UdListDefinitionId int32 The id of the list which this heading belongs to
TableRight TableRight The carrier's table right
FieldProperties object Field property dictionary mapping field names to field access rights.

Sample request

PUT /api/v1/List/Category/Headings
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en
Content-Type: application/json; charset=utf-8

[
  {
    "HeadingId": 921,
    "Name": "Wehner, Rogahn and Ryan",
    "Tooltip": "et",
    "Deleted": false,
    "Rank": 184,
    "UdListDefinitionId": 775
  },
  {
    "HeadingId": 921,
    "Name": "Wehner, Rogahn and Ryan",
    "Tooltip": "et",
    "Deleted": false,
    "Rank": 184,
    "UdListDefinitionId": 775
  }
]

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

[
  {
    "HeadingId": 288,
    "Name": "Buckridge, Von and Blick",
    "Tooltip": "incidunt",
    "Deleted": false,
    "Rank": 934,
    "UdListDefinitionId": 659,
    "TableRight": null,
    "FieldProperties": {
      "fieldName": {
        "FieldRight": null,
        "FieldType": "System.Int32",
        "FieldLength": 99
      }
    }
  }
]