Jump to

• Request
• Response

Update a resupply by ID

put

/ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/resupplies/{resupplyId}

Updates a resupply group by ID. Rights: SupplySettingRightsPost. Required sponsor roles are clinical supply manager and site manager.

Request

Path Parameters

• mode(required): string
  Mode of the study, accepts: test, active, or training
• resupplyId(required): string(uuid)
  ID of resupply group
• studyId(required): string(uuid)
  ID of the study

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Request object for resupply group.

Show Source

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

  Maximum Number of Items: 2147483647
• resupplyId: string (uuid)
  Resupply Id
• resupplyName(required): string
  Minimum Length: 0

  Maximum Length: 50

  Resupply name

  Example: Resupply 1
• resupplyTypeId(required): integer (int32)
  Id of the resupply type.

  Example: 2
• type(required): string

{
    "required":[
        "kitTypes",
        "resupplyName",
        "resupplyTypeId",
        "type"
    ],
    "type":"object",
    "properties":{
        "resupplyId":{
            "type":"string",
            "description":"Resupply Id",
            "format":"uuid"
        },
        "resupplyName":{
            "maxLength":"50",
            "minLength":"0",
            "type":"string",
            "description":"Resupply name",
            "example":"Resupply 1"
        },
        "resupplyTypeId":{
            "type":"integer",
            "description":"Id of the resupply type.",
            "format":"int32",
            "example":"2"
        },
        "kitTypes":{
            "maxItems":"2147483647",
            "minItems":"1",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResupplyGroupRequest.KitTypeSummary"
            }
        },
        "type":{
            "type":"string"
        }
    },
    "description":"Request object for resupply group."
}

Nested Schema : kitTypes

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

Show Source

• Array of: object ResupplyGroupRequest.KitTypeSummary
  Kit type summary details object.

{
    "maxItems":"2147483647",
    "minItems":"1",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ResupplyGroupRequest.KitTypeSummary"
    }
}

Nested Schema : ResupplyGroupRequest.KitTypeSummary

Type: object

Kit type summary details object.

Show Source

• id(required): string
  ID of the kit type.

  Example: kitA
• initialShippingUnits: number (double)
  Minimum Value: 0

  Maximum Value: 99

  The number of kits of each type that are in the initial shipment.

  Example: 50
• manualConsignment: number (double)
  Minimum Value: 0

  Maximum Value: 99

  The number of kits of each type that are included in a manual shipment.

  Example: 50
• maxBuffer(required): number (double)
  Minimum Value: 0

  The number of kits that will be present at the site after a resupply shipment arrives.

  Example: 50
• minBuffer(required): number (double)
  Minimum Value: 0

  The number of kits that trigger a shipment when the resupply strategy runs.

  Example: 5
• resupplyWeeks: number (double)
  Minimum Value: 0

  Maximum Value: 99

  The number of weeks that the resupply strategy resupplies for.

  Example: 3
• triggerWeeks: number (double)
  Minimum Value: 0

  Maximum Value: 99

  The number of weeks that the resupply strategy looks out to determine the supply.

  Example: 3

{
    "required":[
        "id",
        "maxBuffer",
        "minBuffer"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID of the kit type.",
            "example":"kitA"
        },
        "minBuffer":{
            "minimum":"0",
            "type":"number",
            "description":"The number of kits that trigger a shipment when the resupply strategy runs.",
            "format":"double",
            "example":"5"
        },
        "maxBuffer":{
            "minimum":"0",
            "type":"number",
            "description":"The number of kits that will be present at the site after a resupply shipment arrives.",
            "format":"double",
            "example":"50"
        },
        "initialShippingUnits":{
            "maximum":"99",
            "minimum":"0",
            "type":"number",
            "description":"The number of kits of each type that are in the initial shipment.",
            "format":"double",
            "example":"50"
        },
        "manualConsignment":{
            "maximum":"99",
            "minimum":"0",
            "type":"number",
            "description":"The number of kits of each type that are included in a manual shipment.",
            "format":"double",
            "example":"50"
        },
        "triggerWeeks":{
            "maximum":"99",
            "minimum":"0",
            "type":"number",
            "description":"The number of weeks that the resupply strategy looks out to determine the supply.",
            "format":"double",
            "example":"3"
        },
        "resupplyWeeks":{
            "maximum":"99",
            "minimum":"0",
            "type":"number",
            "description":"The number of weeks that the resupply strategy resupplies for.",
            "format":"double",
            "example":"3"
        }
    },
    "description":"Kit type summary details object."
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

400 Response

'Validation error, 'Invalid resupply type', 'Resupply already exists', 'Resupply contains duplicate IDs for kit types', 'Invalid kit type'

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