Field
A field represents a field in a data access request form. Once a field is created, it cannot be updated.
| StringConstraint |
|---|
| long size |
| UserListConstraint |
|---|
| boolean isCertified |
| boolean hasValidatedProfile |
| Field |
|---|
| String id |
| AcceptType type (String, Long, UserList, File) |
| String prompt (default null) |
| Constraint constraint (default null) |
...
| Action | Intended User | URI | Method | Request Params | Request Body | Response Body | |
|---|---|---|---|---|---|---|---|
| 1 | create a field | ACT | /field | POST | FieldCreate | Field | |
| 2 | retrieve a field | ACT | /field/{fieldId} | GET | Field |
Template (Phase 2)
A template contains a list of default fields the ACT wants to have on certain data access request form. When a member of the ACT creates a form on a dataset, they will create the form from an existing template. Once a template is created, it cannot be updated.
...
| Action | Intended User | URI | Method | Request Params | Request Body | Response Body | |
|---|---|---|---|---|---|---|---|
| 3 | create a template | ACT | /template | POST | TemplateCreate | Template | |
| 4 | retrieve a template | ACT | /template/{templateId} | GET | Template |
Form
A form is created by an ACT member for a particular AccessRequirement. It contains the list of information the ACT wants from data requestor. It has the ACT's instruction on how to fill out a request for the data under access requirement.
...
| Action | Intended User | URI | Method | Request Params | Request Body | Response Body | |
|---|---|---|---|---|---|---|---|
| 5 | create a form | ACT | /form | POST | FormCreate | Form | |
| 6 | retrieve a form | ACT | /form/{formId} | GET | Form |
DataAccessRequest
A DataAccessRequest is submitted by a data requestor to request access to a particular dataset.
...
| UserListValue |
|---|
| String fieldId |
| List<String> userIdList |
| FileValue |
|---|
| String fieldId |
| String fileHandleId |
| DataAccessRequest |
|---|
| String requestorId |
| List<String> accessorIdList |
| String formId |
| Long accessRequirementId |
| List<Value> values |
...
- What actions are required to validate a request? look at DUC (attachment that has user's signature).
- Which fields are need to lookup, sorted by? sorted by createdOn, status
Notification
| Condition | Target User | Notes | |
|---|---|---|---|
| 1 | After a new request is created | ACT member | Includes link to a page that manages the dataset's access requests |
| 2 | After a request is granted | Requestor | |
| 3 | After a request is rejected | Requestor | Includes reason Includes link to create a new request from the rejected one |
| 4 | One month before request expires | Requestor | Include links to update request |
| 5 | After request expires | Requestor |
...