Du er her:
InsCensusServiceStd:getMembersWithPlans
Bruk denne tjenesten til å hente listen over folketellingsmedlemmer for en gitt censusId. Tilsvarende disse folketellingsmedlemmene henter tjenesten ContractGroupPlanIds fra GroupCensusMemberPlan. Tjenesten henter også hoder basert på fieldsetName og planFieldsetName.
Klasse: InsCensusServiceStd
Metode: getMembersWithPlans
Slik virker det
Denne tjenesten har to nøkkelfunksjoner:
- Henter listen over felt i
GroupCensusMemberogGroupCensusMemberPlan.Tjenesten bruker parameteren
fieldsetNametil å hente listen overGroupCensusMember-felt. Hvis det ikke er noen verdi, hentes felt fra standardfeltsettet. Hvis den oppgitte verdien ikke finner et samsvar, hentes ingen felt.Tjenesten bruker parameteren
planFieldsetNametil å hente listen overGroupCensusMemberPlan-felt. Hvis det ikke er noen verdi, hentes alle feltene. Hvis den oppgitte verdien ikke finner et samsvar, hentes ingen felt.Henter relasjonsfelt som kombineres for å danne JSON-hoder-noden selv om disse feltene ikke er inkludert i
fieldsetName. Disse feltene er:PrimaryGroupCensusMemberId,RelationshipToPrimaryMember,SourceSystemIdentifierogPrimaryMemberSource.Hvis
-parameteren har verdi, fyller den ut listen over kontraktslinjeposter med følgende detaljer om kontrakten:contractGroupPlanIdNavn på kontraktsgruppeplan
Produkttype
ID-en til kontraktsgruppeplanene
-
Tjenesten bruker
censusIdtil å hente listen over folketellingsmedlemmer fraGroupCensusMemberposter og kontraktsgruppeplaner fraGroupCensusMemberPlanfor hvert medlem.-
Hvis forskyvningen har en verdi, henter den Primære
GroupCensusMember-rader (sortert med Id) etter forskyvningen, og henter deretter alle avhengige for disse Primære medlemmene. -
Hvis det er en grenseverdi, henter tjenesten de primære
GroupCensusMember-radene (sortert etter Id) som ikke er større enn den angitte grensen. Den henter deretter alle avhengige for disse primære medlemmene. Grensen kan ikke være mer enn 500. -
Hvis
searchKeyhar verdi, henter tjenestenGroupCensusMemberrader (sortert med Id) sammen med tilhørende familie, som harsearchKeysom en delstreng til stede i deresFirstNameellerLastName. HvisGroupCensusMemberinneholder avhengige, henter tjenesten primære medlemmer som tilsvarer de avhengige. -
Hvis
memberIdshar en verdi, henter denGroupCensusMember-rader (sortert etter Id) der Id er en del avmemberIds-matrisen. EntenmemberIdsellersearchKeymå oppgis i inndata. -
Informasjonen som hentes for hvert medlem er basert på feltene hentet fra
GroupCensusMemberogGroupCensusMemberPlan. -
Medlemslisten plasseres i
members-noden.
-
Virkemåte for service
Forstå hvordan forskjellige inndata påvirker tjenesteutdataene.
| Inndata | Tjenesteutdata |
|---|---|
Ingen |
Tjenesten henter ikke noe folketellingsmedlem. |
Ingen fieldsetName og gyldig censusId |
Tjenesten henter:
|
Gyldig fieldsetName og gyldig censusId |
Tjenesten viser GroupCensusMember-felt i henhold til den angitte fieldsetName og henter listen over GroupCensusMember med ContractGroupPlanIds. |
Ingen planFieldsetName gyldig fieldsetName og gyldig censusId |
Tjenesten viser GroupCensusMember-felt i henhold til det angitte fieldsetName-, ContractGroupPlanId- og Navn-feltet i GroupCensusMemberPlan. Den henter en liste over med ContractGroupPlanIds. |
planFieldsetName Gyldig fieldsetName og gyldig censusId |
Tjenesten henter:
|
Gyldig contractId |
Tjenesten henter navnet på kontraktgruppeplanen, produkttypen, underordnede produkter og kontraktgruppeplan-IDen som alternativer i ContractGroupPlanId-topptekstfeltet. |
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:
|
Eksterne alternativer
| Options | Description |
|---|---|
|
Obligatorisk. ID-en til folketellingen der medlemmer må hentes. |
|
Obligatorisk . ID for kontoens gjeldende kontrakt. Henter navnet på kontraktsgruppeplanen, produkttypen og kontraktsgruppen |
|
Valgfritt. Navn på feltsettet for henting av GroupCensusMember-feltene. Hvis verdien er ugyldig, returnerer ikke tjenesten noen felt. Hvis det ikke er noen verdi, bruker tjenesten standardfeltsettet til å hente GroupCensusMember-felt. |
|
Valgfritt. Henter feltene GroupCensusMemberPlan og GroupCensusMember når det er en gyldig feltverdi for en plan. Ingen felt returneres hvis verdien ikke er gyldig. Alle GroupCensusMemberPlan-felt returneres når det ikke er noen verdi. |
|
Optional. Antall folketellingsmedlemmer som skal hentes. |
|
Optional. ID-en til folketellingsmedlemmet som folketellingsmedlemmene må hentes etter. |
|
En streng for å søke etter samsvarende poster for folketellingsmedlemmer. |
Inndata-JSON
Denne tjenesten tar ikke en inndata-JSON.
Utdata-JSON
Tjenesten returnerer en JSON-fil for utdata som er formatert i henhold til eksempelet nedenfor. Utdataene har detaljer for medlemmene i folketellingen, der headers er en liste over felt-API-navn på GroupCensusMember og GroupCensusMemberPlan. members-noden returnerer listen over valgte planer for medlemmet sammen med ContractGroupPlanId avgrenset med ;. lastOffset-feltet viser ID-en til det siste folketellingsmedlemmet som hentes. Denne verdien kan brukes som forskyvningsparameter for å hente de neste radene.
Her er et eksempel på JSON-formatet for utdata:
{
"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 et eksempel på JSON-koden for utdata:
{
"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"
}