Jump to

• Request
• Response

Get list of visits visits start date for subjects

post

/ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/visits/subjectvisitsinfo

Retrieves a list of visits visit start date for subjects, as well as the subject number and randomization number .

Request

Path Parameters

• mode(required): string
  Mode of the study. Accepts test, active, or training.
• studyId(required): string
  ID of the study for which you want to get the list of subjects.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• subjects: array subjects

{
    "type":"object",
    "properties":{
        "subjects":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SubjectVisitsInfoReq"
            }
        }
    }
}

Nested Schema : subjects

Type: array

Show Source

• Array of: object SubjectVisitsInfoReq

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SubjectVisitsInfoReq"
    }
}

Nested Schema : SubjectVisitsInfoReq

Type: object

Show Source

• subjectId: string
• visits: array visits

{
    "type":"object",
    "properties":{
        "subjectId":{
            "type":"string"
        },
        "visits":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/VisitInfoDetailReq"
            }
        }
    }
}

Nested Schema : visits

Type: array

Show Source

• Array of: object VisitInfoDetailReq

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/VisitInfoDetailReq"
    }
}

Nested Schema : VisitInfoDetailReq

Type: object

Show Source

• eventId: string
• eventInstanceNum: integer (int32)

{
    "type":"object",
    "properties":{
        "eventId":{
            "type":"string"
        },
        "eventInstanceNum":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object SubjectVisitInfoResponse

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SubjectVisitInfoResponse"
    }
}

Nested Schema : SubjectVisitInfoResponse

Type: object

Show Source

• subjects: array subjects

{
    "type":"object",
    "properties":{
        "subjects":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SubjectVisitInfo"
            }
        }
    }
}

Nested Schema : subjects

Type: array

Show Source

• Array of: object SubjectVisitInfo

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SubjectVisitInfo"
    }
}

Nested Schema : SubjectVisitInfo

Type: object

Show Source

• screeningNumber: string
• subjectId: string (uuid)
• subjectNumber: string
• visits: array visits

{
    "type":"object",
    "properties":{
        "subjectId":{
            "type":"string",
            "format":"uuid"
        },
        "subjectNumber":{
            "type":"string"
        },
        "screeningNumber":{
            "type":"string"
        },
        "visits":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/VisitInfoDetail"
            }
        }
    }
}

Nested Schema : visits

Type: array

Show Source

• Array of: object VisitInfoDetail

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/VisitInfoDetail"
    }
}

Nested Schema : VisitInfoDetail

Type: object

Show Source

• eventId: string
• eventInstanceNum: integer (int32)
• visitStartDate: string (date-time)

{
    "type":"object",
    "properties":{
        "eventId":{
            "type":"string"
        },
        "eventInstanceNum":{
            "type":"integer",
            "format":"int32"
        },
        "visitStartDate":{
            "type":"string",
            "format":"date-time"
        }
    }
}

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