Skip to content

GetWorkersRequestDto

← Worker DTO

Filters for GET Api/Workers. 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.

Address filters (city, postalCode, street, house, regionCodeIds, addressTypes, addressComment) match if ANY of the worker's addresses matches — a worker can have several.

Backend-источник: core.businesslogicservice/Core.BusinessLogicService/Nuget.BusinessApiClient/Dto/Worker/Request/GetWorkersRequestDto.cs (core.businesslogicservice).

Поля

ПолеТип (TS)ОбязательноеОписаниеТип (C#)
paginationPaginationдаPagination
statusFilterPaginationFilter<WorkerStatusDto>нет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.
inBlackListbooleanнетOmitted or false excludes blacklisted workers, which is the historical behaviour of this endpoint. true returns only blacklisted ones, making GET Api/Workers/InBlackList redundant.
firstNamestringнетPrefix match on the first name.
lastNamestringнетPrefix match on the last name.
createdAtPaginationRangeFilter<string>нетISO 8601 range over the creation timestamp.
updatedAtPaginationRangeFilter<string>нетISO 8601 range over the last-update timestamp. Workers never updated are excluded.
gendersGenderParam[]нет
birthDatePaginationRangeFilter<string>нетISO date (yyyy-MM-dd) range over the birth date.
nationalitystringнетPrefix match on the nationality.
religionstringнетPrefix match on the religion.
employmentTypesEmploymentTypeParam[]нет
referralSourcesReferralSourceDto[]нет
transportTypesTransportTypeParam[]нетMatches workers having any of the listed transport types.
isStaffedbooleanнет
isAvailableForClientsbooleanнет
isTrainedbooleanнет
hasCertificatebooleanнет
hasExperiencebooleanнет
hasAllergybooleanнет
childsbooleanнет
workWithMenbooleanнет
workWithWomenbooleanнет
maxClientsCountPaginationRangeFilter<number>нет
paidVacationPerYearCountPaginationRangeFilter<number>нет
contractSignedDatePaginationRangeFilter<string>нетISO date (yyyy-MM-dd) range.
contractTerminationDatePaginationRangeFilter<string>нетISO date (yyyy-MM-dd) range.
goToWorkDatePaginationRangeFilter<string>нетISO date (yyyy-MM-dd) range.
citystringнетPrefix match on any of the worker addresses.
postalCodestringнетPrefix match on any of the worker addresses.
streetstringнетPrefix match on any of the worker addresses.
housestringнетPrefix match on any of the worker addresses.
regionCodeIdsnumber[]нет
addressTypesWorkerAddressTypeParam[]нет
ratePerHourIdsnumber[]нет
ratePaginationRangeFilter<number>нетRange over the hourly rate of the assigned tariff.
userIdnumberнет
phoneNumberstringнет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.
emailstringнетExact match against the linked email contacts. Stored as a value object, so a partial address does not match — pass the full address.
commentstringнетSubstring match on the general comment.
availabilityCommentstringнетSubstring match on the availability comment.
applicationCommentstringнетSubstring match on the application comment.
allergyCommentstringнетSubstring match on the allergy comment.
addressCommentstringнетSubstring match on the comment of any of the worker addresses.

Пример

json
{
  "pagination": "<Pagination>",
  "statusFilter": "<PaginationFilter<WorkerStatusDto>>",
  "inBlackList": false,
  "firstName": "string",
  "lastName": "string",
  "createdAt": "<PaginationRangeFilter<string>>",
  "updatedAt": "<PaginationRangeFilter<string>>",
  "genders": [],
  "birthDate": "<PaginationRangeFilter<string>>",
  "nationality": "string",
  "religion": "string",
  "employmentTypes": [],
  "referralSources": [],
  "transportTypes": [],
  "isStaffed": false,
  "isAvailableForClients": false,
  "isTrained": false,
  "hasCertificate": false,
  "hasExperience": false,
  "hasAllergy": false,
  "childs": false,
  "workWithMen": false,
  "workWithWomen": false,
  "maxClientsCount": "<PaginationRangeFilter<number>>",
  "paidVacationPerYearCount": "<PaginationRangeFilter<number>>",
  "contractSignedDate": "<PaginationRangeFilter<string>>",
  "contractTerminationDate": "<PaginationRangeFilter<string>>",
  "goToWorkDate": "<PaginationRangeFilter<string>>",
  "city": "string",
  "postalCode": "string",
  "street": "string",
  "house": "string",
  "regionCodeIds": [],
  "addressTypes": [],
  "ratePerHourIds": [],
  "rate": "<PaginationRangeFilter<number>>",
  "userId": 0,
  "phoneNumber": "+49123456789",
  "email": "user@example.com",
  "comment": "string",
  "availabilityComment": "string",
  "applicationComment": "string",
  "allergyComment": "string",
  "addressComment": "string"
}