Jump to

• Request
• Response

[Deprecated]: v2.0

post

/ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{srcSubjectId}/replacekits

Deprecated: Replaces a subject's kits in the system, accepts Strings and Numbers. Rights: OrsVisitManagementPost.

Request

Path Parameters

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

  Example:

  test

• srcSubjectId(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

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

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• kits: array kits
  Contains kits.
• reason(required): string
  Minimum Length: 1

  Maximum Length: 255

  Reason

  Example: Some reason
• reasonLabel(required): string
  Minimum Length: 1

  Maximum Length: 255

  ReasonLabel

  Example: kits are damaged
• siteId(required): string (uuid)
  Site ID.
• visits: array visits

{
    "required":[
        "reason",
        "reasonLabel",
        "siteId"
    ],
    "type":"object",
    "properties":{
        "kits":{
            "type":"array",
            "description":"Contains kits.",
            "example":[
                "5a"
            ],
            "items":{
                "type":"string",
                "format":"String",
                "example":"5a"
            }
        },
        "siteId":{
            "type":"string",
            "description":"Site ID.",
            "format":"uuid"
        },
        "reason":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"Reason",
            "example":"Some reason"
        },
        "reasonLabel":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"ReasonLabel",
            "example":"kits are damaged"
        },
        "visits":{
            "type":"array",
            "example":[
                {
                    "subjectVisitNsinventoryId":"41200000000000000000000000000252",
                    "quantity":10
                }
            ],
            "items":{
                "$ref":"#/components/schemas/NsReplaceKitRequest"
            }
        }
    }
}

Nested Schema : kits

Type: array

Contains kits.

Show Source

• Array of: string(String)
  Example: 5a

{
    "type":"array",
    "description":"Contains kits.",
    "example":[
        "5a"
    ],
    "items":{
        "type":"string",
        "format":"String",
        "example":"5a"
    }
}

Example:

[
    "5a"
]

Nested Schema : visits

Type: array

Show Source

• Array of: object NsReplaceKitRequest
  Request object containing non-serialized kit replacement details.

{
    "type":"array",
    "example":[
        {
            "subjectVisitNsinventoryId":"41200000000000000000000000000252",
            "quantity":10
        }
    ],
    "items":{
        "$ref":"#/components/schemas/NsReplaceKitRequest"
    }
}

Example:

[
    {
        "subjectVisitNsinventoryId":"41200000000000000000000000000252",
        "quantity":10
    }
]

Nested Schema : NsReplaceKitRequest

Type: object

Request object containing non-serialized kit replacement details.

Show Source

• quantity(required): integer (int32)
  Minimum Value: 1

  Quantity that must be replaced.

  Example: 10
• subjectVisitNsinventoryId: string (uuid)
  Inventory ID of the replaced kit.

{
    "required":[
        "quantity"
    ],
    "type":"object",
    "properties":{
        "subjectVisitNsinventoryId":{
            "type":"string",
            "description":"Inventory ID of the replaced kit.",
            "format":"uuid"
        },
        "quantity":{
            "minimum":1,
            "type":"integer",
            "description":"Quantity that must be replaced.",
            "format":"int32",
            "example":10
        }
    },
    "description":"Request object containing non-serialized kit replacement details.",
    "example":{
        "subjectVisitNsinventoryId":"41200000000000000000000000000252",
        "quantity":10
    }
}

Example:

{
    "subjectVisitNsinventoryId":"41200000000000000000000000000252",
    "quantity":10
}

Examples

Select an example Replace Subject Kits Request

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : SubjectReplaceKitsResponse

Type: object

Title: SubjectReplaceKitsResponse

Response containing kit replacement for subject.

Show Source

• replacedKits: array replacedKits
  List of replaced kits.

