Difference between revisions of "Request Object"
| Line 1: | Line 1: | ||
| + | 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 9: | ||
<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]] 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>[[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> | ||
Revision as of 17:23, 8 January 2007
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 Name | Type | Description |
|---|---|---|
| requestid | int field | |
| eprintid | itemref field eprint | The ID of the record |
| docid | text field | The ID of the document requested |
| datestamp | time field | When the request was made |
| userid | itemref field user | The ID of the user who can respond to the request (if email matches a registered user) |
| text field | The email the request was sent to | |
| requester_email | text field | The email of the person who requested the document |
| reason | longtext field | The reason that the request was made, if any |
