Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

Description

This method is used to create new propertyStakeholder in DB.

Request

ParameterTypeMandatory/OptionalMaximum character length/limitDescription
PersonKeystringMandatoryNot Relevantperson key
PlantIdstringMandatoryNot RelevantSelected plant id
StakeholderTypestringMandatoryNot Relevantstakeholder type id
applicationNamestringMandatoryShould be less than or equal to 10 charactersThe 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

ParameterDescription
PersonNameProperty owner name
StakeholderIdCreated stakeholder Id
StakeholderTypeIdStakeholder type Id
StakeholderTypeStakeholder type name
DocumentCountUploaded document count
CreatedByCreated User
CreatedUserIdCreated User Id
LastUpdatedDateLast Updated Date
PersonIdPerson Id
PersonEmailProperty 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 codeDescription
108Input parameters contain invalid or null data
111plantId does not exist for your company or your license does not authorize you to access this plantId
123An exception occurred while processing your request
130Input plantId is either zero or negative. Please enter a positive value for the id
152No property is connected to the given plantId
419Given stakeholder already exist in DB
420Stakeholder type is not valid
421Person key is not valid
422Given stakeholder type is not valid
423Can not find given property Owner
  • No labels