REST API for Clinical One Cloud Service

v2.0

get

/ec-site-svc/rest/v2/studies/{studyId}/{mode}/country/{countryId}/states

Compared with v1, this version returns state data with hidden-flag information for the selected country ID.

Request

Path Parameters

countryId(required): string
Country identifier as a 32-character uppercase hexadecimal UUID string.
Example:
```
C36A3197FDEE433FB5547EE83DE99E4B
```
mode(required): string
Study mode. Allowed values: active (live study operations), test (testing data), training (training or sandbox data).
Example:
```
test
```
studyId(required): string(uuid)
Study identifier as a 32-character uppercase hexadecimal UUID string.
Example:
```
C36A3197FDEE433FB5547EE83DE99E4B
```

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation.

Root Schema : StatesResponse v1.0

Type: object

Title: StatesResponse v1.0

Response wrapping the state list.

Show Source

states: object StateDto2 v2.0

Title: StateDto2 v2.0

State metadata that includes the hidden flag.

{
    "title":"StatesResponse v1.0",
    "type":"object",
    "properties":{
        "states":{
            "title":"StateDto2 v2.0",
            "type":"object",
            "properties":{
                "id":{
                    "title":"State ID",
                    "type":"string",
                    "description":"Unique state identifier (UUID, 32-character uppercase hexadecimal string).",
                    "format":"uuid"
                },
                "versionStart":{
                    "title":"Version Start",
                    "type":"string",
                    "description":"Timestamp when this state version was created.",
                    "format":"date-time",
                    "example":"2025-03-16T12:00:00Z"
                },
                "code":{
                    "title":"State Code",
                    "type":"string",
                    "description":"ISO code identifying the state.",
                    "example":"CA"
                },
                "name":{
                    "title":"State Name",
                    "type":"string",
                    "description":"Official state name.",
                    "example":"California"
                },
                "reason":{
                    "title":"Reason",
                    "type":"string",
                    "description":"Reason metadata for the state.",
                    "example":"Legacy mapping"
                },
                "comment":{
                    "title":"Comment",
                    "type":"string",
                    "description":"Additional comment for the state.",
                    "example":"Population threshold 1000000"
                },
                "hidden":{
                    "title":"Hidden",
                    "type":"boolean",
                    "description":"Indicates whether the state is hidden from derived lists.",
                    "example":true
                }
            },
            "description":"State metadata that includes the hidden flag.",
            "example":[
                {
                    "id":"9F2504E04F8911D39A0C0305E82C3301",
                    "versionStart":"2025-03-16T12:00:00.000Z",
                    "code":"CA",
                    "name":"California",
                    "reason":"Legacy mapping",
                    "comment":"Population threshold 1000000",
                    "hidden":false
                }
            ]
        }
    },
    "description":"Response wrapping the state list."
}

Nested Schema : StateDto2 v2.0

Type: object

Title: StateDto2 v2.0

State metadata that includes the hidden flag.

Show Source

code: string

Title: State Code

ISO code identifying the state.

Example: CA
comment: string

Title: Comment

Additional comment for the state.

Example: Population threshold 1000000
hidden: boolean

Title: Hidden

Indicates whether the state is hidden from derived lists.

Example: true
id: string (uuid)

Title: State ID

Unique state identifier (UUID, 32-character uppercase hexadecimal string).
name: string

Title: State Name

Official state name.

Example: California
reason: string

Title: Reason

Reason metadata for the state.

Example: Legacy mapping
versionStart: string (date-time)

Title: Version Start

Timestamp when this state version was created.

Example: 2025-03-16T12:00:00Z

{
    "title":"StateDto2 v2.0",
    "type":"object",
    "properties":{
        "id":{
            "title":"State ID",
            "type":"string",
            "description":"Unique state identifier (UUID, 32-character uppercase hexadecimal string).",
            "format":"uuid"
        },
        "versionStart":{
            "title":"Version Start",
            "type":"string",
            "description":"Timestamp when this state version was created.",
            "format":"date-time",
            "example":"2025-03-16T12:00:00Z"
        },
        "code":{
            "title":"State Code",
            "type":"string",
            "description":"ISO code identifying the state.",
            "example":"CA"
        },
        "name":{
            "title":"State Name",
            "type":"string",
            "description":"Official state name.",
            "example":"California"
        },
        "reason":{
            "title":"Reason",
            "type":"string",
            "description":"Reason metadata for the state.",
            "example":"Legacy mapping"
        },
        "comment":{
            "title":"Comment",
            "type":"string",
            "description":"Additional comment for the state.",
            "example":"Population threshold 1000000"
        },
        "hidden":{
            "title":"Hidden",
            "type":"boolean",
            "description":"Indicates whether the state is hidden from derived lists.",
            "example":true
        }
    },
    "description":"State metadata that includes the hidden flag.",
    "example":[
        {
            "id":"9F2504E04F8911D39A0C0305E82C3301",
            "versionStart":"2025-03-16T12:00:00.000Z",
            "code":"CA",
            "name":"California",
            "reason":"Legacy mapping",
            "comment":"Population threshold 1000000",
            "hidden":false
        }
    ]
}

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.

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