Jump to

• Request
• Response

Get country name

get

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

Retrieves the country and state names based on the ISO3 code.

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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : CountriesResponse2

Type: object

Show Source

• countries: array countries

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

Nested Schema : countries

Type: array

Show Source

• Array of: object CountryDto2

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

Nested Schema : CountryDto2

Type: object

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• 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
• 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"
        }
    }
}

400 Response

Bad request.

Body ()

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

Back to Top