GET api/v2/electrical/projects/planning/list?OrganizationId={OrganizationId}&StartDate={StartDate}&PeriodKind={PeriodKind}

ListProjectPlanning

Request Information

URI Parameters

Name	Type	Additional information
OrganizationId	universally unique identifier	Required
StartDate	date	Required
PeriodKind	ListElectricalProjectPlanningPeriodKind	Required

Body Parameters

None.

Response Information

Resource Description

ListProjectPlanningQueryResult

ListElectricalProjectPlanningQueryResult

Name	Description	Type	Additional information
Projects		Collection of ListElectricalProjectPlanningQueryResultProject	Required

Response Formats

application/json

Sample:

{
  "Projects": [
    {
      "ElectricalProjectVersionId": "00000000-0000-0000-0000-000000000000",
      "Reports": [
        {
          "ElectricalProjectDocumentTemplateId": "00000000-0000-0000-0000-000000000000",
          "Name": "sample string 1",
          "ContentKind": "ElectricalProjectPriceQuote",
          "IntervalKind": "None",
          "InspectionKind": "None"
        },
        {
          "ElectricalProjectDocumentTemplateId": "00000000-0000-0000-0000-000000000000",
          "Name": "sample string 1",
          "ContentKind": "ElectricalProjectPriceQuote",
          "IntervalKind": "None",
          "InspectionKind": "None"
        }
      ],
      "Status": "Request",
      "CreateDate": "2025-04-16T15:42:31.506+00:00",
      "ProjectObject": {
        "Name": "sample string 1",
        "Street": "sample string 2",
        "StreetNumber": "sample string 3",
        "PostalCode": "sample string 4",
        "Locality": "sample string 5"
      },
      "ProjectUsers": [
        {
          "UserId": "00000000-0000-0000-0000-000000000000",
          "Kind": "Inspector",
          "DisplayName": "sample string 1",
          "Email": "sample string 2"
        },
        {
          "UserId": "00000000-0000-0000-0000-000000000000",
          "Kind": "Inspector",
          "DisplayName": "sample string 1",
          "Email": "sample string 2"
        }
      ],
      "StartDate": "2025-04-16T16:42:31.506",
      "EndDate": "2025-04-16T16:42:31.506"
    },
    {
      "ElectricalProjectVersionId": "00000000-0000-0000-0000-000000000000",
      "Reports": [
        {
          "ElectricalProjectDocumentTemplateId": "00000000-0000-0000-0000-000000000000",
          "Name": "sample string 1",
          "ContentKind": "ElectricalProjectPriceQuote",
          "IntervalKind": "None",
          "InspectionKind": "None"
        },
        {
          "ElectricalProjectDocumentTemplateId": "00000000-0000-0000-0000-000000000000",
          "Name": "sample string 1",
          "ContentKind": "ElectricalProjectPriceQuote",
          "IntervalKind": "None",
          "InspectionKind": "None"
        }
      ],
      "Status": "Request",
      "CreateDate": "2025-04-16T15:42:31.506+00:00",
      "ProjectObject": {
        "Name": "sample string 1",
        "Street": "sample string 2",
        "StreetNumber": "sample string 3",
        "PostalCode": "sample string 4",
        "Locality": "sample string 5"
      },
      "ProjectUsers": [
        {
          "UserId": "00000000-0000-0000-0000-000000000000",
          "Kind": "Inspector",
          "DisplayName": "sample string 1",
          "Email": "sample string 2"
        },
        {
          "UserId": "00000000-0000-0000-0000-000000000000",
          "Kind": "Inspector",
          "DisplayName": "sample string 1",
          "Email": "sample string 2"
        }
      ],
      "StartDate": "2025-04-16T16:42:31.506",
      "EndDate": "2025-04-16T16:42:31.506"
    }
  ]
}