Loading
Seguro
InsCensusServiceStd:getMembers

InsCensusServiceStd:getMembers

Utilice este servicio para recuperar los miembros de un censo desde el GroupCensusMember. También recupera los encabezados basándose en el fieldsetName.

Clase: InsCensusServiceStd​

Método: getMembers

El servicio acepta entradas en este formato.

censusId fieldsetName Compensación límite searchKey
c101 test_fieldset cmember101 entero prefijo

El servicio utiliza valores de entrada para generar resultados que se ajustan a su modelo de producto.

censo lastOffSet
headers miembros Id. del último miembro del censo
Lista de campos Lista de miembros

Funcionamiento

Este servicio tiene dos funciones clave:

  1. Recupera la lista de campos de GroupCensusMember y encabezados basándose en el fieldetName. El resultado siempre tiene PrimaryGroupCensusMemberId, RelationshipToPrimaryMember, SourceSystemIdentifier y PrimaryMemberSource incluso si estos campos no están incluidos en el fieldsetName.

  2. El servicio utiliza ​censusId para recuperar la lista de miembros del censo desde registros de GroupCensusMember​​.
    1. 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.
    2. 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.

    3. 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.

    4. 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.

    5. Si withPlans está establecido como true, el servicio recupera una lista de planes seleccionados para cada miembro. Los ContractGroupPlanId válidos para cada miembro están delimitados por punto y coma y se devuelven como una cadena.

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

    7. 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 o censusId no válidos El servicio no recupera ningún miembro del censo.
No fieldsetName y censusId válido
  • Si el StandardFieldset está presente, el servicio lo toma como el conjunto de campos predeterminado y recupera la lista de GroupCensusMember.
  • Si StandardFieldset no está presente, el servicio consume lista de campos de GroupCensusMember presentes en Conjunto de campos de tabla modificable y recupera la lista de GroupCensusMember.
  • 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 recupera la lista de campos de GroupCensusMember presentes en el conjunto de campos concreto y la lista de GroupCensusMember.
limit válido

El servicio recupera la lista de GroupCensusMember dentro del límite especificado. Esta lista también incluye dependientes asociados con los miembros principales.

offset válido

El servicio recupera la lista de GroupCensusMember. Esta lista también incluye dependientes asociados con los miembros principales.

  • El Id. de cada GroupCensusMember principal recuperado es mayor que la compensación.
limit válido offset y válido

El servicio recupera la lista de campos de GroupCensusMember presentes en el conjunto de campos concreto y la lista de GroupCensusMember.

  • El Id. de cada GroupCensusMember principal recuperado es mayor que la compensación.
  • El número de GroupCensusMember principales recuperados es inferior o igual al límite especificado.
  • Recupera dependientes asociados con el GroupCensusMember principal de la lista.

searchKey válido

El servicio recupera la lista de campos de GroupCensusMember presentes en el conjunto de campos concreto y la lista de GroupCensusMember. Si la lista tiene dependientes, el servicio recupera miembros principales correspondientes a estos dependientes. Todos los miembros contendrán searchKey como subcadena en sus FirstName o LastName.

searchKey válidos y limit válidos

El servicio recupera la lista de campos de GroupCensusMember presentes en el conjunto de campos concreto y la lista de GroupCensusMember. Si la lista tiene dependientes, el servicio también recupera miembros principales correspondientes a estos dependientes. Todos los miembros contendrán searchKey como subcadena en sus FirstName o LastName. El número de GroupCensusMember recuperados no será superior al límite.

offset válido searchKey y válido

El servicio recupera la lista de campos de GroupCensusMember presentes en el conjunto de campos concreto y la lista de GroupCensusMember. Si la lista tiene dependientes, el servicio también recupera miembros principales correspondientes a estos dependientes. Todos los miembros contendrán searchKey como subcadena en sus FirstName o LastName. Id. de cada GroupCensusMember recuperado es mayor que compensación.

searchKey válidos, limit válidos y offset válidos

El servicio recupera la lista de campos de GroupCensusMember presentes en el conjunto de campos concreto y la lista de GroupCensusMember.

  • Todos los miembros contendrán searchKey como subcadena en sus FirstName o LastName.
  • El Id. de cada GroupCensusMember recuperado es mayor que la compensación.
  • El número de GroupCensusMember recuperados es inferior o igual al límite.
  • Si la lista tiene dependientes, el servicio también recupera miembros principales correspondientes a estos dependientes.

Opciones remotas

Opciones Descripción

​​​censusId​​​

Requerido.

Id. del censo cuyos miembros deben recuperarse.

​​​

fieldsetName​​​

Opcional.

Nombre del conjunto de campos para recuperar los campos de GroupCensusMember​​.

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

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

​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​

Una 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 una lista de campos, una lista de miembros y un valor 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"
}
 
Cargando
Salesforce Help | Article