GET PreferenceDescriptionLine/default

• 2 minutes to read
 • 2 minutes to read 
GET /api/v1/PreferenceDescriptionLine/default

Set default values into a new PreferenceDescriptionLine.

NetServer calculates default values on the entity, which is required when creating/storing a new instance Calls the Preference agent service CreateDefaultPreferenceDescriptionLine.

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
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.

Response:

OK

Response Description
200 OK

Response body: PreferenceDescriptionLine

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

GET /api/v1/PreferenceDescriptionLine/default
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: sv

Sample response

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

{
  "PrefDescLineId": 246,
  "PrefDescId": 356,
  "PrefValue": "et",
  "PrefShowValue": "blanditiis",
  "Description": "Public-key empowering product",
  "IsBuiltin": false,
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 772
    }
  }
}