EditJobDocumentChapterThree - Obsolete
- Janith Weerasinghe (Unlicensed)
- Buddhi Chathuranga Senarathna (Unlicensed)
- Per-Christian Svendsen (Unlicensed)
Description
This method is developed for electricians and is used to edit Chapter Three of a previously generated job document.
Request
| Parameter | Type | Mandatory/Optional | Maximum character length/limit | Description |
|---|---|---|---|---|
jobDocument | Mandatory | Not Relevant | Model containing the generated document from the GenerateJobDocument method | |
overwrite | boolean | Mandatory | Not Relevant | If this field is set to TRUE, the existing Chapter Three section of the document is removed, and the given document is added. If it is set to FALSE, the existing Chapter Three section is preserved and the given document is appended to this section. |
inputDoc | Mandatory | Not Relevant | Document to be inserted as Chapter 3 or a set of EfoIds which can be used to generate Chapter 3 by getting relevant Efo documents | |
documentName | string | Mandatory | Not Relevant | Name of the document |
plantId | long | Mandatory | Not Relevant | Id of the plant to which the generated document should be associated |
orderNo | string | Optional | Not Relevant | Order number |
applicationName | string | Mandatory | Should be less than or equal to 10 characters | The name of the integration partner |
Request - sample input
Response
| Type | Description |
|---|---|
A model containing the Url of the generated document, documentId, and a list of failed EfoIds. |
Response - sample output
Exceptions
| Error Code | Description |
|---|---|
111 | plantId does not exist for your company or your license does not authorize you to access this plantId |
123 | An exception occurred while processing your request |
138 | applicationName length has exceeded the maximum character limit allowed (10) |
144 | One or more of the input document models does not contain adequate information (EfoIds, Url or Base64 encoded data) |
145 | The plantId is invalid |
146 | The applicationName is not set |
148 | The documentName cannot be empty |
149 | Input job document is not set |
150 | Could not find Efo documents for any of the EfoIds provided |
151 | The company is not authorized to access one or more of the given documents |
152 | No property is connected to the given plantId |
153 | 64 bit encoded data decoding failed |
159 | Unable to parse the input job document. Make sure you have uploaded a document generated by the Boligmappa system |
167 | You are not authorized to use this method |
174 | Provided Boligmappa documentId is invalid |