Skip to content

PageList_Load_Query#


Description#

This function loads a list of pages in the store. By passing a search filter for layout equals False, you can specify if you want layouts returned in the results since layouts are just a special type of page.

Example Request#

{
    "Store_Code": "{{Store_Code}}",
    "Miva_Request_Timestamp": "{{$timestamp}}",
    "Function": "PageList_Load_Query",
    "Count": 0,
    "Offset": 0,
    "Sort": "code",
    "Filter": [
        {
            "name": "ondemandcolumns",
            "value": []
        },
        {
            "name": "search",
            "value": [
                {
                    "field": "layout",
                    "operator": "FALSE",
                    "value": ""
                }
            ]
        }
    ]
}

Example Response#

{
    "success": 1,
    "data": {
        "total_count": 86,
        "start_offset": 0,
        "data": [
            {
                "id": 41,
                "admin": false,
                "layout": false,
                "secure": true,
                "code": "ABAL",
                "name": "Customer Account Balance",
                "title": "",
                "ui_id": 160,
                "templ_id": 271,
                "cache": "anonempty",
                "fragment": false
            },
            {
                "id": 21,
                "admin": false,
                "layout": false,
                "secure": true,
                "code": "ABUS",
                "name": "About Us",
                "title": "",
                "ui_id": 160,
                "templ_id": 193,
                "cache": "anonempty",
                "fragment": false
            },
            {
                "id": 45,
                "admin": false,
                "layout": false,
                "secure": true,
                "code": "ACAD",
                "name": "Customer Create",
                "title": "",
                "ui_id": 160,
                "templ_id": 288,
                "cache": "anonempty",
                "fragment": false
            },
            {
                "id": 46,
                "admin": false,
                "layout": false,
                "secure": true,
                "code": "ACED",
                "name": "Customer Edit",
                "title": "",
                "ui_id": 160,
                "templ_id": 292,
                "cache": "anonempty",
                "fragment": false
            },
            {
                "id": 40,
                "admin": false,
                "layout": false,
                "secure": true,
                "code": "ACLN",
                "name": "Customer Account",
                "title": "",
                "ui_id": 160,
                "templ_id": 264,
                "cache": "anonempty",
                "fragment": false
            },
            {
                "id": 48,
                "admin": false,
                "layout": false,
                "secure": true,
                "code": "ACRT",
                "name": "Customer Password Reset",
                "title": "",
                "ui_id": 160,
                "templ_id": 299,
                "cache": "anonempty",
                "fragment": false
            },
            {
                "id": 22,
                "admin": false,
                "layout": false,
                "secure": true,
                "code": "AFAD",
                "name": "Affiliate Create",
                "title": "",
                "ui_id": 160,
                "templ_id": 196,
                "cache": "anonempty",
                "fragment": false
            },
            {
                "id": 24,
                "admin": false,
                "layout": false,
                "secure": true,
                "code": "AFCL",
                "name": "Affiliate Login",
                "title": "",
                "ui_id": 160,
                "templ_id": 204,
                "cache": "anonempty",
                "fragment": false
            },
            {
                "id": 23,
                "admin": false,
                "layout": false,
                "secure": true,
                "code": "AFED",
                "name": "Affiliate Edit",
                "title": "",
                "ui_id": 160,
                "templ_id": 200,
                "cache": "anonempty",
                "fragment": false
            },
            {
                "id": 85,
                "admin": false,
                "layout": false,
                "secure": true,
                "code": "AFFR",
                "name": "Affiliate Password Reset",
                "title": "",
                "ui_id": 160,
                "templ_id": 445,
                "cache": "anonempty",
                "fragment": false
            }
        ]
    }
}