Difference between revisions of "Web Services"

From EPrints Documentation
Jump to: navigation, search
 
 
(8 intermediate revisions by 6 users not shown)
Line 1: Line 1:
 +
{{devel}}
 +
 
Web services are under development and will not be ''part'' of the next release, but will be made available as a seperate download soon after.
 
Web services are under development and will not be ''part'' of the next release, but will be made available as a seperate download soon after.
 
+
                                                                                                                                                           
 
There are security and reliability issues to address.
 
There are security and reliability issues to address.
 
+
                                                                                                                                                           
 
== Methods ==
 
== Methods ==
 
+
                                                                                                                                                           
 
Note that things which are "int" inside eprints, such as eprintid's are "xsd:string" here. EPrints will check the data, rather than leaving it to the SOAP level. Also xsd:int can't be null.
 
Note that things which are "int" inside eprints, such as eprintid's are "xsd:string" here. EPrints will check the data, rather than leaving it to the SOAP level. Also xsd:int can't be null.
 
+
                                                                                                                                                           
 
There is no standard error responses yet.
 
There is no standard error responses yet.
 
+
                                                                                                                                                           
 
=== echo ===
 
=== echo ===
 
+
                                                                                                                                                           
xsd:string return = echo( xsd:string inputString, xsd:int stringDuplicationCount )
+
<code>xsd:string return = echo( xsd:string inputString, xsd:int stringDuplicationCount )</code>
 
+
                                                                                                                                                           
 
Returns the inputString repeated stringDuplicationCount times. This method is provided as a hello world style function to check the basics are working.
 
Returns the inputString repeated stringDuplicationCount times. This method is provided as a hello world style function to check the basics are working.
 
                                                                                                                                                              
 
                                                                                                                                                              
 
=== removeEprint ===
 
=== removeEprint ===
 
+
                                                                                                                                                           
removeEprint( xsd:string eprintID )
+
<code>removeEprint( xsd:string eprintID )</code>
 
+
                                                                                                                                                           
 
remove the named eprint.
 
remove the named eprint.
 
                                                                                                                                                              
 
                                                                                                                                                              
 
=== getEprintFiles ===
 
=== getEprintFiles ===
 
+
                                                                                                                                                           
pm:Eprint eprint = getEprintFiles( xsd:string eprintID )
+
<code>pm:Eprint eprint = getEprintFiles( xsd:string eprintID )</code>
 
+
                                                                                                                                                           
 
Return an eprint object including the files base64 encoded.
 
Return an eprint object including the files base64 encoded.
 
                                                                                                                                                              
 
                                                                                                                                                              
 
=== getEprint ===
 
=== getEprint ===
 
+
                                                                                                                                                           
pm:Eprint eprint = getEprint( xsd:string eprintID )
+
<code>pm:Eprint eprint = getEprint( xsd:string eprintID )</code>
 
+
                                                                                                                                                           
 
Return an eprint object, but not the full data of the files.
 
Return an eprint object, but not the full data of the files.
 
                                                                                                                                                              
 
                                                                                                                                                              
 
=== putEprint ===
 
=== putEprint ===
 
                                                                                                                                                              
 
                                                                                                                                                              
putEprint( pm:Eprint eprint )
+
<code>putEprint( pm:Eprint eprint )</code>
 
+
                                                                                                                                                           
 
Upload a new EPrint including documents and files.
 
Upload a new EPrint including documents and files.
 
+
                                                                                                                                                           
 
=== modifyEprint ===
 
=== modifyEprint ===
 
                                                                                                                                                              
 
                                                                                                                                                              
modifyEprint( xsd:string eprintID, pm:Eprint eprint )
+
<code>modifyEprint( xsd:string eprintID, pm:Eprint eprint )</code>
 
+
                                                                                                                                                           
 
Modify eprint record "eprintID". The eprint object should only contain fields which should be changed. Other fields will be left alone. This will not
 
Modify eprint record "eprintID". The eprint object should only contain fields which should be changed. Other fields will be left alone. This will not
 
modify documents or files.
 
modify documents or files.
 
+
                                                                                                                                                           
 
=== addDocument ===
 
=== addDocument ===
 
                                                                                                                                                              
 
                                                                                                                                                              
xsd:documentID = addDocument( xsd:string eprintID, pm:Document document )
+
<code>xsd:documentID = addDocument( xsd:string eprintID, pm:Document document )</code>
 
+
                                                                                                                                                           
 
Add this document to the eprint number eprintID. The document can include base64 encoded files.
 
Add this document to the eprint number eprintID. The document can include base64 encoded files.
  
 
=== modifyDocument ===
 
