PATCH api/v2/electrical/projects/organizations/patch

PatchElectricalProjectOrganization

Request Information

URI Parameters

None.

Body Parameters

The command

PatchElectricalProjectOrganizationCommand
NameDescriptionTypeAdditional information
ElectricalProjectOrganizationId

universally unique identifier

Required

ClearFields

Collection of PatchElectricalProjectOrganizationCommandClearField

None.

Name

string

Max length: 100

Description

string

Max length: 250

Address

PatchElectricalProjectOrganizationCommandAddress

None.

Email

string

Data type: EmailAddress

Max length: 256

TelephoneNumber

string

Max length: 60

Website

string

Max length: 250

IsProjectCustomer

boolean

None.

IsObjectOwner

boolean

None.

IsObjectAdministrator

boolean

None.

IsObjectTenant

boolean

None.

IsPVInstallationConstructionCompany

boolean

None.

Request Formats

application/json

Sample:
{
  "ElectricalProjectOrganizationId": "00000000-0000-0000-0000-000000000000",
  "ClearFields": [
    "Name",
    "Name"
  ],
  "Name": "sample string 1",
  "Description": "sample string 2",
  "Address": {
    "Street": "sample string 1",
    "StreetNumber": "sample string 2",
    "PostalCode": "sample string 3",
    "Locality": "sample string 4",
    "AdministrativeArea": "sample string 5",
    "CountryId": "00000000-0000-0000-0000-000000000000"
  },
  "Email": "sample string 3",
  "TelephoneNumber": "sample string 4",
  "Website": "sample string 5",
  "IsProjectCustomer": true,
  "IsObjectOwner": true,
  "IsObjectAdministrator": true,
  "IsObjectTenant": true,
  "IsPVInstallationConstructionCompany": true
}

Response Information

Resource Description

PatchElectricalProjectOrganizationCommandResult

PatchElectricalProjectOrganizationCommandResult
NameDescriptionTypeAdditional information
Result

PatchElectricalProjectOrganizationCommandResultKind

Required

Response Formats

application/json

Sample:
{
  "Result": "Success"
}