Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

ActionURIMethodRequest BodyAuthorization
create AccessRequirement/accessRequirementPOSTextension of AccessRequirement.jsonACT membership 
create 'lock' Access Requirement/entity/{id}/lockAccessRequirementPOSTN/ACREATE or UPDATE access to the entity 
read paginated list of all AccessRequirement objects for an entity/entity/{entityId}/accessRequirementGETVariableContentPaginatedResults<AccessRequirement>ALL 
read paginated list of all AccessRequirement objects for an evaluation/evaluation/{evaluationId}/accessRequirementGETVariableContentPaginatedResults<AccessRequirement>ALL 
read paginated list of all AccessRequirement objects for a team/team/{teamId}/accessRequirementGETVariableContentPaginatedResults<AccessRequirement>ALL 
retrieve paginated list of unfufilled access requirements (of type DOWNLOAD) for an entity/entity/{entityId}/accessRequirementUnfulfilledGETVariableContentPaginatedResults<AccessRequirement>ALL 
retrieve paginated list of unfufilled access requirements (of type DOWNLOAD or PARTICIPATE) for an evaluation/evaluation/{evaluationId}/accessRequirementUnfulfilledGETVariableContentPaginatedResults<AccessRequirement>ALL 
retrieve paginated list of unfufilled access requirements (of type DOWNLOAD or PARTICIPATE) for a team/team/{teamId}/accessRequirementUnfulfilledGETVariableContentPaginatedResults<AccessRequirement>ALL 
update AccessRequirement/accessRequirement/{accessRqmtId}PUTextension of AccessRequirement.jsonACT membership 
delete AccessRequirement (along with all approvals granted for the requirement)/accessRequirement/{accessRqmtId}DELETE----ACT membership 
create AccessApproval/accessApprovalPOSTTermsOfUseAccessApproval.jsonALL
    ACTAccessApproval.jsonACT membership 
read all AccessApproval objects for a given entity/entity/{entityId}/accessApprovalGETVariableContentPaginatedResults<AccessApproval>ACT membership 
read all AccessApproval objects for a given evaluation/evaluation/{evaluationId}/accessApprovalGETVariableContentPaginatedResults<AccessApproval>VariableContentPaginatedResults<AccessApproval>ACT 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.

...