REST API for Clinical One Platform

Get existing data from non-subject forms for kit IDs

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)

ID of the study

Supported Media Types

application/json

Root Schema : schema

Type: object

Request object containing kit Ids.

Show Source

kitIds(required): array kitIds

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

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

Response

Supported Media Types

application/json

200 Response

Successful operation

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

rigths needed for kit Description.

Example: ORSUnblinded,ORSUnblindedPharmacist

{
    "type":"object",
    "properties":{
        "kitId":{
            "type":"string",
            "description":"Kit Id.",
            "format":"uuid"
        },
        "rightsNeeded":{
            "type":"string",
            "description":" rigths needed for kit Description.",
            "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

contains the property keys

Example: blinded
codeLIstId: string

contains the codeLIstId

Example: KitType,InventoryStatus
codeListIdForBlindedValue: string

contains the property keys

Example: BlindedValues
propertyName: string

contains the property keys

Example: Kit Description
propertyValue: string

contains the property value

Example: Returned to Site,Vial
propertyValueTimestamp: string (date-time)
rightsNeeded: string

contains the rights

Example: ORSUnblinded,ORSUnblindedPharmacist,ORSBlindedDepotGet
srcId: string

contains the property keys

Example: B1B8327AFAA6412287106192AB5984EF
srcType: string

contains the property keys

Example: DCSubject

{
    "type":"object",
    "properties":{
        "propertyName":{
            "type":"string",
            "description":"contains the property keys",
            "example":"Kit Description"
        },
        "codeLIstId":{
            "type":"string",
            "description":"contains the codeLIstId ",
            "example":"KitType,InventoryStatus"
        },
        "propertyValue":{
            "type":"string",
            "description":"contains the property value",
            "example":"Returned to Site,Vial"
        },
        "rightsNeeded":{
            "type":"string",
            "description":"contains the rights",
            "example":"ORSUnblinded,ORSUnblindedPharmacist,ORSBlindedDepotGet"
        },
        "codeListIdForBlindedValue":{
            "type":"string",
            "description":"contains the property keys",
            "example":"BlindedValues"
        },
        "codeListBlindedKeyValue":{
            "type":"string",
            "description":"contains the property keys",
            "example":"blinded"
        },
        "srcId":{
            "type":"string",
            "description":"contains the property keys",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "srcType":{
            "type":"string",
            "description":"contains the property keys",
            "example":"DCSubject"
        },
        "propertyValueTimestamp":{
            "type":"string",
            "format":"date-time"
        }
    },
    "description":"Contains the property details"
}

404 Response

Invalid study ID or version number

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

errorData: object ErrorResponseData

Title: ErrorResponseData

Error Response Details Information
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

Title: ErrorResponseData

Error Response Details Information

Show Source

details: object Object

Title: Object

Object with error details information.
errorCode: string

Error code which is stored in ErrorCode enum. Example : C1-003

Example: C1-003
errorMessage: string

Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Result Object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

500 Response

Internal server error

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

errorData: object ErrorResponseData

Title: ErrorResponseData

Error Response Details Information
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

Title: ErrorResponseData

Error Response Details Information

Show Source

details: object Object

Title: Object

Object with error details information.
errorCode: string

Error code which is stored in ErrorCode enum. Example : C1-003

Example: C1-003
errorMessage: string

Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Result Object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.