Olet tässä:
InsCensusServiceStd:getFields
Käytä tätä palvelua noutaaksesi kenttien määritelmiä ja kenttien API-nimiä ryhmän väestönlaskennan jäsenille ja ryhmän väestönlaskennan jäsenten suunnitelmille.
Luokka: InsCensusServiceStd
Metodi: getFields
Miten se toimii?
- Palvelu noutaa luettelon
GroupCensusMember-kentistä, jotka kuuluvat input-parametrinfieldsetName-kenttäjoukkoon. -
Jos
withPlans-parametri on true, palvelu noutaa myösGroupCensusMemberPlan-kenttien luettelon. -
Kenttien määritelmien (kenttien datatyyppien, kenttien otsikoiden, kenttien API-nimien ja kenttien .csv-otsikoiden) luettelo yhdistetään muodostamaan
headers.-
Jos kenttien haettuun luetteloon sisältyy
GroupClassId, palvelu lisää ylätunnisteiden alle noodin -GroupClassId.Name.
-
-
Kenttien API-nimien luettelo yhdistetään JSON-noodiin.
-
Jos kenttien noudettuun luetteloon sisältyy
GroupClassId, palvelu lisää kenttien alla noodin -GroupClassId.Name.
-
Etäasetukset
Vaihtoehto |
Kuvaus |
|---|---|
|
Hakee määritettyyn kenttäjoukkoon kuuluvat Jos syötetty arvo ei vastaa olemassa olevaa kenttäjoukkoa, palvelu palauttaa virheen - "Määritetty kenttäjoukon nimi <kenttäjoukonNimi> ei ole olemassa". Jos käyttäjä ei määritä arvoa, palvelu käyttää oletusarvoista kenttäjoukkoa - |
|
Hakee kaikkien kelvollisten arvojen kenttäjoukkoon sisältyvät Jos syötetty arvo ei vastaa olemassa olevaa kenttäjoukkoa, palvelu palauttaa virheen - "Määritetty kenttäjoukon nimi <planFieldsetName> ei ole olemassa". Jos käyttäjä ei määritä arvoa, palvelu palauttaa kaikki |
|
Totuusarvo Jos Oletusarvo on |
Syötetty JSON
Alla on esimerkki syötetystä JSON-tiedostosta:
{
"fieldsetName": "memberFields",
"withPlans": true,
"planFieldsetName": "planFields"
}Tulos-JSON
Palvelu palauttaa luettelon kaikista kenttien API-nimistä, jotka kuuluvat kenttäjoukon myFieldsetName-objektiin GroupCensusMember-objektissa. Jos withPlans-parametri on true, tulos sisältää myös kenttien API-nimet, jotka ovat osa kenttäjoukon myPlanFieldsetName-objektia GroupCensusMemberPlan-objektissa.
Ylätunnisteet koostuvat kenttien API-nimien, kenttien otsikoiden, kenttien datatyyppien ja kaikkien palvelun noutamien kenttien CSV-otsakkeen luettelosta.
Palvelu palauttaa tuloksen JSON-tiedoston, joka on muotoiltu seuraavan esimerkin mukaisesti:
{
"fields": [
"vlocityins__AttributeSelectedValues__c",
"AccountId",
"Gender",
"ContractGroupPlanId",
],
"headers": [
{
"fieldId": "",
"type": "StringPlusClob",
"label": "Attribute Selected Values",
"name": "vlocityins__AttributeSelectedValues__c"
},
{
"fieldId": "",
"type": "EntityId",
"label": "Account ID",
"name": "AccountId"
},
{
"fieldId": "",
"type": "DynamicEnum",
"label": "Gender",
"name": "Gender"
"options": [
{
"label": "Male",
"name": "Male"
},
{
"label": "Female",
"name": "Female"
}
],
},
{
"fieldId": "",
"type": "EntityId",
"label": "Contract Group Plan ID",
"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"
}
]
}
]
}
]
}
