com.exlibris.dps.sdk.deposit

Interface DepositWebServices

All Superinterfaces:

com.exlibris.core.infra.svc.api.GenericWebService

public interface DepositWebServices
extends com.exlibris.core.infra.svc.api.GenericWebService

DepositWebServices defines the Web services that enable depositing an item in the system and retrieving information on deposits.

Author:

zvif

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDepositActivityBySubmitDate(java.lang.String pdsHandle, java.lang.String depositActivityStatus, java.lang.String producerID, java.lang.String producerAgentID, java.lang.String submitDateFrom, java.lang.String submitDateTo, java.lang.String startRecord, java.lang.String endRecord) API for retrieving a list of deposit activities according to the submission date
java.lang.String	getDepositActivityBySubmitDateByMaterialFlow(java.lang.String pdsHandle, java.lang.String depositActivityStatus, java.lang.String materialFlowId, java.lang.String producerID, java.lang.String producerAgentID, java.lang.String submitDateFrom, java.lang.String submitDateTo, java.lang.String startRecord, java.lang.String endRecord) API for retrieving a list of deposit activities according to the submission date
java.lang.String	getDepositActivityByUpdateDate(java.lang.String pdsHandle, java.lang.String depositActivityStatus, java.lang.String producerID, java.lang.String producerAgentID, java.lang.String updateDateFrom, java.lang.String updateDateTo, java.lang.String startRecord, java.lang.String endRecord) API for retrieving a list of deposit activities according to the update date
java.lang.String	getDepositActivityByUpdateDateByMaterialFlow(java.lang.String pdsHandle, java.lang.String depositActivityStatus, java.lang.String materialFlowId, java.lang.String producerID, java.lang.String producerAgentID, java.lang.String updateDateFrom, java.lang.String updateDateTo, java.lang.String startRecord, java.lang.String endRecord) API for retrieving a list of deposit activities according to the update date
java.lang.String	submitDepositActivity(java.lang.String pdsHandle, java.lang.String materialFlowId, java.lang.String subDirectoryName, java.lang.String producerId, java.lang.String depositSetId) API for submitting a deposit

Methods inherited from interface com.exlibris.core.infra.svc.api.GenericWebService

getHeartBit

Method Detail

submitDepositActivity

java.lang.String submitDepositActivity(java.lang.String pdsHandle,
                                       java.lang.String materialFlowId,
                                       java.lang.String subDirectoryName,
                                       java.lang.String producerId,
                                       java.lang.String depositSetId)

API for submitting a deposit

Parameters:

pdsHandle - of a logged in user

materialFlowId - of the material flow used

subDirectoryName - of the load directory

producerId - of the Producer

depositSetId - not in use

Returns:

an XML with the reply to the request that includes
1. isError - true/false
2. messageCode - of error
3. messageDesc - of error
4. sipId - if no error, new SIP ID
5. depositActivityId - if no error, new deposit activity ID
6. userParams - that were submitted with request
7. creationDate
Example:
<xb:deposit_result xmlns:xb="http://com/exlibris/digitool/deposit/service/xmlbeans">
<xb:isError>true</xb:isError>
<xb:messageCode xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<xb:messageDesc>MaterialFlow with id 6 does not exist in DB.</xb:messageDesc>
<xb:userParams>pdsHandle=202200816413213002020082413216, materialFlowId=6, subDirectoryName=deposit - 4 - dc - complex, producerId=1, depositSetId=1</xb:userParams>
<xb:creationDate xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
</xb:deposit_result>

getDepositActivityBySubmitDate

java.lang.String getDepositActivityBySubmitDate(java.lang.String pdsHandle,
                                                java.lang.String depositActivityStatus,
                                                java.lang.String producerID,
                                                java.lang.String producerAgentID,
                                                java.lang.String submitDateFrom,
                                                java.lang.String submitDateTo,
                                                java.lang.String startRecord,
                                                java.lang.String endRecord)

API for retrieving a list of deposit activities according to the submission date

Parameters:

pdsHandle - of a logged in user

