POST Agents/Quote/GetInUseQuoteLineConfigurations

• 3 minutes to read
 • 3 minutes to read 
POST /api/v1/Agents/Quote/GetInUseQuoteLineConfigurations

Returns the configuration fields that should be visible in the GUI.

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/Quote/GetInUseQuoteLineConfigurations?$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
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:array

OK

Response Description
200 OK

Response body: array

Property Name Type Description
QuoteLineConfigurationId int32 Primary key
FieldName string The name of the field being configured, from data dictionary
Label string Label resource string.
Tooltip string Tooltip resource string.
Editable bool Is this a read only field?
InUse bool Should this field be displayed in the GUI?
Mandatory bool Is this a mandatory field?
Rank int32 Rank of the field
RestrictEdit bool If true, then this field cannot be set readwrite or mandatory: It's bound to be readonly
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/Quote/GetInUseQuoteLineConfigurations
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

[
  {
    "QuoteLineConfigurationId": 802,
    "FieldName": "Berge LLC",
    "Label": "et",
    "Tooltip": "soluta",
    "Editable": false,
    "InUse": false,
    "Mandatory": false,
    "Rank": 574,
    "RestrictEdit": true,
    "TableRight": null,
    "FieldProperties": {
      "fieldName": {
        "FieldRight": null,
        "FieldType": "System.Int32",
        "FieldLength": 398
      }
    }
  }
]