Difference between revisions of "Request Object"

From EPrints Documentation
Jump to: navigation, search
(Add new fields added to Request object)
 
(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 ===
  
 
<table border="1" cellspacing="0" cellpadding="2">
 
<table border="1" cellspacing="0" cellpadding="2">
 
<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>[[counter 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>[[timestamp field]]</td><td>When the request was made</td></tr>
<tr><td>userid</td><td>[[itemref field]] user</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>[[email 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>[[email 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>
 +
<tr><td>expiry_date</td><td>[[time field]]</td><td>The time at which the request will expires.</td></tr>
 +
<tr><td>code</td><td>[[text field]]</td><td>The code for this request, which can be used to created private URLs.</td></tr>
 +
<tr><td>captcha</td><td>[[recaptcha field]]</td><td>The ReCAPTCHA field for the form for the request.</td></tr>
 
</table>
 
</table>

Latest revision as of 00:53, 15 February 2022

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


Data Objects: Access - Document - EPrint - Event Queue - File - History - Import - Login Ticket - Request - Saved Search - Subject - User


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
requestidcounter field
eprintiditemref field eprintThe ID of the record
docidtext fieldThe ID of the document requested
datestamptimestamp fieldWhen the request was made
useriditemref field userThe ID of the user who can respond to the request (if email matches a registered user)
emailemail fieldThe email the request was sent to
requester_emailemail fieldThe email of the person who requested the document
reasonlongtext fieldThe reason that the request was made, if any
expiry_datetime fieldThe time at which the request will expires.
codetext fieldThe code for this request, which can be used to created private URLs.
captcharecaptcha fieldThe ReCAPTCHA field for the form for the request.