위치:
InsCensusServiceStd:getMembersWithPlans
이 서비스를 사용하여 주어진 censusId의 인구 조사 구성원 목록을 검색합니다. 이 인구 조사 구성원에 해당하는 서비스는 GroupCensusMemberPlan에서 ContractGroupPlanIds을 검색합니다. 또한 서비스는 fieldsetName 및 planFieldsetName를 기반으로 머리글을 검색합니다.
클래스: InsCensusServiceStd
방법: getMembersWithPlans
작동 방법
이 서비스에는 다음과 같은 두 가지 핵심 기능이 있습니다.
-
GroupCensusMember및GroupCensusMemberPlan의 필드 목록을 검색합니다.서비스는 매개 변수
fieldsetName를 사용하여GroupCensusMember필드 목록을 검색합니다. 값이 없는 경우 기본 필드 집합에서 필드가 검색됩니다. 입력한 값이 일치하는 항목을 찾지 못할 경우 필드가 검색되지 않습니다.서비스는 매개 변수
planFieldsetName를 사용하여GroupCensusMemberPlan필드 목록을 검색합니다. 값이 없으면 모든 필드가 검색됩니다. 입력한 값이 일치하는 항목을 찾지 못할 경우 필드가 검색되지 않습니다.이러한 필드가
fieldsetName에 포함되지 않은 경우에도 JSON 머리글 노드를 형성하기 위해 결합된 관계 필드를 검색합니다. 이 필드는 다음과 같습니다.PrimaryGroupCensusMemberId,RelationshipToPrimaryMember,SourceSystemIdentifier및PrimaryMemberSource.contractGroupPlanId계약 그룹 계획 이름
제품 유형
계약 그룹 계획의 ID
-
서비스는
GroupCensusMember레코드 및 각 구성원에GroupCensusMemberPlan대한 계약 그룹 계획에서 인구 조사 구성원의 목록을 검색하는censusId데 사용합니다.-
오프셋에 값이 있는 경우 오프셋 다음에 Id로 정렬된 Primary
GroupCensusMember행을 검색한 다음, 이러한 Primary Members에 대한 모든 종속성을 검색합니다. -
제한 값이 있는 경우 서비스에서 지정된 제한보다 크지 않은 기본
GroupCensusMember행(Id로 정렬)을 검색합니다. 그런 다음, 해당 기본 구성원의 모든 종속인을 검색합니다. 제한은 500개를 초과할 수 없습니다. -
searchKey에 값이 있는 경우 서비스는 해당 패밀리와 함께GroupCensusMember행(Id로 정렬)을 검색합니다. 이 패밀리는searchKey이 그들의FirstName또는LastName에 있는 하위 문자열로 존재합니다.GroupCensusMember에 종속인이 포함된 경우 서비스는 해당 종속인에 해당하는 기본 구성원을 검색합니다. -
memberIds에 값이 있는 경우 Id가memberIds배열의 일부인GroupCensusMember행(Id로 정렬)을 검색합니다.memberIds또는searchKey중 하나를 입력으로 제공해야 합니다. -
각 구성원에 대해 검색되는 정보는
GroupCensusMember및GroupCensusMemberPlan에서 검색한 필드를 기반으로 합니다. -
구성원 목록이
members노드에 배치됩니다.
-
서비스 동작
다양한 입력이 서비스 출력에 미치는 영향을 이해합니다.
| 입력 | 서비스 출력 |
|---|---|
|
서비스에서 인구 조사 구성원을 검색하지 않습니다. |
없음 fieldsetName 및 유효한 censusId |
서비스가 다음을 검색합니다.
|
유효한 fieldsetName 및 유효한 censusId |
서비스는 지정된 fieldsetName에 따라 GroupCensusMember 필드를 나열하고 ContractGroupPlanIds가 있는 GroupCensusMember 목록을 검색합니다. |
planFieldsetName 유효한 fieldsetName 및 유효한 censusId 없음 |
서비스는 GroupCensusMemberPlan의 지정된 fieldsetName, ContractGroupPlanId 및 Name 필드에 따라 GroupCensusMember 필드를 나열합니다. ContractGroupPlanIds가 있는 |
유효한 planFieldsetName 유효한 fieldsetName 및 유효한 censusId |
서비스가 다음을 검색합니다.
|
유효한 contractId |
서비스는 계약 그룹 계획 이름, 제품 유형, 하위 제품 및 계약 그룹 계획 ID를 ContractGroupPlanId 머리글 필드의 옵션으로 검색합니다. |
유효한 limit |
서비스가 다음을 검색합니다.
|
유효한 offset |
서비스가 다음을 검색합니다.
|
유효한 offset 및 유효한 limit |
서비스가 다음을 검색합니다.
|
유효한 searchKey |
서비스가 다음을 검색합니다.
|
유효한 searchKey 및 유효한 limit |
서비스가 다음을 검색합니다.
|
유효한 searchKey 및 유효한 offset |
서비스가 다음을 검색합니다.
|
유효한 searchKey, 유효한 limit 및 유효한 offset |
서비스가 다음을 검색합니다.
|
원격 옵션
| 옵션 | 설명 |
|---|---|
|
필수 항목. 구성원을 검색해야 하는 인구 조사 ID입니다. |
|
필수 항목 . 계정의 현재 계약 ID입니다. 계약 그룹 플랜 이름, 제품 유형 및 계약 그룹 검색 |
|
선택 사항. GroupCensusMember 필드를 검색하기 위해 설정된 필드의 이름입니다. 값이 잘못되면 서비스에서 필드를 반환하지 않습니다. 값이 없는 경우 서비스에서 기본 필드 집합을 사용하여 GroupCensusMember 필드를 검색합니다. |
|
(선택 사항) 유효한 계획 필드 집합 값이 있는 경우 GroupCensusMemberPlan 및 GroupCensusMember 필드를 검색합니다. 값이 유효하지 않은 경우에는 필드가 반환되지 않습니다. 값이 없으면 모든 GroupCensusMemberPlan 필드가 반환됩니다. |
|
선택 사항. 검색할 인구 조사 구성원의 수입니다. |
|
옵션입니다. 인구 조사 구성원을 검색해야 하는 인구 조사 구성원의 ID입니다. |
|
일치하는 인구 조사 구성원 레코드를 검색하는 문자열입니다. |
입력 JSON
이 서비스는 입력 JSON을 받지 않습니다.
출력 JSON
서비스는 아래 예에 따라 서식이 지정된 출력 JSON을 반환합니다. 출력에는 인구 조사의 구성원에 대한 세부 사항이 있습니다. 여기서 머리글은 GroupCensusMember 및 GroupCensusMemberPlan의 필드 API 이름 목록입니다. members 노드는 구성원에 대해 선택한 계획 목록과 ;로 구분된 ContractGroupPlanId를 반환합니다. lastOffset 필드에는 검색된 마지막 인구 조사 구성원의 ID가 표시됩니다. 이 값은 다음 행을 가져오기 위해 오프셋 매개 변수로 사용할 수 있습니다.
샘플 출력 JSON 형식은 다음과 같습니다.
{
"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"
}샘플 출력 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"
}