Loading
Vakuutus
InsCensusServiceStd:getMembersWithPlans

Olet tässä:

  1. Salesforce-ohje
  2. Asiakirja
  3. Digitaalinen vakuutus

InsCensusServiceStd:getMembersWithPlans

Käytä tätä palvelua noutaaksesi tietyn censusId määrityksen jäsenten luettelon. Palvelu noutaa ContractGroupPlanIds-arvon vastaavasti näiltä väestönlaskentajäseniltä GroupCensusMemberPlan:sta. Palvelu noutaa myös ylätunnisteet niiden fieldsetName ja planFieldsetName perusteella.

Luokka: InsCensusServiceStd​​

Metodi: getMembersWithPlans

Miten se toimii?

Tällä palvelulla on kaksi avaintoimintoa:

  1. Hakee GroupCensusMember- ja GroupCensusMemberPlan-kenttien luettelon.

    • Palvelu noutaa GroupCensusMember​​-kenttien luettelon parametrin ​fieldsetName avulla. Jos arvoa ei ole, kentät noudetaan oletusarvoisesta kenttäjoukosta. Jos syötetty arvo ei löydä vastaavuutta, kenttiä ei noudeta.

    • Palvelu noutaa GroupCensusMemberPlan-kenttien luettelon parametrin planFieldsetName​ avulla. Jos arvoa ei ole, kaikki kentät noudetaan. Jos syötetty arvo ei löydä vastaavuutta, kenttiä ei noudeta.

    • Hakee suhdekenttiä, jotka on yhdistetty JSON-otsikot-noodiin, vaikka näitä kenttiä ei sisällytettäisiin fieldsetName. Nämä kentät ovat: PrimaryGroupCensusMemberId, RelationshipToPrimaryMember, SourceSystemIdentifier ja PrimaryMemberSource.

    • Jos contractGroupPlanId-parametrillä on arvo, se täyttää sopimuksen rivitietueiden luettelon sopimuksen seuraavilla tiedoilla:

      • Sopimusryhmän suunnitelman nimi

      • Tuotetyyppi

      • Sopimusryhmän suunnitelmien tunnus

  2. Palvelu käyttää censusId-funktiota noutaakseen määrityksen jäsenten luettelon kunkin jäsenen GroupCensusMember-tietueista ja sopimusryhmien suunnitelmista GroupCensusMemberPlan-tietueesta.

    • Jos offset-arvolla on arvo, se noutaa ensisijaiset GroupCensusMember-rivit (tunnuksen mukaan järjestettynä) offset-arvon jälkeen ja sitten kaikki näiden ensisijaisten jäsenten sidonnaiset.

    • Jos rajoitusarvo on olemassa, palvelu noutaa Ensisijainen GroupCensusMember -rivit (järjestettynä Id-arvolla) enintään määritetyn rajoituksen perusteella. Sen jälkeen se noutaa kaikki näiden ensisijaisten jäsenten sidonnaiset. Rajoitus voi olla enintään 500.

    • Jos searchKey-arvolla on arvo, palvelu noutaa GroupCensusMember-rivit (tunnuksen mukaan järjestettynä) sekä vastaavan perheen, jonka alamerkkijonona on searchKey, joka on läsnä niiden FirstName- tai LastName-kentissä. Jos GroupCensusMember sisältää sidonnaisia, palvelu noutaa niihin vastaavat ensisijaiset jäsenet.

    • Jos memberIds sisältää arvon, se noutaa GroupCensusMember-rivit (tunnuksen mukaan järjestettynä), joiden tunnus on osa memberIds-taulukkoa. Input-arvona täytyy olla joko memberIds tai searchKey.

    • Jokaiselle jäsenelle haetut tiedot perustuvat GroupCensusMember:sta ja GroupCensusMemberPlan:sta haettuihin kenttiin.

    • Jäsenten luettelo asetetaan members-noodiin.

Palvelun toimintatapa

Katso miten eri syötteet vaikuttavat palvelutuloksiin.

Input Palvelun output

Ei censusId tai virheellinen censusId

Palvelu ei nouda mitään väestönlaskun jäsentä.
Ei fieldsetName ja käypä censusId

