Вы находитесь здесь:
InsCensusServiceStd:getMembers
Используйте эту службу для извлечения участников переписи из GroupCensusMember. Он также извлекает заголовки на основе fieldsetName.
Класс: InsCensusServiceStd
Метод: getMembers
Служба принимает вводные данные в этом формате.
| CensusId | fieldsetName | Смещение | limit | searchKey |
|---|---|---|---|---|
| c101 | test_fieldset | cmember101 | целочисленный | префикс |
Служба использует значения ввода для создания вывода, соответствующего модели продукта.
| перепись | lastOffSet | |
|---|---|---|
| headers | members | Код последнего участника переписи |
| Список полей | Список участников | |
Принцип работы
Данная служба выполняет две ключевые функции:
-
Извлекает список полей и заголовков
GroupCensusMemberна основеfieldetName. Результат всегда содержитPrimaryGroupCensusMemberId,RelationshipToPrimaryMember,SourceSystemIdentifierиPrimaryMemberSource, даже если эти поля не включены вfieldsetName. - Служба использует
censusIdдля извлечения списка участников переписи из записейGroupCensusMember.- Если смещение имеет значение, оно извлекает строки основного
GroupCensusMember(упорядоченные по коду) после смещения, а потом извлекает все зависимости для этих основных участников. При наличии значения ограничения служба извлекает строки основного
GroupCensusMember(упорядоченные по коду) не более указанного ограничения. Потом извлекаются все зависимости для этих «Основных участников». Ограничение не может превышать 500.Если
searchKeyимеет значение, служба извлекает строкиGroupCensusMember(упорядоченные по коду) вместе с соответствующим семейством, которые имеютsearchKeyв качестве подстроки, присутствующей в ихFirstNameилиLastName.Если у
memberIdsесть значение, оно извлекает строкиGroupCensusMember(упорядоченные по коду), код которых является частью массиваmemberIds. Вводные данные должны представляться либоmemberIds, либоsearchKey.Если
withPlansустановлен наtrue, служба извлекает список выбранных планов для каждого участника. ДопустимыеContractGroupPlanIdдля каждого участника разделяются точкой с запятой и возвращаются в виде строки.Сведения, извлеченные для каждого участника, основаны на полях, извлеченных из
GroupCensusMember.Список участников добавляется в узел
members.
- Если смещение имеет значение, оно извлекает строки основного
Алгоритм обслуживания
Понимание влияния разных вводных данных на результаты обслуживания.
| Ввод | Вывод обслуживания |
|---|---|
Нет censusId или недопустимые censusId |
Служба не извлекает участника переписи. |
Нет fieldsetName и действительный censusId |
|
Допустимые fieldsetName и действительные censusId |
Служба извлекает список полей GroupCensusMember, присутствующих в данном наборе полей, и список GroupCensusMember. |
Допустимые limit |
Служба извлекает список |
Допустимые offset |
Служба извлекает список
|
Допустимые offset и действительные limit |
Служба извлекает список полей
|
Допустимые searchKey |
Служба извлекает список полей |
Допустимые searchKey и действительные limit |
Служба извлекает список полей |
Допустимые searchKey и действительные offset |
Служба извлекает список полей |
Допустимые searchKey, действительные limit и действительные offset |
Служба извлекает список полей
|
Удаленные параметры
| Параметры | Описание |
|---|---|
|
Обязательно. Код переписи, участники которой должны быть извлечены. |
|
По желанию. Имя поля для извлечения полей Если значение недопустимо, служба не возвращает полей. Если значение отсутствует, служба использует стандартный набор полей для извлечения полей |
|
По желанию. Количество участников переписи для извлечения. |
|
Дополнительно . Код участника переписи, после которого участники переписи должны быть извлечены. |
|
Строка для поиска совпадающих записей участников переписи. |
JSON ввода
Данная служба не использует JSON ввода.
Вывод JSON
Служба возвращает вывод JSON со списком полей, списком участников и значением lastOffSet.
{
"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"
}