PUT api/v2/portal/electrical/projects/documents/list

ListDocumentForElectricalProjectPortal

Request Information

URI Parameters

None.

Body Parameters

The query

ListElectricalProjectDocumentPortalQuery
NameDescriptionTypeAdditional information
ElectricalProjectId

universally unique identifier

Required

Request Formats

application/json

Sample:
{
  "ElectricalProjectId": "00000000-0000-0000-0000-000000000000"
}

Response Information

Resource Description

ListDocumentForElectricalProjectPortalQueryResult

ListElectricalProjectDocumentPortalQueryResult
NameDescriptionTypeAdditional information
Versions

Collection of ListElectricalProjectDocumentPortalQueryResultVersion

Required

InspectionPlan

ListElectricalProjectDocumentPortalQueryResultVersion

None.

Inspection

ListElectricalProjectDocumentPortalQueryResultVersion

None.

RepeatInspection

ListElectricalProjectDocumentPortalQueryResultVersion

None.

Response Formats

application/json

Sample:
{
  "Versions": [
    {
      "ElectricalProjectVersionId": "00000000-0000-0000-0000-000000000000",
      "Date": "2025-04-16T15:42:31.506+00:00",
      "InspectionKind": "Inspection",
      "CreateUser": {
        "UserId": "00000000-0000-0000-0000-000000000000",
        "DisplayName": "sample string 1"
      },
      "Documents": [
        {
          "DocumentId": "00000000-0000-0000-0000-000000000000",
          "ElectricalProjectVersionId": "00000000-0000-0000-0000-000000000000",
          "ElectricalProjectObservationId": "00000000-0000-0000-0000-000000000000",
          "FileKind": "Pdf",
          "ContentKind": "ElectricalProjectPriceQuote",
          "HasFile": true,
          "File": {
            "FileId": "00000000-0000-0000-0000-000000000000",
            "Name": "sample string 1",
            "Size": 1,
            "ContentType": "sample string 2",
            "IsImage": true,
            "Width": 1,
            "Height": 1,
            "LastUpdateDate": "2025-04-16T15:42:31.506+00:00"
          },
          "SerialNumber": 1,
          "Description": "sample string 1"
        },
        {
          "DocumentId": "00000000-0000-0000-0000-000000000000",
          "ElectricalProjectVersionId": "00000000-0000-0000-0000-000000000000",
          "ElectricalProjectObservationId": "00000000-0000-0000-0000-000000000000",
          "FileKind": "Pdf",
          "ContentKind": "ElectricalProjectPriceQuote",
          "HasFile": true,
          "File": {
            "FileId": "00000000-0000-0000-0000-000000000000",
            "Name": "sample string 1",
            "Size": 1,
            "ContentType": "sample string 2",
            "IsImage": true,
            "Width": 1,
            "Height": 1,
            "LastUpdateDate": "2025-04-16T15:42:31.506+00:00"
          },
          "SerialNumber": 1,
          "Description": "sample string 1"
        }
      ]
    },
    {
      "ElectricalProjectVersionId": "00000000-0000-0000-0000-000000000000",
      "Date": "2025-04-16T15:42:31.506+00:00",
      "InspectionKind": "Inspection",
      "CreateUser": {
        "UserId": "00000000-0000-0000-0000-000000000000",
        "DisplayName": "sample string 1"
      },
      "Documents": [
        {
          "DocumentId": "00000000-0000-0000-0000-000000000000",
          "ElectricalProjectVersionId": "00000000-0000-0000-0000-000000000000",
          "ElectricalProjectObservationId": "00000000-0000-0000-0000-000000000000",
          "FileKind": "Pdf",
          "ContentKind": "ElectricalProjectPriceQuote",
          "HasFile": true,
          "File": {
            "FileId": "00000000-0000-0000-0000-000000000000",
            "Name": "sample string 1",
            "Size": 1,
            "ContentType": "sample string 2",
            "IsImage": true,
            "Width": 1,
            "Height": 1,
            "LastUpdateDate": "2025-04-16T15:42:31.506+00:00"
          },
          "SerialNumber": 1,
          "Description": "sample string 1"
        },
        {
          "DocumentId": "00000000-0000-0000-0000-000000000000",
          "ElectricalProjectVersionId": "00000000-0000-0000-0000-000000000000",
          "ElectricalProjectObservationId": "00000000-0000-0000-0000-000000000000",
          "FileKind": "Pdf",
          "ContentKind": "ElectricalProjectPriceQuote",
          "HasFile": true,
          "File": {
            "FileId": "00000000-0000-0000-0000-000000000000",
            "Name": "sample string 1",
            "Size": 1,
            "ContentType": "sample string 2",
            "IsImage": true,
            "Width": 1,
            "Height": 1,
            "LastUpdateDate": "2025-04-16T15:42:31.506+00:00"
          },
          "SerialNumber": 1,
          "Description": "sample string 1"
        }
      ]
    }
  ],
  "InspectionPlan": {
    "ElectricalProjectVersionId": "00000000-0000-0000-0000-000000000000",
    "Date": "2025-04-16T15:42:31.506+00:00",
    "InspectionKind": "Inspection",
    "CreateUser": {
      "UserId": "00000000-0000-0000-0000-000000000000",
      "DisplayName": "sample string 1"
    },
    "Documents": [
      {
        "DocumentId": "00000000-0000-0000-0000-000000000000",
        "ElectricalProjectVersionId": "00000000-0000-0000-0000-000000000000",
        "ElectricalProjectObservationId": "00000000-0000-0000-0000-000000000000",
        "FileKind": "Pdf",
        "ContentKind": "ElectricalProjectPriceQuote",
        "HasFile": true,
        "File": {
          "FileId": "00000000-0000-0000-0000-000000000000",
          "Name": "sample string 1",
          "Size": 1,
          "ContentType": "sample string 2",
          "IsImage": true,
          "Width": 1,
          "Height": 1,
          "LastUpdateDate": "2025-04-16T15:42:31.506+00:00"
        },
        "SerialNumber": 1,
        "Description": "sample string 1"
      },
      {
        "DocumentId": "00000000-0000-0000-0000-000000000000",
        "ElectricalProjectVersionId": "00000000-0000-0000-0000-000000000000",
        "ElectricalProjectObservationId": "00000000-0000-0000-0000-000000000000",
        "FileKind": "Pdf",
        "ContentKind": "ElectricalProjectPriceQuote",
        "HasFile": true,
        "File": {
          "FileId": "00000000-0000-0000-0000-000000000000",
          "Name": "sample string 1",
          "Size": 1,
          "ContentType": "sample string 2",
          "IsImage": true,
          "Width": 1,
          "Height": 1,
          "LastUpdateDate": "2025-04-16T15:42:31.506+00:00"
        },
        "SerialNumber": 1,
        "Description": "sample string 1"
      }
    ]
  },
  "Inspection": {
    "ElectricalProjectVersionId": "00000000-0000-0000-0000-000000000000",
    "Date": "2025-04-16T15:42:31.506+00:00",
    "InspectionKind": "Inspection",
    "CreateUser": {
      "UserId": "00000000-0000-0000-0000-000000000000",
      "DisplayName": "sample string 1"
    },
    "Documents": [
      {
        "DocumentId": "00000000-0000-0000-0000-000000000000",
        "ElectricalProjectVersionId": "00000000-0000-0000-0000-000000000000",
        "ElectricalProjectObservationId": "00000000-0000-0000-0000-000000000000",
        "FileKind": "Pdf",
        "ContentKind": "ElectricalProjectPriceQuote",
        "HasFile": true,
        "File": {
          "FileId": "00000000-0000-0000-0000-000000000000",
          "Name": "sample string 1",
          "Size": 1,
          "ContentType": "sample string 2",
          "IsImage": true,
          "Width": 1,
          "Height": 1,
          "LastUpdateDate": "2025-04-16T15:42:31.506+00:00"
        },
        "SerialNumber": 1,
        "Description": "sample string 1"
      },
      {
        "DocumentId": "00000000-0000-0000-0000-000000000000",
        "ElectricalProjectVersionId": "00000000-0000-0000-0000-000000000000",
        "ElectricalProjectObservationId": "00000000-0000-0000-0000-000000000000",
        "FileKind": "Pdf",
        "ContentKind": "ElectricalProjectPriceQuote",
        "HasFile": true,
        "File": {
          "FileId": "00000000-0000-0000-0000-000000000000",
          "Name": "sample string 1",
          "Size": 1,
          "ContentType": "sample string 2",
          "IsImage": true,
          "Width": 1,
          "Height": 1,
          "LastUpdateDate": "2025-04-16T15:42:31.506+00:00"
        },
        "SerialNumber": 1,
        "Description": "sample string 1"
      }
    ]
  },
  "RepeatInspection": {
    "ElectricalProjectVersionId": "00000000-0000-0000-0000-000000000000",
    "Date": "2025-04-16T15:42:31.506+00:00",
    "InspectionKind": "Inspection",
    "CreateUser": {
      "UserId": "00000000-0000-0000-0000-000000000000",
      "DisplayName": "sample string 1"
    },
    "Documents": [
      {
        "DocumentId": "00000000-0000-0000-0000-000000000000",
        "ElectricalProjectVersionId": "00000000-0000-0000-0000-000000000000",
        "ElectricalProjectObservationId": "00000000-0000-0000-0000-000000000000",
        "FileKind": "Pdf",
        "ContentKind": "ElectricalProjectPriceQuote",
        "HasFile": true,
        "File": {
          "FileId": "00000000-0000-0000-0000-000000000000",
          "Name": "sample string 1",
          "Size": 1,
          "ContentType": "sample string 2",
          "IsImage": true,
          "Width": 1,
          "Height": 1,
          "LastUpdateDate": "2025-04-16T15:42:31.506+00:00"
        },
        "SerialNumber": 1,
        "Description": "sample string 1"
      },
      {
        "DocumentId": "00000000-0000-0000-0000-000000000000",
        "ElectricalProjectVersionId": "00000000-0000-0000-0000-000000000000",
        "ElectricalProjectObservationId": "00000000-0000-0000-0000-000000000000",
        "FileKind": "Pdf",
        "ContentKind": "ElectricalProjectPriceQuote",
        "HasFile": true,
        "File": {
          "FileId": "00000000-0000-0000-0000-000000000000",
          "Name": "sample string 1",
          "Size": 1,
          "ContentType": "sample string 2",
          "IsImage": true,
          "Width": 1,
          "Height": 1,
          "LastUpdateDate": "2025-04-16T15:42:31.506+00:00"
        },
        "SerialNumber": 1,
        "Description": "sample string 1"
      }
    ]
  }
}