Palvelu noutaa:

  • Jos StandardFieldset on olemassa, palvelu ottaa vakiomuotoisessa kenttäjoukossa olevien GroupCensusMember-kenttien luettelon ja noutaa luettelon GroupCensusMember, joilla on ContractGroupPlanIds.

  • Jos vakiomuotoista kenttäjoukkoa ei ole, palvelu ottaa Muokattava taulukon kenttäjoukko -kentässä olevien GroupCensusMember-kenttien luettelon ja noutaa luettelon GroupCensusMember, joilla on ContractGroupPlanIds.

  • Jos StandardFieldset ja Muokattava taulukko -kenttäjoukot eivät ole molemmat esillä, palvelu lähettää virheen.
Kelvolliset fieldsetName ja kelvolliset censusId Palvelu luetteloi GroupCensusMember-kentät määritetyn fieldsetName mukaan ja noutaa luettelon GroupCensusMember ja ContractGroupPlanIds.
Ei planFieldsetName käypää fieldsetName ja käypä censusId Palvelu luetteloi GroupCensusMember-kentät GroupCensusMemberPlan määritetyn fieldsetName-, ContractGroupPlanId- ja Name-kentän perusteella. Se noutaa luettelon GroupCensusMember, joilla on ContractGroupPlanIds.
planFieldsetName Kelvollinen fieldsetName ja käypä censusId

Palvelu noutaa:

  • GroupCensusMember-kentät määritetyn kenttäjoukonNimen perusteella.

  • GroupCensusMemberPlan-kentät määritetyn planFieldsetName mukaan.

  • Luettelo kohteista GroupCensusMember ContractGroupPlanIds.
Kelvollinen contractId Palvelu noutaa sopimusryhmän suunnitelman nimen, tuotetyypin, alitason tuotteiden ja sopimusryhmän suunnitelman tunnuksen vaihtoehtoina ContractGroupPlanId-otsakekentässä.
Kelvollinen limit

Palvelu noutaa:

  • GroupCensusMember kentät määritetyn kenttäjoukonNimen perusteella.

  • GroupCensusMemberPlan-kentät määritetyn planFieldsetName mukaan.

  • Luettelo GroupCensusMember ja ContractGroupPlanIds.

  • Noudettujen ensisijaisten GroupCensusMember-arvojen määrä on enintään rajoitus.

  • Luettelossa ensisijaiseen GroupCensusMember liittyvät sidonnaiset.
Kelvollinen offset

Palvelu noutaa:

  • GroupCensusMember-kentät määritetyn fieldsetName mukaan.

  • GroupCensusMemberPlan-kentät määritetyn planFieldsetName mukaan.

  • Luettelo GroupCensusMember ja ContractGroupPlanIds.

  • Kunkin haetun ensisijaisen GroupCensusMember tunnus on suurempi kuin offset.

  • Luettelossa ensisijaiseen GroupCensusMember liittyvät sidonnaiset.
Kelvollinen offset ja käypä limit

Palvelu noutaa:

  • GroupCensusMember-kentät määritetyn fieldsetName mukaan.

  • GroupCensusMemberPlan-kentät määritetyn planFieldsetName mukaan.

  • Luettelo GroupCensusMember ja ContractGroupPlanIds.

  • Noudettujen ensisijaisten GroupCensusMember-arvojen määrä on enintään rajoitus.

  • Luettelossa ensisijaiseen GroupCensusMember liittyvät sidonnaiset.

  • Kunkin haetun ensisijaisen GroupCensusMember tunnus on suurempi kuin offset.
Kelvollinen searchKey

Palvelu noutaa:

  • GroupCensusMember-kentät määritetyn kenttäjoukonNimen perusteella.

  • GroupCensusMemberPlan-kentät määritetyn planFieldsetName mukaan

  • Luettelo GroupCensusMember ja ContractGroupPlanIds.

  • Jos luettelossa on sidonnaisia, palvelu noutaa näihin sidonnaisiin vastaavat ensisijaiset jäsenet.

  • Kaikki jäsenet sisältävät searchKey-merkkijonon FirstName- tai LastName-merkkijonona.
Kelvolliset searchKey ja kelvolliset limit