=== modifyDocument ===
 
                                                                                                                                                              
 
                                                                                                                                                              
modifyDocument( xsd:string documentID, pm:Document document )
+
<code>modifyDocument( xsd:string documentID, pm:Document document )</code>
 
+
                                                                                                                                                           
 
Modify the metadata of the named document. Fields not mentioned in the document object passed in, will not be modified. Does not affect files.
 
Modify the metadata of the named document. Fields not mentioned in the document object passed in, will not be modified. Does not affect files.
 
+
                                                                                                                                                           
 
=== removeDocument ===
 
=== removeDocument ===
 
                                                                                                                                                              
 
                                                                                                                                                              
removeDocument( xsd:string documentID )
+
<code>removeDocument( xsd:string documentID )</code>
 
+
                                                                                                                                                           
 
Remove the named document from it's parent EPrint, erase any files attached to it.
 
Remove the named document from it's parent EPrint, erase any files attached to it.
 
+
                                                                                                                                                           
 
=== addFile ===
 
=== addFile ===
 
                                                                                                                                                              
 
                                                                                                                                                              
addFile( xsd:string documentID, xsd:string filename, xsd:base64Binary data )
+
<code>addFile( xsd:string documentID, xsd:string filename, xsd:base64Binary data )</code>
 
+
                                                                                                                                                           
 
Add a file named 'filename' to the indicated document.
 
Add a file named 'filename' to the indicated document.
 
+
                                                                                                                                                           
 
=== removeFile ===
 
=== removeFile ===
 
                                                                                                                                                              
 
                                                                                                                                                              
removeFile( xsd:string documentID, xsd:string filename )
+
<code>removeFile( xsd:string documentID, xsd:string filename )</code>
 
+
                                                                                                                                                           
 
Remove the file named 'filename' from the indicated document.
 
Remove the file named 'filename' from the indicated document.
 
+
                                                                                                                                                           
 
=== searchEprint ===
 
=== searchEprint ===
 
                                                                                                                                                              
 
                                                                                                                                                              
pm:ListEprint results = searchEprint( pm:ListParam params, pm:ListSearchField searchFields )
+
<code>pm:ListEprint results = searchEprint( pm:ListParam params, pm:ListSearchField searchFields )</code>
 +
                                                                                                                                                           
 +
Create and execute an EPrints Search.
  
Create and execute an EPrints Search.
+
[[Category:Releases]]
 +
[[Category:Staff]]

Latest revision as of 11:25, 14 March 2010

PLEASE NOTE...

This feature is under development. It is not yet available in any realeased version of EPrints. Use the talk page to make any suggestions.

Web services are under development and will not be part of the next release, but will be made available as a seperate download soon after.

There are security and reliability issues to address.

Methods

Note that things which are "int" inside eprints, such as eprintid's are "xsd:string" here. EPrints will check the data, rather than leaving it to the SOAP level. Also xsd:int can't be null.

There is no standard error responses yet.

echo

xsd:string return = echo( xsd:string inputString, xsd:int stringDuplicationCount )

Returns the inputString repeated stringDuplicationCount times. This method is provided as a hello world style function to check the basics are working.

removeEprint

removeEprint( xsd:string eprintID )

remove the named eprint.

getEprintFiles

pm:Eprint eprint = getEprintFiles( xsd:string eprintID )

Return an eprint object including the files base64 encoded.

getEprint

pm:Eprint eprint = getEprint( xsd:string eprintID )

Return an eprint object, but not the full data of the files.

putEprint

putEprint( pm:Eprint eprint )

Upload a new EPrint including documents and files.

modifyEprint

modifyEprint( xsd:string eprintID, pm:Eprint eprint )

Modify eprint record "eprintID". The eprint object should only contain fields which should be changed. Other fields will be left alone. This will not modify documents or files.

addDocument

xsd:documentID = addDocument( xsd:string eprintID, pm:Document document )

Add this document to the eprint number eprintID. The document can include base64 encoded files.

modifyDocument

modifyDocument( xsd:string documentID, pm:Document document )

Modify the metadata of the named document. Fields not mentioned in the document object passed in, will not be modified. Does not affect files.

removeDocument

removeDocument( xsd:string documentID )

Remove the named document from it's parent EPrint, erase any files attached to it.

addFile

addFile( xsd:string documentID, xsd:string filename, xsd:base64Binary data )

Add a file named 'filename' to the indicated document.

removeFile

removeFile( xsd:string documentID, xsd:string filename )

Remove the file named 'filename' from the indicated document.

searchEprint

pm:ListEprint results = searchEprint( pm:ListParam params, pm:ListSearchField searchFields )

Create and execute an EPrints Search.