GET api/v2/electrical/projects/list

ListElectricalProject

Request Information

URI Parameters

NameDescriptionTypeAdditional information
OrganizationId

universally unique identifier

Required

IsOrderConfirmed

boolean

None.

CustomerName

StringExpressionQueryFilterList

None.

ObjectStreet

StringExpressionQueryFilterList

None.

ObjectStreetNumber

StringExpressionQueryFilterList

None.

ObjectLocality

StringExpressionQueryFilterList

None.

ObjectPostalCode

StringExpressionQueryFilterList

None.

Status

ElectricalProjectVersionStatus

None.

Select

ListElectricalProjectQuerySelect

Required

Sort

Collection of ListElectricalProjectQuerySort

Required

Default value:

PageNumber

integer (32 bits)

Required

Default value: 1

PageSize

integer (32 bits)

Required

Default value: 100

Body Parameters

None.

Response Information

Resource Description

ListElectricalProjectQueryResult

ListElectricalProjectQueryResult
NameDescriptionTypeAdditional information
Projects

Collection of ListElectricalProjectQueryResultProject

Required

Count

integer (32 bits)

Range: inclusive between 0 and 2147483647

Response Formats

application/json

Sample:
{
  "Projects": [
    {
      "ProjectId": "00000000-0000-0000-0000-000000000000",
      "ElectricalProjectId": "00000000-0000-0000-0000-000000000000",
      "OrganizationId": "00000000-0000-0000-0000-000000000000",
      "Identifier": "sample string 1",
      "Description": "sample string 2",
      "Status": "Request",
      "CurrentElectricalProjectVersionId": "00000000-0000-0000-0000-000000000000",
      "CustomerName": "sample string 3",
      "CreateDate": "2025-04-16T15:42:31.506+00:00",
      "LastActivityDate": "2025-04-16T15:42:31.506+00:00",
      "LastActivityUser": {
        "UserId": "00000000-0000-0000-0000-000000000000",
        "Email": "sample string 1",
        "DisplayName": "sample string 2"
      },
      "Reports": [
        {
          "Name": "sample string 1"
        },
        {
          "Name": "sample string 1"
        }
      ],
      "Users": [
        {
          "UserId": "00000000-0000-0000-0000-000000000000",
          "Email": "sample string 1",
          "DisplayName": "sample string 2",
          "Kind": "Inspector"
        },
        {
          "UserId": "00000000-0000-0000-0000-000000000000",
          "Email": "sample string 1",
          "DisplayName": "sample string 2",
          "Kind": "Inspector"
        }
      ],
      "Object": {
        "ObjectId": "00000000-0000-0000-0000-000000000000",
        "Street": "sample string 1",
        "StreetNumber": "sample string 2",
        "PostalCode": "sample string 3",
        "Locality": "sample string 4"
      }
    },
    {
      "ProjectId": "00000000-0000-0000-0000-000000000000",
      "ElectricalProjectId": "00000000-0000-0000-0000-000000000000",
      "OrganizationId": "00000000-0000-0000-0000-000000000000",
      "Identifier": "sample string 1",
      "Description": "sample string 2",
      "Status": "Request",
      "CurrentElectricalProjectVersionId": "00000000-0000-0000-0000-000000000000",
      "CustomerName": "sample string 3",
      "CreateDate": "2025-04-16T15:42:31.506+00:00",
      "LastActivityDate": "2025-04-16T15:42:31.506+00:00",
      "LastActivityUser": {
        "UserId": "00000000-0000-0000-0000-000000000000",
        "Email": "sample string 1",
        "DisplayName": "sample string 2"
      },
      "Reports": [
        {
          "Name": "sample string 1"
        },
        {
          "Name": "sample string 1"
        }
      ],
      "Users": [
        {
          "UserId": "00000000-0000-0000-0000-000000000000",
          "Email": "sample string 1",
          "DisplayName": "sample string 2",
          "Kind": "Inspector"
        },
        {
          "UserId": "00000000-0000-0000-0000-000000000000",
          "Email": "sample string 1",
          "DisplayName": "sample string 2",
          "Kind": "Inspector"
        }
      ],
      "Object": {
        "ObjectId": "00000000-0000-0000-0000-000000000000",
        "Street": "sample string 1",
        "StreetNumber": "sample string 2",
        "PostalCode": "sample string 3",
        "Locality": "sample string 4"
      }
    }
  ],
  "Count": 1
}