Get a site or depot details by SDF ID and SDF Type
get
/ec-site-svc/rest/v2.0/studies/{studyId}/{mode}/sdfs/sdf/{sdfType}/{sdfId}
Get a site or depot details by SDF ID and SDF Type with audit support. Rights: SiteGet;StudyDepotGet
Request
Path Parameters
-
mode(required): string
Mode of the study. Accepts active, test, or training.
-
sdfId(required): string
Unique Id to identify Site, Lab or Depot (SDF)
-
sdfType(required): string
Type of SDF : Sites or Depots.
-
studyId(required): string(uuid)
The ID of the study.
Query Parameters
-
attributes: string
Optional query parameter to return info with address/properties/kit settings or all. Sample Query Parameters: INFO,PROPERTIES,ADDRESSES,KITSETTINGS
-
excludeExtendedProperties: string
Retrieve extended properties for site only if the excludeExtendedProperties flag is false
-
history: boolean
Boolean parameter to determine whether history of changes is required.
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 : Response
Type:
Show Source
object
-
allowedMethods: array
allowedMethods
Unique Items Required:
true
-
closed: boolean
-
cookies: object
cookies
Additional Properties Allowed: NewCookie
-
date: string
(date-time)
-
entity: object
entity
-
entityTag: object
EntityTag
-
headers: object
headers
Additional Properties Allowed: additionalProperties
-
language: object
language
-
lastModified: string
(date-time)
-
length: integer
(int32)
-
links: array
links
Unique Items Required:
true
-
location: string
(uri)
-
mediaType: object
MediaType
-
metadata: object
metadata
Additional Properties Allowed: additionalProperties
-
status: integer
(int32)
-
statusInfo: object
StatusType
-
stringHeaders: object
stringHeaders
Additional Properties Allowed: additionalProperties
Nested Schema : entity
Type:
object
Nested Schema : language
Type:
Show Source
object
-
country: string
-
displayCountry: string
-
displayLanguage: string
-
displayName: string
-
displayScript: string
-
displayVariant: string
-
extensionKeys: array
extensionKeys
Unique Items Required:
true
-
iso3Country: string
-
iso3Language: string
-
language: string
-
script: string
-
unicodeLocaleAttributes: array
unicodeLocaleAttributes
Unique Items Required:
true
-
unicodeLocaleKeys: array
unicodeLocaleKeys
Unique Items Required:
true
-
variant: string
Nested Schema : MediaType
Type:
Show Source
object
-
parameters: object
parameters
Additional Properties Allowed: additionalProperties
-
subtype: string
-
type: string
-
wildcardSubtype: boolean
-
wildcardType: boolean
Nested Schema : StatusType
Type:
Show Source
object
-
family: string
Allowed Values:
[ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ]
-
reasonPhrase: string
-
statusCode: integer
(int32)
Nested Schema : NewCookie
Type:
Show Source
object
-
comment: string
-
domain: string
-
expiry: string
(date-time)
-
httpOnly: boolean
-
maxAge: integer
(int32)
-
name: string
-
path: string
-
sameSite: string
Allowed Values:
[ "NONE", "LAX", "STRICT" ]
-
secure: boolean
-
value: string
-
version: integer
(int32)
Nested Schema : items
Type:
object
Nested Schema : Link
Type:
Show Source
object
-
params: object
params
Additional Properties Allowed: additionalProperties
-
rel: string
-
rels: array
rels
-
title: string
-
type: string
-
uri: string
(uri)
-
uriBuilder: object
UriBuilder
Nested Schema : UriBuilder
Type:
object
Nested Schema : items
Type:
object