Jump to

• Request
• Response

Create or update selected depot resupply associations

put

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

Creates or updates selected associations between a resupply and a depot.
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)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: array

Show Source

• Array of: object DepotResupplyRequest
  Depot resupply request object.

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

Nested Schema : DepotResupplyRequest

Type: object

Depot resupply request object.

Show Source

• depotId: string
  Example: B1B8327AFAA6412287106192AB5984EF
• resupplyId: string
  Example: B1B8327AFAA6412287106192AB5984EF

{
    "type":"object",
    "properties":{
        "depotId":{
            "type":"string",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "resupplyId":{
            "type":"string",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        }
    },
    "description":"Depot resupply request object."
}

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)
  The end date until which the data is applicable or valid.
• versionStart: string (date-time)
  The timestamp marking the beginning of the validity period for this record version within the system.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Resupply site id",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "description":"The timestamp marking the beginning of the validity period for this record version within the system.",
            "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":"The end date until which the data is applicable or valid.",
            "format":"date-time"
        },
        "subjectVisitId":{
            "type":"string",
            "format":"uuid"
        }
    },
    "description":"Site resupply details."
}

400 Response

'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
  Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
• 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

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

• details: object details
  Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
• errorCode: string
  Application or business-specific error code representing the error type.

  Example: REPT_401
• errorMessage: string
  Human-readable error message describing the failure or issue.

  Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"object",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Result Object

Nested Schema : details

Type: object

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example:

User role is missing required permission REPORTING_VIEW. Field: userId

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
  Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
• 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

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

• details: object details
  Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
• errorCode: string
  Application or business-specific error code representing the error type.

  Example: REPT_401
• errorMessage: string
  Human-readable error message describing the failure or issue.

  Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"object",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Result Object

Nested Schema : details

Type: object

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example:

User role is missing required permission REPORTING_VIEW. Field: userId

500 Response

Internal server error

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
  Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
• 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

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

• details: object details
  Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
• errorCode: string
  Application or business-specific error code representing the error type.

  Example: REPT_401
• errorMessage: string
  Human-readable error message describing the failure or issue.

  Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"object",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Result Object

Nested Schema : details

Type: object

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example:

User role is missing required permission REPORTING_VIEW. Field: userId

Back to Top