Jump to

• Request
• Response

v1.0

get

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

Retrieves locally sourced kit settings for a Subject ID.

Request

Path Parameters

• externalSubjectId(required): string(uuid)
  Unique identifier of the subject. Used to represent a participant enrolled in a study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

• mode(required): string
  Indicates the operational mode of the study. Accepted values: active, test, or training.

  Example:

  test

• studyId(required): string(uuid)
  Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

Query Parameters

• instanceNumber: string
  Instance number for unscheduled visit.
• visitId: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the visit

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

204 Response

Successful operation

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object LocallySourceKitsResponse v1.0
  Title: LocallySourceKitsResponse v1.0

  Response containing locally sourced kit details.

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

Nested Schema : LocallySourceKitsResponse v1.0

Type: object

Title: LocallySourceKitsResponse v1.0

Response containing locally sourced kit details.

Show Source

• deviceConnection: string
  Title: Device Connection Type

  Device connection type.
• deviceType: string
  Title: Device Type

  Device type.
• dispensationDate: string (date-time)
  Title: Dispensation Date

  Dispensation date.
• instanceNumber: number
  Title: Instance Number

  Visit instance number.
• kitDescription: string
  Kit description.
• quantity: number
  Title: Quantity

  Kit quantity.
• trialSupplyType: string
  Title: Trial Supply Type

  Type of the trial supply.
• userId: string (uuid)
  Title: User ID

  User ID.
• visitId: string (uuid)
  Title: Visit Source ID

  Visit source identifier.

{
    "title":"LocallySourceKitsResponse v1.0",
    "type":"object",
    "properties":{
        "kitDescription":{
            "type":"string",
            "description":"Kit description."
        },
        "deviceType":{
            "title":"Device Type",
            "type":"string",
            "description":"Device type."
        },
        "deviceConnection":{
            "title":"Device Connection Type",
            "type":"string",
            "description":"Device connection type."
        },
        "trialSupplyType":{
            "title":"Trial Supply Type",
            "type":"string",
            "description":"Type of the trial supply."
        },
        "visitId":{
            "title":"Visit Source ID",
            "type":"string",
            "description":"Visit source identifier.",
            "format":"uuid"
        },
        "instanceNumber":{
            "title":"Instance Number",
            "type":"number",
            "description":"Visit instance number."
        },
        "userId":{
            "title":"User ID",
            "type":"string",
            "description":"User ID.",
            "format":"uuid"
        },
        "dispensationDate":{
            "title":"Dispensation Date",
            "type":"string",
            "description":"Dispensation date.",
            "format":"date-time"
        },
        "quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Kit quantity."
        }
    },
    "description":"Response containing locally sourced kit details."
}

Examples

Select an example Locally Sourced Kits Response

500 Response

Internal server error

Body ()

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

Examples

Select an example Locally Sourced Kits Server Error Response

Back to Top