PATCH api/v2/electrical/projects/objects/patch

PatchElectricalProjectObject

Request Information

URI Parameters

None.

Body Parameters

The command

Name	Type	Additional information
ElectricalProjectVersionId	universally unique identifier	Required
ClearFields	Collection of PatchElectricalProjectObjectCommandClearField	None.
BagIdentificationNumber	string	Max length: 30
Name	string	Max length: 100
Description	string	Max length: 250
Street	string	Max length: 64
StreetNumber	string	Max length: 32
PostalCode	string	Max length: 16
Locality	string	Max length: 64
TotalFloorArea	integer (32 bits)	Range: inclusive between 0 and 1000000
BuildingConstructionYear	integer (32 bits)	Range: inclusive between 1000 and 2100
Email	string	Data type: EmailAddress Max length: 256
TelephoneNumber	string	Max length: 60
BuildingCount	integer (32 bits)	Range: inclusive between 0 and 100000
DistributionBoardCount	integer (32 bits)	Range: inclusive between 0 and 100000
ControlBoxCount	integer (32 bits)	Range: inclusive between 0 and 100000
IsElectricalInstallationConstructionYearKnown	boolean	None.
ElectricalInstallationConstructionYear	integer (32 bits)	Range: inclusive between 1800 and 2100
Remarks	string	Max length: 1000
InspectionPlanCreatorKind	ElectricalProjectInspectionPlanCreatorKind	None.
PVPanelCount	integer (32 bits)	Range: inclusive between 0 and 100000
PVInverterCount	integer (32 bits)	Range: inclusive between 0 and 100000
PVPanelsTotalPower	integer (32 bits)	Range: inclusive between 0 and 10000
PVInvertersTotalPower	integer (32 bits)	Range: inclusive between 0 and 10000
PVBuildKind	ElectricalPVInstallationBuildKind	None.
PVInstallationConstructionYear	integer (32 bits)	Range: inclusive between 1800 and 2100
PVSpecialSpaceKind	ElectricalPVInstallationSpecialSpacesKind	None.
PVEarthingSystemKind	ElectricalEarthingSystemKind	None.
PVMainsVoltage	integer (32 bits)	Range: inclusive between 0 and 10000
PVInstallationHasLightningProtection	boolean	None.
PVInspectionCoverEntireInstallation	boolean	None.
PVInstallationExludedParts	string	Max length: 1000
PVAreSpecialSpacesPresent	boolean	None.

Request Formats

application/json

Sample:

{
  "ElectricalProjectVersionId": "00000000-0000-0000-0000-000000000000",
  "ClearFields": [
    "BagIdentificationNumber",
    "BagIdentificationNumber"
  ],
  "BagIdentificationNumber": "sample string 1",
  "Name": "sample string 2",
  "Description": "sample string 3",
  "Street": "sample string 4",
  "StreetNumber": "sample string 5",
  "PostalCode": "sample string 6",
  "Locality": "sample string 7",
  "TotalFloorArea": 1,
  "BuildingConstructionYear": 1,
  "Email": "sample string 8",
  "TelephoneNumber": "sample string 9",
  "BuildingCount": 1,
  "DistributionBoardCount": 1,
  "ControlBoxCount": 1,
  "IsElectricalInstallationConstructionYearKnown": true,
  "ElectricalInstallationConstructionYear": 1,
  "Remarks": "sample string 10",
  "InspectionPlanCreatorKind": "InstallationAdministrator",
  "PVPanelCount": 1,
  "PVInverterCount": 1,
  "PVPanelsTotalPower": 1,
  "PVInvertersTotalPower": 1,
  "PVBuildKind": "InRoof",
  "PVInstallationConstructionYear": 1,
  "PVSpecialSpaceKind": "New",
  "PVEarthingSystemKind": "TT",
  "PVMainsVoltage": 1,
  "PVInstallationHasLightningProtection": true,
  "PVInspectionCoverEntireInstallation": true,
  "PVInstallationExludedParts": "sample string 11",
  "PVAreSpecialSpacesPresent": true
}

Response Information

Resource Description

PatchElectricalProjectObjectCommandResult

Name	Description	Type	Additional information
Result		PatchElectricalProjectObjectCommandResultKind	Required

Response Formats

application/json

Sample:

{
  "Result": "Success"
}