Jump to

• Request
• Response

Get all depot resupplies

get

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/depot/resupplies

Retrieves all depot resupplies. Rights: SupplySettingRightsPost. Required sponsor roles are clinical supply manager and depot manager

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 : schema

Type: array

Show Source

• Array of: object SiteResupply
  Site resupply details.

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

Nested Schema : SiteResupply

Type: object

Site resupply details.

Show Source

• comment: string
  Comments

  Example: Some comments
• id: string (uuid)
  Resupply site id
• objectVersionNumber: number (double)
  Object Version Number.

  Example: 5
• operationType: string
  Allowed Values: [ "CREATED", "REMOVED", "MODIFIED" ]

  Operation type.

  Example: MODIFIED
• reason: string
  Reason.

  Example: Some reason
• resupplyId: string (uuid)
  Resupply ID
• resupplyVersionStart: string (date-time)
  Resupply version start
• siteId: string (uuid)
  Site ID
• siteVersionStart: string (date-time)
  Site version start
• softwareVersionNumber: number (double)
  Software Version Number.

  Example: 2
• subjectVisitId: string (uuid)
• userId: string (uuid)
  User id
• versionEnd: string (date-time)
  Version End
• versionStart: string (date-time)
  Version Start

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Resupply site id",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "description":"Version Start",
            "format":"date-time"
        },
        "comment":{
            "type":"string",
            "description":"Comments",
            "example":"Some comments"
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Object Version Number.",
            "format":"double",
            "example":"5"
        },
        "operationType":{
            "type":"string",
            "description":"Operation type.",
            "example":"MODIFIED",
            "enum":[
                "CREATED",
                "REMOVED",
                "MODIFIED"
            ]
        },
        "reason":{
            "type":"string",
            "description":"Reason.",
            "example":"Some reason"
        },
        "resupplyId":{
            "type":"string",
            "description":"Resupply ID",
            "format":"uuid"
        },
        "resupplyVersionStart":{
            "type":"string",
            "description":"Resupply version start",
            "format":"date-time"
        },
        "siteId":{
            "type":"string",
            "description":"Site ID",
            "format":"uuid"
        },
        "siteVersionStart":{
            "type":"string",
            "description":"Site version start",
            "format":"date-time"
        },
        "softwareVersionNumber":{
            "type":"number",
            "description":"Software Version Number.",
            "format":"double",
            "example":"2"
        },
        "userId":{
            "type":"string",
            "description":"User id",
            "format":"uuid"
        },
        "versionEnd":{
            "type":"string",
            "description":"Version End",
            "format":"date-time"
        },
        "subjectVisitId":{
            "type":"string",
            "format":"uuid"
        }
    },
    "description":"Site resupply details."
}

400 Response

'The depot in the study does not match the Clinical One study configuration, 'Duplicate depot'

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

404 Response

'Resupply not found', 'Study identifier does not match any study identifiers in Clinical One.'

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