Loading
Seguro
InsCensusServiceStd:getMembersWithPlans

Usted está aquí:

  1. Ayuda de Salesforce
  2. Documentos
  3. Seguro digital

InsCensusServiceStd:getMembersWithPlans

Utilice este servicio para recuperar la lista de miembros del censo para un censusId concreto. Correspondiente a estos miembros del censo, el servicio recupera el ContractGroupPlanIds de GroupCensusMemberPlan. El servicio también recupera encabezados basándose en la fieldsetName y la planFieldsetName.

Clase: InsCensusServiceStd​​

Método: getMembersWithPlans

Funcionamiento

Este servicio tiene dos funciones clave:

  1. Recupera la lista de campos en GroupCensusMember y GroupCensusMemberPlan .

    • El servicio utiliza el parámetro ​fieldsetName para recuperar la lista de campos de GroupCensusMember​​. Si no hay ningún valor, los campos se recuperan del conjunto de campos predeterminado. Si el valor ingresado no encuentra una coincidencia, no se recupera ningún campo.

    • El servicio utiliza el parámetro planFieldsetName​ para recuperar la lista de campos de GroupCensusMemberPlan. Si no hay ningún valor, se recuperan todos los campos. Si el valor ingresado no encuentra una coincidencia, no se recupera ningún campo.

    • Recupera campos de relaciones que se combinan para formar el nodo de encabezados JSON incluso si estos campos no están incluidos en el fieldsetName. Estos campos son: PrimaryGroupCensusMemberId, RelationshipToPrimaryMember, SourceSystemIdentifier y PrimaryMemberSource.

    • Si el parámetro contractGroupPlanId tiene valor, rellena la lista de registros de partidas de contrato con los siguientes detalles del contrato:

      • Nombre de plan de grupo de contratos

      • Tipo de producto

      • Id. de los planes de grupo de contratos

  2. El servicio utiliza censusId para recuperar la lista de miembros del censo desde registros de GroupCensusMember y planes de grupos de contratos desde GroupCensusMemberPlan para cada miembro.

    • Si la compensación tiene valor, recupera filas de GroupCensusMember principal (ordenadas por Id.) después de la compensación y luego recupera todos los dependientes para estos Miembros principales.

    • Si hay un valor límite, el servicio recupera las filas de GroupCensusMember principal (ordenadas por Id.) no superiores al límite especificado. A continuación recupera todos los dependientes para estos Miembros principales. El límite no puede ser superior a 500.

    • Si searchKey tiene valor, el servicio recupera filas de GroupCensusMember (ordenadas por Id.) junto con la familia correspondiente, que tiene searchKey como una subcadena presente en sus FirstName o LastName. Si GroupCensusMember contiene dependientes, el servicio recupera miembros principales correspondientes a esos dependientes.

    • Si memberIds tiene un valor, recupera filas de GroupCensusMember (ordenadas por Id.) cuyo Id. forma parte de la matriz memberIds. Debe proporcionarse memberIds o searchKey en la entrada.

    • La información recuperada para cada miembro se basa en los campos recuperados de GroupCensusMember y GroupCensusMemberPlan.

    • La lista de miembros se coloca en el nodo members.

Comportamiento de servicio

Comprenda cómo afectan las diferentes entradas a los resultados del servicio.

Entrada Salida de servicio

Sin censusId ni censusId no válidos

El servicio no recupera ningún miembro del censo.
censusId no fieldsetName y válido

El servicio recupera:

  • Si StandardFieldset está presente, el servicio toma la lista de campos de GroupCensusMember presentes en Conjunto de campos estándar y recupera la lista de GroupCensusMember con ContractGroupPlanIds.

  • Si Conjunto de campos estándar no está presente, el servicio toma la lista de campos de GroupCensusMember presentes en Conjunto de campos de tabla modificable y recupera la lista de GroupCensusMember con ContractGroupPlanIds.

  • Si StandardFieldset y Conjunto de campos de tabla modificable no están presentes, el servicio arroja un error.
fieldsetName válidos y censusId válidos El servicio enumera campos de GroupCensusMember según la fieldsetName especificada y recupera la lista de GroupCensusMember con ContractGroupPlanIds.
Sin fieldsetName planFieldsetName válido y censusId válido El servicio enumera campos de GroupCensusMember según el campo fieldsetName, ContractGroupPlanId y Nombre especificado de GroupCensusMemberPlan. Recupera la lista de GroupCensusMember con ContractGroupPlanIds.
planFieldsetName fieldsetName válidos y censusId válidos

El servicio recupera:

  • Campos de GroupCensusMember según el fieldsetName especificado.

  • Campos de GroupCensusMemberPlan según la planFieldsetName especificada.

  • Lista de GroupCensusMember con ContractGroupPlanIds.
contractId válido El servicio recupera el nombre del plan del grupo de contratos, el tipo de producto, los productos secundarios y el Id. del plan del grupo de contratos como opciones en el campo de encabezado de ContractGroupPlanId.
limit válido

