Jump to

• Request
• Response

Get region details

get

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

Retrieves a region's details. Rights required: RegionGet. Region includes list of countries and states associated with hidden flag.

Request

Path Parameters

• mode(required): string
  Mode of the study. Accepts active, test, or training.
• regionId(required): string
  Id for the required region
• studyId(required): string(uuid)
  The ID of the study.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Type: object

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• id: string (uuid)
• name(required): string
  Minimum Length: 1

  Maximum Length: 100
• reason: string
  Minimum Length: 0

  Maximum Length: 255
• regionCountries(required): array regionCountries
  Minimum Number of Items: 1

  Maximum Number of Items: 2147483647
• versionStart: string (date-time)

{
    "required":[
        "name",
        "regionCountries"
    ],
    "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"
        },
        "name":{
            "maxLength":"100",
            "minLength":"1",
            "type":"string"
        },
        "regionCountries":{
            "maxItems":"2147483647",
            "minItems":"1",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RegionCountryDto"
            }
        }
    }
}

Nested Schema : regionCountries

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

Show Source

• Array of: object RegionCountryDto

{
    "maxItems":"2147483647",
    "minItems":"1",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RegionCountryDto"
    }
}

Nested Schema : RegionCountryDto

Type: object

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• countryId(required): string (uuid)
• countryName: string
• id: string (uuid)
• reason: string
  Minimum Length: 0

  Maximum Length: 255
• versionStart: string (date-time)

{
    "required":[
        "countryId"
    ],
    "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"
        },
        "countryId":{
            "type":"string",
            "format":"uuid"
        },
        "countryName":{
            "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