SendDocumentsToPrivateSection

Description

This method is used to send documents to a potential buyer or seller of a property. User should have a valid work-space for the given property in order to send documents for that particular property.

Request

Parameter	Type	Mandatory/Optional	Comments
SendDocumentsToPrivateSectionInput		Mandatory	Not relevant
applicationName	string	Mandatory	Should be less than or equal to 10 character

Sample Input

<SendDocumentsToPrivateSection>
  <MethodParameters>
    <UserAuthentication>
      <UserName>sameera</UserName>
      <Password>xxxxx</Password>
      <AnyAttr attr0="XmlAttributeArray" isNull="false">
        <XmlAttributeArray0>System.Xml.XmlAttribute</XmlAttributeArray0>
      </AnyAttr>
    </UserAuthentication>
    <input>
      <StakeholderId>7</StakeholderId>
      <Documents attr0="DocumentSubsetInputArray" isNull="false">
        <DocumentSubsetInputArray0>
          <FileName>HomeSaleDoc.pdf</FileName>
          <DocumentTypeId>0</DocumentTypeId>
		  <Title>Sales of New apartment</Title>
          <Url>https://wwww.sample.com/silvestris_silvestris_small_gradual_decrease_of_quality.png</Url>
          <Description>Home Sale 3</Description>
          <Data isNull="false" />
          <IsVisibleToStakeholder>True</IsVisibleToStakeholder>
          <ProfessionId>-1</ProfessionId>
        </DocumentSubsetInputArray0>
		<DocumentSubsetInputArray1>
          <FileName>HomeSaleDoc.pdf</FileName>
          <DocumentTypeId>12</DocumentTypeId>
		  <Title>Sales of New Home</Title>
          <Url></Url>
          <Description>Home Sale 3</Description>
          <Data>Valid Base64 String</Data>
          <IsVisibleToStakeholder>True</IsVisibleToStakeholder>
          <ProfessionId>-1</ProfessionId>
        </DocumentSubsetInputArray1>
      </Documents>
    </input>
    <applicationName>HO1</applicationName>
  </MethodParameters>
</SendDocumentsToPrivateSection>

Response

Type	Description
SendDocumentsToPrivateSectionOutput	Saved Documents Array with status code

Sample Output

<SendDocumentsToPrivateSection>
  <MethodParameters>
    <SendDocumentsToPrivateSectionOutput>
      <Statuses attr0="DocumentUploadStatusArray" isNull="false">
        <DocumentUploadStatusArray0>
          <DocumentTitle>HomeSaleDoc.pdf</DocumentTitle>
          <DocumentId>101414</DocumentId>
          <UploadStatusCode>1</UploadStatusCode>
          <ErrorCode>0</ErrorCode>
        </DocumentUploadStatusArray0>
      </Statuses>
    </SendDocumentsToPrivateSectionOutput>
  </MethodParameters>
</SendDocumentsToPrivateSection>

Exceptions

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
112	There is no document to upload
113	One or more mandatory fields have not been provided
114	File name contains invalid charactor(s)
115	Given ProfessionId(s) are not valid
116	Invalid DocumentTypeId
123	An exception occurred while processing your request
126	File extension is not specified or file extension is not valid
133	Url or Data must be provided to create a document file
136	Provided Url is invalid
138	applicationName length has exceeded the maximum character limit allowed (10)
146	The applicationName is not set
165	The given profession is not registered to your company
167	You are not authorized to use this method
332	Document FileName has exceeded the maximum character limit of 260
330	Document Description has exceeded the maximum character limit of 360
331	Document Title has exceeded the maximum character limit of 260
153	64 bit encoded data decoding has failed
428	Stakeholder Id does not exist for your company or your license does not authorize you to access this Stakeholder Id