breadcrumbDescription
InsCensusServiceStd:getMembersWithPlans
Brug denne tjeneste til at hente listen over folketællingsmedlemmer for en given censusId. I forhold til disse folketællingsmedlemmer henter tjenesten ContractGroupPlanIds fra GroupCensusMemberPlan. Tjenesten henter også sidehoveder baseret på fieldsetName og planFieldsetName.
Kategori: InsCensusServiceStd
Metode: getMembersWithPlans
Sådan fungerer det
Denne tjeneste har to nøglefunktioner:
- Henter listen over felter i
GroupCensusMemberogGroupCensusMemberPlan.Tjenesten bruger parameteren
fieldsetNametil at hente listen overGroupCensusMemberfelter. Hvis der ikke er nogen værdi, hentes felter fra standardfeltsættet. Hvis den angivne værdi ikke finder et match, hentes der ingen felter.Tjenesten bruger parameteren
planFieldsetNametil at hente listen overGroupCensusMemberPlanfelter. Hvis der ikke er nogen værdi, hentes alle felter. Hvis den angivne værdi ikke finder et match, hentes der ingen felter.Henter relationsfelter, der er kombineret til at danne JSON-sidehoveder-noden, selvom disse felter ikke er inkluderet i
fieldsetName. Disse felter er:PrimaryGroupCensusMemberId,RelationshipToPrimaryMember,SourceSystemIdentifierogPrimaryMemberSource.Hvis
har værdi, udfyldes listen over kontraktlinjeregistreringer med følgende kontraktoplysninger:contractGroupPlanIdNavn på kontraktgruppeplan
Produkttype
Id for kontraktgruppens planer
-
Tjenesten bruger
censusIdtil at hente listen over folketællingsmedlemmer fraGroupCensusMemberog kontraktgruppeplaner fraGroupCensusMemberPlanfor hvert medlem.-
Hvis forskydningen har værdi, henter den Rækker med primære
GroupCensusMember(arrangeret efter Id) efter forskydningen og henter derefter alle afhængige for disse primære medlemmer. -
Hvis der er en grænseværdi, henter tjenesten rækkerne Primær
GroupCensusMember(arrangeret efter Id), der ikke er større end den angivne grænse. Den henter derefter alle afhængige for disse primære medlemmer. Grænsen må ikke være på mere end 500. -
Hvis
searchKeyhar værdi, henter tjenestenGroupCensusMemberrækker (arrangeret med Id) sammen med den tilsvarende familie, som harsearchKeysom en delstreng til stede i deresFirstNameellerLastName. HvisGroupCensusMemberindeholder afhængige, henter tjenesten de primære medlemmer, der svarer til disse afhængige. -
Hvis
memberIdshar en værdi, henter denGroupCensusMemberrækker (arrangeret efter Id), hvis Id er en del afmemberIds-matrixen. EntenmemberIdsellersearchKeyskal angives i input. -
De oplysninger, der hentes for hvert medlem, er baseret på de felter, der hentes fra
GroupCensusMemberogGroupCensusMemberPlan. -
Listen over medlemmer placeres i
members.
-
Serviceadfærd
Forstå, hvordan forskellige input påvirker serviceoutput.
| Input | Serviceoutput |
|---|---|
Ingen |
Tjenesten henter ingen optællingsmedlemmer. |
Ingen fieldsetName og gyldig censusId |
Tjenesten henter:
|
Gyldig fieldsetName og gyldig censusId |
Tjenesten viser GroupCensusMember felter i henhold til de angivne fieldsetName og henter listen over GroupCensusMember med ContractGroupPlanIds. |
Ingen planFieldsetName gyldig fieldsetName og gyldig censusId |
Tjenesten viser GroupCensusMember felter i henhold til de angivne fieldsetName, ContractGroupPlanId og Navn-felter i GroupCensusMemberPlan. Den henter en liste over med ContractGroupPlanIds. |
Gyldig planFieldsetName gyldig fieldsetName og gyldig censusId |
Tjenesten henter:
|
Gyldig contractId |
Tjenesten henter kontraktgruppens plannavn, produkttype, underordnede produkter og kontraktgruppens plan-id som indstillinger i ContractGroupPlanId-sidehovedfeltet. |
Gyldig limit |
Tjenesten henter:
|
Gyldig offset |
Tjenesten henter:
|
Gyldig offset og gyldig limit |
Tjenesten henter:
|
Gyldig searchKey |
Tjenesten henter:
|
Gyldig searchKey og gyldig limit |
Tjenesten henter:
|
Gyldig searchKey og gyldig offset |
Tjenesten henter:
|
Gyldig searchKey, gyldig limit og gyldig offset |
Tjenesten henter:
|
Fjernindstillinger
| Indstillinger | Beskrivelse |
|---|---|
|
Påkrævet. Id for den folketælling, hvis medlemmer skal hentes. |
|
Påkrævet. Id for kontoens aktuelle kontrakt. Henter navnet på kontraktgruppens plan, produkttype og kontraktgruppe |
|
Valgfrit. Navn på felt, der er angivet til at hente GroupCensusMember-felterne. Hvis værdien er ugyldig, returnerer tjenesten ingen felter. Hvis der ikke er nogen værdi, bruger tjenesten standardfeltet til at hente GroupCensusMember-felter. |
|
Valgfrit. Henter felterne GroupCensusMemberPlan og GroupCensusMember, når der er en gyldig planfeltsætværdi. Der returneres ingen felter, hvis værdien ikke er gyldig. Alle GroupCensusMemberPlan-felter returneres, når der ikke er nogen værdi. |
|
Valgfrit. Antallet af folketællingsmedlemmer, der skal hentes. |
|
Valgfrit. Id'et på folketællingsmedlemmet, hvorefter folketællingsmedlemmerne skal hentes. |
|
En streng til at søge efter matchende registreringer for optællingsmedlemmer. |
Input JSON
Denne tjeneste tager ikke et input-JSON.
Output JSON
Tjenesten returnerer et output-JSON, der er formateret som i eksemplet nedenfor. Outputtet har detaljer for medlemmerne i folketællingen, hvor headers er en liste over API-feltnavne på GroupCensusMember og GroupCensusMemberPlan. members returnerer listen over valgte planer for medlemmet sammen med ContractGroupPlanId afgrænset af ;. Feltet lastOffset viser id'et for det sidste optællingsmedlem, der hentes. Denne værdi kan bruges som forskydningsparameteren til at hente de næste rækker.
Her er eksempel på output-JSON-format:
{
"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"
}Her er eksempelresultat-JSON:
{
"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"
}