Submit participant response

Authorization

BearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

studyKey*string

participantID*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

id?string

ObjectID

key*string

participantId?string

versionId?string

openedAt?integer

submittedAt?integer

arrivedAt?integer

responses?array<>

context?

Response Body

`application/json`

curl -X POST "https://example.com/v1/studies/string/participants/string/responses" \  -H "Content-Type: application/json" \  -d '{    "key": "string"  }'

{
  "message": "string",
  "result": [
    {
      "studyKey": "string",
      "surveyKey": "string",
      "validFrom": 0,
      "validUntil": 0,
      "category": "string",
      "profileID": "string"
    }
  ],
  "participant": {
    "id": "string",
    "participantId": "string",
    "currentStudySession": "string",
    "modifiedAt": 0,
    "enteredAt": 0,
    "studyStatus": "string",
    "flags": {
      "property1": "string",
      "property2": "string"
    },
    "linkingCodes": {
      "property1": "string",
      "property2": "string"
    },
    "assignedSurveys": [
      {
        "studyKey": "string",
        "surveyKey": "string",
        "validFrom": 0,
        "validUntil": 0,
        "category": "string",
        "profileID": "string"
      }
    ],
    "lastSubmissions": {
      "property1": 0,
      "property2": 0
    },
    "messages": [
      {}
    ]
  }
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

Submit participant response

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`