Navigation:  Integration via SOAP web services > Published web services > Archive >

newPhysicalFileLoan

Previous  Top  Next

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

Request

web/wwwroot/ws/java/archival/NewPhysicalFileLoanRequestType.java

Return

web/wwwroot/ws/java/archival/NewPhysicalFileLoanResponseType.java

 

Request

ID #

Required

Description

UserID

X

Requester user ID

LoanDate

X

Loan date (format: yyyy-mm-dd)

DocumentID

X

Document ID #

CategoryID

X

Category ID #

DevolutionDate

 

Loan devolution date (format: yyyy-mm-dd). If not entered, the deadline according to the default deadline specified in the document category is calculated.

ReasonID

 

Loan reason ID #

 

Return

ID #

Description

Status

FAILURE (in case of failure) / SUCCESS (in case of success)

Code

Code - 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;

Detail

Message detailing the error or success in the execution of the method

RecordID

Loan record code created (in case of success) or empty (in case of failure)