Loading
Försäkring
InsCensusServiceStd:getMembersWithPlans

InsCensusServiceStd:getMembersWithPlans

Använd denna tjänst för att hämta listan över folkräkningsmedlemmar för en given censusId. Motsvarande dessa folkräkningsmedlemmar hämtar tjänsten ContractGroupPlanIds från GroupCensusMemberPlan. Tjänsten hämtar även sidhuvuden baserat på fieldsetName och planFieldsetName.

Klass: InsCensusServiceStd​​

Metod: getMembersWithPlans

Så här fungerar det

Denna tjänst har två nyckelfunktioner:

  1. Hämtar listan över fält i GroupCensusMember och GroupCensusMemberPlan .
    • Tjänsten använder parametern ​fieldsetName för att hämta listan över GroupCensusMember​​. Om det inte finns något värde hämtas fält från standardfältuppsättningen. Om det angivna värdet inte hittar någon träff hämtas inga fält.

    • Tjänsten använder parametern planFieldsetName​ för att hämta listan över GroupCensusMemberPlan. Om det inte finns något värde hämtas alla fält. Om det angivna värdet inte hittar någon träff hämtas inga fält.

    • Hämtar relationsfält som kombineras för att bilda JSON-sidhuvudnoden även om dessa fält inte är inkluderade i fieldsetName. Dessa fält är: PrimaryGroupCensusMemberId, RelationshipToPrimaryMember, SourceSystemIdentifier och PrimaryMemberSource.

    • Om parametern contractGroupPlanId har värde fyller den i listan över kontraktradposter med följande detaljer om kontraktet:

      • Namn på kontraktgruppplan

      • Produkttyp

      • ID för kontraktgruppplanerna

  2. Tjänsten använder censusId för att hämta listan över folkräkningsmedlemmar från GroupCensusMember och kontraktgruppplaner från GroupCensusMemberPlan för varje medlem.

    • Om förskjutningen har ett värde hämtar den Primära GroupCensusMember (ordnade efter Id) efter förskjutningen och hämtar sedan alla beroenden för dessa Primära medlemmar.

    • Om det finns ett gränsvärde hämtar tjänsten raderna för Primär GroupCensusMember (ordnade efter Id) som inte är större än den specificerade gränsen. Den hämtar sedan alla beroenden för dessa primära medlemmar. Gränsen får inte vara högre än 500.

    • Om searchKey har värde hämtar tjänsten GroupCensusMember (ordnade efter Id) tillsammans med motsvarande familj, som har searchKey som en understräng i sina FirstName eller LastName. Om GroupCensusMember innehåller beroenden hämtar tjänsten primära medlemmar som motsvarar dessa beroenden.

    • Om memberIds har ett värde hämtar det GroupCensusMember (ordnade efter Id) vars Id är en del av memberIds. Antingen memberIds eller searchKey måste anges som indata.

    • Informationen som hämtas för varje medlem baseras på fälten som hämtas från GroupCensusMember och GroupCensusMemberPlan.

    • Listan över medlemmar placeras i members.

Servicebeteende

Förstå hur olika inmatningar påverkar serviceresultaten.

Indata Serviceresultat

Inga censusId eller ogiltiga censusId

Tjänsten hämtar ingen folkräkningsmedlem.
Ingen fieldsetName och giltig censusId

Tjänsten hämtar:

  • Om StandardFieldset finns tar tjänsten listan över GroupCensusMember som finns i standardfältuppsättningen och hämtar listan över GroupCensusMember med ContractGroupPlanIds.
  • Om Standardfältuppsättning inte finns tar tjänsten listan över GroupCensusMember som finns i Redigerbar tabell Fältuppsättning och hämtar listan över GroupCensusMember med ContractGroupPlanIds.

  • Om StandardFieldset och Redigerbar tabellfältuppsättning båda inte finns ger tjänsten ett fel.
Giltiga fieldsetName och giltiga censusId Tjänsten listar GroupCensusMember enligt det specificerade fieldsetName och hämtar listan över GroupCensusMember med ContractGroupPlanIds.
Inga planFieldsetName giltiga fieldsetName och giltiga censusId Tjänsten listar GroupCensusMember enligt det specificerade fältet fieldsetName, ContractGroupPlanId och Namn för GroupCensusMemberPlan. Den hämtar en lista över GroupCensusMember med ContractGroupPlanIds.
planFieldsetName Giltigt fieldsetName och giltigt censusId

