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

Saves form

Request Information

URI Parameters

NameDescriptionTypeAdditional information
studyId

Study identifier in GUID format

globally unique identifier

Required

Body Parameters

Form payload

FormSaveModel
NameDescriptionTypeAdditional information
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:
{
  "studyVersion": 1,
  "subjectId": 2,
  "visitId": 3,
  "formId": 4,
  "timePointId": 5,
  "subjectConfirmation": "QEA=",
  "userConfirmation": "QEA=",
  "comments": "sample string 6",
  "username": "sample string 7",
  "dataCollection": [
    {
      "variableId": 1,
      "value": {},
      "version": 3
    },
    {
      "variableId": 1,
      "value": {},
      "version": 3
    }
  ],
  "isSkippedByUser": true
}

Response Information

Resource Description

OkResult
NameDescriptionTypeAdditional information
Request

HttpRequestMessage

None.

Response Formats

application/json, text/json

Sample:

Sample not available.