REST API for Clinical One Platform

Get sites

get

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites

Retrieves sites by study ID. Rights: OrsInventoryGet.

Request

Path Parameters

mode(required): string

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

ID of the study

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : schema

Type: array

Show Source

Array of: object SDFModel

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

Nested Schema : SDFModel

Type: object

Show Source

sdf(required): object SDFs
sdfAddresses: array sdfAddresses
sdfPropertyList: array sdfPropertyList

{
    "required":[
        "sdf"
    ],
    "type":"object",
    "properties":{
        "sdf":{
            "$ref":"#/components/schemas/SDFs"
        },
        "sdfPropertyList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SDFProperty"
            }
        },
        "sdfAddresses":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SDFAddress"
            }
        }
    }
}

Nested Schema : SDFs

Type: object

Show Source

comment: string

Minimum Length: 0

Maximum Length: 2048
id: string (uuid)
name(required): string

Minimum Length: 0

Maximum Length: 200
reason: string

Minimum Length: 0

Maximum Length: 255
sdfType(required): string

Minimum Length: 0

Maximum Length: 50
status(required): string

Minimum Length: 0

Maximum Length: 50
studyOrgId(required): string

Minimum Length: 0

Maximum Length: 50
tenantEntityId: string (uuid)
versionStart: string (date-time)

{
    "required":[
        "name",
        "sdfType",
        "status",
        "studyOrgId"
    ],
    "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":200,
            "minLength":0,
            "type":"string"
        },
        "status":{
            "maxLength":50,
            "minLength":0,
            "type":"string"
        },
        "sdfType":{
            "maxLength":50,
            "minLength":0,
            "type":"string"
        },
        "studyOrgId":{
            "maxLength":50,
            "minLength":0,
            "type":"string"
        },
        "tenantEntityId":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Nested Schema : sdfAddresses

Type: array

Show Source

Array of: object SDFAddress

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

Nested Schema : sdfPropertyList

Type: array

Show Source

Array of: object SDFProperty

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

Nested Schema : SDFAddress

Type: object

Show Source

addressCity(required): string

Minimum Length: 0

Maximum Length: 100
addressCountry(required): string

Minimum Length: 0

Maximum Length: 100
addressPostalcode(required): string

Minimum Length: 0

Maximum Length: 20
addressStateOrProvOrCounty: string

Minimum Length: 0

Maximum Length: 100
addressStreet1(required): string

Minimum Length: 0

Maximum Length: 150

Pattern: .*[A-z].*|.*\p{L}+.*
addressStreet2: string

Minimum Length: 0

Maximum Length: 150
addressType(required): string

Minimum Length: 0

Maximum Length: 100
comment: string

Minimum Length: 0

Maximum Length: 2048
email: string

Minimum Length: 0

Maximum Length: 255
fax: string

Minimum Length: 0

Maximum Length: 50
id: string (uuid)
phone: string

Minimum Length: 0

Maximum Length: 50
reason: string

Minimum Length: 0

Maximum Length: 255
sdfId: string (uuid)
versionStart: string (date-time)

{
    "required":[
        "addressCity",
        "addressCountry",
        "addressPostalcode",
        "addressStreet1",
        "addressType"
    ],
    "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"
        },
        "sdfId":{
            "type":"string",
            "format":"uuid"
        },
        "addressType":{
            "maxLength":100,
            "minLength":0,
            "type":"string"
        },
        "addressStreet1":{
            "maxLength":150,
            "minLength":0,
            "pattern":".*[A-z].*|.*\\p{L}+.*",
            "type":"string"
        },
        "addressStreet2":{
            "maxLength":150,
            "minLength":0,
            "type":"string"
        },
        "addressCity":{
            "maxLength":100,
            "minLength":0,
            "type":"string"
        },
        "addressStateOrProvOrCounty":{
            "maxLength":100,
            "minLength":0,
            "type":"string"
        },
        "addressPostalcode":{
            "maxLength":20,
            "minLength":0,
            "type":"string"
        },
        "addressCountry":{
            "maxLength":100,
            "minLength":0,
            "type":"string"
        },
        "fax":{
            "maxLength":50,
            "minLength":0,
            "type":"string"
        },
        "email":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "phone":{
            "maxLength":50,
            "minLength":0,
            "type":"string"
        }
    }
}

Nested Schema : SDFProperty

Type: object

Show Source

comment: string

Minimum Length: 0

Maximum Length: 2048
id: string (uuid)
propertyName(required): string

Minimum Length: 0

Maximum Length: 100
propertyValue(required): string

Minimum Length: 0

Maximum Length: 2048
reason: string

Minimum Length: 0

Maximum Length: 255
sdfId: string (uuid)
versionStart: string (date-time)

{
    "required":[
        "propertyName",
        "propertyValue"
    ],
    "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"
        },
        "sdfId":{
            "type":"string",
            "format":"uuid"
        },
        "propertyName":{
            "maxLength":100,
            "minLength":0,
            "type":"string"
        },
        "propertyValue":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        }
    }
}

404 Response

Invalid study ID or version

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

errorData: object ErrorResponseData

Title: ErrorResponseData

Error Response Details Information
result: object result

Result Object
status: string

Status of request

Example: Success
version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

Nested Schema : ErrorResponseData

Type: object

Title: ErrorResponseData

Error Response Details Information

Show Source

details: object Object

Title: Object

Object with error details information.
errorCode: string

Error code which is stored in ErrorCode enum. Example : C1-003

Example: C1-003
errorMessage: string

Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Result Object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

500 Response

Internal server error

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

errorData: object ErrorResponseData

Title: ErrorResponseData

Error Response Details Information
result: object result

Result Object
status: string

Status of request

Example: Success
version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

Nested Schema : ErrorResponseData

Type: object

Title: ErrorResponseData

Error Response Details Information

Show Source

details: object Object

Title: Object

Object with error details information.
errorCode: string

Error code which is stored in ErrorCode enum. Example : C1-003

Example: C1-003
errorMessage: string

Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Result Object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.