Vous êtes ici :
InsCensusServiceStd:getMembers
Utilisez ce service pour récupérer les membres d'un recensement dans le GroupCensusMember. Il récupère également les en-têtes en fonction de la fieldsetName.
Classe: InsCensusServiceStd
Méthode : getMembers
Le service accepte les entrées sous ce format.
| censusId | fieldsetName | Décalage | limite | searchKey |
|---|---|---|---|---|
| c101 | test_fieldset | cmember101 | nombre entier | préfixe |
Le service utilise des valeurs d'entrée pour générer une sortie adaptée à votre modèle de produit.
| recensement | lastOffSet | |
|---|---|---|
| headers | membres | ID du dernier membre du recensement |
| Liste de champs | Liste des membres | |
Fonctionnement
Ce service a deux fonctions clés :
-
Récupère la liste des champs et des en-têtes de
GroupCensusMemberbasés sur lefieldetName. La sortie contient toujoursPrimaryGroupCensusMemberId,RelationshipToPrimaryMember,SourceSystemIdentifieretPrimaryMemberSource, même si ces champs ne sont pas inclus dans lafieldsetName. - Le service utilise
censusIdpour récupérer la liste des membres du recensement dans les enregistrementsGroupCensusMember.- Si le décalage a une valeur, il récupère les lignes de
GroupCensusMemberprincipal (organisées par ID) après le décalage, puis récupère toutes les personnes dépendantes de ces Membres principaux. Si une valeur limite existe, le service récupère les lignes de
GroupCensusMemberprincipal (organisées par ID) qui ne dépassent pas la limite spécifiée. Il récupère ensuite toutes les personnes dépendantes de ces Membres principaux. La limite ne peut pas dépasser 500.Si
searchKeya une valeur, le service récupère les lignes deGroupCensusMember(organisées par ID) avec la famille correspondante, qui contientsearchKeyen tant que sous-chaîne dans sonFirstNameouLastName.Si
memberIdsa une valeur, il récupère les lignes deGroupCensusMember(organisées par ID) dont l'ID fait partie du tableaumemberIds.memberIdsousearchKeydoit être fourni dans l'entrée.Si
withPlansest défini surtrue, le service récupère la liste des plans sélectionnés pour chaque membre. LesContractGroupPlanIdvalides de chaque membre sont délimitées par un point-virgule et renvoyées sous forme de chaîne.Les informations récupérées pour chaque membre sont basées sur les champs récupérés dans
GroupCensusMember.La liste des membres est placée dans le nœud
members.
- Si le décalage a une valeur, il récupère les lignes de
Comportement de service
Comprenez comment les différentes entrées affectent les sorties de service.
| Entrée | Sortie de service |
|---|---|
Aucun censusId ou censusId non valide |
Le service ne récupère aucun membre du recensement. |
censusId non fieldsetName et valide |
|
fieldsetName valides et censusId valides |
Le service récupère la liste des champs de GroupCensusMember présents dans l'ensemble de champs donné et la liste des GroupCensusMember. |
limit valide |
Le service récupère la liste des |
offset valide |
Le service récupère la liste des
|
limit valide offset et valide |
Le service récupère la liste des champs de
|
searchKey valide |
Le service récupère la liste des champs de |
searchKey valides et limit valides |
Le service récupère la liste des champs de |
offset valide searchKey et valide |
Le service récupère la liste des champs de |
searchKey valide, limit valide et offset valide |
Le service récupère la liste des champs de
|
Options distantes
| Options | Description |
|---|---|
|
Requis. ID de recensement dont les membres doivent être récupérés. |
|
Facultatif. Nom de l'ensemble de champs pour récupérer les champs de Si la valeur n'est pas valide, le service ne renvoie aucun champ. En l'absence de valeur, le service utilise l'ensemble de champs par défaut pour récupérer les champs de |
|
Optional. Le nombre de membres du recensement à récupérer. |
|
Facultatif . L'ID du membre du recensement après lequel les membres du recensement doivent être récupérés. |
|
Une chaîne de recherche d'enregistrements de membre du recensement correspondants. |
JSON d'entrée
Ce service ne prend pas de JSON d'entrée.
JSON de sortie
Le service renvoie un JSON de sortie avec une liste de champs, une liste de membres et une valeur de lastOffSet.
{
"census":{
"members":[
{
"Id":"a4C4P000000dNdbUAE",
"LastName":member1,
"FirstName":primary,
"Birthdate":"1999-08-08"
},
{
"Id":"a4C4P000000dNdcUAE",
"LastName":member1,
"FirstName":dependent,
"Birthdate":"1994-08-08"
},
{
"Id":"a4C4P000000dNdeUAE",
"LastName":member2,
"FirstName":primary,
"Birthdate":"1985-08-08"
}
],
"headers":[
{
"type":"STRING",
"label":"First Name",
"fieldId":"",
"name":"FirstName"
},
{
"type":"DATE",
"label":"Birthday",
"fieldId":"",
"name":"Birthdate"
},
{
"type":"STRING",
"label":"Last Name",
"fieldId":"",
"name":"LastName"
}
]
},
"lastOffset" : "a4C4P000000dNdeUAE"
}