Jump to

• Request
• Response

v2.0

get

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

Retrieves all resupply groups created for a study.
Rights: SupplySettingRightsGet. Required sponsor roles are clinical supply manager and site manager.triggerWeeks and resupplyWeeks fields aren't needed for Min/Max strategies, so they're hidden when fetched.

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.

Query Parameters

• resupplyTypeId(required): integer(int32)
  ID of resupply type.

  Allowed Values: [ null ]
• type: string
  Type of resupply.

  Allowed Values: [ "Site,Depot" ]

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ResupplyGroupResponse v2.0

Type: object

Title: ResupplyGroupResponse v2.0

Response object for resupply group.

Show Source

• resupplies: array Resupply Groups
  Title: Resupply Groups

  List of resupply groups.

{
    "title":"ResupplyGroupResponse v2.0",
    "type":"object",
    "properties":{
        "resupplies":{
            "title":"Resupply Groups",
            "type":"array",
            "description":"List of resupply groups.",
            "items":{
                "$ref":"#/components/schemas/ResupplyGroup"
            }
        }
    },
    "description":"Response object for resupply group."
}

Nested Schema : Resupply Groups

Type: array

Title: Resupply Groups

List of resupply groups.

Show Source

• Array of: object ResupplyGroup
  Title: ResupplyGroup

  Resupply group details.

{
    "title":"Resupply Groups",
    "type":"array",
    "description":"List of resupply groups.",
    "items":{
        "$ref":"#/components/schemas/ResupplyGroup"
    }
}

Nested Schema : ResupplyGroup

Type: object

Title: ResupplyGroup

Resupply group details.

Show Source

• id: string (uuid)
  Title: Resupply ID

  Resupply ID.
• kitTypes: array kitTypes
• resupplyName: string
  Title: Resupply Name

  Resupply name.

  Example: Resupply 1
• resupplyTypeId: number (Integer)
  Title: Resupply Type ID

  ID of the resupply type.

  Example: 2
• type: string
  Title: Resupply Group Type

  Resupply group type.

  Example: Site

{
    "title":"ResupplyGroup",
    "type":"object",
    "properties":{
        "resupplyName":{
            "title":"Resupply Name",
            "type":"string",
            "description":"Resupply name.",
            "example":"Resupply 1"
        },
        "resupplyTypeId":{
            "title":"Resupply Type ID",
            "type":"number",
            "description":"ID of the resupply type.",
            "format":"Integer",
            "example":2
        },
        "kitTypes":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResupplyGroupResponse.KitTypeSummary"
            }
        },
        "type":{
            "title":"Resupply Group Type",
            "type":"string",
            "description":"Resupply group type.",
            "example":"Site"
        },
        "id":{
            "title":"Resupply ID",
            "type":"string",
            "description":"Resupply ID.",
            "format":"uuid"
        }
    },
    "description":"Resupply group details."
}

Nested Schema : kitTypes

Type: array

Show Source

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

  Kit type summary details object.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ResupplyGroupResponse.KitTypeSummary"
    }
}

Nested Schema : KitTypeSummary v1.0

Type: object

Title: KitTypeSummary v1.0

Kit type summary details object.

Show Source

• description: string
  Title: Description

  Kit type description.

  Example: Non dosing kit
• id: string
  Title: Kit Type ID

  Kit type identifier.

  Example: kitA
• initialShippingUnits: number (double)
  The number of kits of each type that are in the initial shipment.

  Example: 50
• kitTypeName: string
  Title: Kit Type Name

  Kit type name.

  Example: Kit A
• manualConsignment: number (double)
  The number of kits of each type that are included in a manual shipment.

  Example: 50
• maxBuffer: number (double)
  The number of kits that will be present at the site after a resupply shipment arrives.

  Example: 50
• minBuffer: number (double)
  The number of kits that trigger a shipment when the resupply strategy runs.

  Example: 5
• packageTypeId: number (double)
  Title: Package Type ID

  Allowed Values: [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ]

  Package type ID.

  Example: 5
• resupplyWeeks: number (double)
  The number of weeks that the resupply strategy resupplies for.

  Example: 3
• triggerWeeks: number (double)
  The number of weeks that the resupply strategy looks out to determine the supply.

  Example: 3

{
    "title":"KitTypeSummary v1.0",
    "type":"object",
    "properties":{
        "id":{
            "title":"Kit Type ID",
            "type":"string",
            "description":"Kit type identifier.",
            "example":"kitA"
        },
        "kitTypeName":{
            "title":"Kit Type Name",
            "type":"string",
            "description":"Kit type name.",
            "example":"Kit A"
        },
        "description":{
            "title":"Description",
            "type":"string",
            "description":"Kit type description.",
            "example":"Non dosing kit"
        },
        "packageTypeId":{
            "title":"Package Type ID",
            "type":"number",
            "description":"Package type ID.",
            "format":"double",
            "example":5,
            "enum":[
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9,
                10
            ]
        },
        "minBuffer":{
            "type":"number",
            "description":"The number of kits that trigger a shipment when the resupply strategy runs.",
            "format":"double",
            "example":5
        },
        "maxBuffer":{
            "type":"number",
            "description":"The number of kits that will be present at the site after a resupply shipment arrives.",
            "format":"double",
            "example":50
        },
        "initialShippingUnits":{
            "type":"number",
            "description":"The number of kits of each type that are in the initial shipment.",
            "format":"double",
            "example":50
        },
        "manualConsignment":{
            "type":"number",
            "description":"The number of kits of each type that are included in a manual shipment.",
            "format":"double",
            "example":50
        },
        "triggerWeeks":{
            "type":"number",
            "description":"The number of weeks that the resupply strategy looks out to determine the supply.",
            "format":"double",
            "example":3
        },
        "resupplyWeeks":{
            "type":"number",
            "description":"The number of weeks that the resupply strategy resupplies for.",
            "format":"double",
            "example":3
        }
    },
    "description":"Kit type summary details object."
}

404 Response

Resupply not found.

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