El servicio recupera:

  • GroupCensusMember campos según el fieldsetName especificado.

  • Campos de GroupCensusMemberPlan según la planFieldsetName especificada.

  • Lista de GroupCensusMember con ContractGroupPlanIds.

  • El número de GroupCensusMember principales recuperados es inferior o igual al límite.

  • Dependientes asociados con el GroupCensusMember principal de la lista.
offset válido

El servicio recupera:

  • Campos de GroupCensusMember según la fieldsetName especificada.

  • Campos de GroupCensusMemberPlan según la planFieldsetName especificada.

  • Lista de GroupCensusMember con ContractGroupPlanIds.

  • El Id. de cada GroupCensusMember principal recuperado es superior a la compensación.

  • Dependientes asociados con el GroupCensusMember principal de la lista.
limit válido offset y válido

El servicio recupera:

  • Campos de GroupCensusMember según la fieldsetName especificada.

  • Campos de GroupCensusMemberPlan según la planFieldsetName especificada.

  • Lista de GroupCensusMember con ContractGroupPlanIds.

  • El número de GroupCensusMember principales recuperados es inferior o igual al límite.

  • Dependientes asociados con el GroupCensusMember principal de la lista.

  • El Id. de cada GroupCensusMember principal recuperado es superior a la compensación.
searchKey válido

El servicio recupera:

  • Campos de GroupCensusMember según el fieldsetName especificado.

  • Campos de GroupCensusMemberPlan según la planFieldsetName especificada

  • Lista de GroupCensusMember con ContractGroupPlanIds.

  • Si la lista tiene dependientes, el servicio recupera miembros principales correspondientes a estos dependientes.

  • Todos los miembros contendrán una searchKey como subcadena en sus FirstName o LastName.
searchKey válidos y limit válidos

El servicio recupera:

  • Campos de GroupCensusMember según el fieldsetName especificado.

  • Campos de GroupCensusMemberPlan según la planFieldsetName especificada.

  • Lista de GroupCensusMember con ContractGroupPlanIds.

  • Si la lista tiene dependientes, el servicio recupera miembros principales correspondientes a estos dependientes.

  • Todos los miembros contendrán una searchKey como subcadena en sus FirstName o LastName.

  • El número de GroupCensusMember recuperados es inferior o igual al límite especificado.

searchKey válidos y offset válidos

El servicio recupera:

  • Campos de GroupCensusMember según la fieldsetName especificada.

  • Campos de GroupCensusMemberPlan según la planFieldsetName especificada.

  • Lista de GroupCensusMember con ContractGroupPlanIds.

  • Si la lista tiene dependientes, el servicio recupera miembros principales correspondientes a estos dependientes.

  • Todos los miembros contendrán una searchKey como subcadena en sus FirstName o LastName.

  • El Id. de cada GroupCensusMember recuperado es superior a la compensación.
searchKey válidos, limit válidos y offset válidos

El servicio recupera:

  • Campos de GroupCensusMember según la fieldsetName especificada.

  • Campos de GroupCensusMemberPlan según la planFieldsetName especificada.

  • Lista de GroupCensusMember con ContractGroupPlanIds.

  • Si la lista tiene dependientes, el servicio recupera miembros principales correspondientes a estos dependientes.

  • Todos los miembros contendrán una searchKey como subcadena en sus FirstName o LastName.

  • El número de GroupCensusMember recuperados es inferior o igual al límite especificado.

  • El Id. de cada GroupCensusMember recuperado es superior a la compensación.

Opciones remotas

Opciones Descripción

​​​censusId​​​

Requerido.

Id. del censo cuyos miembros deben recuperarse.

​​​contractId

Obligatorio.

Id. del contrato actual de la cuenta.

Recupera el nombre del plan del grupo de contratos, el tipo de producto y el grupo de contratos

​​​

fieldsetName​​​

Opcional.

Nombre del conjunto de campos para recuperar los campos GroupCensusMember.

Si el valor no es válido, el servicio no devuelve campos.

Si no hay ningún valor, el servicio utiliza el campo predeterminado establecido para recuperar campos GroupCensusMember.

​​​planFieldsetName​​​

Opcional.

Recupera los campos GroupCensusMemberPlan y GroupCensusMember cuando hay un valor de conjunto de campos de plan válido.

No se devuelven campos si el valor no es válido.

Todos los campos GroupCensusMemberPlan se devuelven cuando no hay valor.

​limit​

Opcional.

El número de miembros del censo a recuperar.

​​​offset​​​

Opcional .

El Id. del miembro del censo después del cual se deben recuperar los miembros del censo.

​searchKey​

Cadena para buscar registros de miembros del censo coincidentes.

JSON de entrada

Este servicio no toma un JSON de entrada.

JSON de salida

El servicio devuelve un JSON de salida con formato según el siguiente ejemplo. El resultado tiene detalles para los miembros en el censo, donde encabezados es una lista de nombres de API de campo de GroupCensusMember y GroupCensusMemberPlan. El nodo members devuelve la lista de planes seleccionados para el miembro junto con ContractGroupPlanId delimitado por ;. El campo lastOffset muestra el Id. del último miembro del censo que se recupera. Este valor se puede utilizar como el parámetro offset para obtener las siguientes filas.

Este es el formato JSON de salida de muestra:

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

Este es el JSON de salida de muestra:


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