GET api/globalsearch/properties
Search for Properties across the system.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
Term | string |
None. |
|
PageSize | integer |
None. |
|
PageNumber | integer |
None. |
|
BranchId | integer |
None. |
|
GroupTypes | Collection of Dezrez.Core.DataContracts.External.Api.GlobalSearch.Query.Groups.GroupSearchType |
None. |
|
ExcludeDeleted | boolean |
None. |
|
ExcludeArchived | boolean |
None. |
|
LastUpdated | date |
None. |
|
ServiceType | string |
None. |
|
PaginationLastDocumentId | integer |
None. |
Body Parameters
None.
Response Information
Resource Description
PagedCollectionDataContractOfDezrez.Core.DataContracts.External.Api.GlobalSearch.Query.Property.GlobalSearchPropertyResultDataContractName | Description | Type | Additional information |
---|---|---|---|
TotalCount | integer |
None. |
|
CurrentCount | integer |
None. |
|
PageSize | integer |
None. |
|
PageNumber | integer |
None. |
|
Collection | Collection of Dezrez.Core.DataContracts.External.Api.GlobalSearch.Query.Property.GlobalSearchPropertyResultDataContract |
None. |
Response Formats
application/json, text/json
Sample:
{ "TotalCount": 1, "CurrentCount": 2, "PageSize": 1, "PageNumber": 1, "Collection": [ { "PrimaryGroupMember": { "Id": 1, "GroupId": 2, "Title": "sample string 3", "Name": "sample string 4", "EmailAddress": { "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 }, "Telephone": { "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 } }, "Property": { "Address": { "OrganizationName": "sample string 1", "Number": "sample string 2", "BuildingName": "sample string 3", "Street": "sample string 4", "Town": "sample string 5", "Locality": "sample string 6", "Postcode": "sample string 7", "County": "sample string 8" }, "Id": 1 }, "Roles": [ { "OwningTeamId": 1, "BranchId": 2, "Name": "sample string 3", "TeamAccessType": "sample string 4", "RoleType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "DefaultPicture": { "Url": "sample string 1", "RequiresAuthentication": true, "ExpiryDate": "2024-10-08T09:09:12.7779176Z", "FileStream": null, "Tags": [ { "Name": "sample string 1", "SystemStatusName": "sample string 2", "TagType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Id": 3 }, { "Name": "sample string 1", "SystemStatusName": "sample string 2", "TagType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Id": 3 } ], "DocumentType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "DocumentSubType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "FileName": "sample string 3", "ContentType": "sample string 4", "FileExtension": "sample string 5", "Description": "sample string 6", "FileSize": "sample string 7", "CreatedDate": "2024-10-08T09:09:12.7779176Z", "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": 9 }, "RoleStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "SummaryTextDescription": "sample string 5", "Price": { "PriceValue": 1.1, "CurrencyCode": "sample string 2", "PriceText": "sample string 3", "PriceType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "PriceQualifierType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Id": 4 }, "CreatedDate": "2024-10-08T09:09:12.7779176Z", "ExchangedPrice": { "PriceValue": 1.1, "CurrencyCode": "sample string 2", "PriceText": "sample string 3", "PriceType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "PriceQualifierType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Id": 4 }, "OfferAcceptedPrice": { "PriceValue": 1.1, "CurrencyCode": "sample string 2", "PriceText": "sample string 3", "PriceType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "PriceQualifierType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Id": 4 }, "TenantRoleStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "TenantRoleId": 7, "LastUpdated": "2024-10-08T09:09:12.7779176Z", "Id": 8 }, { "OwningTeamId": 1, "BranchId": 2, "Name": "sample string 3", "TeamAccessType": "sample string 4", "RoleType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "DefaultPicture": { "Url": "sample string 1", "RequiresAuthentication": true, "ExpiryDate": "2024-10-08T09:09:12.7779176Z", "FileStream": null, "Tags": [ { "Name": "sample string 1", "SystemStatusName": "sample string 2", "TagType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Id": 3 }, { "Name": "sample string 1", "SystemStatusName": "sample string 2", "TagType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Id": 3 } ], "DocumentType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "DocumentSubType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "FileName": "sample string 3", "ContentType": "sample string 4", "FileExtension": "sample string 5", "Description": "sample string 6", "FileSize": "sample string 7", "CreatedDate": "2024-10-08T09:09:12.7779176Z", "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": 9 }, "RoleStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "SummaryTextDescription": "sample string 5", "Price": { "PriceValue": 1.1, "CurrencyCode": "sample string 2", "PriceText": "sample string 3", "PriceType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "PriceQualifierType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Id": 4 }, "CreatedDate": "2024-10-08T09:09:12.7779176Z", "ExchangedPrice": { "PriceValue": 1.1, "CurrencyCode": "sample string 2", "PriceText": "sample string 3", "PriceType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "PriceQualifierType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Id": 4 }, "OfferAcceptedPrice": { "PriceValue": 1.1, "CurrencyCode": "sample string 2", "PriceText": "sample string 3", "PriceType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "PriceQualifierType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Id": 4 }, "TenantRoleStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "TenantRoleId": 7, "LastUpdated": "2024-10-08T09:09:12.7779176Z", "Id": 8 } ], "LastUpdated": "2024-10-08T09:09:12.7779176Z", "Id": 1 }, { "PrimaryGroupMember": { "Id": 1, "GroupId": 2, "Title": "sample string 3", "Name": "sample string 4", "EmailAddress": { "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 }, "Telephone": { "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 } }, "Property": { "Address": { "OrganizationName": "sample string 1", "Number": "sample string 2", "BuildingName": "sample string 3", "Street": "sample string 4", "Town": "sample string 5", "Locality": "sample string 6", "Postcode": "sample string 7", "County": "sample string 8" }, "Id": 1 }, "Roles": [ { "OwningTeamId": 1, "BranchId": 2, "Name": "sample string 3", "TeamAccessType": "sample string 4", "RoleType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "DefaultPicture": { "Url": "sample string 1", "RequiresAuthentication": true, "ExpiryDate": "2024-10-08T09:09:12.7779176Z", "FileStream": null, "Tags": [ { "Name": "sample string 1", "SystemStatusName": "sample string 2", "TagType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Id": 3 }, { "Name": "sample string 1", "SystemStatusName": "sample string 2", "TagType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Id": 3 } ], "DocumentType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "DocumentSubType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "FileName": "sample string 3", "ContentType": "sample string 4", "FileExtension": "sample string 5", "Description": "sample string 6", "FileSize": "sample string 7", "CreatedDate": "2024-10-08T09:09:12.7779176Z", "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": 9 }, "RoleStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "SummaryTextDescription": "sample string 5", "Price": { "PriceValue": 1.1, "CurrencyCode": "sample string 2", "PriceText": "sample string 3", "PriceType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "PriceQualifierType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Id": 4 }, "CreatedDate": "2024-10-08T09:09:12.7779176Z", "ExchangedPrice": { "PriceValue": 1.1, "CurrencyCode": "sample string 2", "PriceText": "sample string 3", "PriceType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "PriceQualifierType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Id": 4 }, "OfferAcceptedPrice": { "PriceValue": 1.1, "CurrencyCode": "sample string 2", "PriceText": "sample string 3", "PriceType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "PriceQualifierType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Id": 4 }, "TenantRoleStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "TenantRoleId": 7, "LastUpdated": "2024-10-08T09:09:12.7779176Z", "Id": 8 }, { "OwningTeamId": 1, "BranchId": 2, "Name": "sample string 3", "TeamAccessType": "sample string 4", "RoleType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "DefaultPicture": { "Url": "sample string 1", "RequiresAuthentication": true, "ExpiryDate": "2024-10-08T09:09:12.7779176Z", "FileStream": null, "Tags": [ { "Name": "sample string 1", "SystemStatusName": "sample string 2", "TagType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Id": 3 }, { "Name": "sample string 1", "SystemStatusName": "sample string 2", "TagType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Id": 3 } ], "DocumentType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "DocumentSubType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "FileName": "sample string 3", "ContentType": "sample string 4", "FileExtension": "sample string 5", "Description": "sample string 6", "FileSize": "sample string 7", "CreatedDate": "2024-10-08T09:09:12.7779176Z", "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": 9 }, "RoleStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "SummaryTextDescription": "sample string 5", "Price": { "PriceValue": 1.1, "CurrencyCode": "sample string 2", "PriceText": "sample string 3", "PriceType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "PriceQualifierType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Id": 4 }, "CreatedDate": "2024-10-08T09:09:12.7779176Z", "ExchangedPrice": { "PriceValue": 1.1, "CurrencyCode": "sample string 2", "PriceText": "sample string 3", "PriceType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "PriceQualifierType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Id": 4 }, "OfferAcceptedPrice": { "PriceValue": 1.1, "CurrencyCode": "sample string 2", "PriceText": "sample string 3", "PriceType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "PriceQualifierType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Id": 4 }, "TenantRoleStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "TenantRoleId": 7, "LastUpdated": "2024-10-08T09:09:12.7779176Z", "Id": 8 } ], "LastUpdated": "2024-10-08T09:09:12.7779176Z", "Id": 1 } ] }