Jump to

• Request
• Response

V10.0

delete

/ec-designer-ors-svc/rest/v10.0/studies/{studyId}/versions/{version}/kits/{kitId}

Removes a kit type from a study.

Request

Path Parameters

• kitId(required): string(uuid)
  The Kit ID
• studyId(required): string(uuid)
  Study unique identifier.
• version(required): string
  Study version identifier.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Kit was deleted successfully for the requested study version.

Body ()

Root Schema : Kits Delete Response v10.0

Type: object

Title: Kits Delete Response v10.0

Designer response envelope returned by DELETE kit.

Show Source

• errorData: object Kits GET Error
  Title: Kits GET Error

  Error payload returned inside the Designer response envelope.
• result: string
  Minimum Length: 1

  Maximum Length: 255

  Deletion status message returned by the service.

  Example: Kit deleted successfully.
• status: string
  Minimum Length: 1

  Maximum Length: 32

  Allowed Values: [ "success" ]

  Envelope status returned by this endpoint. Allowed value: `success`, which indicates the Designer response wrapper was created successfully for this request.

  Example: success
• version: integer (int32)
  Minimum Value: 1

  Envelope version for the shared Designer response wrapper.

  Example: 1

{
    "title":"Kits Delete Response v10.0",
    "type":"object",
    "properties":{
        "status":{
            "maxLength":32,
            "minLength":1,
            "type":"string",
            "description":"Envelope status returned by this endpoint. Allowed value: `success`, which indicates the Designer response wrapper was created successfully for this request.",
            "example":"success",
            "enum":[
                "success"
            ]
        },
        "result":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"Deletion status message returned by the service.",
            "example":"Kit deleted successfully."
        },
        "errorData":{
            "$ref":"#/components/schemas/KitsGetErrorDoc"
        },
        "version":{
            "minimum":1,
            "type":"integer",
            "description":"Envelope version for the shared Designer response wrapper.",
            "format":"int32",
            "example":1
        }
    },
    "description":"Designer response envelope returned by DELETE kit."
}

Nested Schema : Kits GET Error

Type: object

Title: Kits GET Error

Error payload returned inside the Designer response envelope.

Show Source

• details: object Kits GET Error Details
  Title: Kits GET Error Details

  Request values echoed back in the error payload for troubleshooting.
• errorCode: string
  Minimum Length: 1

  Maximum Length: 32

  Application error code.

  Example: C1-500
• errorMessage: string
  Minimum Length: 1

  Maximum Length: 1024

  Human-readable explanation of the failure.

  Example: Unable to retrieve kits for the requested study version.

{
    "title":"Kits GET Error",
    "type":"object",
    "properties":{
        "errorCode":{
            "maxLength":32,
            "minLength":1,
            "type":"string",
            "description":"Application error code.",
            "example":"C1-500"
        },
        "errorMessage":{
            "maxLength":1024,
            "minLength":1,
            "type":"string",
            "description":"Human-readable explanation of the failure.",
            "example":"Unable to retrieve kits for the requested study version."
        },
        "details":{
            "$ref":"#/components/schemas/KitsGetErrorDetailsDoc"
        }
    },
    "description":"Error payload returned inside the Designer response envelope.",
    "example":{
        "errorCode":"C1-500",
        "errorMessage":"Unable to retrieve kits for the requested study version.",
        "details":{
            "studyId":"CF1E6500073D4AD298F4DA93DA670786",
            "version":"1.0.0.1",
            "kitType":"ALL",
            "kitTypeExclude":false
        }
    }
}

Example:

{
    "errorCode":"C1-500",
    "errorMessage":"Unable to retrieve kits for the requested study version.",
    "details":{
        "studyId":"CF1E6500073D4AD298F4DA93DA670786",
        "version":"1.0.0.1",
        "kitType":"ALL",
        "kitTypeExclude":false
    }
}

Nested Schema : Kits GET Error Details

Type: object

Title: Kits GET Error Details

Request values echoed back in the error payload for troubleshooting.

Show Source

• kitType: string
  Minimum Length: 3

  Maximum Length: 21

  Allowed Values: [ "ALL", "STANDARD", "TITRATION", "DEVICE", "advancedDispensation" ]

  Kit type filter from the request. Allowed values: `ALL` for every kit type, `STANDARD` for standard kits, `TITRATION` for titration kits, `DEVICE` for device kits, and `advancedDispensation` for advanced dispensation kits.

  Example: ALL
• kitTypeExclude: boolean
  Whether the request excluded the selected kit type instead of including it.

  Example: false
• studyId: string (uuid)
  Minimum Length: 32

  Maximum Length: 32

  Study identifier from the request.
• version: string
  Minimum Length: 1

  Maximum Length: 32

  Study version from the request.

  Example: 1.0.0.1

{
    "title":"Kits GET Error Details",
    "type":"object",
    "properties":{
        "studyId":{
            "maxLength":32,
            "minLength":32,
            "type":"string",
            "description":"Study identifier from the request.",
            "format":"uuid"
        },
        "version":{
            "maxLength":32,
            "minLength":1,
            "type":"string",
            "description":"Study version from the request.",
            "example":"1.0.0.1"
        },
        "kitType":{
            "maxLength":21,
            "minLength":3,
            "type":"string",
            "description":"Kit type filter from the request. Allowed values: `ALL` for every kit type, `STANDARD` for standard kits, `TITRATION` for titration kits, `DEVICE` for device kits, and `advancedDispensation` for advanced dispensation kits.",
            "example":"ALL",
            "enum":[
                "ALL",
                "STANDARD",
                "TITRATION",
                "DEVICE",
                "advancedDispensation"
            ]
        },
        "kitTypeExclude":{
            "type":"boolean",
            "description":"Whether the request excluded the selected kit type instead of including it.",
            "example":false
        }
    },
    "description":"Request values echoed back in the error payload for troubleshooting.",
    "example":{
        "studyId":"CF1E6500073D4AD298F4DA93DA670786",
        "version":"1.0.0.1",
        "kitType":"ALL",
        "kitTypeExclude":false
    }
}

Example:

{
    "studyId":"CF1E6500073D4AD298F4DA93DA670786",
    "version":"1.0.0.1",
    "kitType":"ALL",
    "kitTypeExclude":false
}

Examples

Select an example DeleteKitV10Success

500 Response

Returned when the service cannot delete the requested kit for the supplied study version because of an unexpected server-side failure.

Body ()

Root 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 : details

Type: object

Back to Top