depositActivityStatus - All, In process, Rejected, Draft, Approved, Declined

producerID - A Producer ID if requesting for a specific Producer

producerAgentID - A Producer Agent ID if requesting for a specific Producer Agent

submitDateFrom - The requested period start date, mandatory

submitDateTo - The requested period end date, mandatory

startRecord - Used for pagination

endRecord - Used for pagination

Returns:

an XML with the reply to the request, which includes the list of requested deposit activities according to the submission date The reply is created by deposit_activity_list.xsd and has an xmlBeans to parse the reply.

getDepositActivityByUpdateDate

java.lang.String getDepositActivityByUpdateDate(java.lang.String pdsHandle,
                                                java.lang.String depositActivityStatus,
                                                java.lang.String producerID,
                                                java.lang.String producerAgentID,
                                                java.lang.String updateDateFrom,
                                                java.lang.String updateDateTo,
                                                java.lang.String startRecord,
                                                java.lang.String endRecord)

API for retrieving a list of deposit activities according to the update date

Parameters:

pdsHandle - of a logged in user

depositActivityStatus - All, In process, Rejected, Draft, Approved, Declined

producerID - A Producer ID if requesting for a specific Producer

producerAgentID - A Producer Agent ID if requesting for a specific Producer Agent

submitDateFrom - The requested period start date, mandatory

submitDateTo - The requested period end date, mandatory

startRecord - Used for pagination

endRecord - Used for pagination

Returns:

an XML with the reply to the request, which includes the list of requested deposit activities according to the update date The reply is created by deposit_activity_list.xsd and has an xmlBeans to parse the reply.

getDepositActivityBySubmitDateByMaterialFlow

java.lang.String getDepositActivityBySubmitDateByMaterialFlow(java.lang.String pdsHandle,
                                                              java.lang.String depositActivityStatus,
                                                              java.lang.String materialFlowId,
                                                              java.lang.String producerID,
                                                              java.lang.String producerAgentID,
                                                              java.lang.String submitDateFrom,
                                                              java.lang.String submitDateTo,
                                                              java.lang.String startRecord,
                                                              java.lang.String endRecord)

API for retrieving a list of deposit activities according to the submission date

Parameters:

pdsHandle - of a logged in user

depositActivityStatus - All, In process, Rejected, Draft, Approved, Declined

materialFlowId - material flow id

producerID - A Producer ID if requesting for a specific Producer

producerAgentID - A Producer Agent ID if requesting for a specific Producer Agent

submitDateFrom - The requested period start date, mandatory

submitDateTo - The requested period end date, mandatory

startRecord - Used for pagination

endRecord - Used for pagination

Returns:

an XML with the reply to the request, which includes the list of requested deposit activities according to the submission date The reply is created by deposit_activity_list.xsd and has an xmlBeans to parse the reply.

getDepositActivityByUpdateDateByMaterialFlow

java.lang.String getDepositActivityByUpdateDateByMaterialFlow(java.lang.String pdsHandle,
                                                              java.lang.String depositActivityStatus,
                                                              java.lang.String materialFlowId,
                                                              java.lang.String producerID,
                                                              java.lang.String producerAgentID,
                                                              java.lang.String updateDateFrom,
                                                              java.lang.String updateDateTo,
                                                              java.lang.String startRecord,
                                                              java.lang.String endRecord)

API for retrieving a list of deposit activities according to the update date

Parameters:

pdsHandle - of a logged in user

depositActivityStatus - All, In process, Rejected, Draft, Approved, Declined

materialFlowId - material flow id

producerID - A Producer ID if requesting for a specific Producer

producerAgentID - A Producer Agent ID if requesting for a specific Producer Agent

submitDateFrom - The requested period start date, mandatory

submitDateTo - The requested period end date, mandatory

startRecord - Used for pagination

endRecord - Used for pagination

Returns:

an XML with the reply to the request, which includes the list of requested deposit activities according to the update date The reply is created by deposit_activity_list.xsd and has an xmlBeans to parse the reply.