Skip to main content
Version: 2.2.1

newPhysicalFileLoan

This method makes it possible to add a record of a physical record loan. For this action, it is necessary to follow the standard documented below.

Java class
Requestweb/wwwroot/ws/java/archival/NewPhysicalFileLoanRequestType.java
Returnweb/wwwroot/ws/java/archival/NewPhysicalFileLoanResponseType.java

Request:

ID #RequiredDescription
UserIDXRequester user ID
LoanDateXLoan date (format: yyyy-mm-dd)
DocumentIDXDocument ID #
CategoryIDXCategory ID #
DevolutionDateLoan return date (format: yyyy-mm-dd). If not entered, the deadline according to the default deadline specified in the document category is calculated.
ReasonIDLoan reason ID #

Request structure:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:archival">
<soapenv:Header/>
<soapenv:Body>
<urn:newPhysicalFileLoan>
<urn:UserID>?</urn:UserID>
<urn:LoanDate>?</urn:LoanDate>
<urn:DocumentID>?</urn:DocumentID>
<urn:CategoryID>?</urn:CategoryID>
<urn:DevolutionDate>?</urn:DevolutionDate>
<urn:ReasonID>?</urn:ReasonID>
</urn:newPhysicalFileLoan>
</soapenv:Body>
</soapenv:Envelope>

Return:

ID #Description
StatusFAILURE (in case of failure) / SUCCESS (in case of success)
CodeCode - Error code:
• 0 - No error (record created successfully);
• 1 - Logged user does not have permission;
• 2 - Document not found;
• 3 - Category not found;
• 4 - User not found;
• 5 - Required parameter not entered or entered incorrectly;
• 6 - Document already loaned out;
• 7 - Document processing;
• 8 - Document is not archived;
• 9 - Document has already been deleted;
• 10 - Reason not found;
DetailMessage detailing the error or success in the execution of the method.
RecordIDLoan record code created (in case of success) or empty (in case of failure)