PUT api/ItemHeritageStudy

No documentation available.

Request Information

Parameters

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

Request body formats

application/json, text/json

Sample:

{
  "HeritageStudy": {
    "$id": "2",
    "PK": 1
  },
  "StudyType": {
    "$id": "3",
    "$values": [
      {
        "$id": "4",
        "Id": 1,
        "CodeDesc": "sample string 2",
        "AlternativeDesc": "sample string 3",
        "SystemCode": "sample string 4",
        "SequenceNo": 1
      },
      {
        "$ref": "4"
      },
      {
        "$ref": "4"
      }
    ]
  },
  "Request": {
    "$id": "5",
    "Filters": {
      "$id": "6",
      "$values": [
        {
          "$id": "7",
          "<Field>k__BackingField": "sample string 1",
          "<Operator>k__BackingField": "sample string 2",
          "<Value>k__BackingField": {
            "$id": "8"
          },
          "<Logic>k__BackingField": "sample string 4",
          "<Filters>k__BackingField": {
            "$id": "9",
            "$values": [
              {
                "$ref": "7"
              },
              {
                "$ref": "7"
              },
              {
                "$ref": "7"
              }
            ]
          }
        },
        {
          "$ref": "7"
        },
        {
          "$ref": "7"
        }
      ]
    },
    "Page": 1,
    "PageSize": 2,
    "Sort": {
      "$id": "10",
      "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
  },
  "ScreenType": "sample string 1",
  "HasEditAccess": true,
  "Organisation": "sample string 3",
  "Entity": {
    "$id": "11",
    "PK": 1
  },
  "Validation": {
    "$id": "12",
    "SuccessOutput": {
      "$id": "13"
    },
    "Success": true,
    "ErrorMessages": null,
    "WarningMessages": {
      "$id": "14",
      "$values": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ]
    },
    "InfoMessages": {
      "$id": "15",
      "$values": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ]
    },
    "DatabaseErrorMessage": "sample string 3",
    "SuccessMessage": "sample string 4",
    "RelatedKeyId": "sample string 5"
  },
  "PageAccess": {
    "$id": "16",
    "PageCode": "sample string 1",
    "StepAccesses": {
      "$id": "17",
      "$values": [
        {
          "$id": "18",
          "StageCode": "sample string 1",
          "StepCode": "sample string 2"
        },
        {
          "$ref": "18"
        },
        {
          "$ref": "18"
        }
      ]
    },
    "Positions": {
      "$id": "19",
      "$values": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ]
    }
  },
  "UserRole": 0
}

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 'ItemHeritageStudyViewModel'.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "Validation": {
    "$id": "2",
    "SuccessOutput": {
      "$id": "3"
    },
    "Success": true,
    "ErrorMessages": null,
    "WarningMessages": {
      "$id": "4",
      "$values": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ]
    },
    "InfoMessages": {
      "$id": "5",
      "$values": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ]
    },
    "DatabaseErrorMessage": "sample string 3",
    "SuccessMessage": "sample string 4",
    "RelatedKeyId": "sample string 5"
  },
  "PageAccess": {
    "$id": "6",
    "PageCode": "sample string 1",
    "StepAccesses": {
      "$id": "7",
      "$values": [
        {
          "$id": "8",
          "StageCode": "sample string 1",
          "StepCode": "sample string 2"
        },
        {
          "$ref": "8"
        },
        {
          "$ref": "8"
        }
      ]
    },
    "Positions": {
      "$id": "9",
      "$values": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ]
    }
  },
  "UserRole": 0
}