REST API for Clinical One Platform

Update or delete depot association with country or state by GUID

put

/ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/sdf/{sdfType}/country/{sdfId}

Updates or removes depot association with country or state by GUID: depot GUID, country GUID or state GUID.

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.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

sdfCountriesList: array sdfCountriesList

{
    "type":"object",
    "properties":{
        "sdfCountriesList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SDFCountryDto"
            }
        }
    }
}

Nested Schema : sdfCountriesList

Type: array

Show Source

Array of: object SDFCountryDto

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SDFCountryDto"
    }
}

Nested Schema : SDFCountryDto

Type: object

Show Source

associationOperationType: string
comment: string

Minimum Length: 0

Maximum Length: 2048
countryId(required): string (uuid)
id: string (uuid)
primarySupply(required): string

Minimum Length: 0

Maximum Length: 10
reason: string

Minimum Length: 0

Maximum Length: 255
sdfId(required): string (uuid)
stateId: string (uuid)
versionStart: string (date-time)

{
    "required":[
        "countryId",
        "primarySupply",
        "sdfId"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "comment":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "countryId":{
            "type":"string",
            "format":"uuid"
        },
        "stateId":{
            "type":"string",
            "format":"uuid"
        },
        "sdfId":{
            "type":"string",
            "format":"uuid"
        },
        "primarySupply":{
            "maxLength":"10",
            "minLength":"0",
            "type":"string"
        },
        "associationOperationType":{
            "type":"string",
            "writeOnly":true
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Successful operation.

Root Schema : SDFCountriesResponse

Type: object

Show Source

sdfCountriesList: array sdfCountriesList

{
    "type":"object",
    "properties":{
        "sdfCountriesList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SDFCountryDto"
            }
        }
    }
}

Nested Schema : sdfCountriesList

Type: array

Show Source

Array of: object SDFCountryDto

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SDFCountryDto"
    }
}

Nested Schema : SDFCountryDto

Type: object

Show Source

associationOperationType: string
comment: string

Minimum Length: 0

Maximum Length: 2048
countryId(required): string (uuid)
id: string (uuid)
primarySupply(required): string

Minimum Length: 0

Maximum Length: 10
reason: string

Minimum Length: 0

Maximum Length: 255
sdfId(required): string (uuid)
stateId: string (uuid)
versionStart: string (date-time)

{
    "required":[
        "countryId",
        "primarySupply",
        "sdfId"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "comment":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "countryId":{
            "type":"string",
            "format":"uuid"
        },
        "stateId":{
            "type":"string",
            "format":"uuid"
        },
        "sdfId":{
            "type":"string",
            "format":"uuid"
        },
        "primarySupply":{
            "maxLength":"10",
            "minLength":"0",
            "type":"string"
        },
        "associationOperationType":{
            "type":"string",
            "writeOnly":true
        }
    }
}

400 Response

Bad request.

Root Schema : SDFResponse

Type: object

Show Source

errorData: object ErrorResponseData
result: object result
status: string

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    }
}

Nested Schema : ErrorResponseData

Type: object

Show Source

details: object details
errorCode: string
errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Nested Schema : details

Type: object