CreateStakeholder

Description

This method is used to create new propertyStakeholder in DB.

Request

Parameter	Type	Mandatory/Optional	Maximum character length/limit	Description
PersonKey	string	Mandatory	Not Relevant	person key
PlantId	string	Mandatory	Not Relevant	Selected plant id
StakeholderType	string	Mandatory	Not Relevant	stakeholder type id
applicationName	string	Mandatory	Should be less than or equal to 10 characters	The name of the integration partner

Request XML

<CreateStakeholder>
  <MethodParameters>
    <UserAuthentication>
      <UserName></UserName>
      <Password></Password>
      <AnyAttr attr0="XmlAttributeArray" isNull="false">
        <XmlAttributeArray0>System.Xml.XmlAttribute</XmlAttributeArray0>
      </AnyAttr>
    </UserAuthentication>
    <createBuyerOrSellerInput>
      <PersonKey></PersonKey>
      <PlantId></PlantId>
      <StakeholderType></StakeholderType>
    </createBuyerOrSellerInput>
    <applicationName></applicationName>
  </MethodParameters>
</CreateStakeholder>

Response

Parameter	Description
PersonName	Property owner name
StakeholderId	Created stakeholder Id
StakeholderTypeId	Stakeholder type Id
StakeholderType	Stakeholder type name
DocumentCount	Uploaded document count
CreatedBy	Created User
CreatedUserId	Created User Id
LastUpdatedDate	Last Updated Date
PersonId	Person Id
PersonEmail	Property owner email

Response XML

<CreateStakeholder>
  <MethodParameters>
    <CreateStakeholderOutput>
      <PersonName>Frode Willoch</PersonName>
      <StakeholderId>23</StakeholderId>
      <StakeholderTypeId>1</StakeholderTypeId>
      <StakeholderType>Buyer</StakeholderType>
      <DocumentCount>0</DocumentCount>
      <CreatedBy>test</CreatedBy>
      <CreatedUserId>44</CreatedUserId>
      <LastUpdatedDate>01.10.2019 14:36:46</LastUpdatedDate>
      <PersonId>984</PersonId>
      <PersonEmail isNull="true" />
    </CreateStakeholderOutput>
  </MethodParameters>
</CreateStakeholder>

Error Codes

Error code	Description
108	Input parameters contain invalid or null data
111	plantId does not exist for your company or your license does not authorize you to access this plantId
123	An exception occurred while processing your request
130	Input plantId is either zero or negative. Please enter a positive value for the id
152	No property is connected to the given plantId
419	Given stakeholder is already linked with the selected plant
420	Stakeholder type is not valid
421	Person key is not valid
422	Given stakeholder type is not valid
423	Can not find given property Owner