POST api/ItemHeritageStudy/search-results

No documentation available.

Request Information

Parameters

Name	Description	Additional information
request	No documentation available.	Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "Filters": {
    "$id": "2",
    "$values": [
      {
        "$id": "3",
        "<Field>k__BackingField": "sample string 1",
        "<Operator>k__BackingField": "sample string 2",
        "<Value>k__BackingField": {
          "$id": "4"
        },
        "<Logic>k__BackingField": "sample string 4",
        "<Filters>k__BackingField": {
          "$id": "5",
          "$values": [
            {
              "$ref": "3"
            },
            {
              "$ref": "3"
            },
            {
              "$ref": "3"
            }
          ]
        }
      },
      {
        "$ref": "3"
      },
      {
        "$ref": "3"
      }
    ]
  },
  "Page": 1,
  "PageSize": 2,
  "Sort": {
    "$id": "6",
    "Field": "sample string 1",
    "Dir": "sample string 2",
    "SecondaryField": "sample string 3",
    "SecondaryDir": "sample string 4",
    "ThirdField": "sample string 5",
    "ThirdDir": "sample string 6"
  },
  "PreviousPageSize": 3
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'DataSearchRequest'.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "TResults": {
    "$id": "2",
    "$values": [
      {
        "$id": "3",
        "ItemHeritageStudieId": 1,
        "ItemId": 2,
        "HeritageStudyId": 3,
        "Title": "sample string 4",
        "ReferenceNumber": "sample string 5",
        "Year": 1,
        "Author": "sample string 6",
        "InspectedBy": "sample string 7",
        "DisplayGuidelinesFlag": "sample string 8",
        "OrganisationId": 1,
        "OrganisationName": "sample string 9",
        "CreatedByUser": "sample string 10",
        "CreatedDate": "2024-11-09T12:58:23.6736563+11:00",
        "ModifiedByUser": "sample string 11",
        "ModifiedDate": "2024-11-09T12:58:23.6736563+11:00",
        "InspectedDate": "2024-11-09T12:58:23.6736563+11:00",
        "RecommendedToStateSignificanceFlag": true,
        "RecommendedStateSignificant": true,
        "ItemName": "sample string 12",
        "ItemTypeLovId": 1,
        "ItemTypeDescription": "sample string 13",
        "AddressSummary": "sample string 14",
        "GroupName": "sample string 15",
        "ParentItemId": 1,
        "StudyCode": "sample string 16",
        "StudyTypeLovId": 1,
        "StudyTypeDescription": "sample string 17",
        "PK": 3
      },
      {
        "$ref": "3"
      },
      {
        "$ref": "3"
      }
    ]
  },
  "FullResults": {
    "$id": "4",
    "$values": [
      {
        "$ref": "3"
      },
      {
        "$ref": "3"
      },
      {
        "$ref": "3"
      }
    ]
  },
  "Validation": {
    "$id": "5",
    "SuccessOutput": {
      "$id": "6"
    },
    "Success": true,
    "ErrorMessages": null,
    "WarningMessages": {
      "$id": "7",
      "$values": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ]
    },
    "InfoMessages": {
      "$id": "8",
      "$values": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ]
    },
    "DatabaseErrorMessage": "sample string 3",
    "SuccessMessage": "sample string 4",
    "RelatedKeyId": "sample string 5"
  },
  "Results": {
    "$id": "9",
    "$values": [
      {
        "$id": "10"
      },
      {
        "$id": "11"
      },
      {
        "$id": "12"
      }
    ]
  },
  "Page": 1,
  "PageSize": 1,
  "PageCount": 1,
  "Sort": {
    "$id": "13",
    "Field": "sample string 1",
    "Dir": "sample string 2",
    "SecondaryField": "sample string 3",
    "SecondaryDir": "sample string 4",
    "ThirdField": "sample string 5",
    "ThirdDir": "sample string 6"
  },
  "Total": 2,
  "IsExternal": true,
  "UserRole": 0,
  "Area": "sample string 4",
  "MaxLayerSeachResultsExceededWarningMessage": "sample string 5",
  "maxHeritageLayerSearchValue": 1,
  "MaxResultsExceeded": true
}