Location List

NOTE: User must be logged in as admin to access this API

URL : api/location-list
Method: GET
Query Parameters :

Parameter Type Possible Values Required/Optional Description
sort-field String name Optional Field name to sort
sort-order String asc, desc Optional Sorting order either ascending or descending
search-query String location name Optional Keyword to be searched in Location list page
limit Integer 10 Optional Number of records to be displayed in each page
page Integer 2 Optional Page number

Success Response:

{
    "success": true,
    "data": {
        "current_page": 1,
        "first_page_url": "http://development.faveo/v3/api/location-list?page=1",
        "from": 1,
        "last_page": 1,
        "last_page_url": "http://development.faveo/v3/api/location-list?page=1",
        "next_page_url": null,
        "path": "http://development.faveo/v3/api/location-list",
        "per_page": 10,
        "prev_page_url": null,
        "to": 4,
        "total": 4,
        "locations": [
            {
                "id": 1,
                "title": "Bangalore",
                "phone": "",
                "address": "",
                "country_id": null,
                "state_id": null,
                "pin_code": null,
                "city": null,
                "created_at": "2020-11-24 12:00:14",
                "updated_at": "2020-11-24 12:00:14"
            },
            {
                "id": 2,
                "title": "Delhi",
                "phone": "",
                "address": "",
                "country_id": null,
                "state_id": null,
                "pin_code": null,
                "city": null,
                "created_at": "2020-11-24 12:00:14",
                "updated_at": "2020-11-24 12:00:14",
            }
        ]
    }
}
Tagged: