QIMA Logo
API Reference

8 categories • 44 endpoints

  • All APIs

    44

    • Quick Actions
    Getting StartedDocumentation
    Parameter
    v1.0.0

    Get the lists of available sample levels

    Request
    Query Parameters
    NameTypeLocationRequiredDescription
    typestringqueryNoThe type of sample level to return, default is all of them
    refreshstringqueryNoWhether to refresh the cache
    Responses
    200
    Expected data returned

    Content-Type: application/json

    message
    string
    FieldTypeDescription
    messagestring
    FieldTypeDescription
    generalarraySample levels in general type
    general[].valuestringSample level value
    general[].labelstringSample level text
    fabricarraySample levels in fabric type
    eyeweararraySample levels in eyewear type
    {
  "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%"
      }
    ]
  }
}
    GET
    /parameter/v2/sample-levels
    Request samples

    application/json

    {}
    Response samples

    application/json

    { "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%" } ] } }