Jump to

• Request
• Response

V1.0

post

/ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/unlock

Unlocks the specified subject at subject-level. Accepts a ReasonCommentRequest payload capturing reason and comment for audit.

Request

Path Parameters

• mode(required): string
  Mode of the study, accepts: test, active, or training.

  Example:

  test

• studyId(required): string(uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

  Example:

  09ABE234123456789ABCDEFDEADBEEFA

• subjectId(required): string(uuid)
  Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.

  Example:

  07DFAAAA34CB44141AEFBB123ABC345F

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Reason and comment to justify operation.

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048

  Comment

  Example: Removing incorrect data captured by mistake
• reason: string
  Minimum Length: 0

  Maximum Length: 255

  Reason

  Example: Incorrect entry

{
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason",
            "example":"Incorrect entry"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Comment",
            "example":"Removing incorrect data captured by mistake"
        }
    },
    "description":"Reason and comment to justify operation."
}

Examples

Select an example ReasonCommentRequest payload

Back to Top

Response

Supported Media Types

• application/json

202 Response

subject unlock request received- empty response body - standard for HTTP 202.

400 Response

Bad_Request

Body ()

Root Schema : RestResponse

Type: object

Show Source

• errorData: object ErrorResponseData
• result: object result
• status: string
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "version":{
            "type":"integer",
            "format":"int32",
            "writeOnly":true
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    }
}

Nested Schema : ErrorResponseData

Type: object

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Nested Schema : details

Type: object

Back to Top