Ti trovi qui:
InsCensusServiceStd:getMembers
Utilizzare questo servizio per recuperare i membri di un censimento dal GroupCensusMember. Recupera anche le intestazioni in base al fieldsetName.
Classe: InsCensusServiceStd
Metodo: getMembers
Il servizio accetta input in questo formato.
| censusId | fieldsetName | Offset | limite | searchKey |
|---|---|---|---|---|
| c101 | test_fieldset | cmember101 | intero | prefix |
Il servizio utilizza i valori di input per generare output adatti al modello di prodotto.
| censimento | lastOffSet | |
|---|---|---|
| headers | membri | ID dell'ultimo membro del censimento |
| Elenco di campi | Elenco dei membri | |
Funzionamento
Questo servizio ha due funzioni chiave:
-
Recupera l'elenco dei campi e delle intestazioni
GroupCensusMemberin base alfieldetName. L'output contiene semprePrimaryGroupCensusMemberId,RelationshipToPrimaryMember,SourceSystemIdentifierePrimaryMemberSourceanche se questi campi non sono inclusi nelfieldsetName. - Il servizio utilizza
censusIdper recuperare l'elenco dei membri del censimento dai recordGroupCensusMember.- Se l'offset ha un valore, recupera le righe di
GroupCensusMemberprincipale (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
GroupCensusMemberprincipale (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
searchKeyha un valore, il servizio recupera le righe diGroupCensusMember(ordinate in base all'ID) insieme alla famiglia corrispondente, che hannosearchKeycome sottostringa presente nel loroFirstNameoLastName.Se
memberIdsha un valore, recupera le righeGroupCensusMember(ordinate in base all'ID) il cui Id fa parte della matricememberIds.memberIdsosearchKeydeve essere fornito in input.Se
withPlansè impostato sutrue, il servizio recupera un elenco dei piani selezionati per ogni membro. IContractGroupPlanIdvalidi per ogni membro sono delimitati da un punto e virgola e restituiti come stringa.Le informazioni recuperate per ogni membro si basano sui campi recuperati da
GroupCensusMember.L'elenco dei membri viene inserito nel nodo
members.
- Se l'offset ha un valore, recupera le righe di
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 |
|
fieldsetName validi e censusId validi |
Il servizio recupera l'elenco dei campi GroupCensusMember presenti nell'insieme di campi specificato e l'elenco dei GroupCensusMember. |
limit valido |
Il servizio recupera l'elenco delle |
offset valido |
Il servizio recupera l'elenco dei
|
limit validi offset e validi |
Il servizio recupera l'elenco dei campi
|
searchKey valido |
Il servizio recupera l'elenco dei campi |
searchKey validi e limit validi |
Il servizio recupera l'elenco dei campi |
offset validi searchKey e validi |
Il servizio recupera l'elenco dei campi |
searchKey validi, limit validi e offset validi |
Il servizio recupera l'elenco dei campi
|
Opzioni remote
| Opzioni | Descrizione |
|---|---|
|
Obbligatorio. ID del censimento i cui membri devono essere recuperati. |
|
Facoltativo. Nome dell'insieme di campi per recuperare i campi 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 |
|
Optional. Il numero di membri del censimento da recuperare. |
|
Facoltativo . ID del membro del censimento dopo il quale i membri del censimento devono essere recuperati. |
|
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 con un elenco di campi, un elenco di membri e un valore di 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"
}