POST Agents/Preference/SavePreferenceDescriptionLines

• 3 minutes to read
 • 3 minutes to read 
POST /api/v1/Agents/Preference/SavePreferenceDescriptionLines

Saves the PreferenceDescriptionLine array in the SuperOffice database

Query String Parameters

Parameter Name Type Description
$select string Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields. 
POST /api/v1/Agents/Preference/SavePreferenceDescriptionLines?$select=name,department,category/id

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: request

PreferenceDescriptionLines

Property Name Type Description
PreferenceDescriptionLines Array

Response:array

OK

Response Description
200 OK

Response body: array

Property Name Type Description
PrefDescLineId int32 Primary key
PrefDescId int32 Preference description (parent)
PrefValue string Possible value
PrefShowValue string Descriptive value, multilang-parsed, to put in list
Description string Description of preference value, multi-language parsed
IsBuiltin bool 1 = This row populated and maintained by SuperOffice
TableRight TableRight The carrier's table right
FieldProperties object Field property dictionary mapping field names to field access rights.

Sample request

POST /api/v1/Agents/Preference/SavePreferenceDescriptionLines
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: *
Content-Type: application/json; charset=utf-8

{
  "PreferenceDescriptionLines": [
    {
      "PrefDescLineId": 954,
      "PrefDescId": 795,
      "PrefValue": "beatae",
      "PrefShowValue": "tempore",
      "Description": "Diverse bandwidth-monitored approach",
      "IsBuiltin": true
    },
    {
      "PrefDescLineId": 954,
      "PrefDescId": 795,
      "PrefValue": "beatae",
      "PrefShowValue": "tempore",
      "Description": "Diverse bandwidth-monitored approach",
      "IsBuiltin": true
    }
  ]
}

Sample response

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

[
  {
    "PrefDescLineId": 149,
    "PrefDescId": 286,
    "PrefValue": "et",
    "PrefShowValue": "molestiae",
    "Description": "Optional disintermediate encryption",
    "IsBuiltin": true,
    "TableRight": null,
    "FieldProperties": {
      "fieldName": {
        "FieldRight": null,
        "FieldType": "System.Int32",
        "FieldLength": 6
      }
    }
  }
]