{
    "title":"SubjectReplaceKitsResponse",
    "type":"object",
    "properties":{
        "replacedKits":{
            "type":"array",
            "description":"List of replaced kits.",
            "example":[
                {
                    "inventoryId":"D313327EF13845169A8ADADDA435431E",
                    "kitNumber":1001,
                    "kitTypeName":"Kit A"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/DispensationKit"
            }
        }
    },
    "description":"Response containing kit replacement for subject."
}

Nested Schema : replacedKits

Type: array

List of replaced kits.

Show Source

• Array of: object DispensationKit v13.0
  Title: DispensationKit v13.0

  Contains information for the kit dispensation.

{
    "type":"array",
    "description":"List of replaced kits.",
    "example":[
        {
            "inventoryId":"D313327EF13845169A8ADADDA435431E",
            "kitNumber":1001,
            "kitTypeName":"Kit A"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/DispensationKit"
    }
}

Example:

[
    {
        "inventoryId":"D313327EF13845169A8ADADDA435431E",
        "kitNumber":1001,
        "kitTypeName":"Kit A"
    }
]

Nested Schema : DispensationKit v13.0

Type: object

Title: DispensationKit v13.0

Contains information for the kit dispensation.

Show Source

• barcode: string
  Barcode.

  Example: 1000
• conserved: boolean
  Title: Conserved

  Conserved for dispensation.

  Example: true
• consumeAcrossDoses: boolean
  Title: Consume Across Doses

  Indicates whether consumption across doses is allowed.

  Example: true
• deviceConnection: string
  Title: Device Connection Type

  Allowed Values: [ "CloudtoCloud", "DevicetoCloud", "NoConnection" ]

  Device connection type.

  Example: DevicetoCloud
• deviceType: string
  Title: Device Type

  Allowed Values: [ "ActivityWatch", "BloodPressureMonitor", "WeightScale", "ECGReader", "Spirometer", "MobileApp", "SmartPillBottle", "PulseOximeter", "WearablePatch", "Other", "GlucoseMonitor" ]

  Device type.

  Example: ActivityWatch
• dispensationConfirmed: boolean
  Indicates whether dispensation is confirmed.

  Example: true
• dose: number (double)
  Title: Dose

  Dose.

  Example: 5
• dosingInstruction: string
  Title: Dosing Instruction

  Dosing instruction.

  Example: Take one capsule daily
• dosingUnblinded: boolean
  Title: Dosing Unblinded

  Indicates whether dosing is unblinded.

  Example: true
• frequency: string
  Title: Frequency

  Allowed Values: [ "Once", "QD", "BID", "TID", "QID", "Q3", "Q4", "Q8", "Q12", "Q24", "Bedtime", "With meals", "With meals and at bedtime" ]

  Dosing frequency.

  Example: BID
• groupingNumber: integer (int32)
  Title: Grouping Number

  Grouping number for a kit.

  Example: 1
• id: number (Integer)
  Title: Dispensation Kit ID

  Unique identifier of the dispensation kit.

  Example: 2
• inventoryId: string
  Title: Inventory ID

  Inventory ID.

  Example: D313327EF13845169A8ADADDA435431E
• kitDescription: string
  Title: Kit Description

  Kit description.

  Example: Kit A
• kitNumberUTF: string
  Title: Kit Number UTF

  Kit number with UTF-8 support.

  Example: A-1
• locallySourced: boolean
  Title: Locally Sourced

  Indicates whether the kit is locally sourced.

  Example: true
• lotId: string
  Title: Lot ID

  Lot ID.

  Example: D313327EF13845169A8ADADDA435431E
• lotNumber: string
  Title: Lot Number

  Lot number.

  Example: LOT20240605A
• measurement: string
  Title: Measurement

  Dose Measurement.

  Example: ml
• quantity: number (BigDecimal)
  Title: Quantity

  Kit quantity.

  Example: 5
• titrationKitLabel: string
  Title: Blinded Titration Label

  Blinded titration label.

  Example: High dose
• titrationOption: string
  Title: Titration Option

  Allowed Values: [ "up", "down", "maintain" ]

  Titration options to dispense kits. For example: up/down/maintain.

  Example: up
• trialSupplyType: string
  Title: Trial Supply Type

  Type of the trial supply.

  Example: BOTTLE

{
    "title":"DispensationKit v13.0",
    "type":"object",
    "properties":{
        "id":{
            "title":"Dispensation Kit ID",
            "type":"number",
            "description":"Unique identifier of the dispensation kit.",
            "format":"Integer",
            "example":2
        },
        "kitDescription":{
            "title":"Kit Description",
            "type":"string",
            "description":"Kit description.",
            "example":"Kit A"
        },
        "dose":{
            "title":"Dose",
            "type":"number",
            "description":"Dose.",
            "format":"double",
            "example":5
        },
        "measurement":{
            "title":"Measurement",
            "type":"string",
            "description":"Dose Measurement.",
            "example":"ml"
        },
        "frequency":{
            "title":"Frequency",
            "type":"string",
            "description":"Dosing frequency.",
            "example":"BID",
            "enum":[
                "Once",
                "QD",
                "BID",
                "TID",
                "QID",
                "Q3",
                "Q4",
                "Q8",
                "Q12",
                "Q24",
                "Bedtime",
                "With meals",
                "With meals and at bedtime"
            ]
        },
        "consumeAcrossDoses":{
            "title":"Consume Across Doses",
            "type":"boolean",
            "description":"Indicates whether consumption across doses is allowed.",
            "example":true
        },
        "deviceType":{
            "title":"Device Type",
            "type":"string",
            "description":"Device type.",
            "example":"ActivityWatch",
            "enum":[
                "ActivityWatch",
                "BloodPressureMonitor",
                "WeightScale",
                "ECGReader",
                "Spirometer",
                "MobileApp",
                "SmartPillBottle",
                "PulseOximeter",
                "WearablePatch",
                "Other",
                "GlucoseMonitor"
            ]
        },
        "deviceConnection":{
            "title":"Device Connection Type",
            "type":"string",
            "description":"Device connection type.",
            "example":"DevicetoCloud",
            "enum":[
                "CloudtoCloud",
                "DevicetoCloud",
                "NoConnection"
            ]
        },
        "inventoryId":{
            "title":"Inventory ID",
            "type":"string",
            "description":"Inventory ID.",
            "example":"D313327EF13845169A8ADADDA435431E"
        },
        "trialSupplyType":{
            "title":"Trial Supply Type",
            "type":"string",
            "description":"Type of the trial supply.",
            "example":"BOTTLE"
        },
        "conserved":{
            "title":"Conserved",
            "type":"boolean",
            "description":"Conserved for dispensation.",
            "example":true
        },
        "titrationKitLabel":{
            "title":"Blinded Titration Label",
            "type":"string",
            "description":"Blinded titration label.",
            "example":"High dose"
        },
        "barcode":{
            "type":"string",
            "description":"Barcode.",
            "example":"1000"
        },
        "dispensationConfirmed":{
            "type":"boolean",
            "description":"Indicates whether dispensation is confirmed.",
            "example":true
        },
        "groupingNumber":{
            "title":"Grouping Number",
            "type":"integer",
            "description":"Grouping number for a kit.",
            "format":"int32",
            "example":1
        },
        "kitNumberUTF":{
            "title":"Kit Number UTF",
            "type":"string",
            "description":"Kit number with UTF-8 support.",
            "example":"A-1"
        },
        "dosingUnblinded":{
            "title":"Dosing Unblinded",
            "type":"boolean",
            "description":"Indicates whether dosing is unblinded.",
            "example":true
        },
        "titrationOption":{
            "title":"Titration Option",
            "type":"string",
            "description":"Titration options to dispense kits. For example: up/down/maintain.",
            "example":"up",
            "enum":[
                "up",
                "down",
                "maintain"
            ]
        },
        "locallySourced":{
            "title":"Locally Sourced",
            "type":"boolean",
            "description":"Indicates whether the kit is locally sourced.",
            "example":true
        },
        "quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Kit quantity.",
            "format":"BigDecimal",
            "example":5
        },
        "lotId":{
            "title":"Lot ID",
            "type":"string",
            "description":"Lot ID.",
            "example":"D313327EF13845169A8ADADDA435431E"
        },
        "lotNumber":{
            "title":"Lot Number",
            "type":"string",
            "description":"Lot number.",
            "example":"LOT20240605A"
        },
        "dosingInstruction":{
            "title":"Dosing Instruction",
            "type":"string",
            "description":"Dosing instruction.",
            "example":"Take one capsule daily"
        }
    },
    "description":"Contains information for the kit dispensation."
}

Examples

Select an example Replace Subject Kits Response

400 Response

For invalid subject or this operation is not allowed during the current subject statusOr invalid kit

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 Replace Subject Kits Bad Request Response

404 Response

For invalid study ID or version. Or subject not found. Or site ID not found in site service

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 Replace Subject Kits Not Found Response

500 Response

Subject is randomized in error. Or not enough inventory

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 Replace Subject Kits Server Error Response

Back to Top