Jump to

• Request
• Response

v1.0

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
  Indicates the operational mode of the study. Accepted values: active, test, or training.

  Example:

  test

• 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: array

Show Source

• Array of: object DepotResupplyRequest v1.0
  Title: DepotResupplyRequest v1.0

  Depot resupply request object.

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

Nested Schema : DepotResupplyRequest v1.0

Type: object

Title: DepotResupplyRequest v1.0

Depot resupply request object.

Show Source

• depotId: string
  Title: Depot ID

  Depot ID.

  Example: B1B8327AFAA6412287106192AB5984EF
• resupplyId: string
  Title: Resupply ID

  Resupply ID.

  Example: B1B8327AFAA6412287106192AB5984EF

{
    "title":"DepotResupplyRequest v1.0",
    "type":"object",
    "properties":{
        "depotId":{
            "title":"Depot ID",
            "type":"string",
            "description":"Depot ID.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "resupplyId":{
            "title":"Resupply ID",
            "type":"string",
            "description":"Resupply ID.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        }
    },
    "description":"Depot resupply request object."
}

Examples

Select an example Associate Depot Resupplies Request

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
  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.

Examples

Select an example Associate Depot Resupply Bad Request Response

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
  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.

Examples

Select an example Associate Depot Resupply Not Found Response

500 Response

Internal server error

Body ()

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.

Examples

Select an example Associate Depot Resupply Server Error Response

Back to Top