Jump to

• Request
• Response

v2.0

get

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

Compared with v1, this version returns region details including associated countries and states.

Request

Path Parameters

• mode(required): string
  Study mode. Allowed values: active (live study operations), test (testing data), training (training or sandbox data).

  Example:

  test

• regionId(required): string
  Unique ID for a given region.

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

• studyId(required): string(uuid)
  Study identifier as a 32-character uppercase hexadecimal UUID string.

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : RegionStatesDto v2.0

Type: object

Title: RegionStatesDto v2.0

Region metadata that lists country and state associations.

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: string (uuid)
  Title: Region ID

  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the region.
• name(required): string
  Title: Region Name

  Minimum Length: 1

  Maximum Length: 100

  Official name of the region.

  Example: North America Region
• reason: string
  Title: Reason

  Minimum Length: 0

  Maximum Length: 255

  Reason provided for the audited update.

  Example: Protocol update requested by study operations.
• regionCountriesStates(required): object RegionCountryStatesDto v2.0
  Title: RegionCountryStatesDto v2.0

  Country and state metadata returned for a region.
• versionStart: string (date-time)
  Title: Version Start

  Timestamp when this region version was created.

  Example: 2026-03-17T10:00:00Z

{
    "title":"RegionStatesDto v2.0",
    "required":[
        "name",
        "regionCountriesStates"
    ],
    "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":"Region ID",
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the region.",
            "format":"uuid"
        },
        "versionStart":{
            "title":"Version Start",
            "type":"string",
            "description":"Timestamp when this region version was created.",
            "format":"date-time",
            "example":"2026-03-17T10:00:00Z"
        },
        "name":{
            "title":"Region Name",
            "maxLength":100,
            "minLength":1,
            "type":"string",
            "description":"Official name of the region.",
            "example":"North America Region"
        },
        "regionCountriesStates":{
            "title":"RegionCountryStatesDto v2.0",
            "required":[
                "countryId",
                "stateId"
            ],
            "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":"Region Country ID",
                    "type":"string",
                    "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the region-country association.",
                    "format":"uuid"
                },
                "versionStart":{
                    "title":"Version Start",
                    "type":"string",
                    "description":"Timestamp when this region-country association version was created.",
                    "format":"date-time",
                    "example":"2026-03-17T10:00:00Z"
                },
                "countryId":{
                    "title":"Country ID",
                    "type":"string",
                    "description":"Identifier of the country linked to the region.",
                    "format":"uuid"
                },
                "countryName":{
                    "title":"Country Name",
                    "type":"string",
                    "description":"Display name of the country associated with the region.",
                    "example":"United States"
                },
                "stateId":{
                    "title":"State ID",
                    "type":"string",
                    "description":"Identifier of the state associated with the country.",
                    "format":"uuid"
                },
                "stateName":{
                    "title":"State Name",
                    "type":"string",
                    "description":"Name of the state associated with the region.",
                    "example":"California"
                }
            },
            "description":"Country and state metadata returned for a region.",
            "example":[
                {
                    "countryId":"A0E1B2C3D4E5F67890123456789ABCDE",
                    "stateId":"B0C1D2E3F4A567890123456789ABCDEF",
                    "stateName":"California"
                }
            ]
        }
    },
    "description":"Region metadata that lists country and state associations."
}

Nested Schema : RegionCountryStatesDto v2.0

Type: object

Title: RegionCountryStatesDto v2.0

Country and state metadata returned for a region.

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.
• countryId(required): string (uuid)
  Title: Country ID

  Identifier of the country linked to the region.
• countryName: string
  Title: Country Name

  Display name of the country associated with the region.

  Example: United States
• id: string (uuid)
  Title: Region Country ID

  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the region-country association.
• reason: string
  Title: Reason

  Minimum Length: 0

  Maximum Length: 255

  Reason provided for the audited update.

  Example: Protocol update requested by study operations.
• stateId(required): string (uuid)
  Title: State ID

  Identifier of the state associated with the country.
• stateName: string
  Title: State Name

  Name of the state associated with the region.

  Example: California
• versionStart: string (date-time)
  Title: Version Start

  Timestamp when this region-country association version was created.

  Example: 2026-03-17T10:00:00Z

{
    "title":"RegionCountryStatesDto v2.0",
    "required":[
        "countryId",
        "stateId"
    ],
    "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":"Region Country ID",
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the region-country association.",
            "format":"uuid"
        },
        "versionStart":{
            "title":"Version Start",
            "type":"string",
            "description":"Timestamp when this region-country association version was created.",
            "format":"date-time",
            "example":"2026-03-17T10:00:00Z"
        },
        "countryId":{
            "title":"Country ID",
            "type":"string",
            "description":"Identifier of the country linked to the region.",
            "format":"uuid"
        },
        "countryName":{
            "title":"Country Name",
            "type":"string",
            "description":"Display name of the country associated with the region.",
            "example":"United States"
        },
        "stateId":{
            "title":"State ID",
            "type":"string",
            "description":"Identifier of the state associated with the country.",
            "format":"uuid"
        },
        "stateName":{
            "title":"State Name",
            "type":"string",
            "description":"Name of the state associated with the region.",
            "example":"California"
        }
    },
    "description":"Country and state metadata returned for a region.",
    "example":[
        {
            "countryId":"A0E1B2C3D4E5F67890123456789ABCDE",
            "stateId":"B0C1D2E3F4A567890123456789ABCDEF",
            "stateName":"California"
        }
    ]
}

Example:

[
    {
        "countryId":"A0E1B2C3D4E5F67890123456789ABCDE",
        "stateId":"B0C1D2E3F4A567890123456789ABCDEF",
        "stateName":"California"
    }
]

Examples

Select an example Success Response

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

• 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

Select an example Bad Request Response

403 Response

Returned when the caller is authenticated but does not have permission to access this endpoint.

Body ()

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

Select an example Forbidden Response

Back to Top