Difference between revisions of "Access Object"
(added accessid description.) |
|||
| (6 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
{{dataobj}} | {{dataobj}} | ||
| + | __NOTOC__ | ||
=== Built in Fields === | === Built in Fields === | ||
| Line 6: | Line 6: | ||
<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>accessid</td><td>[[int field]]</td><td></td></tr> | + | <tr><td>accessid</td><td>[[int field]]</td><td> The ID number of this Access Object (unique within a single repository)</td></tr> |
| − | <tr><td>datestamp</td><td>[[time field]]</td><td></td></tr> | + | <tr><td>datestamp</td><td>[[time field]]</td><td>Date/time the request occurred (not when the request was eventually served!).</td></tr> |
| − | <tr><td>requester_id</td><td>[[text field]]</td><td></td></tr> | + | <tr><td>requester_id</td><td>[[text field]]</td><td>The identity of the requesting user, currently their IP address but this may change in future.</td></tr> |
| − | <tr><td>requester_user_agent</td><td>[[text field]]</td><td></td></tr> | + | <tr><td>requester_user_agent</td><td>[[text field]]</td><td>The user agent string given by the user's web browser (useful for robots detection).</td></tr> |
| − | <tr><td>requester_country</td><td>[[text field]]</td><td></td></tr> | + | <tr><td>requester_country</td><td>[[text field]]</td><td>The country the user made the request from (if available).</td></tr> |
| − | <tr><td>requester_institution</td><td>[[text field]]</td><td> | + | <tr><td>requester_institution</td><td>[[text field]]</td><td>The institution the user made the request from (if available).</td></tr> |
| − | + | <tr><td>referring_entity_id</td><td>[[text field]]</td><td>The location from which the user has come (either a web page or eprint id).</td></tr> | |
| − | <tr><td>referring_entity_id</td><td>[[text field]]</td><td></td></tr> | + | <tr><td>service_type_id</td><td>[[text field]]</td><td>The type of object requested, currently one of "?fulltext=yes" or "?abstract=yes"</td></tr> |
| − | <tr><td>service_type_id</td><td>[[text field]]</td><td></td></tr> | + | <tr><td>referent_id</td><td>[[text field]]</td><td>The id of the eprint requested.</td></tr> |
| − | <tr><td>referent_id</td><td>[[text field]]</td><td></td></tr> | + | <tr><td>referent_docid</td><td>[[text field]]</td><td>The id of the document requested (if it was a full-text request).</td></tr> |
| − | <tr><td>referent_docid</td><td>[[text field]]</td><td></td></tr> | ||
</table> | </table> | ||
| + | |||
| + | == See Also == | ||
| + | * [[API:EPrints/DataObj/Access|EPrints::DataObj::Access]] - API page. | ||
| + | * [[Access Log Dataset]] - Details the functionality of this data objects within the dataset. | ||
Latest revision as of 09:16, 9 March 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
Built in Fields
| Field Name | Type | Description |
|---|---|---|
| accessid | int field | The ID number of this Access Object (unique within a single repository) |
| datestamp | time field | Date/time the request occurred (not when the request was eventually served!). |
| requester_id | text field | The identity of the requesting user, currently their IP address but this may change in future. |
| requester_user_agent | text field | The user agent string given by the user's web browser (useful for robots detection). |
| requester_country | text field | The country the user made the request from (if available). |
| requester_institution | text field | The institution the user made the request from (if available). |
| referring_entity_id | text field | The location from which the user has come (either a web page or eprint id). |
| service_type_id | text field | The type of object requested, currently one of "?fulltext=yes" or "?abstract=yes" |
| referent_id | text field | The id of the eprint requested. |
| referent_docid | text field | The id of the document requested (if it was a full-text request). |
See Also
- EPrints::DataObj::Access - API page.
- Access Log Dataset - Details the functionality of this data objects within the dataset.
