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)
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

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

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

FormCreate
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

Services to Manage Access Request

Field

Template

Form