Difference between revisions of "Request Object"

From EPrints Documentation
Jump to: navigation, search
 
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
{{dataobj}}
 +
__NOTOC__
 +
 +
The Request object encapsulates a single request for a document, which can be:
 +
 +
* a specific (restricted) document in the repository
 +
* a document not in the repository (where a record has no documents attached)
 +
 
=== Built in Fields ===
 
=== Built in Fields ===
  
Line 4: Line 12:
 
<tr><th>Field Name</th><th>Type</th><th>Description</th></tr>
 
<tr><th>Field Name</th><th>Type</th><th>Description</th></tr>
 
<tr><td>requestid</td><td>[[int field]]</td><td></td></tr>
 
<tr><td>requestid</td><td>[[int field]]</td><td></td></tr>
<tr><td>eprintid</td><td>[[itemref field]] eprint</td><td></td></tr>
+
<tr><td>eprintid</td><td>[[itemref field]] eprint</td><td>The ID of the record</td></tr>
<tr><td>docid</td><td>[[text field]]</td><td></td></tr>
+
<tr><td>docid</td><td>[[text field]]</td><td>The ID of the document requested</td></tr>
<tr><td>datestamp</td><td>[[time field]]</td><td></td></tr>
+
<tr><td>datestamp</td><td>[[time field]]</td><td>When the request was made</td></tr>
<tr><td>userid</td><td>[[itemref field]] document</td><td></td></tr>
+
<tr><td>userid</td><td>[[itemref field]] user</td><td>The ID of the user who can respond to the request (if <b>email</b> matches a registered user)</td></tr>
<tr><td>email</td><td>[[text field]]</td><td></td></tr>
+
<tr><td>email</td><td>[[text field]]</td><td>The email the request was sent to</td></tr>
<tr><td>requester_email</td><td>[[text field]]</td><td></td></tr>
+
<tr><td>requester_email</td><td>[[text field]]</td><td>The email of the person who requested the document</td></tr>
<tr><td>reason</td><td>[[longtext field]]</td><td></td></tr>
+
<tr><td>reason</td><td>[[longtext field]]</td><td>The reason that the request was made, if any</td></tr>
 
</table>
 
</table>

Latest revision as of 15:28, 11 January 2007

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects


Data Objects: EPrint - User - Document - Subject - Saved Search - History - Access - Request


The Request object encapsulates a single request for a document, which can be:

  • a specific (restricted) document in the repository
  • a document not in the repository (where a record has no documents attached)

Built in Fields

Field NameTypeDescription
requestidint field
eprintiditemref field eprintThe ID of the record
docidtext fieldThe ID of the document requested
datestamptime fieldWhen the request was made
useriditemref field userThe ID of the user who can respond to the request (if email matches a registered user)
emailtext fieldThe email the request was sent to
requester_emailtext fieldThe email of the person who requested the document
reasonlongtext fieldThe reason that the request was made, if any