REST API for Clinical One Platform

Get association between country and site (ISO3 codes)

get

/ec-site-svc/rest/v5.0/studies/{studyId}/{mode}/sdfcountry

Retrieves associations between countries and sites based on site ID and country ID (ISO3 codes). Gets history of changes based on parameters.

Request

Path Parameters

mode(required): string

Mode of the study. Accepts active, test, or training.
studyId(required): string(uuid)

The ID of the study.

Query Parameters

countries(required): string

Country ID.
history(required): boolean

Boolean parameter to determine whether history of changes is required.
limit: integer(int32)

Number of rows to return.
offset: integer(int32)

Row number to start from.
states(required): string

State ID.

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation.

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

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