Jump to

• Request
• Response

[Deprecated]: Get subject's visits list and the current state's study version

post

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

Deprecated: Retrieves the list of visits status for a list of subjects and the current state's study version. This API also returns unscheduled events details.

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":{
                "type":"string",
                "format":"uuid"
            }
        }
    }
}

Nested Schema : subjects

Type: array

Show Source

• Array of: string(uuid)

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object SubjectVisitsDto20

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

Nested Schema : SubjectVisitsDto20

Type: object

Show Source

• crntStateStudyVrsn: string
• subjectId: string
• visits: array visits

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

Nested Schema : visits

Type: array

Show Source

• Array of: object schema

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

Nested Schema : schema

Type: object

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• eventId: string
• eventType: string
• id: string (uuid)
• reason: string
  Minimum Length: 0

  Maximum Length: 255
• siteId: string
• studyVersion(required): string
  Minimum Length: 0

  Maximum Length: 100
• subjectId: string
• userId: string (uuid)
• versionStart: string (date-time)
• visitStartDate: string (date-time)
• visitStatus: string
• visitType: string

{
    "required":[
        "studyVersion"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "subjectId":{
            "type":"string"
        },
        "eventId":{
            "type":"string"
        },
        "siteId":{
            "type":"string"
        },
        "studyVersion":{
            "maxLength":"100",
            "minLength":"0",
            "type":"string"
        },
        "visitStatus":{
            "type":"string"
        },
        "reason":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "comment":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "visitStartDate":{
            "type":"string",
            "format":"date-time"
        },
        "visitType":{
            "type":"string"
        },
        "eventType":{
            "type":"string"
        }
    }
}

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