REST API for Clinical One Platform

Add a region

post

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

Creates a region with list of countries and states associations (minimum 1).
Right: RegionPost.

Request

Path Parameters

mode(required): string

Mode of the study. Accepts active, test, or training.
studyId(required): string(uuid)

The ID of the study.

Supported Media Types

application/json

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
regionCountriesStates(required): array regionCountriesStates

Minimum Number of Items: 1

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

{
    "required":[
        "name",
        "regionCountriesStates"
    ],
    "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"
        },
        "regionCountriesStates":{
            "maxItems":2147483647,
            "minItems":1,
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RegionCountryStatesDto"
            }
        }
    }
}

Nested Schema : regionCountriesStates

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

Show Source

Array of: object RegionCountryStatesDto

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

Nested Schema : RegionCountryStatesDto

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
stateId(required): string (uuid)
stateName: string
versionStart: string (date-time)

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

Response

Supported Media Types

application/json

200 Response

Successful operation

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

In case a region already exist with same name or a country to be associated is already associated with another region

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