Tjänsten hämtar:

  • GroupCensusMember fält enligt det specificerade fieldsetName.

  • GroupCensusMemberPlan enligt det specificerade planFieldsetName.

  • Lista över GroupCensusMember med ContractGroupPlanIds.

Giltig contractId Tjänsten hämtar namnet på kontraktgruppens plan, produkttyp, underordnade produkter och ID för kontraktgruppens plan som alternativ i ContractGroupPlanId.
Giltig limit

Tjänsten hämtar:

  • GroupCensusMember fält enligt det specificerade fieldsetName.

  • GroupCensusMemberPlan enligt det specificerade planFieldsetName.

  • Lista över GroupCensusMember med ContractGroupPlanIds.

  • Antalet hämtade primära GroupCensusMember är mindre än eller lika med gränsen.

  • Beroenden associerade med den primära GroupCensusMember i listan.

Giltig offset

Tjänsten hämtar:

  • GroupCensusMember enligt det specificerade fieldsetName.

  • GroupCensusMemberPlan enligt det specificerade planFieldsetName.

  • Lista över GroupCensusMember med ContractGroupPlanIds.

  • Id för varje hämtad primär GroupCensusMember är större än förskjutning.

  • Beroenden associerade med den primära GroupCensusMember i listan.

Giltig offset och giltig limit

Tjänsten hämtar:

  • GroupCensusMember enligt det specificerade fieldsetName.

  • GroupCensusMemberPlan enligt det specificerade planFieldsetName.

  • Lista över GroupCensusMember med ContractGroupPlanIds.

  • Antalet hämtade primära GroupCensusMember är mindre än eller lika med gränsen.

  • Beroenden associerade med den primära GroupCensusMember i listan.

  • Id för varje hämtad primär GroupCensusMember är större än förskjutning.

Giltig searchKey

Tjänsten hämtar:

  • GroupCensusMember fält enligt det specificerade fieldsetName.

  • GroupCensusMemberPlan enligt den specificerade planFieldsetName

  • Lista över GroupCensusMember med ContractGroupPlanIds.

  • Om listan har beroenden hämtar tjänsten primära medlemmar som motsvarar dessa beroenden.

  • Alla medlemmar kommer att innehålla en searchKey som understräng i sin FirstName eller LastName.

Giltiga searchKey och giltiga limit

Tjänsten hämtar:

  • GroupCensusMember fält enligt det specificerade fieldsetName.
  • GroupCensusMemberPlan enligt det specificerade planFieldsetName.

  • Lista över GroupCensusMember med ContractGroupPlanIds.

  • Om listan har beroenden hämtar tjänsten primära medlemmar som motsvarar dessa beroenden.

  • Alla medlemmar kommer att innehålla en searchKey som understräng i sin FirstName eller LastName.

  • Antal hämtade GroupCensusMember är mindre än eller lika med den specificerade gränsen.

Giltiga searchKey och giltiga offset

Tjänsten hämtar:

  • GroupCensusMember enligt det specificerade fieldsetName.

  • GroupCensusMemberPlan enligt det specificerade planFieldsetName.

  • Lista över GroupCensusMember med ContractGroupPlanIds.

  • Om listan har beroenden hämtar tjänsten primära medlemmar som motsvarar dessa beroenden.

  • Alla medlemmar kommer att innehålla en searchKey som understräng i sin FirstName eller LastName.

  • ID för varje hämtat GroupCensusMember är större än förskjutning.

Giltigt searchKey, giltigt limit och giltigt offset

Tjänsten hämtar:

  • GroupCensusMember enligt det specificerade fieldsetName.

  • GroupCensusMemberPlan enligt det specificerade planFieldsetName.

  • Lista över GroupCensusMember med ContractGroupPlanIds.

  • Om listan har beroenden hämtar tjänsten primära medlemmar som motsvarar dessa beroenden.

  • Alla medlemmar kommer att innehålla en searchKey som understräng i sin FirstName eller LastName.

  • Antal hämtade GroupCensusMember är mindre än eller lika med den specificerade gränsen.

  • ID för varje hämtat GroupCensusMember är större än förskjutning.

Fjärralternativ

Alternativ Beskrivning

​​​censusId​​​

Obligatoriskt.

ID för folkräkning vars medlemmar måste hämtas.

​​​contractId

