POST api/UploadedFile/excavation-cv/{stepCode}

No documentation available.

Request Information

Parameters

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

Request body formats

application/json, text/json

Sample:

{
  "FileAttachment": "QEBA",
  "FileUrl": "sample string 1",
  "IsFileTooLarge": true,
  "ParentKeyId": 1,
  "ParentFolderName": "sample string 3",
  "IsDisabled": true,
  "FileRequiredFlag": true,
  "DropzoneText": "sample string 6",
  "DisableAutomaticUpload": true,
  "SharepointFilePath": "sample string 8",
  "MaxFileCount": 1,
  "MaxFileSize": 1,
  "IsAttached": true,
  "FileTypeCode": "sample string 10",
  "DoesFileGenerate": true,
  "HasFileBeenGenerated": true,
  "IsShowingLink": true,
  "SubmittedVersionNo": 1,
  "ApplicationId": 14,
  "StampImagePath": "sample string 15",
  "CurrentApplicationStep": "sample string 16",
  "FetchStamped": true,
  "IsStepFile": true,
  "IsStepReadOnly": true,
  "IsSequenceNumberRequired": true,
  "IsAutoCommit": true,
  "StakeholderId": 22,
  "StakeholderType": "sample string 23",
  "DocumentTypes": {
    "$id": "2",
    "$values": [
      {
        "$id": "3",
        "CodeLovId": 1,
        "CodeType": "sample string 2",
        "Description": "sample string 3",
        "AlternativeDesc": "sample string 4",
        "ShortDesc": "sample string 5",
        "ActiveFlag": true,
        "SequenceNo": 1,
        "SystemCode": "sample string 7",
        "IsStreetAddressFlag": true
      },
      {
        "$ref": "3"
      },
      {
        "$ref": "3"
      }
    ]
  },
  "OtherFileTypeLovId": 24,
  "FileTypeName": "sample string 25",
  "AcceptedFileTypes": "sample string 26",
  "IsLabeled": true,
  "IsImage": true,
  "CreatedBy": "sample string 29",
  "ModifiedBy": "sample string 30",
  "UploadedFileScanDataId": "sample string 31",
  "ApplicationTypeCode": "sample string 32",
  "ActionToCall": "sample string 33",
  "IsUploadHeritageItem": true,
  "IsAllRecordsErrors": true,
  "UploadHeritageItems": {
    "$id": "4",
    "$values": [
      {
        "$id": "5",
        "ApplicationId": 1,
        "ItemId": 2,
        "Address": "sample string 3",
        "ModifiedDate": "2024-11-29T01:48:45.8252343+11:00",
        "ItemName": "sample string 5",
        "StreetNo": "sample string 6",
        "StreetAddress": "sample string 7",
        "Suburb": "sample string 8",
        "Postcode": "sample string 9",
        "PhysicalDescription": "sample string 10",
        "StatementSignificance": "sample string 11",
        "History": "sample string 12"
      },
      {
        "$ref": "5"
      },
      {
        "$ref": "5"
      }
    ]
  },
  "Entity": {
    "$id": "6",
    "PK": 1
  },
  "Validation": {
    "$id": "7",
    "SuccessOutput": {
      "$id": "8"
    },
    "Success": true,
    "ErrorMessages": null,
    "WarningMessages": {
      "$id": "9",
      "$values": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ]
    },
    "InfoMessages": {
      "$id": "10",
      "$values": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ]
    },
    "DatabaseErrorMessage": "sample string 3",
    "SuccessMessage": "sample string 4",
    "RelatedKeyId": "sample string 5"
  },
  "PageAccess": {
    "$id": "11",
    "PageCode": "sample string 1",
    "StepAccesses": {
      "$id": "12",
      "$values": [
        {
          "$id": "13",
          "StageCode": "sample string 1",
          "StepCode": "sample string 2"
        },
        {
          "$ref": "13"
        },
        {
          "$ref": "13"
        }
      ]
    },
    "Positions": {
      "$id": "14",
      "$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 'UploadedFileViewModel'.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "FileAttachment": "QEBA",
  "FileUrl": "sample string 1",
  "IsFileTooLarge": true,
  "ParentKeyId": 1,
  "ParentFolderName": "sample string 3",
  "IsDisabled": true,
  "FileRequiredFlag": true,
  "DropzoneText": "sample string 6",
  "DisableAutomaticUpload": true,
  "SharepointFilePath": "sample string 8",
  "MaxFileCount": 1,
  "MaxFileSize": 1,
  "IsAttached": true,
  "FileTypeCode": "sample string 10",
  "DoesFileGenerate": true,
  "HasFileBeenGenerated": true,
  "IsShowingLink": true,
  "SubmittedVersionNo": 1,
  "ApplicationId": 14,
  "StampImagePath": "sample string 15",
  "CurrentApplicationStep": "sample string 16",
  "FetchStamped": true,
  "IsStepFile": true,
  "IsStepReadOnly": true,
  "IsSequenceNumberRequired": true,
  "IsAutoCommit": true,
  "StakeholderId": 22,
  "StakeholderType": "sample string 23",
  "DocumentTypes": {
    "$id": "2",
    "$values": [
      {
        "$id": "3",
        "CodeLovId": 1,
        "CodeType": "sample string 2",
        "Description": "sample string 3",
        "AlternativeDesc": "sample string 4",
        "ShortDesc": "sample string 5",
        "ActiveFlag": true,
        "SequenceNo": 1,
        "SystemCode": "sample string 7",
        "IsStreetAddressFlag": true
      },
      {
        "$ref": "3"
      },
      {
        "$ref": "3"
      }
    ]
  },
  "OtherFileTypeLovId": 24,
  "FileTypeName": "sample string 25",
  "AcceptedFileTypes": "sample string 26",
  "IsLabeled": true,
  "IsImage": true,
  "CreatedBy": "sample string 29",
  "ModifiedBy": "sample string 30",
  "UploadedFileScanDataId": "sample string 31",
  "ApplicationTypeCode": "sample string 32",
  "ActionToCall": "sample string 33",
  "IsUploadHeritageItem": true,
  "IsAllRecordsErrors": true,
  "UploadHeritageItems": {
    "$id": "4",
    "$values": [
      {
        "$id": "5",
        "ApplicationId": 1,
        "ItemId": 2,
        "Address": "sample string 3",
        "ModifiedDate": "2024-11-29T01:48:45.8408584+11:00",
        "ItemName": "sample string 5",
        "StreetNo": "sample string 6",
        "StreetAddress": "sample string 7",
        "Suburb": "sample string 8",
        "Postcode": "sample string 9",
        "PhysicalDescription": "sample string 10",
        "StatementSignificance": "sample string 11",
        "History": "sample string 12"
      },
      {
        "$ref": "5"
      },
      {
        "$ref": "5"
      }
    ]
  },
  "Entity": {
    "$id": "6",
    "PK": 1
  },
  "Validation": {
    "$id": "7",
    "SuccessOutput": {
      "$id": "8"
    },
    "Success": true,
    "ErrorMessages": null,
    "WarningMessages": {
      "$id": "9",
      "$values": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ]
    },
    "InfoMessages": {
      "$id": "10",
      "$values": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ]
    },
    "DatabaseErrorMessage": "sample string 3",
    "SuccessMessage": "sample string 4",
    "RelatedKeyId": "sample string 5"
  },
  "PageAccess": {
    "$id": "11",
    "PageCode": "sample string 1",
    "StepAccesses": {
      "$id": "12",
      "$values": [
        {
          "$id": "13",
          "StageCode": "sample string 1",
          "StepCode": "sample string 2"
        },
        {
          "$ref": "13"
        },
        {
          "$ref": "13"
        }
      ]
    },
    "Positions": {
      "$id": "14",
      "$values": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ]
    }
  },
  "UserRole": 0
}