GET api/group/{id}/lettingssearching?pageSize={pageSize}&pageNumber={pageNumber}
Get Lettings Searching Roles for a Group
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id | integer |
Required |
|
pageSize | integer |
Default value is 20 |
|
pageNumber | integer |
Default value is 1 |
Body Parameters
None.
Response Information
Resource Description
A list of Searching Roles
PagedCollectionDataContractOfDezrez.Core.DataContracts.External.Api.Group.Query.SearchingRoles.GroupLettingsSearchingRoleDataContractName | Description | Type | Additional information |
---|---|---|---|
TotalCount | integer |
None. |
|
CurrentCount | integer |
None. |
|
PageSize | integer |
None. |
|
PageNumber | integer |
None. |
|
Collection | Collection of Dezrez.Core.DataContracts.External.Api.Group.Query.SearchingRoles.GroupLettingsSearchingRoleDataContract |
None. |
Response Formats
application/json, text/json
Sample:
{ "TotalCount": 1, "CurrentCount": 2, "PageSize": 1, "PageNumber": 1, "Collection": [ { "Criteria": { "TargetMoveIn": "2024-10-30T15:17:04.408058Z", "TermType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Students": true, "IsSmoker": true, "PetOwner": true, "HousingBenefits": true, "FurnishLevelType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "PriceType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "BudgetFrom": 5, "BudgetTo": 1, "NormalisedBudgetFrom": 6.1, "NormalisedBudgetTo": 1.1, "BudgetFlexible": true, "MustHave": { "MinimumBedrooms": 1, "MinimumReceptions": 2, "MinimumBathrooms": 3, "PropertyTypes": [ { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" } ], "PropertyTags": [ { "Name": "sample string 1", "Id": 2 }, { "Name": "sample string 1", "Id": 2 } ], "Regions": [ { "Id": 1, "Name": "sample string 2", "Type": "sample string 3", "Source": "sample string 4" }, { "Id": 1, "Name": "sample string 2", "Type": "sample string 3", "Source": "sample string 4" } ] }, "ShouldHave": { "PropertyTypes": [ { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" } ], "PropertyTags": [ { "Name": "sample string 1", "Id": 2 }, { "Name": "sample string 1", "Id": 2 } ] }, "ShouldNotHave": { "PropertyTypes": [ { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" } ], "PropertyTags": [ { "Name": "sample string 1", "Id": 2 }, { "Name": "sample string 1", "Id": 2 } ] }, "MustNotHave": { "Regions": [ { "Id": 1, "Name": "sample string 2", "Type": "sample string 3", "Source": "sample string 4" }, { "Id": 1, "Name": "sample string 2", "Type": "sample string 3", "Source": "sample string 4" } ] } }, "Description": "sample string 1", "DislikedRoles": [ 1, 2 ], "LikedRoles": [ 1, 2 ], "ShouldRoles": [ 1, 2 ], "RoleStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "OwningTeamId": 2, "BranchId": 3, "GroupId": 4, "Name": "sample string 5", "TeamAccessType": "sample string 6", "RoleType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "CustomFields": [ { "Name": "sample string 1", "Values": [ { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 1", "Value": {} }, { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 1", "Value": {} } ] }, { "Name": "sample string 1", "Values": [ { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 1", "Value": {} }, { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 1", "Value": {} } ] } ], "CreatedDate": "2024-10-30T15:17:04.408058Z", "CreatedBy": { "Initials": "sample string 1", "ContactName": "sample string 2", "Gender": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Title": "sample string 3", "FirstName": "sample string 4", "LastName": "sample string 5", "PrimaryTelephone": { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": "sample string 1", "Notes": "sample string 2", "ContactOrder": 3, "AllowContact": true, "MarketingContactStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 5", "Id": 6 }, "PrimaryEmail": { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": "sample string 1", "Notes": "sample string 2", "ContactOrder": 3, "AllowContact": true, "MarketingContactStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 5", "Id": 6 }, "JobTitle": "sample string 6", "Id": 7 }, "Id": 8 }, { "Criteria": { "TargetMoveIn": "2024-10-30T15:17:04.408058Z", "TermType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Students": true, "IsSmoker": true, "PetOwner": true, "HousingBenefits": true, "FurnishLevelType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "PriceType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "BudgetFrom": 5, "BudgetTo": 1, "NormalisedBudgetFrom": 6.1, "NormalisedBudgetTo": 1.1, "BudgetFlexible": true, "MustHave": { "MinimumBedrooms": 1, "MinimumReceptions": 2, "MinimumBathrooms": 3, "PropertyTypes": [ { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" } ], "PropertyTags": [ { "Name": "sample string 1", "Id": 2 }, { "Name": "sample string 1", "Id": 2 } ], "Regions": [ { "Id": 1, "Name": "sample string 2", "Type": "sample string 3", "Source": "sample string 4" }, { "Id": 1, "Name": "sample string 2", "Type": "sample string 3", "Source": "sample string 4" } ] }, "ShouldHave": { "PropertyTypes": [ { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" } ], "PropertyTags": [ { "Name": "sample string 1", "Id": 2 }, { "Name": "sample string 1", "Id": 2 } ] }, "ShouldNotHave": { "PropertyTypes": [ { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" } ], "PropertyTags": [ { "Name": "sample string 1", "Id": 2 }, { "Name": "sample string 1", "Id": 2 } ] }, "MustNotHave": { "Regions": [ { "Id": 1, "Name": "sample string 2", "Type": "sample string 3", "Source": "sample string 4" }, { "Id": 1, "Name": "sample string 2", "Type": "sample string 3", "Source": "sample string 4" } ] } }, "Description": "sample string 1", "DislikedRoles": [ 1, 2 ], "LikedRoles": [ 1, 2 ], "ShouldRoles": [ 1, 2 ], "RoleStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "OwningTeamId": 2, "BranchId": 3, "GroupId": 4, "Name": "sample string 5", "TeamAccessType": "sample string 6", "RoleType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "CustomFields": [ { "Name": "sample string 1", "Values": [ { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 1", "Value": {} }, { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 1", "Value": {} } ] }, { "Name": "sample string 1", "Values": [ { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 1", "Value": {} }, { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 1", "Value": {} } ] } ], "CreatedDate": "2024-10-30T15:17:04.408058Z", "CreatedBy": { "Initials": "sample string 1", "ContactName": "sample string 2", "Gender": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Title": "sample string 3", "FirstName": "sample string 4", "LastName": "sample string 5", "PrimaryTelephone": { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": "sample string 1", "Notes": "sample string 2", "ContactOrder": 3, "AllowContact": true, "MarketingContactStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 5", "Id": 6 }, "PrimaryEmail": { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": "sample string 1", "Notes": "sample string 2", "ContactOrder": 3, "AllowContact": true, "MarketingContactStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 5", "Id": 6 }, "JobTitle": "sample string 6", "Id": 7 }, "Id": 8 } ] }