v1.0
/ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/form/verify/status/dateRange
Supported filter points:
- Site-level retrieval: supply
siteId. This API is site-scoped. - Date-range retrieval: supply
startDateandendDate.
The inclusive date range is applied to versionStart; records are eligible when versionStart >= startDate and versionStart <= endDate. The response is ordered by versionStart in ascending order.
Cursor pagination: omit pageToken on the first request. Invoke the next-page request only when hasMore is true. To retrieve the complete data set, pass the previous response nextPageToken as the next request pageToken exactly as received. Consumers must not modify nextPageToken. In the corner case where the response contains records equal to the requested limit, hasMore may still be true and nextPageToken may be returned even when no additional records are available.
First request example: /v1.0/studies/ABCDEF1234567890ABCDEF1234567890/active/form/verify/status/dateRange?siteId=ABCDEF1234567890ABCDEF1234567890&startDate=01-Jun-2026%2009:15:30.123&endDate=01-Jun-2026%2010:15:30.456&limit=25
Next-page request example: /v1.0/studies/ABCDEF1234567890ABCDEF1234567890/active/form/verify/status/dateRange?siteId=ABCDEF1234567890ABCDEF1234567890&startDate=01-Jun-2026%2009:15:30.123&endDate=01-Jun-2026%2010:15:30.456&pageToken=MTc1MDc2ODgwMDAwMDoxQkMyOUIzNkY1RDY0QjFCOTVGNEJEQkJDRUE0ODFCRQ&limit=25
Request
-
mode(required): string
Indicates the operational mode of the study. Accepted values: active, test, or training.Example:
active -
studyId(required): string
Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.Example:
ABCDEF1234567890ABCDEF1234567890
-
endDate(required): string(date-time)
Inclusive date-range end in dd-MMM-yyyy HH:mm:ss.SSS format. Inclusive means records with versionStart on or before this value are eligible. The end date must be later than the start date.Example:
01-Jun-2026 10:15:30.456 -
limit(required): integer(int32)
Minimum Value:
1Maximum Value:10000Required. Maximum number of records to return. Accepted values are positive integers from 1 through 10000; negative values are not accepted. The value is an upper bound; fewer records may be returned when no additional matching records exist.Example:25 -
pageToken: string
Opaque cursor token returned as nextPageToken from the previous page. Do not parse or modify this value. Omit it on the first request.Example:
MTc1MDc2ODgwMDAwMDoxQkMyOUIzNkY1RDY0QjFCOTVGNEJEQkJDRUE0ODFCRQ -
siteId(required): string(uuid)
Unique identifier of the site. Uses UUID in a 32-character uppercase hexadecimal string format.Example:
ABCDEF1234567890ABCDEF1234567890 -
startDate(required): string(date-time)
Inclusive date-range start in dd-MMM-yyyy HH:mm:ss.SSS format. Inclusive means records with versionStart on or after this value are eligible.Example:
01-Jun-2026 09:15:30.123
There's no request body for this operation.
Back to TopResponse
- application/json
200 Response
object-
errorData: object
errorData
-
result: object
FormVerificationDateRangeCursor
Cursor metadata and form verification audit records.
-
status: string
Example:
success
objectoracle.doceng.json.BetterJsonNull@5d9f4851object-
hasMore: boolean
Example:
false -
limit: integer
(int32)
Example:
25 -
nextPageToken: string
Example:
null -
resultData: array
resultData
array-
Array of:
object FormVerificationAuditResponseDto1
Form verification audit row returned by the Data Integration form verification status API.
object-
actionStatus: string
Verification action status.Example:
VERIFIED -
eventId: string
Visit or event identifier.Example:
ADF5A7800A954FA5B831E7B6B9CA39A9 -
eventInstanceNum: integer
Visit or event instance number.Example:
1 -
formId: string
Form identifier.Example:
40DB4EF4847849CCB24EFCCB71CDA436 -
innerRepeat: integer
Inner repeat number.Example:
0 -
objectVersionNumber: number
Object version number for the audit row.Example:
1 -
operationType: string
Operation represented by the audit row.Example:
UPDATED -
outerRepeat: integer
Outer repeat number.Example:
0 -
repeatFormNumber: integer
Repeating form number.Example:
1 -
repeatSequenceNumber: integer
Repeat sequence number.Example:
1 -
siteId: string
Site identifier associated with the row.Example:
ABCDEF1234567890ABCDEF1234567890 -
studyId: string
Clinical study identifier.Example:
ABCDEF1234567890ABCDEF1234567890 -
studyVersion: string
Study version associated with the row.Example:
1.0.0.1 -
subjectEventInstId: string
Subject event instance identifier.Example:
123456789 -
subjectId: string
Subject identifier.Example:
10F75668189F422F9A461A315D211111 -
userGuid: string
User identifier associated with the verification action.Example:
00000000000000000000000000000007 -
versionEnd: string
(date-time)
Version end timestamp.Example:
3099-12-31T00:00:00Z -
versionStart: string
(date-time)
Version start timestamp used for date-range filtering.Example:
2023-01-30T17:00:00Z
400 Response
object-
errorData: object
ErrorResponseData
Title:
ErrorResponseDataError Response Details Information -
result: object
result
-
status: string
-
version: integer
(int32)
objectErrorResponseData-
details: object
Object
Title:
ObjectObject with error details information. -
errorCode: string
Error code which is stored in ErrorCode enum. Example : C1-003Example:
C1-003 -
errorMessage: string
Error message which is stored in service property file. Example : Cannot modify object after a study version has been approvedExample:
Cannot modify object after a study version has been approved
objectobjectObject{
"field":"studyId",
"reason":"Invalid value"
}401 Response
object-
errorData: object
ErrorResponseData
Title:
ErrorResponseDataError Response Details Information -
result: object
result
-
status: string
-
version: integer
(int32)
objectErrorResponseData-
details: object
Object
Title:
ObjectObject with error details information. -
errorCode: string
Error code which is stored in ErrorCode enum. Example : C1-003Example:
C1-003 -
errorMessage: string
Error message which is stored in service property file. Example : Cannot modify object after a study version has been approvedExample:
Cannot modify object after a study version has been approved
objectobjectObject{
"field":"studyId",
"reason":"Invalid value"
}403 Response
object-
errorData: object
ErrorResponseData
Title:
ErrorResponseDataError Response Details Information -
result: object
result
-
status: string
-
version: integer
(int32)
objectErrorResponseData-
details: object
Object
Title:
ObjectObject with error details information. -
errorCode: string
Error code which is stored in ErrorCode enum. Example : C1-003Example:
C1-003 -
errorMessage: string
Error message which is stored in service property file. Example : Cannot modify object after a study version has been approvedExample:
Cannot modify object after a study version has been approved
objectobjectObject{
"field":"studyId",
"reason":"Invalid value"
}404 Response
object-
errorData: object
ErrorResponseData
Title:
ErrorResponseDataError Response Details Information -
result: object
result
-
status: string
-
version: integer
(int32)
objectErrorResponseData-
details: object
Object
Title:
ObjectObject with error details information. -
errorCode: string
Error code which is stored in ErrorCode enum. Example : C1-003Example:
C1-003 -
errorMessage: string
Error message which is stored in service property file. Example : Cannot modify object after a study version has been approvedExample:
Cannot modify object after a study version has been approved
objectobjectObject{
"field":"studyId",
"reason":"Invalid value"
}500 Response
object-
errorData: object
ErrorResponseData
Title:
ErrorResponseDataError Response Details Information -
result: object
result
-
status: string
-
version: integer
(int32)
objectErrorResponseData-
details: object
Object
Title:
ObjectObject with error details information. -
errorCode: string
Error code which is stored in ErrorCode enum. Example : C1-003Example:
C1-003 -
errorMessage: string
Error message which is stored in service property file. Example : Cannot modify object after a study version has been approvedExample:
Cannot modify object after a study version has been approved
objectobjectObject{
"field":"studyId",
"reason":"Invalid value"
}