Jump to

• Request
• Response

[Deprecated]: V5.0

post

/ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/subjects/visitschedule

Deprecated: This consolidated API retrieves locked status, subjects and their visit schedule,filter capabilities along with 'canBeCompleted' field for a subject.

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:

  1BC29B36F5D64B1B95F4BDBBCEA481BE

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Request payload to retrieve visit schedules for subjects filtered by sites, pagination, ordering, review status and state filters

Show Source

• containsSearchKeywords: array containsSearchKeywords
  Keywords for contains match in subject search which will be applied on subject number
• exactSearchKeywords: array exactSearchKeywords
  Keywords for exact match in subject search which will be applied on subject number
• limit: integer (int32)
  Maximum number of results to return

  Example: 25
• nextVisitOnly: boolean
  When true, only the next scheduled visit is returned per subject

  Example: false
• notStarted: boolean
  When true, include only subjects that have not started

  Example: false
• offset: integer (int32)
  Offset for pagination

  Example: 0
• order: string
  Sort order for results

  Example: asc
• reviewStatus: string
  Review status filter applied to subjects. Values can be noopenqueries, openqueries, verified, signed, locked, allvisitscomplete, readytosign, allvisitscomplete, readytoverify, all, signedandverified, frozen

  Example: all
• sites: array sites
  List of site identifiers to scope the search
• subjectStates: array subjectStates
  States of subjects to filter by Active, New, Screening_Initiated, Enrolled, Complete, Withdrawn, ehrLinked, ehrNotLinked, Screen_Failed, Auto_Screen_Failed

{
    "type":"object",
    "properties":{
        "sites":{
            "type":"array",
            "description":"List of site identifiers to scope the search",
            "example":[
                "D3C9A4B5E6F78123456789ABCDEF1234",
                "E1F2A3B4C5D6E7F89012ABCDEF345678"
            ],
            "items":{
                "type":"string",
                "description":"List of site identifiers to scope the search",
                "format":"uuid"
            }
        },
        "limit":{
            "type":"integer",
            "description":"Maximum number of results to return",
            "format":"int32",
            "example":25
        },
        "offset":{
            "type":"integer",
            "description":"Offset for pagination",
            "format":"int32",
            "example":0
        },
        "order":{
            "type":"string",
            "description":"Sort order for results",
            "example":"asc"
        },
        "reviewStatus":{
            "type":"string",
            "description":"Review status filter applied to subjects. Values can be noopenqueries, openqueries, verified, signed, locked, allvisitscomplete, readytosign, allvisitscomplete, readytoverify, all, signedandverified, frozen ",
            "example":"all"
        },
        "subjectStates":{
            "type":"array",
            "description":"States of subjects to filter by Active, New, Screening_Initiated, Enrolled, Complete, Withdrawn, ehrLinked, ehrNotLinked, Screen_Failed, Auto_Screen_Failed",
            "example":[
                "Auto_Screen_Failed"
            ],
            "items":{
                "type":"string",
                "description":"States of subjects to filter by Active, New, Screening_Initiated, Enrolled, Complete, Withdrawn, ehrLinked, ehrNotLinked, Screen_Failed, Auto_Screen_Failed",
                "example":"[\"Auto_Screen_Failed\"]"
            }
        },
        "exactSearchKeywords":{
            "type":"array",
            "description":"Keywords for exact match in subject search which will be applied on subject number",
            "example":[
                "1001",
                "SMITH"
            ],
            "items":{
                "type":"string",
                "description":"Keywords for exact match in subject search which will be applied on subject number",
                "example":"[\"1001\",\"SMITH\"]"
            }
        },
        "containsSearchKeywords":{
            "type":"array",
            "description":"Keywords for contains match in subject search which will be applied on subject number",
            "example":[
                "100",
                "SMI"
            ],
            "items":{
                "type":"string",
                "description":"Keywords for contains match in subject search which will be applied on subject number",
                "example":"[\"100\",\"SMI\"]"
            }
        },
        "nextVisitOnly":{
            "type":"boolean",
            "description":"When true, only the next scheduled visit is returned per subject",
            "example":false
        },
        "notStarted":{
            "type":"boolean",
            "description":"When true, include only subjects that have not started",
            "example":false
        }
    },
    "description":"Request payload to retrieve visit schedules for subjects filtered by sites, pagination, ordering, review status and state filters"
}

Nested Schema : containsSearchKeywords

Type: array

Keywords for contains match in subject search which will be applied on subject number

Show Source

• Array of: string
  Keywords for contains match in subject search which will be applied on subject number

  Example: ["100","SMI"]

{
    "type":"array",
    "description":"Keywords for contains match in subject search which will be applied on subject number",
    "example":[
        "100",
        "SMI"
    ],
    "items":{
        "type":"string",
        "description":"Keywords for contains match in subject search which will be applied on subject number",
        "example":"[\"100\",\"SMI\"]"
    }
}

Example:

[
    "100",
    "SMI"
]

Nested Schema : exactSearchKeywords

Type: array

Keywords for exact match in subject search which will be applied on subject number

Show Source

• Array of: string
  Keywords for exact match in subject search which will be applied on subject number

  Example: ["1001","SMITH"]

{
    "type":"array",
    "description":"Keywords for exact match in subject search which will be applied on subject number",
    "example":[
        "1001",
        "SMITH"
    ],
    "items":{
        "type":"string",
        "description":"Keywords for exact match in subject search which will be applied on subject number",
        "example":"[\"1001\",\"SMITH\"]"
    }
}

Example:

[
    "1001",
    "SMITH"
]

Nested Schema : sites

Type: array

List of site identifiers to scope the search

Show Source

• Array of: string(uuid)
  List of site identifiers to scope the search

{
    "type":"array",
    "description":"List of site identifiers to scope the search",
    "example":[
        "D3C9A4B5E6F78123456789ABCDEF1234",
        "E1F2A3B4C5D6E7F89012ABCDEF345678"
    ],
    "items":{
        "type":"string",
        "description":"List of site identifiers to scope the search",
        "format":"uuid"
    }
}

Example:

[
    "D3C9A4B5E6F78123456789ABCDEF1234",
    "E1F2A3B4C5D6E7F89012ABCDEF345678"
]

Nested Schema : subjectStates

Type: array

States of subjects to filter by Active, New, Screening_Initiated, Enrolled, Complete, Withdrawn, ehrLinked, ehrNotLinked, Screen_Failed, Auto_Screen_Failed

Show Source

• Array of: string
  States of subjects to filter by Active, New, Screening_Initiated, Enrolled, Complete, Withdrawn, ehrLinked, ehrNotLinked, Screen_Failed, Auto_Screen_Failed

  Example: ["Auto_Screen_Failed"]

{
    "type":"array",
    "description":"States of subjects to filter by Active, New, Screening_Initiated, Enrolled, Complete, Withdrawn, ehrLinked, ehrNotLinked, Screen_Failed, Auto_Screen_Failed",
    "example":[
        "Auto_Screen_Failed"
    ],
    "items":{
        "type":"string",
        "description":"States of subjects to filter by Active, New, Screening_Initiated, Enrolled, Complete, Withdrawn, ehrLinked, ehrNotLinked, Screen_Failed, Auto_Screen_Failed",
        "example":"[\"Auto_Screen_Failed\"]"
    }
}

Example:

[
    "Auto_Screen_Failed"
]

Back to Top

Response

Supported Media Types

• application/json

200 Response

Subjects success.

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

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