POST api/group/{id}/savelettingssearch

Saves Lettings Search Criteria to a group

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

SaveGroupLettingsSearchingRoleDataContract
NameDescriptionTypeAdditional information
Id

integer

None.

OwningTeamId

integer

None.

BranchId

integer

None.

Description

string

None.

Criteria

GroupLettingsSearchCriteriaDataContract

None.

InActive

boolean

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:
{
  "Id": 1,
  "OwningTeamId": 2,
  "BranchId": 3,
  "Description": "sample string 4",
  "Criteria": {
    "TargetMoveIn": "2025-07-02T05:25:33.169288Z",
    "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
}

Response Information

Resource Description

GroupLettingsSearchingRoleDataContract
NameDescriptionTypeAdditional information
Criteria

GroupLettingsSearchCriteriaDataContract

None.

Description

string

None.

DislikedRoles

Collection of integer

None.

LikedRoles

Collection of integer

None.

ShouldRoles

Collection of integer

None.

RoleStatus

EnumDataContract

None.

OwningTeamId

integer

None.

BranchId

integer

None.

GroupId

integer

None.

Name

string

None.

TeamAccessType

string

None.

RoleType

EnumDataContract

None.

CustomFields

Collection of CustomFieldGroupWithValuesDataContract

None.

CreatedDate

date

None.

CreatedBy

CreatedByDataContract

None.

Id

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Criteria": {
    "TargetMoveIn": "2025-07-02T05:25:33.169288Z",
    "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": "2025-07-02T05:25:33.169288Z",
  "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
}