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

Object

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

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-07-23T08:26:08.4933451Z",
      "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,
        "Garage": true,
        "HasGarden": 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
      },
      "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-07-23T08:26:08.4933451Z",
      "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,
        "Garage": true,
        "HasGarden": 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
      },
      "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
  }
]