Description
...
Description
This method is used to create a job based on the details provided . And also it generates and generate a job document by combining all the documentsThis method . It generates a job document based on the provided two documents documents provided for chapter two and three and the stored default document for chapter one. It returns the URL Url and Id of the generated document and the list of devices created.
...
- Cover page – This is the first page of the generated document and will contain the property and Company Informationcompany information. If companies have uploaded the company logo and description to the Boligmappa Bedrift system then it will be is also included in the cover page. If they are not provided them, relevant spaces will keep empty so that users can include the logo and description manually.
- Table of Contents – The description for Chapter one too can 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") will be used.
- Chapter 1 – Companies are provided the possibility to upload company default chapter one document to Boligmappa Bedrift. For the companies who have uploaded a default chapter one document, it will be used as the chapter one of job documents generated by that particular 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.
- Chapter 2 – This section of the document will contain contains all the work documents supplied by the user. If this is not provided a page with a help text will be is added under ChapterTwo. View the Chapter two help text.
- Chapter 3 – This section will contain all contains all the product documents and device manuals supplied by the user.
Note
Note : Jobs cannot be created in created for plants associated with buildings to buildings.
Request
Parameter | Type | Mandatory/OptionalComments | Maximum character length/limit | Description |
---|---|---|---|---|
plantId | long | MandatoryPlant Id | Not relevant | plantId to which the job should be associated |
job | Job | Mandatory | Not relevant | Details of the job |
chapterOneDocumentId | int | Optional | Not relevant | Id of the company document |
workDocuments | List<File> | Optional | Not relevant | List of documents about the work done in listing the details of the job |
productDocuments | List<File> | Optional | Not relevant | List of manuals of devices that were are already installed |
devices | List<DeviceInput> | Optional | Not relevant | List of newly installed devices |
documentName | string | Mandatory | Not relevant | Name of the document. (A job document is getting created when creating a job. This name is used as the file name with .pdf extension) |
applicationName | string | Mandatory | Third party application identifier, identifying the client consuming the web service – (Length of the applicationName should Should be less than or equal to 10 ) |
...
characters | The name of the integration partner |
Note
In order to create a job, at least one document attached in order to create a jobshould be attached.
Request - sample input
<CreateJob>
<MethodParameters>
<UserAuthentication>
<UserName>username</UserName>
<Password>password</Password>
<AnyAttr attr0="XmlAttributeArray" isNull="false">
<XmlAttributeArray0>System.Xml.XmlAttribute</XmlAttributeArray0>
</AnyAttr>
</UserAuthentication>
<plantId>6731</plantId>
<job>
<Title>New job title</Title>
<Description>Job description</Description>
<WorkTypeId>2</WorkTypeId>
<ProfessionId>2</ProfessionId>
</job>
<chapterOneDocumentId>0</chapterOneDocumentId>
<workDocuments attr0="FileArray" isNull="false">
<FileArray0>
<Url>http://imgsv.imaging.nikon.com/lineup/dslr/d600/img/sample01/img_05_l.jpg</Url>
<Data isNull="false" />
</FileArray0>
</workDocuments>
<productDocuments attr0="FileArray" isNull="false">
<FileArray0>
<Url>http://foersom.com/net/HowTo/data/OoPdfFormExample.pdf</Url>
<Data isNull="false" />
</FileArray0>
</productDocuments>
<devices isNull="true" />
<documentName>testjob document</documentName>
<applicationName>test</applicationName>
</MethodParameters>
</CreateJob>
Response
Type | Description |
---|---|
JobCreateStatus | Status of the job created |
Respnse - sample output
<CreateJob>
<MethodParameters>
<JobCreateStatus>
<JobId>150</JobId>
<Title>New job title</Title>
<JobDocumentId>57797</JobDocumentId>
<JobDocumentUrl>http://172.20.1.183:8080/Document/DownloadDocumentWebService/DownloadDocWithSessionKey?sessionKey=rl%2fL3WDK6Fs%2bCIaABAaVX8sX9yyK%2bcspOfDT60r7lscBpTyzZRxTepBAxQR4epJL</JobDocumentUrl>
<DeviceCreateStatuses attr0="DeviceCreateStatusArray" isNull="false" />
</JobCreateStatus>
</MethodParameters>
</CreateJob>
Exceptions
Error Code | Description |
---|---|
115 | Given professionId(s) are not valid |
123 | An exception occured while processing your request |
133 | Url or Data must be provided to create a document file |
138 | ApplicationName applicationName length is has exceeded the maximum allowed character limit allowed (10) |
146 | The application name applicationName is not set set |
148 | Document name The documentName cannot be empty empty |
152 | No property is connected to the given plant id plantId |
167 | You are not authorized to use this web method |
183 | Invalid WorkTypeId |
184 | Job is not set |
185 | To create a job there should be atleast one document in any of the categories WorkDocuments, ProductDocuments or deviceManuals inputs |
186 | Product name ProductName is not provided provided |
193 | Maintenance task must contain a description |
196 | Url or Data must be provided to create a device manual |
202 | This operation can only be done on plants connected to properties |
204 | Entered month is not valid. The range is from 1-12 |
206 | Invalid building element |
207 | RoomId doesn't does not exist or doesn't belong to the given plantplant |
210 | The Device Type Id DeviceId type provided is not valid |
216 | Maintenance description length is has exceeded the maximum allowed character limit allowed (70) |
219 | Job title cannot be empty |
...