POST api/crmconnect/group/getlettingssearchrole
get a groups lettings searching role in the save SaveGroupLettingsSearchingRoleDataContract format so that it can be created with a group in rezi Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.
Request Information
URI Parameters
None.
Body Parameters
A value usable to identify the item in the crm, this key is generated by the selected domain service
ObjectNone.
Request Formats
application/x-www-form-urlencoded
Sample:
application/json, text/json
Sample:
{}
Response Information
Resource Description
The response returned after the operation completes.
Collection of SaveGroupLettingsSearchingRoleDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
The unique identifier of this resource. |
integer |
None. |
| OwningTeamId |
The unique identifier of the related owning team resource. |
integer |
None. |
| BranchId |
The unique identifier of the related branch resource. |
integer |
None. |
| Description |
The description value. |
string |
None. |
| Criteria |
The criteria value. |
GroupLettingsSearchCriteriaDataContract |
None. |
| InActive |
Indicates whether in active is true. |
boolean |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"Id": 1,
"OwningTeamId": 2,
"BranchId": 3,
"Description": "sample string 4",
"Criteria": {
"TargetMoveIn": "2026-09-30T15:45:47.9882352Z",
"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,
"MaximumBedrooms": 1,
"HasGarden": true,
"Garage": true,
"MinimumReceptions": 4,
"MinimumBathrooms": 5,
"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"
}
],
"AddressId": 1,
"Address": {
"Latitude": 1.1,
"Longitude": 2.1,
"AddressSource": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"SourceId": "sample string 3",
"OrganizationName": "sample string 4",
"Number": "sample string 5",
"BuildingName": "sample string 6",
"Street": "sample string 7",
"Town": "sample string 8",
"Locality": "sample string 9",
"County": "sample string 10",
"Country": "sample string 11",
"Postcode": "sample string 12",
"Uprn": "sample string 13",
"CreatedDate": "2026-09-30T15:45:47.9882352Z",
"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": 15
}
},
"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"
}
]
}
},
"InActive": true
},
{
"Id": 1,
"OwningTeamId": 2,
"BranchId": 3,
"Description": "sample string 4",
"Criteria": {
"TargetMoveIn": "2026-09-30T15:45:47.9882352Z",
"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,
"MaximumBedrooms": 1,
"HasGarden": true,
"Garage": true,
"MinimumReceptions": 4,
"MinimumBathrooms": 5,
"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"
}
],
"AddressId": 1,
"Address": {
"Latitude": 1.1,
"Longitude": 2.1,
"AddressSource": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"SourceId": "sample string 3",
"OrganizationName": "sample string 4",
"Number": "sample string 5",
"BuildingName": "sample string 6",
"Street": "sample string 7",
"Town": "sample string 8",
"Locality": "sample string 9",
"County": "sample string 10",
"Country": "sample string 11",
"Postcode": "sample string 12",
"Uprn": "sample string 13",
"CreatedDate": "2026-09-30T15:45:47.9882352Z",
"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": 15
}
},
"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"
}
]
}
},
"InActive": true
}
]