PUT api/v1/Study/{studyId}/Form

Updates form

Request Information

URI Parameters

Name	Description	Type	Additional information
studyId	Study identifier in GUID format	globally unique identifier	Required

Body Parameters

Form payload

FormUpdateModel

Name	Type	Additional information
ReasonForChange	string	None.
ClearForm	boolean	None.
StudyVersion	integer	None.
SubjectId	integer	None.
VisitId	integer	None.
FormId	integer	None.
TimePointId	integer	None.
SubjectConfirmation	Collection of byte	None.
UserConfirmation	Collection of byte	None.
Comments	string	None.
Username	string	None.
DataCollection	Collection of VariableUpdateModel	None.
IsSkippedByUser	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "reasonForChange": "sample string 1",
  "clearForm": true,
  "studyVersion": 3,
  "subjectId": 4,
  "visitId": 5,
  "formId": 6,
  "timePointId": 7,
  "subjectConfirmation": "QEA=",
  "userConfirmation": "QEA=",
  "comments": "sample string 8",
  "username": "sample string 9",
  "dataCollection": [
    {
      "variableId": 1,
      "value": {},
      "version": 3
    },
    {
      "variableId": 1,
      "value": {},
      "version": 3
    }
  ],
  "isSkippedByUser": true
}

Response Information

Resource Description

OkResult

Name	Description	Type	Additional information
Request		HttpRequestMessage	None.

Response Formats

application/json, text/json

Sample:

Sample not available.