Olet tässä:
InsCensusServiceStd:getMembers
Käytä tätä palvelua noutaaksesi väestönlaskun jäsenet GroupCensusMember-palvelusta. Lisäksi se noutaa ylätunnisteet fieldsetName perusteella.
Luokka: InsCensusServiceStd
Metodi: getMembers
Palvelu hyväksyy syötteen tässä muodossa.
| censusId | fieldsetName | Kompensointi | limit | searchKey |
|---|---|---|---|---|
| c101 | test_fieldset | cmember101 | kokonaisluku | etuliite |
Palvelu käyttää input-arvoja luodakseen tuotemalliisi sopivan output-arvon.
| väestönlaskenta | lastOffSet | |
|---|---|---|
| headers | jäsenet | Viimeisimmän väestönlaskentajäsenen tunnus |
| Kenttien luettelo | Jäsenten luettelo | |
Miten se toimii?
Tällä palvelulla on kaksi avaintoimintoa:
-
Hakee
fieldetName-arvoon perustuvienGroupCensusMember-kenttien ja -otsikoiden luettelon. Tuloksessa on ainaPrimaryGroupCensusMemberId,RelationshipToPrimaryMember,SourceSystemIdentifierjaPrimaryMemberSource, vaikka nämä kentät eivät sisällyfieldsetName. - Palvelu käyttää
censusId-funktiota noutaakseen väestönlaskun jäsenten luettelonGroupCensusMember-tietueista.- Jos offset-arvolla on arvo, se noutaa ensisijaiset
GroupCensusMember-rivit (tunnuksen mukaan järjestettynä) offset-arvon jälkeen ja sitten kaikki näiden ensisijaisten jäsenten sidonnaiset. Jos rajoitusarvo on olemassa, palvelu noutaa Ensisijainen
GroupCensusMember-rivit (järjestettynä Id-arvolla) enintään määritetyn rajoituksen perusteella. Sen jälkeen se noutaa kaikki näiden ensisijaisten jäsenten sidonnaiset. Rajoitus voi olla enintään 500.Jos
searchKey-arvolla on arvo, palvelu noutaaGroupCensusMember-rivit (tunnuksen mukaan järjestettynä) ja niitä vastaavat perheet, joidenFirstName- taiLastName-merkkijonona onsearchKey.Jos
memberIdssisältää arvon, se noutaaGroupCensusMember-rivit (tunnuksen mukaan järjestettynä), joiden tunnus on osamemberIds-taulukkoa. Input-arvona täytyy olla jokomemberIdstaisearchKey.Jos
withPlansontrue, palvelu noutaa valittujen suunnitelmien luettelon kullekin jäsenelle. Kunkin jäsenen kelvollisetContractGroupPlanIdon erotettu puolipisteellä ja palautetaan merkkijonona.Jokaiselle jäsenelle haetut tiedot perustuvat
GroupCensusMember:sta haettuihin kenttiin.Jäsenten luettelo asetetaan
members-noodiin.
- Jos offset-arvolla on arvo, se noutaa ensisijaiset
Palvelun toimintatapa
Katso miten eri syötteet vaikuttavat palvelutuloksiin.
| Input | Palvelun output |
|---|---|
Ei censusId tai virheellinen censusId |
Palvelu ei nouda mitään väestönlaskun jäsentä. |
Ei fieldsetName ja käypä censusId |
|
Kelvolliset fieldsetName ja kelvolliset censusId |
Palvelu noutaa määritetyssä kenttäjoukossa olevien GroupCensusMember-kenttien luettelon ja GroupCensusMember-kenttien luettelon. |
Kelvollinen limit |
Palvelu noutaa määritetyn rajoituksen sisältäneen luettelon |
Kelvollinen offset |
Palvelu noutaa luettelon
|
Kelvollinen offset ja käypä limit |
Palvelu noutaa määritetyssä kenttäjoukossa olevien
|
Kelvollinen searchKey |
Palvelu noutaa määritetyssä kenttäjoukossa olevien |
Kelvolliset searchKey ja kelvolliset limit |
Palvelu noutaa määritetyssä kenttäjoukossa olevien |
Kelvollinen searchKey ja käypä offset |
Palvelu noutaa määritetyssä kenttäjoukossa olevien |
Kelvolliset searchKey, kelvolliset limit ja kelvolliset offset |
Palvelu noutaa määritetyssä kenttäjoukossa olevien
|
Etäasetukset
| Vaihtoehdot | Kuvaus |
|---|---|
|
Pakollinen. Sen väestönlaskun tunnus, jonka jäseniä täytyy hakea. |
|
Valinnainen.
Jos arvo on virheellinen, palvelu ei palauta kenttiä. Jos arvoa ei ole, palvelu käyttää oletusarvoista kenttäjoukkoa |
|
Valinnainen. Noudettavien väestönlaskentajäsenien määrä. |
|
Valinnainen . Rekisteröinnin jäsenen tunnus, jonka jälkeen rekisteröinnin jäsenet täytyy hakea. |
|
Merkkijono, joka hakee vastaavia väestönlaskentajäsenen tietueita. |
Syötetty JSON
Tämä palvelu ei ota syötettyä JSON-tiedostoa.
Tulos-JSON
Palvelu palauttaa tuloksen JSON-tiedoston, joka sisältää kenttien luettelon, jäsenten luettelon ja lastOffSet-arvon.
{
"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"
}