REST API for Clinical One Platform

Get country name

get

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

Retrieves the country and state names, with hidden flag, based on the ISO3 code and language.

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

isoCode3: string

The ISO3 code of the country.
language: string

Language for expected response code list. This field is case sensitive and accepts values like en, ja etc. By default it's english (en)

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation.

Root Schema : CountriesResponse4

Type: object

Show Source

countriesStates: array countriesStates

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

Nested Schema : countriesStates

Type: array

Show Source

Array of: object CountryStatesDto2

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

Nested Schema : CountryStatesDto2

Type: object

Show Source

comment: string

Minimum Length: 0

Maximum Length: 2048
hidden: boolean
id(required): string (uuid)
isoCode(required): string

Minimum Length: 1

Maximum Length: 10
isoCode3(required): string

Minimum Length: 1

Maximum Length: 10
name(required): string

Minimum Length: 1

Maximum Length: 100
reason: string

Minimum Length: 0

Maximum Length: 255
states: array states
versionStart: string (date-time)

{
    "required":[
        "id",
        "isoCode",
        "isoCode3",
        "name"
    ],
    "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"
        },
        "isoCode":{
            "maxLength":10,
            "minLength":1,
            "type":"string"
        },
        "name":{
            "maxLength":100,
            "minLength":1,
            "type":"string"
        },
        "isoCode3":{
            "maxLength":10,
            "minLength":1,
            "type":"string"
        },
        "hidden":{
            "type":"boolean"
        },
        "states":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/StateDto2"
            }
        }
    }
}

Nested Schema : states

Type: array

Show Source

Array of: object StateDto2

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

Nested Schema : StateDto2

Type: object

Show Source

code: string
comment: string
hidden: boolean
id: string (uuid)
name: string
reason: string
versionStart: string (date-time)

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "code":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        },
        "hidden":{
            "type":"boolean"
        }
    }
}

400 Response

Bad request.

Root Schema : SDFResponse

Type: object

Show Source

errorData: object ErrorResponseData

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
result: object result
status: string

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

Nested Schema : ErrorResponseData

Type: object

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

details: string

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example: User role is missing required permission REPORTING_VIEW. Field: userId
errorCode: string

Application or business-specific error code representing the error type.

Example: REPT_401
errorMessage: string

Human-readable error message describing the failure or issue.

Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object