Palvelu noutaa:

  • GroupCensusMember-kentät määritetyn kenttäjoukonNimen perusteella.

  • GroupCensusMemberPlan-kentät määritetyn planFieldsetName mukaan.

  • Luettelo GroupCensusMember ja ContractGroupPlanIds.

  • Jos luettelossa on sidonnaisia, palvelu noutaa näihin sidonnaisiin vastaavat ensisijaiset jäsenet.

  • Kaikki jäsenet sisältävät searchKey-merkkijonon FirstName- tai LastName-merkkijonona.

  • Noudettujen GroupCensusMember määrä on pienempi tai yhtä kuin määritetty rajoitus.

Kelvolliset searchKey ja kelvolliset offset

Palvelu noutaa:

  • GroupCensusMember-kentät määritetyn fieldsetName mukaan.

  • GroupCensusMemberPlan-kentät määritetyn planFieldsetName mukaan.

  • Luettelo GroupCensusMember ja ContractGroupPlanIds.

  • Jos luettelossa on sidonnaisia, palvelu noutaa näihin sidonnaisiin vastaavat ensisijaiset jäsenet.

  • Kaikki jäsenet sisältävät searchKey-merkkijonon FirstName- tai LastName-merkkijonona.

  • Jokaisen noudetun GroupCensusMember tunnus on suurempi kuin offset.
Kelvolliset searchKey, kelvolliset limit ja kelvolliset offset

Palvelu noutaa:

  • GroupCensusMember-kentät määritetyn fieldsetName mukaan.

  • GroupCensusMemberPlan-kentät määritetyn planFieldsetName mukaan.

  • Luettelo GroupCensusMember ja ContractGroupPlanIds.

  • Jos luettelossa on sidonnaisia, palvelu noutaa näihin sidonnaisiin vastaavat ensisijaiset jäsenet.

  • Kaikki jäsenet sisältävät searchKey-merkkijonon FirstName- tai LastName-merkkijonona.

  • Noudettujen GroupCensusMember määrä on pienempi tai yhtä kuin määritetty rajoitus.

  • Jokaisen noudetun GroupCensusMember tunnus on suurempi kuin offset.

Etäasetukset

Vaihtoehdot Kuvaus

​​​censusId​​​

Pakollinen.

Sen väestönlaskun tunnus, jonka jäseniä täytyy hakea.

​​​contractId

Pakollinen .

Tilin tämänhetkisen sopimuksen tunnus.

Hakee sopimusryhmän suunnitelman nimen, tuotetyypin ja sopimusryhmän

​​​

fieldsetName​​​

Valinnainen.

GroupCensusMember-kenttien noutamiseen käytetyn kenttäjoukon nimi.

Jos arvo on virheellinen, palvelu ei palauta kenttiä.

Jos arvoa ei ole, palvelu käyttää oletusarvoista kenttäjoukkoa noutaakseen GroupCensusMember-kenttiä.

​​​planFieldsetName​​​

Valinnainen.

Hakee GroupCensusMemberPlan- ja GroupCensusMember-kentät, kun suunnitelman kenttäjoukon arvo on käypä.

Kenttiä ei palauteta, jos arvo ei ole käypä.

Kaikki GroupCensusMemberPlan-kentät palautetaan, kun arvoa ei ole.

​limit​

Valinnainen.

Noudettavien väestönlaskentajäsenien määrä.

​​​offset​​​

Valinnainen .

Rekisteröinnin jäsenen tunnus, jonka jälkeen rekisteröinnin jäsenet täytyy hakea.

​searchKey​

Merkkijono, joka hakee vastaavia väestönlaskentajäsenen tietueita.

Syötetty JSON

Tämä palvelu ei ota syötettyä JSON-tiedostoa.

Tulos-JSON

Palvelu palauttaa tuloksen JSON-tiedoston, joka on muotoiltu alla olevan esimerkin mukaisesti. Tuloksessa on lisätietoja väestönlaskennan jäsenille, joiden otsikot ovat luettelo GroupCensusMember- ja GroupCensusMemberPlan-kenttien API-nimistä. members-noodi palauttaa jäsenelle valittujen suunnitelmien luettelon sekä ContractGroupPlanId-arvon ;. lastOffset-kentässä näytetään viimeksi noudetun väestönlaskentajäsenen tunnus. Tätä arvoa voidaan käyttää offset-parametrinä seuraavien rivien noutamiseen.

Alla on esimerkki tuloksen JSON-muodosta:

{ 
   "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"
}

Alla on esimerkki tuloksen JSON-tiedostosta:


{ 
   "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"
}
 
Ladataan
Salesforce Help | Article