POST api/group/{id}/savesalessearch
Saves Search Criteria to a Group
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The id of the group |
integer |
Required |
Body Parameters
The groups search criteria
Dezrez.Core.DataContracts.External.Api.Group.Command.AddSearch.SaveGroupSalesSearchingRoleDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | integer |
None. |
|
| OwningTeamId | integer |
None. |
|
| BranchId | integer |
None. |
|
| Description | string |
None. |
|
| Criteria | Dezrez.Core.DataContracts.External.Api.Group.Command.AddSearch.GroupSearchCriteriaDataContract |
None. |
|
| Grade | Dezrez.Core.DataContracts.External.Api.System.EnumDataContract |
None. |
|
| Origin | Dezrez.Core.DataContracts.External.Api.System.EnumDataContract |
None. |
|
| FinancialStatus | Dezrez.Core.DataContracts.External.Api.System.EnumDataContract |
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": {
"BudgetFrom": 1,
"BudgetTo": 1,
"NormalisedBudgetFrom": 2.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"
}
]
}
},
"Grade": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Origin": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"FinancialStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"InActive": true
}
Response Information
Resource Description
The created search criteria
Dezrez.Core.DataContracts.External.Api.Group.Query.SearchingRoles.GroupSalesSearchingRoleDataContractResponse Formats
application/json, text/json
Sample:
{
"Criteria": {
"BudgetFrom": 1,
"BudgetTo": 1,
"NormalisedBudgetFrom": 2.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"
}
]
}
},
"Grade": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Origin": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"FinancialStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"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-11-21T09:37:41.6332102Z",
"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
}