developer notes

Get All Sites By Project

Obtain a comprehensive list of sites filtered by project using the SiteGetAllByProject API. This API supports pagination with parameters such as page, perPage, and startFrom.

Method	API Endpoint
GET	`{{endpoint}}/api/ext/sites`

‍

Headers

‍

Key	Value
Content-Type	`application/json`
Authorization	`Bearer {{token}}`

‍

Filter Fields

‍

Parameter	Type	Example	Required	Description
page	Number	0	true	Specifies the page number
perPage	Number	25	true	Specifies the number of records per page
startFrom	Number	0	true	Specifies the start point of the column being sorted
columnName	String	id	true	Specifies the name of the column being sorted
sortOrder	String	desc/asc	true	Specifies the order in which the column is being sorted
search	String	a	true	Specifies the search query
typeId	Number	1	false	Type ID for filtering
serviceZoneId	Number	2	false	Service Zone ID for filtering
categoryId	Number	1	false	Category ID for filtering
projectId	Number	1	false	Project ID for filtering
geofenceId	Number	1	false	Geofence ID for filtering
customerId	Number	1	false	Customer ID for filtering
origin	String	project	false	Origin information for filtering

‍

API Query Example

‍

Method	API Call
GET	`api/ext/sites?page=1&perPage=10&startFrom=0&columnName=id&sortOrder=desc&search=a&typeId=1&serviceZoneId=1&categoryId=1&projectId=7&geofenceId=1&customerId=1&origin=project`

‍

Example Response

‍

// 200 Response Code 

{
    "total": "6630",
    "count": "3",
    "data": [
        {
            "id": "6644",
            "siteNumber": "ST-006644",
            "siteName": "Site test Hassan",
            "active": "true",
            "customer": "null",
            "geoFence": "null",
            "serviceZone": "null",
            "siteStatus": "null"
        },
        {
            "id": "6643",
            "siteNumber": "ST-006643",
            "siteName": "Site test Hassan",
            "active": "true",
            "customer": "null",
            "geoFence": "null",
            "serviceZone": "null",
            "siteStatus": "null"
        },
        {
            "id": "6642",
            "siteNumber": "ST-006642",
            "siteName": "site",
            "active": "true",
            "customer": {
                "id": "3",
                "name": "1 Load Test [DO NOT DELETE]",
                "email": "null",
                "billingCity": "Sepang",
                "billingCountry": "Malaysia",
                "billingPostcode": "64000",
                "billingState": "Selangor",
                "billingStreet": "Kuala Lumpur International Airport, Kuala Lumpur International Airport",
                "shippingCity": "Sepang",
                "shippingCountry": "Malaysia",
                "shippingPostcode": "64000",
                "shippingState": "Selangor",
                "shippingStreet": "Kuala Lumpur International Airport, Kuala Lumpur International Airport",
                "billingLatitude": "2.7542289",
                "billingLongitude": "101.7043235",
                "phone": "null",
                "geoFence": "null",
                "systemUsed": "null",
                "isDeleted": "N",
                "customerSfExternalId": "null",
                "customerExternalId": "null",
                "shippingLatitude": "2.7542289",
                "shippingLongitude": "101.7043235",
                "serviceZone": {
                    "createdBy": "load.test1@trial.custella.com",
                    "createdDate": "2023-05-04T13:11:53Z",
                    "lastModifiedBy": "load.test1@trial.custella.com",
                    "lastModifiedDate": "2023-05-04T13:11:53Z",
                    "id": "5",
                    "name": "Selangor",
                    "isDefault": "false",
                    "active": "true",
                    "order": "0",
                    "code": "Selangor",
                    "label": "Selangor",
                    "systemValue": "false"
                },
                "categoryType": "null",
                "contactPersonName": "null",
                "customerReferenceNo": "null"
            },
            "geoFence": "null",
            "serviceZone": "null",
            "siteStatus": "null"
        }
    ],
    "recordsTotal": "6630",
    "recordsFiltered": "6630",
    "status": "HAS_DATA"
}