Get sites
get
/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites
Retrieves sites by study ID. Rights: OrsInventoryGet.
Request
Path Parameters
-
mode(required): string
Mode of the study, accepts: test, active, or training
-
studyId(required): string(uuid)
ID of the study
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SDFs
Type:
Show Source
object
-
comment: string
Minimum Length:
0
Maximum Length:2048
-
id: string
(uuid)
-
name(required): string
Minimum Length:
0
Maximum Length:200
-
reason: string
Minimum Length:
0
Maximum Length:255
-
sdfType(required): string
Minimum Length:
0
Maximum Length:50
-
status(required): string
Minimum Length:
0
Maximum Length:50
-
studyOrgId(required): string
Minimum Length:
0
Maximum Length:50
-
tenantEntityId: string
(uuid)
-
versionStart: string
(date-time)
Nested Schema : SDFAddress
Type:
Show Source
object
-
addressCity(required): string
Minimum Length:
0
Maximum Length:100
-
addressCountry(required): string
Minimum Length:
0
Maximum Length:100
-
addressPostalcode(required): string
Minimum Length:
0
Maximum Length:20
-
addressStateOrProvOrCounty: string
Minimum Length:
0
Maximum Length:100
-
addressStreet1(required): string
Minimum Length:
0
Maximum Length:150
Pattern:.*[A-z].*|.*\p{L}+.*
-
addressStreet2: string
Minimum Length:
0
Maximum Length:150
-
addressType(required): string
Minimum Length:
0
Maximum Length:100
-
comment: string
Minimum Length:
0
Maximum Length:2048
-
email: string
Minimum Length:
0
Maximum Length:255
-
fax: string
Minimum Length:
0
Maximum Length:50
-
id: string
(uuid)
-
phone: string
Minimum Length:
0
Maximum Length:50
-
reason: string
Minimum Length:
0
Maximum Length:255
-
sdfId: string
(uuid)
-
versionStart: string
(date-time)
Nested Schema : SDFProperty
Type:
Show Source
object
-
comment: string
Minimum Length:
0
Maximum Length:2048
-
id: string
(uuid)
-
propertyName(required): string
Minimum Length:
0
Maximum Length:100
-
propertyValue(required): string
Minimum Length:
0
Maximum Length:2048
-
reason: string
Minimum Length:
0
Maximum Length:255
-
sdfId: string
(uuid)
-
versionStart: string
(date-time)
404 Response
Invalid study ID or version
Root Schema : ORSResponse
Type:
object
Common response object.
Show Source
-
errorData: object
ErrorResponseData
-
result: object
result
Result Object
-
status: string
Status of requestExample:
Success
-
version: integer
(int32)
Nested Schema : result
Type:
object
Result Object
Nested Schema : details
Type:
object
500 Response
Internal server error
Root Schema : ORSResponse
Type:
object
Common response object.
Show Source
-
errorData: object
ErrorResponseData
-
result: object
result
Result Object
-
status: string
Status of requestExample:
Success
-
version: integer
(int32)
Nested Schema : result
Type:
object
Result Object
Nested Schema : details
Type:
object