GetStakeholderByPlantId
Description
This method is used to get all the potential property stakeholders (buyers / sellers) how are linked to a property.
Request
Parameter | Type | Mandatory/Optional | Maximum character length/limit | Description |
---|---|---|---|---|
plantIdInput | GetStakeholderByPlantIdInput | Mandatory | Not Relevant | The folder Id number (plant) |
applicationName | string | Mandatory | Should be less than or equal to 10 characters | The name of the integration partner |
Note:
- It is mandatory to provide plant Id.
Request - Input sample
<GetStakeholderByPlantId> <MethodParameters> <UserAuthentication> <UserName>?</UserName> <Password>?</Password> <AnyAttr attr0="XmlAttributeArray" isNull="false"> <XmlAttributeArray0>System.Xml.XmlAttribute</XmlAttributeArray0> </AnyAttr> </UserAuthentication> <input> <PlantId>2314</PlantId> </input> <applicationName>WS-2</applicationName> </MethodParameters> </GetStakeholderByPlantId>
Response
Type | Description |
---|---|
GetStakeholderByPlantIdOutput | Plant Id with List of stakeholders linked to a property plant by sales agent |
Response - output sample
<GetStakeholderByPlantId> <MethodParameters> <GetStakeholderByPlantIdOutput> <PlantId>2314</PlantId> <PlantStakeHolders attr0="PlantStakeholderArray" isNull="false"> <PlantStakeholderArray0> <PersonId>550</PersonId> <PersonName>Linn Svendsen</PersonName> <PersonEmail isNull="true" /> <StakeholderType>Seller</StakeholderType> <StakeholderTypeId>2</StakeholderTypeId> <StakeholderId>3</StakeholderId> <DocumentsCount>2</DocumentsCount> <CreatedBy>Sameera</CreatedBy> <CreatedUserId>44</CreatedUserId> <LastUpdatedDate>10/1/2019 4:47:21 PM</LastUpdatedDate> <IsCreatedByRealStateAgent>true</IsCreatedByRealStateAgent> </PlantStakeholderArray0> <PlantStakeholderArray1> <PersonId>551</PersonId> <PersonName>Turkan Sener</PersonName> <PersonEmail isNull="true" /> <StakeholderType>Buyer</StakeholderType> <StakeholderTypeId>1</StakeholderTypeId> <StakeholderId>4</StakeholderId> <DocumentsCount>1</DocumentsCount> <CreatedBy>Sameera</CreatedBy> <CreatedUserId>44</CreatedUserId> <LastUpdatedDate>9/25/2019 4:48:58 PM</LastUpdatedDate> <IsCreatedByRealStateAgent>true</IsCreatedByRealStateAgent> </PlantStakeholderArray1> <PlantStakeholderArray2> <PersonId>550</PersonId> <PersonName>Linn Svendsen</PersonName> <PersonEmail isNull="true" /> <StakeholderType>Buyer</StakeholderType> <StakeholderTypeId>1</StakeholderTypeId> <StakeholderId>6</StakeholderId> <DocumentsCount>0</DocumentsCount> <CreatedBy>Sameera</CreatedBy> <CreatedUserId>44</CreatedUserId> <LastUpdatedDate>9/26/2019 2:39:55 PM</LastUpdatedDate> <IsCreatedByRealStateAgent>false</IsCreatedByRealStateAgent> </PlantStakeholderArray2> <PlantStakeholderArray3> <PersonId>553</PersonId> <PersonName>Aksel Qvist</PersonName> <PersonEmail isNull="true" /> <StakeholderType>Buyer</StakeholderType> <StakeholderTypeId>1</StakeholderTypeId> <StakeholderId>7</StakeholderId> <DocumentsCount>0</DocumentsCount> <CreatedBy>Sameera</CreatedBy> <CreatedUserId>44</CreatedUserId> <LastUpdatedDate>9/26/2019 2:40:33 PM</LastUpdatedDate> <IsCreatedByRealStateAgent>false</IsCreatedByRealStateAgent> </PlantStakeholderArray3> </PlantStakeHolders> </GetStakeholderByPlantIdOutput> </MethodParameters> </GetStakeholderByPlantId>
Exceptions
Error Code | Description |
---|---|
123 | An exception occurred while processing your request |
138 | applicationName length has exceeded the maximum character limit allowed (10) |
146 | The applicationName is not set |
167 | Unauthenticated Bedrift Role |
113 | Required field not provided |
130 | Input plantId is either zero or negative. Please enter a positive value for the id |
111 | User does not have access to the plant |
110 | Input parameters contain null or invalid data |