1. REST API for Clinical One Cloud Service
  2. Tasks
  3. Sites and Depots
  4. Site or Depot (SDF)
  5. SDF Management
  6. Update a site and send notification

[Deprecated]: v1.0
put

/ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/sdf/{sdfId}

Deprecated in v1: use the latest SDF API version.

Request

Path Parameters
  • Study mode. Allowed values: active (live study operations), test (testing data), training (training or sandbox data).
    Example:
    test
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) for a site, depot, or lab (SDF).
    Example:
    C36A3197FDEE433FB5547EE83DE99E4B
  • Study identifier as a 32-character uppercase hexadecimal UUID string.
    Example:
    C36A3197FDEE433FB5547EE83DE99E4B
Supported Media Types
Request Body - application/json ()
Root Schema : SDFModelDto v1.0
Type: object
Title: SDFModelDto v1.0
Wrapper that returns an SDF plus its addresses and properties.
Show Source
Nested Schema : SDFDto v1.0
Type: object
Title: SDFDto v1.0
Metadata for a study site or depot.
Show Source
  • Title: Comment
    Minimum Length: 0
    Maximum Length: 2048
    Additional comment captured for the audited update.
    Example: Association adjusted after data reconciliation.
  • Title: SDF ID
    Unique identifier (UUID, 32-character uppercase hexadecimal string) of the SDF record.
  • Title: Name
    Minimum Length: 0
    Maximum Length: 200
    Official name of the site or depot.
    Example: Oakland Biomed Site
  • Title: Reason
    Minimum Length: 0
    Maximum Length: 255
    Reason provided for the audited update.
    Example: Protocol update requested by study operations.
  • Title: SDF Type
    Minimum Length: 0
    Maximum Length: 50
    Role of the SDF such as Site or Depot.
    Example: SITE
  • Title: Status
    Minimum Length: 0
    Maximum Length: 50
    Current status of the SDF, for example Active or Inactive.
    Example: ACTIVE
  • Title: Study Organization ID
    Minimum Length: 0
    Maximum Length: 50
    Identifier of the study organization linked to the SDF.
    Example: STUDY-123
Example:
{
    "id":"3F2504E04F8911D39A0C0305E82C3301",
    "name":"Oakland Biomed Site",
    "status":"ACTIVE",
    "sdfType":"SITE",
    "studyOrgId":"STUDY-123"
}
Nested Schema : SDFAddressDto v1.0
Type: object
Title: SDFAddressDto v1.0
Address metadata returned for a site or depot.
Show Source
  • Title: City
    Minimum Length: 0
    Maximum Length: 100
    City for the address.
    Example: Metropolis
  • Title: Country
    Minimum Length: 0
    Maximum Length: 100
    Country for the address.
    Example: US
  • Title: Postal Code
    Minimum Length: 0
    Maximum Length: 20
    Postal or ZIP code for the address.
    Example: 94105
  • Title: State or Province or County
    Minimum Length: 0
    Maximum Length: 100
    State, province, or county for the address.
    Example: CA
  • Title: Address Street 1
    Minimum Length: 0
    Maximum Length: 150
    Pattern: .*[A-z].*|.*\p{L}+.*
    Primary street address.
    Example: 123 Primary St
  • Title: Address Street 2
    Minimum Length: 0
    Maximum Length: 150
    Secondary street address (optional).
    Example: Suite 500
  • Title: Address Type
    Minimum Length: 0
    Maximum Length: 100
    Label describing the address type such as Primary or Shipping.
    Example: PRIMARY
  • Title: Comment
    Minimum Length: 0
    Maximum Length: 2048
    Additional comment captured for the audited update.
    Example: Association adjusted after data reconciliation.
  • Title: Email
    Minimum Length: 0
    Maximum Length: 255
    Email address for the site or depot.
    Example: site@clinicalone.com
  • Title: Fax
    Minimum Length: 0
    Maximum Length: 50
    Fax number for the address contact.
    Example: +1-555-321-0000
  • Title: SDF Address ID
    Unique identifier (UUID, 32-character uppercase hexadecimal string) of the address.
  • Title: Phone
    Minimum Length: 0
    Maximum Length: 50
    Phone number for the address contact.
    Example: +1-555-987-6543
  • Title: Reason
    Minimum Length: 0
    Maximum Length: 255
    Reason provided for the audited update.
    Example: Protocol update requested by study operations.
  • Title: SDF ID
    Identifier of the SDF associated with the address.
Example:
[
    {
        "addressStreet1":"123 Primary St",
        "addressCity":"Metropolis",
        "addressCountry":"US"
    }
]
Nested Schema : SDFPropertyDto v1.0
Type: object
Title: SDFPropertyDto v1.0
Property metadata attached to an SDF.
Show Source
  • Title: Comment
    Minimum Length: 0
    Maximum Length: 2048
    Additional comment captured for the audited update.
    Example: Association adjusted after data reconciliation.
  • Title: SDF Property ID
    Unique identifier (UUID, 32-character uppercase hexadecimal string) of the property entry.
  • Title: Property Name
    Minimum Length: 0
    Maximum Length: 100
    Key identifying the property.
    Example: PRIMARY_CONTACT
  • Title: Property Value
    Minimum Length: 0
    Maximum Length: 100
    Value stored for the property.
    Example: ACTIVE
  • Title: Reason
    Minimum Length: 0
    Maximum Length: 255
    Reason provided for the audited update.
    Example: Protocol update requested by study operations.
  • Title: SDF ID
    Identifier of the SDF the property belongs to.
Example:
[
    {
        "propertyName":"PRIMARY",
        "propertyValue":"ACTIVE"
    }
]
Examples

Back to Top

Response

Supported Media Types

200 Response

Successful operation.
Body ()
Root Schema : SDFResponse
Type: object
Title: SDFResponse
Wrapper for service responses containing result or error data.
Show Source
Nested Schema : ErrorResponseData
Type: object
Show Source
Nested Schema : result
Type: object
The result object for successful requests. Type depends on the API operation.
Example:
{
    "hasMore":"true",
    "totalResults":5,
    "count":5,
    "data":[
    ]
}
Nested Schema : details
Type: object
Examples

400 Response

Returned when one or more path parameters, query parameters, or request-body values fail endpoint validation.
Body ()
Root Schema : SDFResponse
Type: object
Title: SDFResponse
Wrapper for service responses containing result or error data.
Show Source
Nested Schema : ErrorResponseData
Type: object
Show Source
Nested Schema : result
Type: object
The result object for successful requests. Type depends on the API operation.
Example:
{
    "hasMore":"true",
    "totalResults":5,
    "count":5,
    "data":[
    ]
}
Nested Schema : details
Type: object
Examples

Back to Top