PUT api/v2/electrical/projects/list

ListElectricalProject

Request Information

URI Parameters

None.

Body Parameters

The query

Name	Type	Additional 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

Request Formats

application/json

Sample:

{
  "OrganizationId": "00000000-0000-0000-0000-000000000000",
  "IsOrderConfirmed": true,
  "CustomerName": {
    "Filters": [
      {
        "Value": "sample string 1",
        "ExpressionKind": "Equal"
      },
      {
        "Value": "sample string 1",
        "ExpressionKind": "Equal"
      }
    ]
  },
  "ObjectStreet": {
    "Filters": [
      {
        "Value": "sample string 1",
        "ExpressionKind": "Equal"
      },
      {
        "Value": "sample string 1",
        "ExpressionKind": "Equal"
      }
    ]
  },
  "ObjectStreetNumber": {
    "Filters": [
      {
        "Value": "sample string 1",
        "ExpressionKind": "Equal"
      },
      {
        "Value": "sample string 1",
        "ExpressionKind": "Equal"
      }
    ]
  },
  "ObjectLocality": {
    "Filters": [
      {
        "Value": "sample string 1",
        "ExpressionKind": "Equal"
      },
      {
        "Value": "sample string 1",
        "ExpressionKind": "Equal"
      }
    ]
  },
  "ObjectPostalCode": {
    "Filters": [
      {
        "Value": "sample string 1",
        "ExpressionKind": "Equal"
      },
      {
        "Value": "sample string 1",
        "ExpressionKind": "Equal"
      }
    ]
  },
  "Status": "Request",
  "Select": {
    "OrganizationId": true,
    "Identifier": true,
    "Description": true,
    "Status": true,
    "CurrentElectricalProjectVersionId": true,
    "CustomerName": true,
    "CreateDate": true,
    "Reports": true,
    "Users": true,
    "ObjectId": true,
    "Street": true,
    "StreetNumber": true,
    "PostalCode": true,
    "Locality": true,
    "LastActivityDate": true,
    "LastActivityUser": true
  },
  "Sort": [
    "Status",
    "Status"
  ],
  "PageNumber": 1,
  "PageSize": 1
}

Response Information

Resource Description

ListElectricalProjectQueryResult

Name	Description	Type	Additional 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
}