Jump to

• Request
• Response

v1.0

get

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

Retrieves all locally sourced kit settings.

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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

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."
}

204 Response

Successful operation

Body ()

Root Schema : ListResponseFactory

Type: object

500 Response

Internal server error

Body ()

Root Schema : ListResponseFactory

Type: object

Back to Top