GET api/globalsearch/auctions

Search for Actions across the system.

Request Information

URI Parameters

NameDescriptionTypeAdditional 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.Auctions.GlobalSearchAuctionResultDataContract
NameDescriptionTypeAdditional information
TotalCount

integer

None.

CurrentCount

integer

None.

PageSize

integer

None.

PageNumber

integer

None.

Collection

Collection of Dezrez.Core.DataContracts.External.Api.GlobalSearch.Query.Auctions.GlobalSearchAuctionResultDataContract

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalCount": 1,
  "CurrentCount": 2,
  "PageSize": 1,
  "PageNumber": 1,
  "Collection": [
    {
      "AuctionDate": "2024-10-15T18:35:07.5137661Z",
      "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
        }
      },
      "PropertyAddress": "sample string 2",
      "NumberOfLots": 3,
      "LastUpdated": "2024-10-15T18:35:07.5137661Z",
      "Id": 4
    },
    {
      "AuctionDate": "2024-10-15T18:35:07.5137661Z",
      "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
        }
      },
      "PropertyAddress": "sample string 2",
      "NumberOfLots": 3,
      "LastUpdated": "2024-10-15T18:35:07.5137661Z",
      "Id": 4
    }
  ]
}