U bent hier:
InsCensusServiceStd:getFields
Gebruik deze service voor het ophalen van velddefinities en veld-API-namen voor leden van de groepstelling en ledenplannen van de groepstelling.
Klasse: InsCensusServiceStd
Methode: getFields
De manier waarop het werkt...
- De service haalt de lijst op van
GroupCensusMemberdie deel uitmaken van de veldset die is doorgegeven in defieldsetNamevan de invoerparameter. -
Als de parameter
withPlanstrue (waar) is, haalt de service ook de lijst vanGroupCensusMemberPlanop. -
De lijst van velddefinities (veldgegevenstypen, veldlabels, veld-API-namen en veld-.csv-headers) wordt gecombineerd om de
headerste vormen.-
Als
GroupClassIdis opgenomen in de opgehaalde lijst van velden, voegt de service een knooppunt toe onder de headers -GroupClassId.Name.
-
-
De lijst van veld-API-namen wordt gecombineerd om het JSON-knooppunt te vormen.
-
Als
GroupClassIdis opgenomen in de opgehaalde lijst van velden, voegt de service een knooppunt toe onder de velden -GroupClassId.Name.
-
Externe opties
Optie |
Beschrijving |
|---|---|
|
Haalt Als de invoer niet overeenkomt met een bestaande veldset, retourneert de service een fout - "De opgegeven veldsetnaam <veldsetNaam> bestaat niet." Als de gebruiker geen waarde opgeeft, gebruikt de service de standaardveldset - |
|
Haalt Als de invoer niet overeenkomt met een bestaande veldset, retourneert de service een foutmelding - "De opgegeven veldsetnaam <planFieldsetName> bestaat niet." Als de gebruiker geen waarde opgeeft, retourneert de service alle |
|
Booleaans Indien De standaardwaarde is |
Invoer-JSON
Hier is de voorbeeldinvoer-JSON:
{
"fieldsetName": "memberFields",
"withPlans": true,
"planFieldsetName": "planFields"
}Uitvoer-JSON
De service retourneert een lijst van alle veld-API-namen die deel uitmaken van de myFieldsetName van de veldset in het object GroupCensusMember. Als de parameter withPlans true (waar) is, omvat de uitvoer ook veld-API-namen die deel uitmaken van de myPlanFieldsetName van de veldset in het object GroupCensusMemberPlan.
Kopteksten bestaan uit een lijst van veld-API-namen, veldlabels, veldgegevenstype en veld-CSV-header voor alle velden die door de service worden opgehaald.
De service retourneert een uitvoer-JSON-indeling zoals in dit voorbeeld:
{
"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"
}
]
}
]
}
]
}
