Jump to

• Request
• Response

v3.0

post

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

Creates a resupply group for a study.
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.
• 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 : Resupply Group Request

Type: object

Title: Resupply Group Request

Request containing resupply group details.

Show Source

• countRandomizedSubjects: boolean
  Set to true to count randomized subjects

  Example: false
• groups(required): array groups
  Minimum Number of Items: 1
• ignoreIfOutsideWindowBy: integer (int32)
  Ignore if outside window by this number of days

  Example: 10
• ignoreSubjectsOnDoseHold: boolean
  Set to true to ignore subjects on dose hold

  Example: false
• ignoreSubjectsOnSkipDispensingVisit: boolean
  Set to true to ignore subjects on skip dispensing visit

  Example: false
• resupplyId: string (uuid)
  Resupply Id
• resupplyName(required): string
  Minimum Length: 0

  Maximum Length: 50

  Resupply name

  Example: resupplyNameNew1
• resupplyTypeId(required): integer (int32)
  Resupply group type.

  Example: 2
• type(required): string
  Resupply group type.

  Example: Site

{
    "title":"Resupply Group Request",
    "required":[
        "groups",
        "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":"resupplyNameNew1"
        },
        "resupplyTypeId":{
            "type":"integer",
            "description":"Resupply group type.",
            "format":"int32",
            "example":2
        },
        "ignoreSubjectsOnDoseHold":{
            "type":"boolean",
            "description":"Set to true to ignore subjects on dose hold",
            "example":false
        },
        "ignoreSubjectsOnSkipDispensingVisit":{
            "type":"boolean",
            "description":"Set to true to ignore subjects on skip dispensing visit",
            "example":false
        },
        "ignoreIfOutsideWindowBy":{
            "type":"integer",
            "description":"Ignore if outside window by this number of days",
            "format":"int32",
            "example":10
        },
        "countRandomizedSubjects":{
            "type":"boolean",
            "description":"Set to true to count randomized subjects",
            "example":false
        },
        "groups":{
            "minItems":1,
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResupplyDynamicGroupV1"
            }
        },
        "type":{
            "type":"string",
            "description":"Resupply group type.",
            "example":"Site"
        }
    },
    "description":"Request containing resupply group details."
}

Nested Schema : groups

Type: array

Minimum Number of Items: 1

Show Source

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

  Group object for resupply group.

{
    "minItems":1,
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ResupplyDynamicGroupV1"
    }
}

Nested Schema : ResupplyDynamicGroup v1.0

Type: object

Title: ResupplyDynamicGroup v1.0

Group object for resupply group.

Show Source

• id: string
  Title: Group ID

  Group identifier.

  Example: 32120000700000000000000000000014
• kitTypes(required): array Kit Types
  Title: Kit Types

  Minimum Number of Items: 1

  Kit type summary.
• maxRange: integer (int32)
  Title: Maximum Range

  Maximum range.

  Example: 100
• minRange: integer (int32)
  Title: Minimum Range

  Minimum range.

  Example: 0
• name: string
  Title: Group Name

  Name of the dynamic group.

  Example: Group 1

{
    "title":"ResupplyDynamicGroup v1.0",
    "required":[
        "kitTypes"
    ],
    "type":"object",
    "properties":{
        "id":{
            "title":"Group ID",
            "type":"string",
            "description":"Group identifier.",
            "example":"32120000700000000000000000000014"
        },
        "name":{
            "title":"Group Name",
            "type":"string",
            "description":"Name of the dynamic group.",
            "example":"Group 1"
        },
        "minRange":{
            "title":"Minimum Range",
            "type":"integer",
            "description":"Minimum range.",
            "format":"int32",
            "example":0
        },
        "maxRange":{
            "title":"Maximum Range",
            "type":"integer",
            "description":"Maximum range.",
            "format":"int32",
            "example":100
        },
        "kitTypes":{
            "title":"Kit Types",
            "minItems":1,
            "type":"array",
            "description":"Kit type summary.",
            "items":{
                "$ref":"#/components/schemas/ResupplyGroupRequest.KitTypeSummary"
            }
        }
    },
    "description":"Group object for resupply group."
}

Nested Schema : Kit Types

Type: array

Title: Kit Types

Minimum Number of Items: 1

Kit type summary.

Show Source

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

  Kit type summary details object.

{
    "title":"Kit Types",
    "minItems":1,
    "type":"array",
    "description":"Kit type summary.",
    "items":{
        "$ref":"#/components/schemas/ResupplyGroupRequest.KitTypeSummary"
    }
}

Nested Schema : KitTypeSummary v1.0

Type: object

Title: KitTypeSummary v1.0

Kit type summary details object.

Show Source

• id(required): string (uuid)
  Title: Kit Type ID

  Kit type identifier.
• 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: number (double)
  Minimum Value: 0

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

  Example: 50
• minBuffer: 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

{
    "title":"KitTypeSummary v1.0",
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "title":"Kit Type ID",
            "type":"string",
            "description":"Kit type identifier.",
            "format":"uuid"
        },
        "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

'Invalid resupply type', 'Duplicate resupply'

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