REST API for Clinical One Platform

v1.0 REST Endpoints

Sites and Depots/Site or Depot (SDF)/SDF Management/v1.0

The operations from the Sites and Depots/Site or Depot (SDF)/SDF Management/v1.0 category.

~~[Deprecated]: Create a site~~: Method: post
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs
~~[Deprecated]: Create a site and send notification~~: Method: post
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/sdf
~~[Deprecated]: Delete a site by ID~~: Method: delete
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/{sdfId}
~~[Deprecated]: Delete depot email~~: Method: delete
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/deleteDepotEmail
~~[Deprecated]: Get a site by ID~~: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/{sdfId}
~~[Deprecated]: Get a site by SDF ID for a tenant~~: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/tenant/{sdfId}
~~[Deprecated]: Get all sites by type~~: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/all
~~[Deprecated]: Get countries for a site~~: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/countries
~~[Deprecated]: Get site by filter parameters~~: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/siteFilterPaginated
~~[Deprecated]: Get site by site name or address and type of SDF~~: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/search
~~[Deprecated]: Get site by site name or address and type of SDF (UI search autocomplete)~~: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/autoSuggest
~~[Deprecated]: Get sites by type or list of countries~~: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs
~~[Deprecated]: Get sites on search key~~: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/searchSite
~~[Deprecated]: Get the principal investigator's last name and address of the site~~: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/pinaddr
~~[Deprecated]: Update a site~~: Method: put
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/{sdfId}
~~[Deprecated]: Update a site and send notification~~: Method: put
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/sdf/{sdfId}
Clear site's SDFs cached data by study ID and mode: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/clearsitecache
Create depot association with country or state by GUID: Method: post
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/sdf/{sdfType}/country/{sdfId}
Create site or depot with study ID and master address: Method: post
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/sdf/{sdfType}
Delete site, master address, properties and kit settings by SDF ID: Method: delete
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/sdf/{sdfType}/{sdfId}
Get all return depot properties details: Method: get
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/depot/{pathAttr}
Get all sites and depots details by study ID based on given filters: Method: get
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/sdf/{sdfType}
Get all sites by type and study version: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/allstudyversions
Get all sites details or depots details by study ID: Method: get
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/allSdf/{sdfType}
Get all study versions for a site: Method: get
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/allstudyversions/{sdfType}
Get countries for a site by SDF type: Method: get
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/{sdfType}/countries
Get locally sourced kits by site: Method: get
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/locallySourcedKitsBySite
Get SDF countries or states associated with depot GUID: Method: get
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/sdf/{sdfType}/country/{sdfId}
Get SDF details for IDs sent in payload: Method: post
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/sdf/sdfDetails
Get SDF information with creation date by SDF type: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/creationDate
Get site by site name and address: Method: get
Path: /ec-site-svc/rest/v1/tenant/sdfs/autoSuggest
Get site or depot details by SDF ID and SDF Type: Method: get
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/sdf/{sdfType}/{sdfId}
Get site or depot information by ID: Method: get
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/{sdfType}/sdfRegion/{sdfId}
Get study site details with study version property by site ID: Method: get
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/site/{mode}/{sdfId}
Update all sites with a new study version: Method: put
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/versionupdate
Update or delete depot association with country or state by GUID: Method: put
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/sdf/{sdfType}/country/{sdfId}
Update SDF status for the given study ID, mode ID and SDF type: Method: put
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/{sdfType}/status
Update site or depot with study ID and master address: Method: put
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/sdf/{sdfType}/{sdfId}
Update site properties for managing sites: Method: put
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/multiple
Validate fields for study labs, depots or sites: Method: post
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/{sdfType}/validateFields