Jump to

• Request
• Response

Get all local source settings

get

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

Retrieves all locally sourced kits settings.

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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : LocalSourceSettingsResponse

Type: object

Contains Local Source Settings detail response.

Show Source

• locallySourcedCountries: array locallySourcedCountries
• sourcedBySiteCountries: array sourcedBySiteCountries

{
    "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

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

Nested Schema : sourcedBySiteCountries

Type: array

Show Source

• Array of: object LocalSourceSettingsTo

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

Nested Schema : LocalSourceSettingsTo

Type: object

Show Source

• comment: string
• countryId: string (uuid)
• enabled: boolean
• kitTypeSrcId: string (uuid)
• localSourceId: string (uuid)
• objectVersionNumber: number
• operationType: string
• reason: string
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)

{
    "type":"object",
    "properties":{
        "localSourceId":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "type":"string"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "reason":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        },
        "kitTypeSrcId":{
            "type":"string",
            "format":"uuid"
        },
        "countryId":{
            "type":"string",
            "format":"uuid"
        },
        "enabled":{
            "type":"boolean"
        }
    }
}

204 Response

Successful operation

Body ()

Root Schema : ListResponseFactory

Type: object

500 Response

Internal server error

Body ()

Root Schema : ListResponseFactory

Type: object

Back to Top