Jump to

• Request
• Response

Get list of visits status for subjects

post

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

Retrieves a list of visit status for subjects. Includes the visit action in subject scheduled visits.

Request

Path Parameters

• studyId(required): string
  ID of the study for which you want to get the list of subjects.

Query Parameters

• cycleCountToDate: string(date-time)
  In case of future visits if this is specified it would include the cycles instances till this date. This is useful in case of infinite cycle count as the default only returns the next cycle visit.
• nextVisitOnly: boolean
  This is to specify to return only the next visit else this would return future visits as well.
• notStarted: boolean
  If this is set then non started visits would be included in the response.
• signVerifyStatus(required): string
  Status of Sign / Verify.

  Default Value: ALL
• siteId: string
  This is the site for which the subjects and their schedule needs to be computed.
• siteStudyVersion: string
  This is the site study version for which the visit schedule needs to be calculated.
• 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

• 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 SubjectVisitsDto12

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

Nested Schema : SubjectVisitsDto12

Type: object

Show Source

• canBeCompleted: boolean
• canBeReplaced: boolean
• canBeUndoWithdrawn: boolean
• crntStateStudyVrsn: string
• ehrLinkStatus: number
• freezedStatus: string
• lastSigned: string
• lockedInStudyVersion: string
• lockedStatus: string
• replaceRand: string
• scheduledVisits: array scheduledVisits
• signedStatus: string
• studyCompletionDate: string (date-time)
• subjectId: string
• verifiedStatus: string
• visits: array visits
• withdrawalDate: string (date-time)

{
    "type":"object",
    "properties":{
        "subjectId":{
            "type":"string"
        },
        "visits":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/VisitsStatusDto14"
            }
        },
        "scheduledVisits":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ScheduledVisitsDto20"
            }
        },
        "crntStateStudyVrsn":{
            "type":"string"
        },
        "signedStatus":{
            "type":"string"
        },
        "verifiedStatus":{
            "type":"string"
        },
        "freezedStatus":{
            "type":"string"
        },
        "lastSigned":{
            "type":"string"
        },
        "lockedStatus":{
            "type":"string"
        },
        "canBeCompleted":{
            "type":"boolean"
        },
        "canBeReplaced":{
            "type":"boolean"
        },
        "canBeUndoWithdrawn":{
            "type":"boolean"
        },
        "replaceRand":{
            "type":"string"
        },
        "lockedInStudyVersion":{
            "type":"string"
        },
        "ehrLinkStatus":{
            "type":"number"
        },
        "withdrawalDate":{
            "type":"string",
            "format":"date-time"
        },
        "studyCompletionDate":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : scheduledVisits

Type: array

Show Source

• Array of: object ScheduledVisitsDto20

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

Nested Schema : visits

Type: array

Show Source

• Array of: object VisitsStatusDto14

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

Nested Schema : ScheduledVisitsDto20

Type: object

Show Source

• cycleCount: number
• eventId: string
• eventInstanceNum: number
• scheduledDate: string (date-time)
• scheduledWindowEndDate: string (date-time)
• scheduledWindowStartDate: string (date-time)
• title: string
• visitAction: string

{
    "type":"object",
    "properties":{
        "eventId":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "scheduledWindowStartDate":{
            "type":"string",
            "format":"date-time"
        },
        "scheduledDate":{
            "type":"string",
            "format":"date-time"
        },
        "scheduledWindowEndDate":{
            "type":"string",
            "format":"date-time"
        },
        "eventInstanceNum":{
            "type":"number"
        },
        "cycleCount":{
            "type":"number"
        },
        "visitAction":{
            "type":"string"
        }
    }
}

Nested Schema : VisitsStatusDto14

Type: object

Show Source

• associatedStudyVersion: string
• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• doseHoldAction: string
• eventId: string
• eventInstanceNum: integer (int32)
• eventType: string
• freezedStatus: string
• id: string (uuid)
• lockedDateTime: string (date-time)
• lockedStatus: string
• objectVersionNumber: number
• operationType: string
• reason: string
  Minimum Length: 0

  Maximum Length: 255
• repeatingFormCount: number
• scheduledWindowEndDate: string (date-time)
• scheduledWindowStartDate: string (date-time)
• signedStatus: string
• siteId: string
• softwareVersionNumber: number
• studyVersion(required): string
  Minimum Length: 0

  Maximum Length: 100
• subjectId: string
• unResolvedQueries: integer (int32)
• userId: string (uuid)
• verifiedStatus: string
• versionEnd: string (date-time)
• versionStart: string (date-time)
• visitAction: string
• visitStartDate: string (date-time)
• visitStartDateLockedDateTime: string (date-time)
• visitStartDateLockedStatus: string
• visitStatus: string
• visitType: string
• visitWindowWarning: 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"
        },
        "operationType":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "visitStartDate":{
            "type":"string",
            "format":"date-time"
        },
        "visitType":{
            "type":"string"
        },
        "eventType":{
            "type":"string"
        },
        "eventInstanceNum":{
            "type":"integer",
            "format":"int32"
        },
        "signedStatus":{
            "type":"string"
        },
        "verifiedStatus":{
            "type":"string"
        },
        "freezedStatus":{
            "type":"string"
        },
        "repeatingFormCount":{
            "type":"number"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "scheduledWindowStartDate":{
            "type":"string",
            "format":"date-time"
        },
        "scheduledWindowEndDate":{
            "type":"string",
            "format":"date-time"
        },
        "associatedStudyVersion":{
            "type":"string"
        },
        "visitAction":{
            "type":"string"
        },
        "lockedStatus":{
            "type":"string"
        },
        "visitStartDateLockedStatus":{
            "type":"string"
        },
        "lockedDateTime":{
            "type":"string",
            "format":"date-time"
        },
        "visitStartDateLockedDateTime":{
            "type":"string",
            "format":"date-time"
        },
        "visitWindowWarning":{
            "type":"string"
        },
        "doseHoldAction":{
            "type":"string"
        },
        "unResolvedQueries":{
            "type":"integer",
            "format":"int32"
        }
    }
}

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