CombineEfoDocuments
Description
This method is used to generate a document combining all the Efo documents for the given EfoIds and returns a Url and DocumentId.
Request
Parameter | Type | Mandatory/Optional | Maximum character length/limit | Description |
---|---|---|---|---|
efoIds | List<EfoItem> | Mandatory | Not relevant | Model containing the EfoIds for which the document has to be generated |
documentName | string | Optional | Not relevant | Name of the document. If this field is not provided, a default name is used. |
applicationName | string | Mandatory | Should be less than or equal to 10 characters | The name of the integration partner |
Request - sample input
<CombineEfoDocuments>
<MethodParameters>
<UserAuthentication>
<UserName>username</UserName>
<Password>password</Password>
<AnyAttr attr0="XmlAttributeArray" isNull="false">
<XmlAttributeArray0>System.Xml.XmlAttribute</XmlAttributeArray0>
</AnyAttr>
</UserAuthentication>
<efoItems attr0="EfoItemArray" isNull="false">
<EfoItemArray0>
<EfoId>1000112</EfoId>
<VendorId isNull="false" />
<DocumentType isNull="false" />
</EfoItemArray0>
<EfoItemArray1>
<EfoId>1001821</EfoId>
<VendorId isNull="false" />
<DocumentType isNull="false" />
</EfoItemArray1>
<EfoItemArray2>
<EfoId>1006578</EfoId>
<VendorId isNull="false" />
<DocumentType isNull="false" />
</EfoItemArray2>
</efoItems>
<documentName>testing1</documentName>
<applicationName>test</applicationName>
</MethodParameters>
</CombineEfoDocuments>
Response
Type | Description |
---|---|
A model containing the Url to the generated document, documentId and failed EfoIds, if there is any |
Response - sample output
<CombineEfoDocuments>
<MethodParameters>
<EfoDocument>
<BoligmappaDocId>57468</BoligmappaDocId>
<Url>http://482.22.1.183:7080/Document/DownloadDocumentWebService/DownloadDocWithSessionKey?sessionKey=rl%2fL3WDK6Fs%2bCIaABAaVX1zaUU5z81hcyPN0SJ5yuLyoJCR7XCKdixU9wV%2bFWOsU</Url>
<FailedEfoIds attr0="EfoItemArray" isNull="false" />
</EfoDocument>
</MethodParameters>
</CombineEfoDocuments>
Exceptions
Error Code | Description |
---|---|
123 | An exception occurred while processing your request |
138 | applicationName length has exceeded the maximum character limit allowed (10) |
140 | Input EfoId list is not set to a correct value |
141 | Input EfoId list is empty |
142 | One or more of the input EfoIds are invalid |
146 | The applicationName is not set |
150 | Could not find Efo documents for any of the EfoIds provided |
167 | You are not authorized to use this method |