GenerateJobDocument - Obsolete

Description

This method is developed for electricians and is used to generate a job document based on the two documents provided for chapter two and three and the stored default document for chapter one. It returns the URL and Id of the generated document and the list of failed DeviceIds.

A sample job document contains five main sections.

1. Cover page – This is the first page of the generated document and will contain the property and company information. If companies have uploaded the company logo and description to the Boligmappa Bedrift system it will also be included in the cover page. If it is not provided, relevant spaces are left empty so that the users can include the logo and description manually.
2. Table of Contents – The description for Chapter one can also be customized in the Boligmappa Bedrift admin's company profile page. If this value is not set in the profile page, a default description ("Generell brukerveiledning for elektriske installasjoner") is used.
3. Chapter 1 – Companies can upload a default chapter one document to Boligmappa Bedrift. The companies that have uploaded a default chapter one document, can use it as the chapter one of job documents generated by that company. The companies also have the option of using the ‘Default Boligmappa chapter one document’ by selecting it in the Boligmappa Bedrift admin page. If this is not provided a page with a help text will be added under ChapterOne.  View the Chapter one help text.
4. Chapter 2 – This section of the document is generated by the user input provided in chapterTwo. If this is not provided a page with a help text is added under ChapterTwo.  View the Chapter two help text.
5. Chapter 3 – This section contains a list of DeviceDocuments (EFO, NRF and NOBB). If the user has provided a Url or Base64 encoded data string as the input of ‘chapterThree’, it is used for this section. If the user has provided a list of DeviceIds as the input of ‘chapterThree’, this section is generated by retrieving the requested Device documents. 

Request

NOTE: It is mandatory to provide either the ChapterTwo or ChapterThree input parameter to generate a job document.

Request - sample input

<GenerateJobDocument>
  <MethodParameters>
    <UserAuthentication>
      <UserName>username</UserName>
      <Password>password</Password>
      <AnyAttr attr0="XmlAttributeArray" isNull="false">
        <XmlAttributeArray0>System.Xml.XmlAttribute</XmlAttributeArray0>
      </AnyAttr>
    </UserAuthentication>
    <chapterOneDocumentId>54616</chapterOneDocumentId>
    <chapterTwo attr0="ChapterTwoArray" isNull="false">
      <ChapterTwoArray0>
        <Url>https://blogs.adobe.com/security/SampleSignedPDFDocument.pdf</Url>
        <Data isNull="false" />
      </ChapterTwoArray0>
    </chapterTwo>
    <chapterThree>
      <DeviceIds isNull="true" />
      <Url>https://s21.q4cdn.com/374334112/files/doc_downloads/test.pdf</Url>
      <Data isNull="false" />
    </chapterThree>
    <documentName>testing</documentName>
    <plantId>6731</plantId>
    <orderNo isNull="false" />
    <propertyOwnerEmail isNull="false" />
    <applicationName>test</applicationName>
  </MethodParameters>
</GenerateJobDocument>

Response

Request - sample output

<GenerateJobDocument>
  <MethodParameters>
    <JobDocument>
      <BoligmappaDocId>57470</BoligmappaDocId>
      <Url>http://172.20.1.183:8080/Document/DownloadDocumentWebService/DownloadDocWithSessionKey?sessionKey=rl%2fL3WDK6Fs%2bCIaABAaVX%2fB86JfdgxtfqB4n377Kp9TqzvRs9lRTzgmkEamQBze3</Url>
      <FailedDeviceIds isNull="true" />
      <EmailStatusCode>1</EmailStatusCode>
    </JobDocument>
  </MethodParameters>
</GenerateJobDocument>

Exceptions