POST Agents/Quote/ValidateQuoteVersion

• 4 minutes to read
 • 4 minutes to read 
POST /api/v1/Agents/Quote/ValidateQuoteVersion

When the user changes one or more values in a quoteline or a quoteAlternative, the connector gets to change the QuoteLines and the alternative, for instance calculate VAT.

ValidateQuoteVersion shall be called when the user presses the validate button, presses the send button or closes the quote dialog. RecalculateQuoteAlternative should typically validate all alternatives, set values in extrafields, and set the state in the version.

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/ValidateQuoteVersion?$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

QuoteVersionId, Action

Property Name Type Description
QuoteVersionId Integer
Action String

Response:

OK

Response Description
200 OK

Response body: QuoteVersionValidated

Property Name Type Description
IsOk bool Answer to the question / An indication if the operation went well. Equivalent to Status != Error.
UserExplanation string A localized explanation to the answer.
TechExplanation string Always in English
ErrorCode string An error code, if available.
ChangedSale Sale If the sale has been changed, the carrier will be added.
ChangedQuote Quote The validated version is a member of Quote
ChangedQuoteVersion QuoteVersion The validated QuoteVersion
ChangedQuoteAlternatives array The changed QuoteAlternatives
Status string QuoteStatus = Ok / OkWithInfo / Warn / Error. Error implies IsOk = false.
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/ValidateQuoteVersion
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: sv
Content-Type: application/json; charset=utf-8

{
  "QuoteVersionId": 243,
  "Action": "Approve"
}

Sample response

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

{
  "IsOk": false,
  "UserExplanation": "ipsa",
  "TechExplanation": "eligendi",
  "ErrorCode": "enim",
  "ChangedSale": null,
  "ChangedQuote": null,
  "ChangedQuoteVersion": null,
  "ChangedQuoteAlternatives": [
    {
      "QuoteLinesHasChanged": true,
      "ChangedQuoteAlternative": null,
      "Changes": null,
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 292
        }
      }
    },
    {
      "QuoteLinesHasChanged": true,
      "ChangedQuoteAlternative": null,
      "Changes": null,
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 292
        }
      }
    }
  ],
  "Status": "Error",
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 884
    }
  }
}