Loading
Insurance
InsQuoteService:getQuoteDetail

InsQuoteService:getQuoteDetail

Utilisez ce service pour récupérer tous les détails du devis en JSON.

Ce service fonctionne bien pour les flux qui prennent un devis enregistré et créent une police d'assurance ou un plan de santé à partir de ce devis.

Classe: InsQuoteService

Méthode : getQuoteDetail

Fonctionnement

  1. Le service prend un quoteId et trouve le devis.

  2. Le service renvoie un JSON qui inclut les clés suivantes : values :

    • quoteDetails : Valeurs de champ de devis

      Inclut des valeurs de champ de devis avec des attributs.

    • insuredItems : Articles assurés et assurés

      Inclut les détails des lignes de devis InsuredItemSpec et InsuredPartySpec. (pas applicable à Vlocity Health).

    • productConfigurationDetail : Configurations de produits

      Modèle de structure JSON Produit

Taxes et frais

Voici comment fonctionne ce service :

  • Les champs taxAmount, TaxAmount__c, feeAmount, FeeAmount__c et TotalAmount__c sont renvoyés pour chaque QuoteLineItem, si les champs ne sont pas nuls.

  • Les champs TotalTaxAmount__c, TotalFeeAmount__c et TotalAmount__c sont renvoyés pour le devis, si les champs ne sont pas nuls.

  • La totalTaxFeeAmount = TaxAmount__c + FeeAmount__c

Entrées

Le service nécessite ces entrées si l'option de télécommande isForExternal est définie sur true. Omettez ces entrées si isForExternal est vide ou défini sur false.

Option

Description

action

Obligatoire lorsque isForExternal=true.

Le service utilise cette valeur pour créer le nœud Action requis pour l'API de tarification externe.

Valeurs possibles :

  • submit
  • reprice
quoteId

Obligatoire lorsque isForExternal=true.

L'ID du devis dont vous souhaitez récupérer les détails.

Options distantes

Option

Description

action

Obligatoire lorsque isForExternal=true.

Indique l'action que le serveur externe doit exécuter avec le Devis.

Valeurs possibles :

  • submit
  • reprice

Pour la soumission, le sourceSystemIdentifer du Quote est passé. Pour le prix, le SourceSystemIdentifer du Root QuoteLineItem à recalculer ou à calculer est passé.

disableAttributeCategories

Facultatif.

Afficher attributeCategories dans le JSON de sortie.

Si cet indicateur est défini sur true, le service getQuoteDetail omet le nœud attributeCategory de la réponse et le service createPolicyVersion ne parvient pas à créer les termes de la stratégie. Pour vous assurer que le service createPolicyVersion crée des termes de police, définissez cet indicateur sur false.

disableChildProducts

Facultatif.

Affichez les enregistrements sous childProduct dans le JSON de sortie.

disableOptionalCoverages

Facultatif.

Lorsqu'elles sont définies sur true, les couvertures facultatives ne sont pas affichées dans un devis d'un OmniScript.

includeOriginalPlan

Si défini sur true, inclut les produits d'origine dans un renouvellement.

Sinon, seuls les produits de remplacement sont affichés.

includeOpportunity

Si défini sur true, renvoyez les détails de l'opportunité du devis dans un nœud JSON séparé. Les champs renvoyés sont déterminés par le OpportunityDetail d'ensemble de champs.

La valeur par défaut est false.

instanceKey

Un identifiant unique associé à l'élément de ligne de devis utilisé pour identifier l'instance d'un produit. L'instanceKey est spécifiée manuellement ou générée par le système.

isMultiRoot

true ou false

Défini sur true pour les devis qui contiennent plusieurs produits d'assurance (plan).

Par exemple, une offre qui inclut un plan de soins, un plan dentaire et un plan de soins de la vue doit avoir cette option définie sur true pour renvoyer les détails des plans.

isForExternal

S'il est défini sur true, le service renvoie le JSON simplifié pour faciliter le mappage avec un système d'administration de stratégie externe.

