Skip to content

ImageTypeList_Load_Query#


Description#

This function loads a list of image types.

Request Parameters#

Parameter
Type Description
count Number Maximum lines of data allowed to be returned in the response. This limit is used to prevent excessive amounts of data return
filter String A string for filtering returned data
offset Number Used with the Count parameter for paginating results of large datasets. Default 0 is no offset.
sort String The order for sorting returned data

Response Parameters#

Parameter
Type Description
success Boolean Boolean value indicating if the API request was successful
total_count Number The number of image types returned
start_offset Number The offset starting point for pagination of return data
id Number The image id
code String The code for the image
descrip String The description of the image

Example Request#

{
    "Store_code": "beta",
    "Function": "ImageTypeList_Load_Query",
    "Count": 42,
    "Offset": 0,
    "Sort": "code"
}

Example Response#

{
    "success": 1,
    "data": {
        "total_count": 1,
        "start_offset": 0,
        "data": [
            {
                "id": 1,
                "code": "main",
                "descrip": "Main"
            }
        ]
    }
}