1. REST API for Clinical One Cloud Service
  2. Tasks
  3. Sites and Depots
  4. Country
  5. Get country name

v5.0

get

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

Compared with v4, this version adds optional language-based localization for country and state names.

Request

Path Parameters
  • Study mode. Allowed values: active (live study operations), test (testing data), training (training or sandbox data).
    Example:
    test
  • Study identifier as a 32-character uppercase hexadecimal UUID string.
    Example:
    C36A3197FDEE433FB5547EE83DE99E4B
Query Parameters
  • ISO alpha-3 country code.
    Example:
    USA
  • Optional language code for localized response values. Supported examples include en (English) and ja (Japanese). Default is en.
    Example:
    en

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation.
Body ()
Root Schema : CountriesResponse v4.0
Type: object
Title: CountriesResponse v4.0
Response wrapping the v4 country list with hidden state metadata.
Show Source
Nested Schema : CountryStatesDto v4.0
Type: object
Title: CountryStatesDto v4.0
Country metadata plus hidden state metadata for v4 APIs.
Show Source
  • Title: Comment
    Minimum Length: 0
    Maximum Length: 2048
    Additional comment captured for the audited update.
    Example: Association adjusted after data reconciliation.
  • Title: Hidden
    Indicates whether the country is hidden from derived lists.
    Example: true
  • Title: Country ID
    Unique country identifier (UUID, 32-character uppercase hexadecimal string).
  • Title: ISO Code
    Minimum Length: 1
    Maximum Length: 10
    Alpha-2 ISO code identifying the country.
    Example: US
  • Title: ISO Code 3
    Minimum Length: 1
    Maximum Length: 10
    Alpha-3 ISO code identifying the country.
    Example: USA
  • Title: Country Name
    Minimum Length: 1
    Maximum Length: 100
    Official country name.
    Example: United States
  • Title: Reason
    Minimum Length: 0
    Maximum Length: 255
    Reason provided for the audited update.
    Example: Protocol update requested by study operations.
  • StateDto2 v2.0
    Title: StateDto2 v2.0
    State metadata that includes the hidden flag.
  • Title: Version Start
    Timestamp when this country version was created.
    Example: 2025-03-16T12:00:00Z
Example:
[
    {
        "id":"3F2504E04F8911D39A0C0305E82C3301",
        "versionStart":"2025-03-16T12:00:00.000Z",
        "isoCode":"US",
        "name":"United States",
        "isoCode3":"USA",
        "hidden":false,
        "states":[
            {
                "id":"9F2504E04F8911D39A0C0305E82C3301",
                "versionStart":"2025-03-16T12:00:00.000Z",
                "code":"CA",
                "name":"California",
                "reason":"Legacy mapping",
                "comment":"Population threshold 1000000",
                "hidden":false
            }
        ]
    }
]
Nested Schema : StateDto2 v2.0
Type: object
Title: StateDto2 v2.0
State metadata that includes the hidden flag.
Show Source
  • Title: State Code
    ISO code identifying the state.
    Example: CA
  • Title: Comment
    Additional comment for the state.
    Example: Population threshold 1000000
  • Title: Hidden
    Indicates whether the state is hidden from derived lists.
    Example: true
  • Title: State ID
    Unique state identifier (UUID, 32-character uppercase hexadecimal string).
  • Title: State Name
    Official state name.
    Example: California
  • Title: Reason
    Reason metadata for the state.
    Example: Legacy mapping
  • Title: Version Start
    Timestamp when this state version was created.
    Example: 2025-03-16T12:00:00Z
Example:
[
    {
        "id":"9F2504E04F8911D39A0C0305E82C3301",
        "versionStart":"2025-03-16T12:00:00.000Z",
        "code":"CA",
        "name":"California",
        "reason":"Legacy mapping",
        "comment":"Population threshold 1000000",
        "hidden":false
    }
]
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