​Required​​​.

ID för kontots aktuella kontrakt.

Hämtar namnet på kontraktgruppens plan, produkttyp och kontraktgrupp

​​​

fieldsetName​​​

Valfritt.

Namn på fältuppsättning för att hämta GroupCensusMember-fälten.

Om värdet är ogiltigt returnerar tjänsten inga fält.

Om det inte finns något värde använder tjänsten standardfältuppsättningen för att hämta GroupCensusMember-fält.

​​​planFieldsetName​​​

Valfritt.

Hämtar fälten GroupCensusMemberPlan och GroupCensusMember när det finns ett giltigt värde för uppsättning av planfält.

Inga fält returneras om värdet inte är giltigt.

Alla GroupCensusMemberPlan-fält returneras om det inte finns något värde.

​limit​

Valfritt.

Antalet folkräkningsmedlemmar som ska hämtas.

​​​offset​​​

Valfritt .

ID för den folkräkningsmedlem efter vilken folkräkningsmedlemmarna måste hämtas.

​searchKey​

En sträng för att söka efter matchande poster för folkräkningsmedlemmar.

Indata-JSON

Denna tjänst tar inte en indata-JSON.

JSON för utdata

Tjänsten returnerar en JSON-utdataformat enligt exemplet nedan. Utdata har detaljer om medlemmarna i folkräkningen, där sidhuvuden är en lista över fältens API-namn på GroupCensusMember och GroupCensusMemberPlan. members returnerar listan över valda planer för medlemmen tillsammans med ContractGroupPlanId avgränsat av ;. Fältet lastOffset visar ID för den senaste folkräkningsmedlemmen som hämtades. Detta värde kan användas som offset-parameter för att få nästa rader.

Här är JSON-formatet för exempelutdata:

{ 
   "census":{ 
      "members":[ 
         { 
            "ContractGroupPlanId":"ID1;ID2",
            "Id":"ID",
            "fieldAPI1":"value"
         }
      ],
      "headers":[ 
         { 
            "type":"field type",
            "label":"field label",
            "fieldId":"",
            "name":"fieldAPI1"
         },
         { 
            "options":[ 
               { 
                  "value":"ID",
                  "type":"Product Type",
                  "name":"Contract Group Plan Name"
               }
            ],
            "type":"REFERENCE",
            "label":"Plan",
            "fieldId":"",
            "name":"ContractGroupPlanId"
         }
      ]
   },
   "lastOffset" : "census member Id"
}

Här är exempelutdata-JSON:


{ 
   "census":{ 
      "members":[ 
         { 
            "ContractGroupPlanId":"",
            "Id":"a4C4P000000dNdbUAE",
            "LastName":member1,
            "FirstName":primary,
            "Birthdate":"1999-08-08"
         },
         { 
            "ContractGroupPlanId":"a2N4P000006ygEjUAI",
            "Id":"a4C4P000000dNdcUAE",
            "LastName":member1,
            "FirstName":dependent,
            "Birthdate":"1994-08-08"
         },
         { 
            "ContractGroupPlanId":"a2N4P000006ygEjUAI;a2N4P000006ygEiUAI",
            "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"
         },
         { 
            "type":"REFERENCE",
            "label":"Plan",
            "fieldId":"",
            "name":"ContractGroupPlanId",
             "options":[
               {
                    "value":"a2N4P000006ygEiUAI",
                    "type":"Medical",
                    "name":"rootProd",
                    "childProducts": [
                        {
                            "value": "0rgDC000000000RYAQ",
                            "IsOptional": false,
                            "name": "MandatoryCoverage"
                        },
                        {  
                            "value": "0rgDC000000000RYBQ",
                            "IsOptional": true,
                            "name": "OptionalCoverage"
                        }
                    ]
                },
                {
                    "value":"a2N4P000006ygEjUAI",
                    "type":"Dental",
                    "name":"rootProd2",
                    "childProducts": [
                        {
                            "value": "0rgDC000000000RYCQ",
                            "IsOptional": false,
                            "name": "MandatoryCoverage"
                        },
                        {
                            "value": "0rgDC000000000RYDQ",
                            "IsOptional": true,
                            "name": "OptionalCoverage"
                        }
                    ]
                }
            ]
         }
      ]
   },
   "lastOffset" : "a4C4P000000dNdeUAE"
}
 
Laddar
Salesforce Help | Article