REST API for Clinical One Platform

v1.0

post

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/locally-sourced-kits

Creates local source settings for kit types.

Request

Path Parameters

mode(required): string

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

Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

Supported Media Types

application/json

Root Schema : LocalSourceSettingRequest v1.0

Type: object

Title: LocalSourceSettingRequest v1.0

Request containing local source settings.

Show Source

kitTypeSrcId(required): string (uuid)

Title: Kit Type Source ID

Kit type source identifier.
locallySourcedCountries: array Locally Sourced Countries

Title: Locally Sourced Countries

List of country IDs where kits are locally sourced.
sourcedBySiteCountries: array Sourced By Site Countries

Title: Sourced By Site Countries

List of country IDs where kits are sourced by site.

{
    "title":"LocalSourceSettingRequest v1.0",
    "required":[
        "kitTypeSrcId"
    ],
    "type":"object",
    "properties":{
        "locallySourcedCountries":{
            "title":"Locally Sourced Countries",
            "type":"array",
            "description":"List of country IDs where kits are locally sourced.",
            "items":{
                "title":"Locally Sourced Countries",
                "type":"string",
                "description":"List of country IDs where kits are locally sourced.",
                "format":"uuid"
            }
        },
        "sourcedBySiteCountries":{
            "title":"Sourced By Site Countries",
            "type":"array",
            "description":"List of country IDs where kits are sourced by site.",
            "items":{
                "title":"Sourced By Site Countries",
                "type":"string",
                "description":"List of country IDs where kits are sourced by site.",
                "format":"uuid"
            }
        },
        "kitTypeSrcId":{
            "title":"Kit Type Source ID",
            "type":"string",
            "description":"Kit type source identifier.",
            "format":"uuid"
        }
    },
    "description":"Request containing local source settings."
}

Nested Schema : Locally Sourced Countries

Type: array

Title: Locally Sourced Countries

List of country IDs where kits are locally sourced.

Show Source

Array of: string(uuid)

Title: Locally Sourced Countries

List of country IDs where kits are locally sourced.

{
    "title":"Locally Sourced Countries",
    "type":"array",
    "description":"List of country IDs where kits are locally sourced.",
    "items":{
        "title":"Locally Sourced Countries",
        "type":"string",
        "description":"List of country IDs where kits are locally sourced.",
        "format":"uuid"
    }
}

Nested Schema : Sourced By Site Countries

Type: array

Title: Sourced By Site Countries

List of country IDs where kits are sourced by site.

Show Source

Array of: string(uuid)

Title: Sourced By Site Countries

List of country IDs where kits are sourced by site.

{
    "title":"Sourced By Site Countries",
    "type":"array",
    "description":"List of country IDs where kits are sourced by site.",
    "items":{
        "title":"Sourced By Site Countries",
        "type":"string",
        "description":"List of country IDs where kits are sourced by site.",
        "format":"uuid"
    }
}

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : LocalSourceSettingsResponse

Type: object

Title: LocalSourceSettingsResponse

Contains Local Source Settings detail response.

Show Source

locallySourcedCountries: array locallySourcedCountries
sourcedBySiteCountries: array sourcedBySiteCountries

{
    "title":"LocalSourceSettingsResponse",
    "type":"object",
    "properties":{
        "locallySourcedCountries":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/LocalSourceSettingsTo"
            }
        },
        "sourcedBySiteCountries":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/LocalSourceSettingsTo"
            }
        }
    },
    "description":"Contains Local Source Settings detail response."
}

Nested Schema : locallySourcedCountries

Type: array

Show Source

Array of: object LocalSourceSettingsTo

Title: LocalSourceSettingsTo

Contains locally sourced kit settings.

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

Nested Schema : sourcedBySiteCountries

Type: array

Show Source

Array of: object LocalSourceSettingsTo

Title: LocalSourceSettingsTo

Contains locally sourced kit settings.

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

Nested Schema : LocalSourceSettingsTo

Type: object

Title: LocalSourceSettingsTo

Contains locally sourced kit settings.

Show Source

comment: string

Title: Comment

Comment.

Example: Additional details.
countryId: string (uuid)

Title: Country ID

Country identifier.

Example: 12345678-90ab-cdef-1234-567890abcdef
enabled: boolean

Title: Enabled

Indicates whether dose hold is enabled.

Example: true
kitTypeSrcId: string (uuid)

Title: Kit Type Source ID

Kit type ID.

Example: 99999999-8888-7777-6666-555555555555
localSourceId: string (uuid)

Title: Local Source ID

Local source identifier.

Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
objectVersionNumber: number

Title: Object Version Number

Object version number.

Example: 1
operationType: string

Title: Operation Type

Operation type.

Example: CREATE
reason: string

Title: Reason

Reason.

Example: Business justification.
userId: string (uuid)

Title: User ID

User ID.

Example: 11111111-2222-3333-4444-555555555555
versionEnd: string (date-time)

Title: Version End

Version end date.

Example: 2025-12-31T23:59:59Z
versionStart: string (date-time)

Title: Version Start

Version start date.

Example: 2025-01-01T00:00:00Z

{
    "title":"LocalSourceSettingsTo",
    "type":"object",
    "properties":{
        "localSourceId":{
            "title":"Local Source ID",
            "type":"string",
            "description":"Local source identifier.",
            "format":"uuid",
            "example":"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
        },
        "versionStart":{
            "title":"Version Start",
            "type":"string",
            "description":"Version start date.",
            "format":"date-time",
            "example":"2025-01-01T00:00:00Z"
        },
        "versionEnd":{
            "title":"Version End",
            "type":"string",
            "description":"Version end date.",
            "format":"date-time",
            "example":"2025-12-31T23:59:59Z"
        },
        "operationType":{
            "title":"Operation Type",
            "type":"string",
            "description":"Operation type.",
            "example":"CREATE"
        },
        "objectVersionNumber":{
            "title":"Object Version Number",
            "type":"number",
            "description":"Object version number.",
            "example":1
        },
        "userId":{
            "title":"User ID",
            "type":"string",
            "description":"User ID.",
            "format":"uuid",
            "example":"11111111-2222-3333-4444-555555555555"
        },
        "reason":{
            "title":"Reason",
            "type":"string",
            "description":"Reason.",
            "example":"Business justification."
        },
        "comment":{
            "title":"Comment",
            "type":"string",
            "description":"Comment.",
            "example":"Additional details."
        },
        "kitTypeSrcId":{
            "title":"Kit Type Source ID",
            "type":"string",
            "description":"Kit type ID.",
            "format":"uuid",
            "example":"99999999-8888-7777-6666-555555555555"
        },
        "countryId":{
            "title":"Country ID",
            "type":"string",
            "description":"Country identifier.",
            "format":"uuid",
            "example":"12345678-90ab-cdef-1234-567890abcdef"
        },
        "enabled":{
            "title":"Enabled",
            "type":"boolean",
            "description":"Indicates whether dose hold is enabled.",
            "example":true
        }
    },
    "description":"Contains locally sourced kit settings."
}

400 Response

LocalSourceSettings Request is not valid

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

errorData: object ErrorResponseData
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

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

Result Object

Nested Schema : details

Type: object

404 Response

For Invalid study ID or version

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

errorData: object ErrorResponseData
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

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

Result Object

Nested Schema : details

Type: object

500 Response

Internal server error

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

errorData: object ErrorResponseData
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

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

Result Object

Nested Schema : details

Type: object