Jump to

• Request
• Response

Get subjects and their visit schedule

post

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

This consolidated API retrieves EHR Link Status, locked status, subjects and their visit schedule. Filter capabilities include 'canBeCompleted', 'canBeReplaced', 'canBeUndoWithdrawn' fields for a subject.

Request

Query Parameters

• showUndoSFWithdCompVisits: boolean
  show all undo ScreenFail/Withdrawal/Completion visits

  Default Value: true
• view: string
  This can take value as dmview and is added for Data Management subject and visit listing page.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• containsSearchKeywords: array containsSearchKeywords
• dmViewReviewStatus: array dmViewReviewStatus
• dmViewSafetyCaseStatus: array dmViewSafetyCaseStatus
• dmViewSortBy: string
• exactSearchKeywords: array exactSearchKeywords
• limit: integer (int32)
• nextVisitOnly: boolean
• notStarted: boolean
• offset: integer (int32)
• order: string
• projectionTillDate: string (date-time)
• reviewStatus: string
• safetyCaseStatus: string
• sites: array sites
• subjectStates: array subjectStates

{
    "type":"object",
    "properties":{
        "sites":{
            "type":"array",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        },
        "limit":{
            "type":"integer",
            "format":"int32"
        },
        "offset":{
            "type":"integer",
            "format":"int32"
        },
        "order":{
            "type":"string"
        },
        "reviewStatus":{
            "type":"string"
        },
        "subjectStates":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "exactSearchKeywords":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "containsSearchKeywords":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "nextVisitOnly":{
            "type":"boolean"
        },
        "notStarted":{
            "type":"boolean"
        },
        "projectionTillDate":{
            "type":"string",
            "format":"date-time"
        },
        "safetyCaseStatus":{
            "type":"string"
        },
        "dmViewSortBy":{
            "type":"string"
        },
        "dmViewReviewStatus":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "dmViewSafetyCaseStatus":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : containsSearchKeywords

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : dmViewReviewStatus

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : dmViewSafetyCaseStatus

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : exactSearchKeywords

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : sites

Type: array

Show Source

• Array of: string(uuid)

{
    "type":"array",
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Nested Schema : subjectStates

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Subjects success.

Body ()

Root Schema : DcsResponse

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

400 Response

Bad request.

Body ()

Root Schema : DcsResponse

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