productCode

Code du produit associé à un Élément de ligne de devis.

productSpecId

ID du produit associé à un Élément de ligne de devis.

quoteId

Obligatoire.

Le QuoteId, ou le QuoteId crypté si la requête concerne un client.

quoteLineItemId

ID de l'élément de ligne de devis. Renvoie un seul Élément de ligne de devis avec l'ID correspondant exact. Si d'autres filtres sont inclus dans la requête qui ne répondent pas aux détails de l'article renvoyé, aucun article n'est renvoyé.

JSON d'entrée

Voici le format du JSON d'entrée :

{
  "quoteId": "...",
  "action":  "..."
}

Voici un exemple de JSON d'entrée :

{
  "quoteId":"0Q06g0000009YA3CAM"
  "action": "submit"
}

Sortie JSON (assurance)

Le service renvoie un JSON qui contient les nœuds suivants :

  • Parties assurées et articles assurés

  • Ensemble de champs Détails du devis

  • Détails de configuration du produit

Conseil
Conseil

L'ensemble de champs quoteDetail existe dans plusieurs objets, mais le service InsQuoteService:getQuoteDetail lit uniquement l'ensemble de champs de l'objet Élément de ligne de devis lorsqu'il élabore le nœud productConfigurationDetail dans la réponse JSON. Les ensembles de champs de l'objet Product2 sont ignorés par ce service.

Pour réduire la taille de la charge utile et améliorer les performances Omniscript, ajoutez ou retirez des champs dans l'ensemble de champs quoteDetail. Quelques champs Élément de ligne de devis tels que Nom du produit, Code produit, ID de produit sont inclus par défaut. Nous recommandons de garder ces ensembles inchangés, car ils sont essentiels pour un devis.

{
  "productConfigurationDetail": {
    "records": [...]
    "totalSize": 1
  },
  "insuredItems": {
    "Driver": [{
        "instanceKey": "Joan Smith",
        "isPrimary": false,
        "isParent": false,
        "LN": "Smith",
        "AGE": 20,
        "FN": "Joan",
        "GENDER": "Female",
        "FirstName": "Joan",
        "LastName": "Smith"
      },
      {
        ...
      }
    ],
    "Auto": [{
        "instanceKey": "2015 Lexus LX250",
        "autoAntiTheft": true,
        "est_annual_mileage": "1-10000",
        "autoLicNum": "Lexus",
        "autoModel": "LX250",
        "autoYear": 2015,
        "BodyClass": "Sedan/Saloon",
        "VehicleType": "PASSENGER CAR",
        "isPrimary": true
        "isParent": false,
      },
      {
        ...
      }
    ]
  },
  "quoteDetail": {
    "attributes": {
      "type": "Quote",
      "url": "/services/data/v43.0/sobjects/Quote/0Q01I000000qeWLSAY"
    },
    "ins_daily4__EffectiveDate__c": "2018-07-27",
    "ins_daily4__TotalSumInsured__c": 0,
    "AccountId": "0011I00000QknfjQAB",
    "ins_daily4__RootItemTotal__c": 0,
    "Id": "0Q01I000000qeWLSAY"
  },
  "error": "OK"
}

Sortie JSON (santé)

Le service renvoie un JSON qui contient les nœuds suivants :

  • Ensemble de champs Détails du devis

  • Détails de configuration du produit

{
  "productConfigurationDetail": {
    "records": [...]
    "totalSize": 1
  },
  "quoteDetail": {
    "attributes": {
      "type": "Quote",
      "url": "/services/data/v43.0/sobjects/Quote/0Q01I000000qeWLSAY"
    },
    "ins_daily4__EffectiveDate__c": "2018-07-27",
    "ins_daily4__TotalSumInsured__c": 0,
    "AccountId": "0011I00000QknfjQAB",
    "ins_daily4__RootItemTotal__c": 0,
    "Id": "0Q01I000000qeWLSAY"
  },
  "error": "OK"
}
 
Chargement
Salesforce Help | Article