Parameter Sample Levels Guide

Latest Update Time: 2026-07-02 00:00:00

Use this API to retrieve the available sample levels used for inspection/lab testing checklists (e.g. AQL sample sizes).

See the Parameter Introduction for base URL, authentication, and required headers.

Endpoint

GET https://ppapi.qima.com/parameter/v2/sample-levels

Query Parameters

Parameter	Required	Description
`type`	No	The type of sample level to return (`general`, `fabric`, or `eyewear`). Defaults to returning all types.
`refresh`	No	Send `false` (default) to use the server cache, or `true` to force a fresh lookup.

Request Example

curl --location --request GET 'https://ppapi.qima.com/parameter/v2/sample-levels' \
  --header 'Ai-Api-Access-Token: {your api access token}' \
  --header 'Ai-User-Id: {your user ID}' \
  --header 'Authorization: Bearer {your token}' \
  --header 'Referer: https://preprodmy.qima.com/'

Successful Response

Trimmed to 2 entries per type here.

{
    "message": "OK",
    "content": {
        "general": [
            { "value": "I", "label": "I" },
            { "value": "II", "label": "II" }
        ],
        "fabric": [
            { "value": "0", "label": "Default" },
            { "value": "10", "label": "10%" }
        ],
        "eyewear": [
            { "value": "3_PERCENT", "label": "3%" },
            { "value": "10_PERCENT", "label": "10%" }
        ]
    }
}

Note: message is "OK" here rather than null — both indicate success. See the common response shape note in the module introduction.

Response Field Notes

Field	Notes
`content.general[]`	Sample levels for general products (e.g. `"I"`, `"II"`). Use as `prodSampleLevel` in a product checklist.
`content.fabric[]`	Sample levels for fabric products, expressed as percentages.
`content.eyewear[]`	Sample levels for eyewear products, expressed as percentages with a text suffix.
`content.*[].value`	The value to submit in a booking's checklist.
`content.*[].label`	Display text — often identical to `value` for this API.

Common Errors

See common authentication errors for 401 and 403 responses.

Next Steps

Use a sample level value in the checkList/productChecklistBean section of an Inspection, Audit, or Lab Testing booking.

Documents