Loading
Assicurazioni
InsCensusServiceStd:getMembersWithPlans

Ti trovi qui:

  1. Guida di Salesforce
  2. Documenti
  3. Assicurazione digitale

InsCensusServiceStd:getMembersWithPlans

Utilizzare questo servizio per recuperare l'elenco dei membri del censimento per un determinato censusId. Corrispondendo a questi membri del censimento, il servizio recupera i ContractGroupPlanIds da GroupCensusMemberPlan. Il servizio recupera anche le intestazioni in base al fieldsetName e al planFieldsetName.

Classe: InsCensusServiceStd​​

Metodo: getMembersWithPlans

Funzionamento

Questo servizio ha due funzioni chiave:

  1. Recupera l'elenco dei campi in GroupCensusMember e GroupCensusMemberPlan .

    • Il servizio utilizza il parametro ​fieldsetName per recuperare l'elenco dei campi GroupCensusMember​​. Se non è presente alcun valore, i campi vengono recuperati dall'insieme di campi predefinito. Se il valore immesso non trova alcuna corrispondenza, non viene recuperato alcun campo.

    • Il servizio utilizza il parametro planFieldsetName​ per recuperare l'elenco dei campi GroupCensusMemberPlan. Se non è presente alcun valore, vengono recuperati tutti i campi. Se il valore immesso non trova alcuna corrispondenza, non viene recuperato alcun campo.

    • Recupera i campi di relazione combinati per formare il nodo Intestazioni JSON anche se questi campi non sono inclusi nel fieldsetName. Questi campi sono: PrimaryGroupCensusMemberId, RelationshipToPrimaryMember, SourceSystemIdentifier e PrimaryMemberSource.

    • Se il parametro contractGroupPlanId ha un valore, compila l'elenco dei record delle voci di contratto con i seguenti dettagli del contratto:

      • Nome piano gruppo di contratti

      • Tipo di prodotto

      • ID dei piani del gruppo di contratti

  2. Il servizio utilizza censusId per recuperare l'elenco dei membri del censimento dai record GroupCensusMember e i piani dei gruppi di contratti da GroupCensusMemberPlan per ogni membro.

    • Se l'offset ha un valore, recupera le righe di GroupCensusMember principale (ordinate in base all'ID) dopo l'offset e quindi recupera tutti i dipendenti per questi membri principali.

    • Se è presente un valore limite, il servizio recupera le righe di GroupCensusMember principale (ordinate in base all'ID) non superiori al limite specificato. Quindi recupera tutti i dipendenti per questi membri principali. Il limite non può superare 500.

    • Se searchKey ha un valore, il servizio recupera le righe di GroupCensusMember (ordinate in base all'ID) insieme alla famiglia corrispondente, che ha searchKey come sottostringa presente nel FirstName o nel LastName. Se GroupCensusMember contiene dipendenti, il servizio recupera i membri principali corrispondenti a tali dipendenti.

    • Se memberIds ha un valore, recupera le righe GroupCensusMember (ordinate in base all'ID) il cui Id fa parte della matrice memberIds. memberIds o searchKey deve essere fornito in input.

    • Le informazioni recuperate per ogni membro si basano sui campi recuperati da GroupCensusMember e GroupCensusMemberPlan.

    • L'elenco dei membri viene inserito nel nodo members.

Comportamento del servizio

Di seguito viene descritto in che modo i diversi input influiscono sugli output del servizio.

Input Output del servizio

Nessun censusId o censusId non valido

Il servizio non recupera alcun membro del censimento.
No fieldsetName e censusId valido

Il servizio recupera:

  • Se è presente StandardFieldset, il servizio recupera l'elenco dei campi GroupCensusMember presenti in Standard Fieldset e l'elenco dei GroupCensusMember con ContractGroupPlanIds.

  • Se Insieme di campi standard non è presente, il servizio recupera l'elenco dei campi GroupCensusMember presenti in Insieme di campi tabella modificabile e recupera l'elenco dei GroupCensusMember con ContractGroupPlanIds.

  • Se StandardFieldset e Set di campi tabella modificabile non sono entrambi presenti, il servizio genera un errore.
fieldsetName validi e censusId validi Il servizio elenca i campi GroupCensusMember in base alla fieldsetName specificata e recupera l'elenco dei GroupCensusMember con ContractGroupPlanIds.
Nessun planFieldsetName fieldsetName valido e censusId valido Il servizio elenca i campi GroupCensusMember in base al campo fieldsetName, ContractGroupPlanId e Nome specificato di GroupCensusMemberPlan. Recupera l'elenco delle GroupCensusMember con ContractGroupPlanIds.
planFieldsetName fieldsetName valido e censusId valido

Il servizio recupera:

  • GroupCensusMember i campi in base al fieldsetName specificato.

  • GroupCensusMemberPlan i campi secondo la planFieldsetName specificata.

  • Elenco di GroupCensusMember con ContractGroupPlanIds.
contractId valido Il servizio recupera il nome del piano del gruppo di contratti, il tipo di prodotto, i prodotti secondari e l'ID del piano del gruppo di contratti come opzioni nel campo dell'intestazione ContractGroupPlanId.
limit valido

Il servizio recupera:

  • GroupCensusMember campi in base al fieldsetName specificato.

  • GroupCensusMemberPlan i campi secondo la planFieldsetName specificata.

  • Elenco di GroupCensusMember con ContractGroupPlanIds.

  • Il numero di GroupCensusMember principali recuperati è minore o uguale al limite.

  • Dipendenti associati al GroupCensusMember principale nell'elenco.
offset valido

Il servizio recupera:

  • GroupCensusMember i campi secondo la fieldsetName specificata.

  • GroupCensusMemberPlan i campi secondo la planFieldsetName specificata.

  • Elenco di GroupCensusMember con ContractGroupPlanIds.

  • L'ID di ogni GroupCensusMember principale recuperato è maggiore dell'offset.

  • Dipendenti associati al GroupCensusMember principale nell'elenco.
limit validi offset e validi

Il servizio recupera:

  • GroupCensusMember i campi secondo la fieldsetName specificata.

  • GroupCensusMemberPlan i campi secondo la planFieldsetName specificata.

  • Elenco di GroupCensusMember con ContractGroupPlanIds.

  • Il numero di GroupCensusMember principali recuperati è minore o uguale al limite.

  • Dipendenti associati al GroupCensusMember principale nell'elenco.

  • L'ID di ogni GroupCensusMember principale recuperato è maggiore dell'offset.
searchKey valido

Il servizio recupera:

  • GroupCensusMember i campi in base al fieldsetName specificato.

  • GroupCensusMemberPlan i campi secondo il planFieldsetName specificato

  • Elenco di GroupCensusMember con ContractGroupPlanIds.

  • Se l'elenco ha dei dipendenti, il servizio recupera i membri principali corrispondenti a questi dipendenti.

  • Tutti i membri conterranno un searchKey come sottostringa nel loro FirstName o LastName.
searchKey validi e limit validi

Il servizio recupera:

  • GroupCensusMember i campi in base al fieldsetName specificato.

  • GroupCensusMemberPlan i campi secondo la planFieldsetName specificata.

  • Elenco di GroupCensusMember con ContractGroupPlanIds.

  • Se l'elenco ha dei dipendenti, il servizio recupera i membri principali corrispondenti a questi dipendenti.

  • Tutti i membri conterranno un searchKey come sottostringa nel loro FirstName o LastName.

  • Il numero di GroupCensusMember recuperati è minore o uguale al limite specificato.

searchKey validi e offset validi

Il servizio recupera:

  • GroupCensusMember i campi secondo la fieldsetName specificata.

  • GroupCensusMemberPlan i campi secondo la planFieldsetName specificata.

  • Elenco di GroupCensusMember con ContractGroupPlanIds.

  • Se l'elenco ha dei dipendenti, il servizio recupera i membri principali corrispondenti a questi dipendenti.

  • Tutti i membri conterranno un searchKey come sottostringa nel loro FirstName o LastName.

  • L'ID di ogni GroupCensusMember recuperato è maggiore di offset.
searchKey validi, limit validi e offset validi

Il servizio recupera:

  • GroupCensusMember i campi secondo la fieldsetName specificata.

  • GroupCensusMemberPlan i campi secondo la planFieldsetName specificata.

  • Elenco di GroupCensusMember con ContractGroupPlanIds.

  • Se l'elenco ha dei dipendenti, il servizio recupera i membri principali corrispondenti a questi dipendenti.

  • Tutti i membri conterranno un searchKey come sottostringa nel loro FirstName o LastName.

  • Il numero di GroupCensusMember recuperati è minore o uguale al limite specificato.

  • L'ID di ogni GroupCensusMember recuperato è maggiore di offset.

Opzioni remote

Opzioni Descrizione

​​​censusId​​​

Obbligatorio.

ID del censimento i cui membri devono essere recuperati.

​​​contractId

Obbligatorio .

ID del contratto corrente dell'account.

Recupera il nome del piano del gruppo di contratti, il tipo di prodotto e il gruppo di contratti

​​​

fieldsetName​​​

Facoltativo.

Nome dell'insieme di campi per recuperare i campi GroupCensusMember.

Se il valore non è valido, il servizio non restituisce alcun campo.

Se non è presente alcun valore, il servizio utilizza l'insieme di campi predefinito per recuperare i campi GroupCensusMember.

​​​planFieldsetName​​​

Facoltativo.

Recupera i campi GroupCensusMemberPlan e GroupCensusMember quando è presente un valore insieme di campi del piano valido.

Non vengono restituiti campi se il valore non è valido.

Tutti i campi GroupCensusMemberPlan vengono restituiti quando non sono presenti valori.

​limit​

Optional.​

Il numero di membri del censimento da recuperare.

​​​offset​​​

Facoltativo .

ID del membro del censimento dopo il quale i membri del censimento devono essere recuperati.

​searchKey​

Stringa per cercare i record dei membri del censimento corrispondenti.

Input JSON

Questo servizio non accetta un JSON di input.

JSON di output

Il servizio restituisce un JSON di output formattato come nell'esempio seguente. L'output contiene i dettagli per i membri del censimento, dove le intestazioni sono un elenco di nomi API dei campi di GroupCensusMember e GroupCensusMemberPlan. Il nodo members restituisce l'elenco dei piani selezionati per il membro insieme al ContractGroupPlanId delimitato da ;. Il campo lastOffset mostra l'ID dell'ultimo membro del censimento recuperato. Questo valore può essere utilizzato come parametro di offset per ottenere le righe successive.

Di seguito è riportato il formato JSON di output di esempio:

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

Di seguito è riportato il JSON di output di esempio:


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