GetClientsRequestDto
Filters for GET Api/Clients. Every field except pagination is optional — an absent field means the condition is not applied.
statusFilter.available is the universe the counts are computed over, statusFilter.selected is the choice; an absent or empty selected means every status. The counts describe the slice left by the other filters, not the whole table.
Backend-источник: core.businesslogicservice/Core.BusinessLogicService/Nuget.BusinessApiClient/Dto/Client/Requests/GetClientsRequestDto.cs (core.businesslogicservice).
Поля
| Поле | Тип (TS) | Обязательное | Описание | Тип (C#) |
|---|---|---|---|---|
pagination | Pagination | да | — | Pagination |
statusFilter | PaginationFilter<ClientStatusDto> | нет | Status facet. available is the universe the counts are computed over, selected is the choice; an absent or empty selected means every status, so no condition is applied. | — |
sentToMeinpflegedienst | boolean | null | нет | — | — |
firstName | string | нет | Prefix match on the first name. | — |
lastName | string | нет | Prefix match on the last name. | — |
createdAt | PaginationRangeFilter<string> | нет | ISO 8601 range over the creation timestamp. | — |
updatedAt | PaginationRangeFilter<string> | нет | ISO 8601 range over the last-update timestamp. Clients never updated are excluded. | — |
genders | GenderParam[] | нет | — | — |
birthdate | PaginationRangeFilter<string> | нет | ISO date (yyyy-MM-dd) range over the birth date. | — |
city | string | нет | Prefix match on the address city. | — |
postalCode | string | нет | Prefix match on the address postal code. | — |
street | string | нет | Prefix match on the address street. | — |
house | string | нет | Prefix match on the address house number. | — |
regionCodeIds | number[] | нет | — | — |
applicationStatuses | ApplicationStatusDto[] | нет | — | — |
severityLevels | SeverityLevelDto[] | нет | — | — |
sourceTypes | SourceTypeDto[] | нет | — | — |
notClientReasons | NotClientReasonDto[] | нет | — | — |
careServiceTypes | CareServiceTypeDto[] | нет | Matches clients having any of the listed care service types. | — |
assistanceTypes | AssistanceTypeDto[] | нет | Matches clients having any of the listed assistance types. | — |
preferredMailingTypes | PreferredMailingTypeDto[] | нет | Matches clients having any of the listed preferred mailing types. | — |
startCareDate | PaginationRangeFilter<string> | нет | ISO date (yyyy-MM-dd) range. | — |
endCareDate | PaginationRangeFilter<string> | нет | ISO date (yyyy-MM-dd) range. | — |
hoursPerWeek | PaginationRangeFilter<number> | нет | — | — |
careConsultation | boolean | нет | — | — |
hasPets | boolean | нет | — | — |
callViaRelatives | boolean | нет | — | — |
hasHearingProblems | boolean | нет | — | — |
allQuestionsAnswered | boolean | нет | — | — |
isDied | boolean | нет | — | — |
partnerIds | number[] | нет | — | — |
socialServicesOfficeIds | number[] | нет | — | — |
insuranceCompanyIds | number[] | нет | — | — |
insuranceTypes | InsuranceTypeDto[] | нет | — | — |
insuranceNumber | string | нет | Prefix match on the insurance number. | — |
insurancePaymentType | string | нет | Prefix match on the insurance payment type. | — |
referralSourceTypes | ClientReferralSourceTypeDto[] | нет | — | — |
referralDetailTypes | ClientReferralDetailTypeDto[] | нет | — | — |
referralName | string | нет | Prefix match on the referral name. | — |
phoneNumber | string | нет | Exact match against the linked phone contacts. Normalized before comparison (digits only, 49-prefixed), so +49 221 12345 and 0221 12345 both work, but a partial number does not match. | — |
email | string | нет | Exact match against the linked email contacts. Stored as a value object, so a partial address does not match — pass the full address. | — |
commentForCallCenter | string | нет | Substring match on the call-centre comment. | — |
commentForEmployee | string | нет | Substring match on the employee comment. | — |
commentForAdministration | string | нет | Substring match on the administration comment. | — |
addressComment | string | нет | Substring match on the address comment. | — |
Пример
json
{
"pagination": "<Pagination>",
"statusFilter": "<PaginationFilter<ClientStatusDto>>",
"sentToMeinpflegedienst": false,
"firstName": "string",
"lastName": "string",
"createdAt": "<PaginationRangeFilter<string>>",
"updatedAt": "<PaginationRangeFilter<string>>",
"genders": [],
"birthdate": "<PaginationRangeFilter<string>>",
"city": "string",
"postalCode": "string",
"street": "string",
"house": "string",
"regionCodeIds": [],
"applicationStatuses": [],
"severityLevels": [],
"sourceTypes": [],
"notClientReasons": [],
"careServiceTypes": [],
"assistanceTypes": [],
"preferredMailingTypes": [],
"startCareDate": "<PaginationRangeFilter<string>>",
"endCareDate": "<PaginationRangeFilter<string>>",
"hoursPerWeek": "<PaginationRangeFilter<number>>",
"careConsultation": false,
"hasPets": false,
"callViaRelatives": false,
"hasHearingProblems": false,
"allQuestionsAnswered": false,
"isDied": false,
"partnerIds": [],
"socialServicesOfficeIds": [],
"insuranceCompanyIds": [],
"insuranceTypes": [],
"insuranceNumber": "string",
"insurancePaymentType": "string",
"referralSourceTypes": [],
"referralDetailTypes": [],
"referralName": "string",
"phoneNumber": "+49123456789",
"email": "user@example.com",
"commentForCallCenter": "string",
"commentForEmployee": "string",
"commentForAdministration": "string",
"addressComment": "string"
}