Jump to

• Request
• Response

v1.0

post

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

Retrieves existing data from clinical supplies forms for kit IDs.

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

Request Body - application/json ()

Root Schema : NonSubjectFormRequest

Type: object

Title: NonSubjectFormRequest

Request object containing kit IDs.

Show Source

• kitIds(required): array kitIds
  Minimum Number of Items: 1

  Maximum Number of Items: 2147483647

{
    "title":"NonSubjectFormRequest",
    "required":[
        "kitIds"
    ],
    "type":"object",
    "properties":{
        "kitIds":{
            "maxItems":2147483647,
            "minItems":1,
            "type":"array",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        }
    },
    "description":"Request object containing kit IDs."
}

Nested Schema : kitIds

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

Show Source

• Array of: string(uuid)

{
    "maxItems":2147483647,
    "minItems":1,
    "type":"array",
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : InventoryDetailsResponse

Type: object

Response object containing kit details.

Show Source

• kitDetails: array kitDetails

{
    "type":"object",
    "properties":{
        "kitDetails":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/InventoryDetailsDTO"
            }
        }
    },
    "description":"Response object containing kit details."
}

Nested Schema : kitDetails

Type: array

Show Source

• Array of: object InventoryDetailsDTO
  Contains kit details.

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

Nested Schema : InventoryDetailsDTO

Type: object

Contains kit details.

Show Source

• kitId: string (uuid)
  Kit ID.
• propertyValuesList: array propertyValuesList
• rightsNeeded: string
  Required rights for the kit.

  Example: ORSUnblinded,ORSUnblindedPharmacist

{
    "type":"object",
    "properties":{
        "kitId":{
            "type":"string",
            "description":"Kit ID.",
            "format":"uuid"
        },
        "rightsNeeded":{
            "type":"string",
            "description":"Required rights for the kit.",
            "example":"ORSUnblinded,ORSUnblindedPharmacist"
        },
        "propertyValuesList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/InventoryProperties"
            }
        }
    },
    "description":"Contains kit details."
}

Nested Schema : propertyValuesList

Type: array

Show Source

• Array of: object InventoryProperties
  Contains the property details.

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

Nested Schema : InventoryProperties

Type: object

Contains the property details.

Show Source

• codeListBlindedKeyValue: string
  Blinded code list key.

  Example: blinded
• codeLIstId: string
  Code list identifier.

  Example: KitType,InventoryStatus
• codeListIdForBlindedValue: string
  Code list ID for blinded value.

  Example: BlindedValues
• propertyName: string
  Property key.

  Example: Kit Description
• propertyValue: string
  Property value.

  Example: Returned to Site,Vial
• propertyValueTimestamp: string (date-time)
  Timestamp when the property value was recorded.
• rightsNeeded: string
  Rights string.

  Example: ORSUnblinded,ORSUnblindedPharmacist,ORSBlindedDepotGet
• srcId: string
  Source identifier.

  Example: B1B8327AFAA6412287106192AB5984EF
• srcType: string
  Source type.

  Example: DCSubject

{
    "type":"object",
    "properties":{
        "propertyName":{
            "type":"string",
            "description":"Property key.",
            "example":"Kit Description"
        },
        "codeLIstId":{
            "type":"string",
            "description":"Code list identifier.",
            "example":"KitType,InventoryStatus"
        },
        "propertyValue":{
            "type":"string",
            "description":"Property value.",
            "example":"Returned to Site,Vial"
        },
        "rightsNeeded":{
            "type":"string",
            "description":"Rights string.",
            "example":"ORSUnblinded,ORSUnblindedPharmacist,ORSBlindedDepotGet"
        },
        "codeListIdForBlindedValue":{
            "type":"string",
            "description":"Code list ID for blinded value.",
            "example":"BlindedValues"
        },
        "codeListBlindedKeyValue":{
            "type":"string",
            "description":"Blinded code list key.",
            "example":"blinded"
        },
        "srcId":{
            "type":"string",
            "description":"Source identifier.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "srcType":{
            "type":"string",
            "description":"Source type.",
            "example":"DCSubject"
        },
        "propertyValueTimestamp":{
            "type":"string",
            "description":"Timestamp when the property value was recorded.",
            "format":"date-time"
        }
    },
    "description":"Contains the property details."
}

404 Response

Invalid study ID or version number

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

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

Back to Top