Vous êtes ici :
InsEnrollmentServiceStd:enrollFamily
Utilisez ce service pour inscrire une famille dans un plan racine qui inclut un membre principal et les personnes à charge associées avec des couvertures.
Classe: InsEnrollmentServiceStd
Méthode : enrollFamily
Fonctionnement
- Le service commence par valider les données d'entrée pour vérifier :
Les données de requête requises sont fournies.
Le
flowNamefourni et sa version sont valides et actifs.La
primaryMemberIdfournie est valide et un enregistrement correspond à unprimaryMemberIdet à uncensusIddonnés.La
contractIdou larootPlanIdfournie est valide ou lacontractGroupPlande larootPlanIdfournie est associée à lacontractIdfournie.Le statut d'inscription est rempli pour les
rootPlanIdetprimaryMemberIdfournis dans le tableau deGroupCensusMemberPlan.Un enregistrement est associé aux
rootPlanIdetprimaryCensusMemberIdspécifiés.
-
Si les données d'entrée sont valides, le service appelle le flux d'inscription.
-
Le flux d'inscription crée Polices d'assurance, Participants à la police d'assurance et Couvertures de police d'assurance.
-
Le service renvoie l'ID de police en cas d'exécution réussie.
-
Le service renvoie des erreurs avec des détails d'erreur en cas d'erreur d'exécution de flux de validation ou d'inscription.
Options distantes
| OPTION | DESCRIPTION |
|---|---|
flowName
|
Obligatoire Nom du flux d'inscription utilisé pour l'inscription individuelle. |
groupCensusId
|
Obligatoire L'ID du recensement du groupe qui contient tous les membres de la famille à inscrire. |
contractId
|
Obligatoire L'ID du contrat auquel les membres appartiennent et les plans auxquels ils seront inscrits. |
primaryMemberId
|
Obligatoire ID du membre principal à inscrire. |
rootPlanId
|
Obligatoire ID du plan de groupe de contrats racine du produit d'inscription. |
isProrated
|
Facultatif. Si |
isSaveMemberPremium
|
Facultatif Indique si le montant de la prime de police doit être défini pour tous les enregistrements InsurancePolicyParticipant. Si |
userInputs
|
Facultatif L'ensemble de données d'entrée que la procédure de tarification utilise pour obtenir le prix du produit. |
additionalInputs
|
Facultatif Carte clé-valeur numérotée des entrées supplémentaires utilisées pour la tarification des produits. |
matchingKeysList
|
Obligatoire Un champ de l'objet Compte séparé par une virgule à utiliser pour détecter les doublons dans les enregistrements Compte existants si personAccount est activé dans une organisation. Champs de l'objet Contact séparés par une virgule à utiliser pour détecter les doublons dans les enregistrements Contact existants si personAccount n'est pas activé dans une organisation. |
inputKeysList
|
Facultatif Une liste de clés d'entrée séparées par une virgule des entrées de cotation à utiliser pour inclure dans les résultats de cotation individuels. |
emailEncodingKey
|
Obligatoire si l'action invocable Créer un utilisateur du portail est utilisée. La clé de codage d'e-mail à utiliser pour créer les enregistrements utilisateur. Par exemple, ISO-8859-1 ou UTF-8. |
languageLocaleKey
|
Facultatif Obligatoire si l'action invocable Créer un utilisateur du portail est utilisée. |
localeSidKey
|
Obligatoire si l'action invocable Créer un utilisateur du portail est utilisée. La clé SID des paramètres régionaux à utiliser pour créer des enregistrements utilisateur. |
timezoneSidKey
|
Obligatoire si l'action invocable Créer un utilisateur du portail est utilisée. La clé SID du fuseau horaire à utiliser pour créer les enregistrements utilisateur. |
profileId
|
Facultatif L'ID de l'enregistrement Profil qui doit être associé à l'enregistrement Utilisateur. |
JSON d'entrée
Voici l'exemple de JSON d'entrée :
{
'flowName': 'Individual_Enrollment',
'groupCensusId':'0rfSG00000003fRYAQ',
'contractId':'800RN000000jyCRYAY',
'primaryMemberId':'0r6SG0000000j1xYAA',
'rootPlanId':'0rgRN0000000320YAA',
'isProrated': true,
'isSaveMemberPremium':true,
'emailEncodingKey':'ISO-8859-1',
'languageLocaleKey':'en_US',
'localeSidKey':'en_US',
'timezoneSidKey':'America/Los_Angeles',
'profileId':'00eSG00000120ug',
'userInputs':{"ratingType": "Enrollment"},
'additionalInputs':{"mergeList": "true", "includeOptionalCovSelectFlag":true}
'matchingKeysList':'FirstName,LastName',
'inputKeysList':'aggByKey,primaryMember,groupCensusMemberId'
}JSON de sortie pour les erreurs
Voici l'exemple de JSON de sortie d'erreur :
{
"errors":[
{
"error":"already enrolled",
"rootPlanId":"0rgRN0000000320YAA",
"censusMemberId":"0r6RN0000006HOJYA2"
},
]
}