SendNoteToPlant

Description

This method is used to generate a PDF document with the given information and associate it to the specified plant.

Request

Parameter	Type	Mandatory/Optional	Maximum character length/limit	Description
plantId	long	Mandatory	Not Relevant	Id of the plant to which the note should be associated
jobDescription	string	Mandatory	Should be less than or equal to 500 characters	A brief description about the job
jobStartDate	DateTime	Mandatory	Not Relevant	Start date of the job
jobEndDate	DateTime	Mandatory	Not Relevant	End date of the job
fileName	string	Optional	Not Relevant	Name of the generated file. Default name is 'Melding om utført arbeid ' *
orderNumber	string	Optional	Not Relevant	The job order number the document is associated with
showInBoligmappa	boolean	Mandatory	Not Relevant	Set the visibility of this document in boligmappa.no. Default is false
propertyOwnerEmail	string	Optional	Not Relevant	A notification is sent to the given email address when a document is uploaded to the property
applicationName	string	Mandatory	Should be less than or equal to 10 characters	The name of the integration partner

Note:

You can either use the default file name “Melding om utført arbeid” or set a preferred file name in your application.

Request - input sample

<SendNoteToPlant>
  <MethodParameters>
    <UserAuthentication>
      <UserName>username</UserName>
      <Password>password</Password>
      <AnyAttr attr0="XmlAttributeArray" isNull="false">
        <XmlAttributeArray0>System.Xml.XmlAttribute</XmlAttributeArray0>
      </AnyAttr>
    </UserAuthentication>
    <plantId>6820</plantId>
    <jobDescription>Send note</jobDescription>
    <jobStartDate>11/16/2017 11:30:28 AM</jobStartDate>
    <jobEndDate>11/16/2017 11:30:28 AM</jobEndDate>
    <fileName isNull="false" />
    <orderNumber isNull="false" />
    <showInBoligmappa>True</showInBoligmappa>
    <propertyOwnerEmail isNull="false" />
    <applicationName>test</applicationName>
  </MethodParameters>
</SendNoteToPlant>

Response

Type	Description
Note	Note created

Response - output sample

<SendNoteToPlant>
  <MethodParameters>
    <Note>
      <BoligmappaDocId>57487</BoligmappaDocId>
      <Url>http://172.20.1.183:8080/Document/DownloadDocumentWebService/DownloadDocWithSessionKey?sessionKey=rl%2fL3WDK6Fs%2bCIaABAaVXwm6knB2nVySYMOnChm4HzP2lcmkQA%2bPM6nCXiQKa9ZS</Url>
      <FileName>Melding om utført arbeid</FileName>
    </Note>
  </MethodParameters>
</SendNoteToPlant>

Exceptions

Error Code	Description
111	plantId does not exist for your company or your license does not authorize you to access this plantId
113	One or more mandatory fields have not been provided
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
161	Job description length has exceeded the maximum character limit allowed (500)
167	You are not authorized to use this web method
175	The jobEndDate needs to be later than the jobStartDate
217	An error occurred while sending the notification mail to the user
218	The propertyOwnerEmail provided is invalid