Jump to

• Request
• Response

Get list of visits status for a date range

get

/ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/visitstatus/dateRange/{subjectId}

Retrieves the list of visits status for a given date range mainly used by Integration hub.

Request

Path Parameters

• subjectId(required): string(uuid)
  Subject ID.

Query Parameters

• endDate: string(date-time)
  The end date until which you want to retrieve the visits details.
• startDate: string(date-time)
  The start date from which you want to retrieve the visits details.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Subjects success

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object VisitsStatus

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

Nested Schema : VisitsStatus

Type: object

Show Source

• associatedStudyVersion: string
  Minimum Length: 0

  Maximum Length: 100
• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• display: string
• doseHoldAction: string
• dynamicAllCycles: string
• eventId: string
• eventInstanceNum: integer (int32)
• eventType: string
• freezedStatus: string
• id: string (uuid)
• leadingDataelementId: string
• lockedDateTime: string (date-time)
• lockedStatus: string
• operationType: string
  Minimum Length: 1

  Maximum Length: 16
• reason: string
  Minimum Length: 0

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

  Maximum Length: 100
• subjectId: string
• userId: string (uuid)
• verifiedStatus: string
• 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":{
        "reason":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "comment":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        },
        "operationType":{
            "maxLength":"16",
            "minLength":"1",
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "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"
        },
        "visitStartDate":{
            "type":"string",
            "format":"date-time"
        },
        "visitType":{
            "type":"string"
        },
        "eventType":{
            "type":"string"
        },
        "eventInstanceNum":{
            "type":"integer",
            "format":"int32"
        },
        "associatedStudyVersion":{
            "maxLength":"100",
            "minLength":"0",
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "leadingDataelementId":{
            "type":"string"
        },
        "dynamicAllCycles":{
            "type":"string"
        },
        "visitWindowWarning":{
            "type":"string"
        },
        "scheduledWindowStartDate":{
            "type":"string",
            "format":"date-time"
        },
        "scheduledWindowEndDate":{
            "type":"string",
            "format":"date-time"
        },
        "repeatingFormCount":{
            "type":"number"
        },
        "signedStatus":{
            "type":"string"
        },
        "lockedStatus":{
            "type":"string"
        },
        "visitStartDateLockedStatus":{
            "type":"string"
        },
        "lockedDateTime":{
            "type":"string",
            "format":"date-time"
        },
        "visitStartDateLockedDateTime":{
            "type":"string",
            "format":"date-time"
        },
        "verifiedStatus":{
            "type":"string"
        },
        "freezedStatus":{
            "type":"string"
        },
        "doseHoldAction":{
            "type":"string"
        },
        "visitAction":{
            "type":"string"
        }
    }
}

400 Response

Bad request.

Body ()

Root Schema : RestResponse

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