Jump to

• Request
• Response

V3.0

get

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

Retrieves the next visit action, rescreen eligibility, and dispensation rollback eligibility for the specified subject.

Request

Path Parameters

• mode(required): string
  Indicates the operational mode of the study. Accepted values: active, test, or training.

  Example:

  test

• studyId(required): string
  Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  3234E620DE2E41D69A36571064E727B2

• subjectId(required): string
  Unique identifier of the subject. Used to represent a participant enrolled in a study. Uses UUID in a 32-character uppercase hexadecimal string format.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : SubjectNextVisitActionResultDto30

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
• rollbackDispensation: object RollbackDispensation
  Rollback Last Dispensation availability and visit context.

{
    "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
        },
        "rollbackDispensation":{
            "$ref":"#/components/schemas/RollbackDispensation"
        }
    }
}

Nested Schema : RollbackDispensation

Type: object

Rollback Last Dispensation availability and visit context.

Show Source

• enabled: boolean
  Indicates whether the last dispensation can be rolled back for the subject.

  Example: true
• eventId: string
  Event id for the dispensation visit eligible for rollback.

  Example: ABCDEF1234567890ABCDEF1234567890
• eventInstanceNum: integer (int32)
  Minimum Value: 1

  Event instance number for repeating or unscheduled dispensation visits.

  Example: 1
• targetKitStatus: string
  Target kit status configured for the rollback visit type.

  Example: AVAILABLE

{
    "type":"object",
    "properties":{
        "enabled":{
            "type":"boolean",
            "description":"Indicates whether the last dispensation can be rolled back for the subject.",
            "example":true
        },
        "eventId":{
            "type":"string",
            "description":"Event id for the dispensation visit eligible for rollback.",
            "example":"ABCDEF1234567890ABCDEF1234567890"
        },
        "eventInstanceNum":{
            "minimum":1,
            "type":"integer",
            "description":"Event instance number for repeating or unscheduled dispensation visits.",
            "format":"int32",
            "example":1
        },
        "targetKitStatus":{
            "type":"string",
            "description":"Target kit status configured for the rollback visit type.",
            "example":"AVAILABLE"
        }
    },
    "description":"Rollback Last Dispensation availability and visit context."
}

400 Response

Bad request.

Body ()

Root Schema : DcsResponse

Type: object

Show Source

• errorData: object ErrorResponseData
  Title: ErrorResponseData

  Error Response Details Information
• 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

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information.",
            "example":{
                "field":"studyId",
                "reason":"Invalid value"
            }
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Example:

{
    "field":"studyId",
    "reason":"Invalid value"
}

Back to Top