Get all sites details by study ID and filters or all depots details by study ID
get
/ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/allSdf/{sdfType}
If sdfType is all, then list all sites and depots. If sdfType is Site, lists all sites and matching filter criterias page by page. If sdfType is Depot, lists all depots details, page by page.
Request
Path Parameters
-
mode(required): string
Mode of the study. Accepts active, test, or training.
-
sdfType(required): string
Type of SDF : Sites or Depots.
-
studyId(required): string
The ID of the study.
Query Parameters
-
countryISOCode: string
the ISO code of the country.
-
countryId: string
Country ID.
-
isLocalized: boolean
Tag to identify is localization is required or not
-
limit: integer(int32)
Number of rows to return.
-
name: string
Name search filter for site
-
offset: integer(int32)
Row number to start from.
-
order: string
The Order in which the sites are returned.
-
sdfId: string
Unique Id to identify Site, Lab or Depot (SDF)
-
statusId: string
Site Status filter
-
studyVersion: string
Study version filter for site
-
supplyCountryId: string
Supply Country ID.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation.
Root Schema : SDFDetailsResponse
Type:
Show Source
object
-
sdf: object
Discriminator: sdfType
Discriminator:
{ "propertyName":"sdfType" }
-
sdfAddressAssociations: array
sdfAddressAssociations
-
sdfKitSettingDto: array
sdfKitSettingDto
-
sdfPropertyList: array
sdfPropertyList
Nested Schema : Discriminator: sdfType
Type:
Show Source
object
-
comment: string
Minimum Length:
0
Maximum Length:2048
-
id: string
(uuid)
-
objectVersionNumber: number
-
oldSdfId: string
(uuid)
-
operationType: string
Minimum Length:
1
Maximum Length:16
-
reason: string
Minimum Length:
0
Maximum Length:255
-
sdfType(required): string
-
softwareVersionNumber: number
-
statusId: string
(uuid)
-
statusIdCodeValue: string
-
studyOrgIdName: string
-
tenantEntityId: string
(uuid)
-
userId: string
(uuid)
-
versionEnd: string
(date-time)
-
versionStart: string
(date-time)
Nested Schema : SDFAddressAssociationDetailsDto
Type:
Show Source
object
-
addressCity: string
-
addressCountry: string
(uuid)
-
addressCountryName: string
-
addressPostalCode: string
-
addressStateOrProvOrCounty: string
(uuid)
-
addressStateOrProvOrCountyName: string
-
addressStreet1: string
-
addressStreet2: string
-
addressTypeId(required): string
(uuid)
-
addressTypeIdCodeValue: string
-
comment: string
Minimum Length:
0
Maximum Length:2048
-
entityAddressAssociationId(required): string
(uuid)
-
entityAddressProperties: array
entityAddressProperties
-
id: string
(uuid)
-
objectVersionNumber: number
-
operationType: string
Minimum Length:
1
Maximum Length:16
-
reason: string
Minimum Length:
0
Maximum Length:255
-
sdfAddressProperties: array
sdfAddressProperties
-
sdfId: string
(uuid)
-
softwareVersionNumber: number
-
userId: string
(uuid)
-
versionEnd: string
(date-time)
-
versionStart: string
(date-time)
Nested Schema : PropertyDto
Type:
Show Source
object
-
comment: string
Minimum Length:
0
Maximum Length:2048
-
entityId: string
(uuid)
-
entityType: string
Minimum Length:
0
Maximum Length:50
-
id: string
(uuid)
-
objectVersionNumber: number
-
propertyName(required): string
Minimum Length:
0
Maximum Length:100
-
propertyValue(required): string
Minimum Length:
0
Maximum Length:500
-
reason: string
Minimum Length:
0
Maximum Length:255
-
versionStart: string
(date-time)
Nested Schema : SDFPropertyDetailsDto
Type:
Show Source
object
-
comment: string
Minimum Length:
0
Maximum Length:2048
-
id: string
(uuid)
-
objectVersionNumber: number
-
operationType: string
Minimum Length:
1
Maximum Length:16
-
propertyName(required): string
Minimum Length:
0
Maximum Length:100
-
propertyValue(required): string
Minimum Length:
0
Maximum Length:1024
-
reason: string
Minimum Length:
0
Maximum Length:255
-
sdfId: string
(uuid)
-
softwareVersionNumber: number
-
userId: string
(uuid)
-
versionEnd: string
(date-time)
-
versionStart: string
(date-time)
Nested Schema : SDFKitSettingDto
Type:
Show Source
object
-
comment: string
Minimum Length:
0
Maximum Length:2048
-
id: string
(uuid)
-
kitTypeId(required): string
(uuid)
-
reason: string
Minimum Length:
0
Maximum Length:255
-
sdfId: string
(uuid)
-
settingName(required): string
-
settingOperationType: string
-
settingValue(required): string
-
versionStart: string
(date-time)
400 Response
Bad request.
Root Schema : SDFDetailsResponse
Type:
Show Source
object
-
sdf: object
Discriminator: sdfType
Discriminator:
{ "propertyName":"sdfType" }
-
sdfAddressAssociations: array
sdfAddressAssociations
-
sdfKitSettingDto: array
sdfKitSettingDto
-
sdfPropertyList: array
sdfPropertyList
Nested Schema : Discriminator: sdfType
Type:
Show Source
object
-
comment: string
Minimum Length:
0
Maximum Length:2048
-
id: string
(uuid)
-
objectVersionNumber: number
-
oldSdfId: string
(uuid)
-
operationType: string
Minimum Length:
1
Maximum Length:16
-
reason: string
Minimum Length:
0
Maximum Length:255
-
sdfType(required): string
-
softwareVersionNumber: number
-
statusId: string
(uuid)
-
statusIdCodeValue: string
-
studyOrgIdName: string
-
tenantEntityId: string
(uuid)
-
userId: string
(uuid)
-
versionEnd: string
(date-time)
-
versionStart: string
(date-time)
Nested Schema : SDFAddressAssociationDetailsDto
Type:
Show Source
object
-
addressCity: string
-
addressCountry: string
(uuid)
-
addressCountryName: string
-
addressPostalCode: string
-
addressStateOrProvOrCounty: string
(uuid)
-
addressStateOrProvOrCountyName: string
-
addressStreet1: string
-
addressStreet2: string
-
addressTypeId(required): string
(uuid)
-
addressTypeIdCodeValue: string
-
comment: string
Minimum Length:
0
Maximum Length:2048
-
entityAddressAssociationId(required): string
(uuid)
-
entityAddressProperties: array
entityAddressProperties
-
id: string
(uuid)
-
objectVersionNumber: number
-
operationType: string
Minimum Length:
1
Maximum Length:16
-
reason: string
Minimum Length:
0
Maximum Length:255
-
sdfAddressProperties: array
sdfAddressProperties
-
sdfId: string
(uuid)
-
softwareVersionNumber: number
-
userId: string
(uuid)
-
versionEnd: string
(date-time)
-
versionStart: string
(date-time)
Nested Schema : PropertyDto
Type:
Show Source
object
-
comment: string
Minimum Length:
0
Maximum Length:2048
-
entityId: string
(uuid)
-
entityType: string
Minimum Length:
0
Maximum Length:50
-
id: string
(uuid)
-
objectVersionNumber: number
-
propertyName(required): string
Minimum Length:
0
Maximum Length:100
-
propertyValue(required): string
Minimum Length:
0
Maximum Length:500
-
reason: string
Minimum Length:
0
Maximum Length:255
-
versionStart: string
(date-time)
Nested Schema : SDFPropertyDetailsDto
Type:
Show Source
object
-
comment: string
Minimum Length:
0
Maximum Length:2048
-
id: string
(uuid)
-
objectVersionNumber: number
-
operationType: string
Minimum Length:
1
Maximum Length:16
-
propertyName(required): string
Minimum Length:
0
Maximum Length:100
-
propertyValue(required): string
Minimum Length:
0
Maximum Length:1024
-
reason: string
Minimum Length:
0
Maximum Length:255
-
sdfId: string
(uuid)
-
softwareVersionNumber: number
-
userId: string
(uuid)
-
versionEnd: string
(date-time)
-
versionStart: string
(date-time)
Nested Schema : SDFKitSettingDto
Type:
Show Source
object
-
comment: string
Minimum Length:
0
Maximum Length:2048
-
id: string
(uuid)
-
kitTypeId(required): string
(uuid)
-
reason: string
Minimum Length:
0
Maximum Length:255
-
sdfId: string
(uuid)
-
settingName(required): string
-
settingOperationType: string
-
settingValue(required): string
-
versionStart: string
(date-time)