...
We introduce JSON schemas for the generic interfaces AccessApproval and AccessRequirement, and schemas for specific types, TermsOfUseAccessRequirement, TermsOfUseAccessApproval (for tier 2 data), ACTAccessRequirement, and ACTAccessApproval (for tier 3 data).
Services
| action | uri | HTTP method | Schema | Authorization | |
|---|---|---|---|---|---|
| create AccessRequirement | /accessRequirement | POST | extension of AccessRequirement.json | ACT membership; anyone with create or update | |
| create 'lock' Access Requirement | /entity/{id}/lockAccessRequirement | POST | N/A | CREATE or UPDATE access to the entity(ies) covered by the AccessRequirement* | |
| read paginated list of all AccessRequirement objects for an entity | /entity/{entityId}/accessRequirement | GET | VariableContentPaginatedResults<AccessRequirement> | ALL | |
| read paginated list of all AccessRequirement objects for an evaluation | /evaluation/{evaluationId}/accessRequirement | GET | VariableContentPaginatedResults<AccessRequirement> | ALL | |
| read paginated list of all AccessRequirement objects for a team | /team/{teamId}/accessRequirement | GET | VariableContentPaginatedResults<AccessRequirement> | ALL | |
| retrieve paginated list of unfufilled access requirements (of type DOWNLOAD) for an entity | /entity/{entityId}/accessRequirementUnfulfilled | GET | VariableContentPaginatedResults<AccessRequirement> | ALL | |
| retrieve paginated list of unfufilled access requirements (of type DOWNLOAD or PARTICIPATE) for an evaluation | /evaluation/{evaluationId}/accessRequirementUnfulfilled | GET | VariableContentPaginatedResults<AccessRequirement> | ALL | |
| retrieve paginated list of unfufilled access requirements (of type DOWNLOAD or PARTICIPATE) for a team | /team/{teamId}/accessRequirementUnfulfilled | GET | VariableContentPaginatedResults<AccessRequirement> | ALL | |
| update AccessRequirement | /accessRequirement/{accessRqmtId} | PUT | extension of AccessRequirement.json | ACT membership | |
| delete AccessRequirement (along with all approvals granted for the requirement) | /accessRequirement/{accessRqmtId} | DELETE | ---- | ACT membership | |
| create AccessApproval | /accessApproval | POST | TermsOfUseAccessApproval.json | ALL | |
| ACTAccessApproval.json | ACT membership | ||||
| read all AccessApproval objects for a given entity | /entity/{entityId}/accessApproval | GET | VariableContentPaginatedResults<AccessApproval> | ACT membership | |
| read all AccessApproval objects for a givenevaluationgiven evaluation | /evaluation/{evaluationId}/accessApproval | GET | VariableContentPaginatedResults<AccessApproval> | VariableContentPaginatedResults<AccessApproval>Evaluation | administratorACT membership |
| delete AccessApproval | /accessApproval/{accessApprovalid} | DELETE | -- | ACT membershi
|
...
...
Web UI
When a user clicks Download on the page for a Data object having a Terms of Use access requirement, they are presented with a dialog showing the text from the access requirement, as shown below. If they accept the terms, then an access approval is created and the Download link is presented.
...