Usted está aquí:
InsCensusServiceStd:updateMembers
Utilice este servicio para actualizar los valores de miembros existentes en un censo.
Clase: InsCensusServiceStd
Método: updateMembers
Funcionamiento
-
Este servicio toma los miembros de un JSON de entrada y actualiza el censo (según el
censusIdconcreto) con los nuevos datos. -
JSON de censo consta de dos listas:
headersymembers.-
headerses la lista de metadatos de campos compuesta defieldId,type,labelyname. Aquí el nombre es el Nombre de API del campo (con el espacio de nombres para paquetes gestionados y campos personalizados). -
memberses la lista de miembros que se deben actualizar en el censo.
-
-
El servicio busca el campo
updateById. Es un campo booleano que decide el curso de acción para el servicio. Los miembros se pueden actualizar de dos formas:-
updateMembersporMemberKeyEsta opción es aplicable cuando la
updateByIdes falsa. Los datos de miembros deben tener una clave de miembro. -
updateMemberspor Id. deGroupCensusMemberEsta opción es aplicable cuando
updateByIdes verdadero. Los datos de miembros deben tener un Id. de miembro del censo de grupo.
-
updateMembers por MemberKey
-
El servicio analiza los datos de los miembros con los campos proporcionados en
headers. Losheadersdeben contener todos los metadatos de los campos utilizados en la lista de miembros. -
El servicio separa miembros principales y miembros dependientes basándose en
RelationshipToPrimaryMember.-
Si la lista de miembros contiene miembros principales y dependientes, la entrada debe tener
SourceSystemIdentifierpara todos los miembros. Todos los miembros deben tener unSourceSystemIdentifierexclusivo. Además, todos los dependientes deben tenerPrimaryMemberSourceoPrimaryGroupCensusMemberId(si el miembro principal ya está presente en el censo). -
Si la lista es una combinación de miembros principales y dependientes, asegúrese de que cada miembro dependiente y miembro principal existe en la lista de miembros.
-
-
El servicio procesa nuevos
GroupClass. Si el servicio tieneGroupClass.Nameen vez deGroupClassId, obtieneGroupClasscon el nombre y crea un nuevoGroupClasscon el mismo nombre si no se encuentra.- Si el servicio tiene
GroupClass.Name, incluya tambiénAccountIden los datos de los miembros. -
headerparaGroupClass.Name:{"type":"STRING","label":"Group Class Name","fieldId":"","name":"GroupClass.Name"}. -
Si el
GroupClass.Nameconcreto no es válido, se devuelve un error. El servicio toma un nuevo parámetroquoteEffectiveDatepara validarGroupClass. ElGroupClassse considera válido si:-
GroupClassestá vinculado a la cuenta de grupo del miembro. -
La
quoteEffectiveDatese encuentra entreStartDatedeGroupClassyEndDate. Si no se proporcionaquoteEffectiveDatecomo un parámetro para el servicio, se omite esta validación.
-
- Si el servicio tiene
-
Los servicios procesan
PrimaryMemberSourcepara dependientes conPrimaryGroupCensusMemberId.-
Si el servicio tiene
PrimaryMemberSourceyPrimaryGroupCensusMemberId, el servicio consideraPrimaryGroupCensusMemberIdcomo origen y actualizaPrimaryMemberSourcede dependiente para incluirSourceSystemIdentifierde principal.
-
-
El servicio guarda todos los miembros principales primero.
-
Analiza dependientes para identificar dependientes huérfanos (Dependientes sin
PrimaryMemberSource). -
Guarda todos los dependientes válidos.
-
El servicio actualiza los
DependentCountde todos los miembros principales de la lista de miembros.
updateMiembros por Id.
-
El servicio analiza los datos de los miembros con los campos proporcionados en
headers. Losheadersdeben contener todos los metadatos de los campos utilizados en la lista de miembros. -
Los datos de
membersdeben tener Id. Si el Id. no se encuentra en los datos de miembros, el servicio arroja un error. -
El servicio procesa nuevos
GroupClass. Si el servicio tieneGroupClass.Nameen vez deGroupClassId, obtieneGroupClasscon el nombre y crea un nuevoGroupClasscon el mismo nombre si no se encuentra.- Si el servicio tiene
GroupClass.Name, incluya tambiénAccountIden los datos de los miembros. -
headerparaGroupClass.Name:{"type":"STRING","label":"Group Class Name","fieldId":"","name":"GroupClass.Name"}.
- Si el servicio tiene
-
El servicio procesa
PrimaryGroupCensusMemberIdpara dependientes conPrimaryMemberSource.- Si proporciona
PrimaryMemberSource, el servicio también actualizaPrimaryGroupCensusMemberId.
- Si proporciona
-
Los servicios procesan
PrimaryMemberSourcepara dependientes conPrimaryGroupCensusMemberId.-
Si el servicio tiene
PrimaryMemberSourceyPrimaryGroupCensusMemberId, el servicio consideraPrimaryGroupCensusMemberIdcomo origen y actualizaPrimaryMemberSourcede dependiente para incluirSourceSystemIdentifierde principal.
-
-
El servicio guarda todos los miembros, incluidos los dependientes.
-
El servicio no identifica dependientes huérfanos.
-
El servicio actualiza los
DependentCountde todos los miembros principales de la lista de miembros.
Opciones remotas
Opción |
Descripción |
|---|---|
|
Obligatorio. Id. del censo con miembros para actualizar. |
|
Obligatorio. Ingrese JSON con detalles para que los miembros se actualicen. |
updateById
|
Opcional Si se establece true, el servicio sigue el flujo El valor predeterminado es falso. |
Comportamiento de servicio
Comprenda cómo afectan las diferentes entradas a los resultados del servicio.
| Entrada | updateById | Salida de servicio |
|---|---|---|
No censusId |
true o false | El servicio devuelve un error: |
| JSON sin entrada de censo | true o false | El servicio devuelve un error: The census input is missing. |
El valor de PrimaryMemberSource proporcionado al miembro principal |
false | El servicio devuelve un error: The PrimaryMemberSource must be null for primary members. |
Falta headers en el censo de entradas |
true o false | El servicio devuelve un error: The header node is missing in the census input. |
Falta members en el censo de entradas |
true o false | El servicio devuelve un error: The members node is missing in the census input. |
| Para dependientes huérfanos (Los dependientes sin PrimaryMemberSource o PrimaryGroupCensusMemberId) | false | El servicio devuelve un error: Dependent has no primary member. |
| Falta el Id. en los datos de los miembros | true | El servicio devuelve un error: Specify Id of the census member. |
JSON de entrada
El JSON de entrada incluye headers, que enumera los campos a actualizar; y members, que enumera miembros con sus pares campo-valor correspondientes, incluyendo fieldId.
JSON de entrada de muestra (updateMembers By MemberKey)
{
"census": {
"headers": [
{
"type": "STRING",
"label": "Last Name",
"fieldId": "",
"name": "Lastname"
},
{
"type": "STRING",
"label": "First Name",
"fieldId": "",
"name": "FirstName"
},
{
"type": "DOUBLE",
"label": "FTE",
"fieldId": "",
"name": "FullTimeEquivalent"
},
{
"type": "PICKLIST",
"label": "Gender",
"fieldId": "",
"name": "Gender"
},
{
"type": "DATE",
"label": "Birthday",
"fieldId": "",
"name": "Birthdate"
},
{
"type": "PICKLIST",
"label": "Relationship To Primary",
"fieldId": "",
"name": "RelationshipToPrimaryMember"
},
{
"type": "BOOLEAN",
"label": "Is Opt-out All Plans",
"fieldId": "",
"name": "IsOptOutAllPlans"
},
{
"type": "MULTIPICKLIST",
"label": "Opt-Out Plan Types",
"fieldId": "",
"name": "OptOutPlanTypes"
},
{
"type": "ENTITYID",
"label": "Account",
"fieldId": "",
"name": "AccountId"
},
{
"type": "EMAIL",
"label": "Email",
"fieldId": "",
"name": "Email"
},
{
"type": "STRING",
"label": "Primary Member Identifier",
"fieldId": "",
"name": "PrimaryMemberSource"
},
{
"type": "STRING",
"label": "Member Identifier",
"fieldId": "",
"name": "SourceSystemIdentifier"
}
],
"members": [
{
"MemberKey": "cd64a62573825ee11b87ce91110aa576",
"Lastname": "KoffinsUpdated",
"FirstName": "RajUpdated",
"FullTimeEquivalent": 1,
"Gender": "Male",
"Birthdate": "1965-10-13",
"SourceSystemIdentifier": "1.primary",
"PrimaryMemberSource": null,
"Email": "testrajUpdated@mail.com"
},
{
"MemberKey": "f2f8735bbb66b3f7d7b2bae794c00650",
"Lastname": "Koffins",
"FirstName": "KrisUpdated",
"Gender": "Male",
"Birthdate": "2010-05-13",
"RelationshipToPrimaryMember": "Child",
"SourceSystemIdentifier": "1.child",
"PrimaryMemberSource": "1.primary",
"Email": "testkrisUpdated@mail.com"
},
{
"Lastname": "WarnerUpdated",
"MemberKey": "5a5bc4e3c05cf461a65a2d7fdc0ab8e0",
"FirstName": "Christopher",
"FullTimeEquivalent": 0.75,
"Gender": "Male",
"Birthdate": "1985-10-13",
"SourceSystemIdentifier": "2.primary",
"PrimaryMemberSource": null,
"Email": "testchristopherUpdated@mail.com"
},
{
"Lastname": "WarnerUpdated",
"MemberKey": "157b2052fc732d8261984c2922a3261b",
"FirstName": "Steph",
"Gender": "Male",
"Birthdate": "1985-10-13",
"RelationshipToPrimaryMember": "Spouse",
"SourceSystemIdentifier": "2.spouse",
"PrimaryMemberSource": "2.primary",
"Email": "teststephUpdated.com"
}
]
}
}JSON de entrada de muestra (updateMembers By Id)
{
"census": {
"headers": [
{
"type": "STRING",
"label": "Last Name",
"fieldId": "",
"name": "Lastname"
},
{
"type": "STRING",
"label": "First Name",
"fieldId": "",
"name": "FirstName"
},
{
"type": "DOUBLE",
"label": "FTE",
"fieldId": "",
"name": "FullTimeEquivalent"
},
{
"type": "PICKLIST",
"label": "Gender",
"fieldId": "",
"name": "Gender"
},
{
"type": "DATE",
"label": "Birthday",
"fieldId": "",
"name": "Birthdate"
},
{
"type": "PICKLIST",
"label": "Relationship To Primary",
"fieldId": "",
"name": "RelationshipToPrimaryMember"
},
{
"type": "BOOLEAN",
"label": "Is Opt-out All Plans",
"fieldId": "",
"name": "IsOptOutAllPlans"
},
{
"type": "MULTIPICKLIST",
"label": "Opt-Out Plan Types",
"fieldId": "",
"name": "OptOutPlanTypes"
},
{
"type": "ENTITYID",
"label": "Account",
"fieldId": "",
"name": "AccountId"
},
{
"type": "EMAIL",
"label": "Email",
"fieldId": "",
"name": "Email"
},
{
"type": "STRING",
"label": "Primary Member Identifier",
"fieldId": "",
"name": "PrimaryMemberSource"
},
{
"type": "STRING",
"label": "Member Identifier",
"fieldId": "",
"name": "SourceSystemIdentifier"
}
],
"members": [
{
"Id":"0r6RO00000005pZYAQ",
"Lastname": "KoffinsUpdatedById",
"FirstName": "RajUpdatedById",
"Birthdate": "1965-10-13",
"Email": "testrajUpdated@mail.com"
},
{
"Id":"0r6RO00000005pbYAA",
"Lastname": "Koffins",
"FirstName": "KrisUpdatedById",
"Gender": "Male",
"Birthdate": "2010-05-13",
"RelationshipToPrimaryMember": "Child",
"Email": "testkrisUpdatedById@mail.com"
},
{
"Id":"0r6RO00000005paYAA",
"Lastname": "WarnerUpdatedById",
"FirstName": "Christopher",
"FullTimeEquivalent": 0.75,
"Gender": "Male",
"Birthdate": "1985-10-13",
"Email": "testchristopherUpdatedById@mail.com"
},
{
"Lastname": "WarnerUpdatedById",
"FirstName": "Steph",
"Birthdate": "1985-10-13",
"Email": "teststephUpdated.com"
}
]
}
}
JSON de salida
El servicio devuelve un mensaje de operación correcta si se completa el flujo, de lo contrario devuelve el error en caso de cualquier excepción.
-
censusMemberIds: La lista deGroupCensusMemberIdsde miembros guardados. -
errores: La lista de miembros con errores. Cada elemento de lista consta de datos de miembros de entrada y error.
-
relatedFieldsUpdateSuccessCount: Número de miembros principales para los que se actualiza elDependentCountpor servicio. -
relatedFieldsUpdateErrorCount: Número de miembros principales para los que la actualización deDependentCountdevuelve errores. -
relatedFieldsUpdateErrors: La lista de errores devueltos al actualizarDependentCountde miembros principales.
JSON de salida de muestra (updateMembers By MemberKey)
{
"result": "success",
"relatedFieldsUpdateErrors": [],
"relatedFieldsUpdateErrorCount": 0,
"relatedFieldsUpdateSuccessCount": 2,
"errors": [
{
"error": "[Email]: INVALID_EMAIL_ADDRESS - Email: invalid email address: teststephUpdated.com",
"Birthdate": "1985-10-13",
"Gender": "Male",
"Lastname": "WarnerUpdated",
"RelationshipToPrimaryMember": "Spouse",
"MemberKey": "157b2052fc732d8261984c2922a3261b",
"SourceSystemIdentifier": "2.spouse",
"FirstName": "Steph",
"Email": "teststephUpdated.com",
"PrimaryMemberSource": "2.primary"
}
],
"censusMemberIds": [
"0r6RO00000005pZYAQ",
"0r6RO00000005paYAA",
"0r6RO00000005pbYAA"
],
"deletedCensusMemberIds": [],
"errorCode": "INVOKE-200",
"error": "OK"
}JSON de salida de muestra - (updateMembers By Id)
{
"result": "success",
"relatedFieldsUpdateErrors": [],
"relatedFieldsUpdateErrorCount": 0,
"relatedFieldsUpdateSuccessCount": 2,
"errors": [
{
"error": "Specify Id of the census member.",
"Birthdate": "1985-10-13",
"Lastname": "WarnerUpdatedById",
"FirstName": "Steph",
"Email": "teststephUpdated.com"
}
],
"censusMemberIds": [
"0r6RO00000005pZYAQ",
"0r6RO00000005pbYAA",
"0r6RO00000005paYAA"
],
"errorCode": "INVOKE-200",
"error": "OK"
}