Jump to

• Request
• Response

V2.0

get

/ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{subjectId}/nextVisitAction

Retrieves the next visit action for the specified subject and also indicates whether rescreening can be initiated with the help of new field enableRescreen.

Request

Path Parameters

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

  Example:

  test

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

  Example:

  CDBBCCDDEEFF11223344556677889900

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

  Example:

  DDEEFF00112233445566778899AABBCC

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Result containing the subject's next visit action and rescreen eligibility.

Body ()

Root Schema : SubjectNextVisitActionResultDto20

Type: object

Show Source

• enableRescreen: boolean
  boolean indicating if a new rescreen visit can be initiated for the subject

  Example: true
• nextVisitAction: integer (int32)
  Next Visit Action will happen. Its values can be SCREEN_ENABLE, SCREEN_DISABLE, RANDOMIZE_ENABLE, RANDOMIZE_DISABLE, DISPENSE_ENABLE, DISPENSE_DISABLE, COMPLETE_STUDY_ENABLE, COMPLETE_STUDY_DISABLE

{
    "type":"object",
    "properties":{
        "nextVisitAction":{
            "type":"integer",
            "description":"Next Visit Action will happen. Its values can be SCREEN_ENABLE, SCREEN_DISABLE, RANDOMIZE_ENABLE, RANDOMIZE_DISABLE, DISPENSE_ENABLE, DISPENSE_DISABLE, COMPLETE_STUDY_ENABLE, COMPLETE_STUDY_DISABLE",
            "format":"int32"
        },
        "enableRescreen":{
            "type":"boolean",
            "description":"boolean indicating if a new rescreen visit can be initiated for the subject",
            "example":true
        }
    }
}

Examples

Select an example Subect Next Visit Action Successful Response

400 Response

Bad request.

Body ()

Root Schema : DcsResponse

Type: object

Show Source

• errorData: object ErrorResponseData
  Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
• 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

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

• details: object details
  Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
• errorCode: string
  Application or business-specific error code representing the error type.

  Example: REPT_401
• errorMessage: string
  Human-readable error message describing the failure or issue.

  Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"object",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Nested Schema : details

Type: object

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example:

User role is missing required permission REPORTING_VIEW. Field: userId

Back to Top