REST API for Clinical One Cloud Service

~~[Deprecated]: v2.0~~

get

/ec-site-svc/rest/v2/studies/{studyId}/{mode}/country

Deprecated: Compared with v1, this version uses ISO alpha-3 (isoCode3) filters instead of ISO alpha-2 (isoCode).

Request

Path Parameters

mode(required): string
Study mode. Allowed values: active (live study operations), test (testing data), training (training or sandbox data).
Example:
```
test
```
studyId(required): string(uuid)
Study identifier as a 32-character uppercase hexadecimal UUID string.
Example:
```
C36A3197FDEE433FB5547EE83DE99E4B
```

Query Parameters

isoCode3: string

ISO alpha-3 country code.

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation.

Root Schema : CountriesResponse v2.0

Type: object

Title: CountriesResponse v2.0

Response wrapping the ISO3-based country list.

Show Source

countries: object CountryDto2 v2.0

Title: CountryDto2 v2.0

Country metadata for ISO3-enabled APIs.

{
    "title":"CountriesResponse v2.0",
    "type":"object",
    "properties":{
        "countries":{
            "title":"CountryDto2 v2.0",
            "required":[
                "id",
                "isoCode",
                "isoCode3",
                "name"
            ],
            "type":"object",
            "properties":{
                "reason":{
                    "title":"Reason",
                    "maxLength":255,
                    "minLength":0,
                    "type":"string",
                    "description":"Reason provided for the audited update.",
                    "example":"Protocol update requested by study operations."
                },
                "comment":{
                    "title":"Comment",
                    "maxLength":2048,
                    "minLength":0,
                    "type":"string",
                    "description":"Additional comment captured for the audited update.",
                    "example":"Association adjusted after data reconciliation."
                },
                "id":{
                    "title":"Country ID",
                    "type":"string",
                    "description":"Unique country identifier (UUID, 32-character uppercase hexadecimal string).",
                    "format":"uuid"
                },
                "versionStart":{
                    "title":"Version Start",
                    "type":"string",
                    "description":"Timestamp when this country version was created.",
                    "format":"date-time",
                    "example":"2025-03-16T12:00:00Z"
                },
                "isoCode":{
                    "title":"ISO Code",
                    "maxLength":10,
                    "minLength":1,
                    "type":"string",
                    "description":"Alpha-2 ISO code identifying the country.",
                    "example":"US"
                },
                "name":{
                    "title":"Country Name",
                    "maxLength":100,
                    "minLength":1,
                    "type":"string",
                    "description":"Official country name.",
                    "example":"United States"
                },
                "isoCode3":{
                    "title":"ISO Code 3",
                    "maxLength":10,
                    "minLength":1,
                    "type":"string",
                    "description":"Alpha-3 ISO code identifying the country.",
                    "example":"USA"
                }
            },
            "description":"Country metadata for ISO3-enabled APIs.",
            "example":[
                {
                    "id":"3F2504E04F8911D39A0C0305E82C3301",
                    "versionStart":"2025-03-16T12:00:00.000Z",
                    "isoCode":"US",
                    "name":"United States",
                    "isoCode3":"USA"
                }
            ]
        }
    },
    "description":"Response wrapping the ISO3-based country list."
}

Nested Schema : CountryDto2 v2.0

Type: object

Title: CountryDto2 v2.0

Country metadata for ISO3-enabled APIs.

Show Source

comment: string

Title: Comment

Minimum Length: 0

Maximum Length: 2048

Additional comment captured for the audited update.

Example: Association adjusted after data reconciliation.
id(required): string (uuid)

Title: Country ID

Unique country identifier (UUID, 32-character uppercase hexadecimal string).
isoCode(required): string

Title: ISO Code

Minimum Length: 1

Maximum Length: 10

Alpha-2 ISO code identifying the country.

Example: US
isoCode3(required): string

Title: ISO Code 3

Minimum Length: 1

Maximum Length: 10

Alpha-3 ISO code identifying the country.

Example: USA
name(required): string

Title: Country Name

Minimum Length: 1

Maximum Length: 100

Official country name.

Example: United States
reason: string

Title: Reason

Minimum Length: 0

Maximum Length: 255

Reason provided for the audited update.

Example: Protocol update requested by study operations.
versionStart: string (date-time)

Title: Version Start

Timestamp when this country version was created.

Example: 2025-03-16T12:00:00Z

{
    "title":"CountryDto2 v2.0",
    "required":[
        "id",
        "isoCode",
        "isoCode3",
        "name"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "title":"Reason",
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason provided for the audited update.",
            "example":"Protocol update requested by study operations."
        },
        "comment":{
            "title":"Comment",
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Additional comment captured for the audited update.",
            "example":"Association adjusted after data reconciliation."
        },
        "id":{
            "title":"Country ID",
            "type":"string",
            "description":"Unique country identifier (UUID, 32-character uppercase hexadecimal string).",
            "format":"uuid"
        },
        "versionStart":{
            "title":"Version Start",
            "type":"string",
            "description":"Timestamp when this country version was created.",
            "format":"date-time",
            "example":"2025-03-16T12:00:00Z"
        },
        "isoCode":{
            "title":"ISO Code",
            "maxLength":10,
            "minLength":1,
            "type":"string",
            "description":"Alpha-2 ISO code identifying the country.",
            "example":"US"
        },
        "name":{
            "title":"Country Name",
            "maxLength":100,
            "minLength":1,
            "type":"string",
            "description":"Official country name.",
            "example":"United States"
        },
        "isoCode3":{
            "title":"ISO Code 3",
            "maxLength":10,
            "minLength":1,
            "type":"string",
            "description":"Alpha-3 ISO code identifying the country.",
            "example":"USA"
        }
    },
    "description":"Country metadata for ISO3-enabled APIs.",
    "example":[
        {
            "id":"3F2504E04F8911D39A0C0305E82C3301",
            "versionStart":"2025-03-16T12:00:00.000Z",
            "isoCode":"US",
            "name":"United States",
            "isoCode3":"USA"
        }
    ]
}

Example:

[
    {
        "id":"3F2504E04F8911D39A0C0305E82C3301",
        "versionStart":"2025-03-16T12:00:00.000Z",
        "isoCode":"US",
        "name":"United States",
        "isoCode3":"USA"
    }
]

Examples

400 Response

Returned when one or more path parameters, query parameters, or request-body values fail endpoint validation.

Root Schema : SDFResponse

Type: object

Title: SDFResponse

Wrapper for service responses containing result or error data.

Show Source

errorData: object ErrorResponseData
result: object result

The result object for successful requests. Type depends on the API operation.
status: string

Status of the response, either 'success' or an error indication.

Example: success

{
    "title":"SDFResponse",
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of the response, either 'success' or an error indication.",
            "example":"success"
        },
        "result":{
            "type":"object",
            "description":"The result object for successful requests. Type depends on the API operation.",
            "example":{
                "hasMore":"true",
                "totalResults":5,
                "count":5,
                "data":[
                ]
            }
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    },
    "description":"Wrapper for service responses containing result or error data."
}

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

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