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

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

Collection of Dezrez.Core.DataContracts.External.Api.Group.Command.AddSearch.SaveGroupLettingsSearchingRoleDataContract

Name	Type	Additional information
Id	integer	None.
OwningTeamId	integer	None.
BranchId	integer	None.
Description	string	None.
Criteria	Dezrez.Core.DataContracts.External.Api.Group.Command.AddSearch.GroupLettingsSearchCriteriaDataContract	None.
InActive	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "OwningTeamId": 2,
    "BranchId": 3,
    "Description": "sample string 4",
    "Criteria": {
      "TargetMoveIn": "2024-10-30T15:16:54.7488027Z",
      "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"
          }
        ]
      }
    },
    "InActive": true
  },
  {
    "Id": 1,
    "OwningTeamId": 2,
    "BranchId": 3,
    "Description": "sample string 4",
    "Criteria": {
      "TargetMoveIn": "2024-10-30T15:16:54.7488027Z",
      "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"
          }
        ]
      }
    },
    "InActive": true
  }
]