Field

A field represents a field in a data access request form. Once a field is created, it cannot be updated.

Field
String id
AcceptType type (String, Long)
String prompt

FieldCreate
AcceptType type (String, Long, User)
String prompt

Services to create and retrieve a field:

	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.

Template
String id
String name
String createdBy
Long createdOn
List<Field> fields

TemplateCreate
String name
List<Field> fields

Services to create and retrieve a template:

	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.

Questions:

Are there multiple versions of a form for a single accessRequirement?
Does form ties to accessRequirement?
Once a form is created for an accessRequirement/ data set, is there a need to update it?

Form
String id
Long accessRequirementId
String name
String createdBy
Long createdOn
List<Field> fields
String instructions

FormCreate
Long accessRequirementId
String name
List<Field> fields
String instructions

Services to create and retrieve a form:

	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.

StringValue
String filedId
String value

LongValue
String filedId
Long value

UserValue
String fieldId
String userId
Boolean validationRequired

DataAccessRequest
String requestorId
List<String> accessorIdList
String formId
Long accessRequirementId
String researchStatement
List<Value> values

DataAccessRequestResult
String id
String requestorId
List<String> accessorIdList
String formId
Long accessRequirementId
Long createdOn
String researchStatement
List<Value> values
DataAccessRequestStatus status (SUBMITTED, APPROVED, REJECTED, EXPIRED)
String reason
Long modifiedOn
String modifiedBy
Long expiredOn

DataAccessRequestList
List<DataAccessRequestResult> results
Long numberOfResults

ChangeDataAccessRequest
String dataAccessRequestId
DataAccessRequestStatus status
String reason
String modifiedBy

Services to create request and granting access:

	Action	Intended User	URI	Method	Request Params	Request Body	Response Body
7	create a request	any Synapse User	/dataAccessRequest	POST		DataAccessRequest	DataAccessRequestResult
8	retrieve requests for accessRequirementId	ACT	/dataAccessRequests	GET	accessRequirementIds, limit (max 20), offset, filter (SUBMITTED, APPROVED, REJECTED, EXPIRED)		DataAccessRequestList
9	delete a request	requestor	/dataAccessRequest/{dataAccessRequestId}	DELETE
10	change request status	ACT	/dataAccessRequest/{dataAccessRequestId}	PUT		ChangeDataAccessRequest

Services to Manage Access Request

Field

Template (Phase 2)

Form

DataAccessRequest