Search locations by below given query parameters

GETSearch locations by below given query parameters

Response of this API includes the details about location coordinates, evse in that location and connector details of that evse. This API can be used to get the evse/connector details which are needed to create a start charging command request to trigger charging.

We can filter the locations by parameters passed in the query string for the below api.

URLhttps://api-gateway-evnnovator.com/api/v1/locations/search

Query Parameters

Namelongitude
Data Typenumber($double)
Variable TypeOptional
DescriptionLongitude values of selected current location by EV Driver
Namelatitude
Data Typenumber($double)
Variable TypeOptional
Descriptionlatitude values of selected current location by EV Driver
Namedistance
Data TypeString
Variable TypeOptional
DescriptionDistance to be covered based on the Input Latitude and Longitude value
Namepower_type
Data TypeString
Variable TypeOptional
DescriptionPower type of the EV Charger. This value could be AC_1_PHASE, AC_3_PHASE and DC
Namestandard
Data TypeString
Variable TypeOptional
DescriptionThe standard of the EV Charger’s connector . Sample values are IEC_62196_T1_COMBO , IEC_62196_T2 and IEC_62196_T2_COMBO etc.
Namestatus
Data TypeString
Variable TypeOptional
DescriptionIndicates the current status of the EVSE. Sample values are AVAILABLE, BLOCKED and CHARGING etc
Namesort_by
Data TypeString
Variable TypeOptional
Description
Namesearch-text
Data TypeString
Variable TypeOptional
DescriptionFree Search Text Field

Sample Request and Response

GET https://api-gateway-evnnovator.com/api/ocpi/api/v1/locations/search?party_id=TCZ&country_code=IN&sort_by=lastModifiedDate&search-text=GJ

Response Json :

{
    "content": [
        {
            "coordinates": {
                "latitude": 28.457523,
                "longitude": 77.026344
            },
            "evses": [
                {
                    "id": "019710d7ec0a66a0063ec9234f17659e",
                    "uid": "55B39FEC-3449-48D1-B46E-B29F726DBE7C",
                    "evse_id": "IN*TCZ*1",
                    "status": "AVAILABLE",
                    "connectors": [
                        {
                            "id": "e5ca60e2b0af2747b5f2077de117e6a4",
                            "standard": "IEC_60309_2_three_16",
                            "format": "SOCKET",
                            "power_type": "AC_1_PHASE",
                            "voltage": 0,
                            "amperage": 0,
                            "tariff_id": "20024"
                        },
                        {
                            "id": "a81e0a5745c397c59c11131b55860876",
                            "standard": "IEC_60309_2_three_16",
                            "format": "SOCKET",
                            "power_type": "AC_1_PHASE",
                            "voltage": 0,
                            "amperage": 0,
                            "tariff_id": "20024"
                        },
                        {
                            "id": "555be295326f43a77256258e015d0fd4",
                            "standard": "IEC_60309_2_three_16",
                            "format": "SOCKET",
                            "power_type": "AC_1_PHASE",
                            "voltage": 0,
                            "amperage": 0,
                            "tariff_id": "20024"
                        }
                    ],
                    "floor_level": "ONE"
                },
                {
                    "id": "e27e60fda59fa4ac2802c6df28718346",
                    "uid": "E247C304-9E72-4531-AB8D-08DC295B5E32",
                    "evse_id": "IN*TCZ*1",
                    "status": "AVAILABLE",
                    "connectors": [
                        {
                            "id": "f09faea1cdf7c92b6d2c1608c02466c5",
                            "standard": "IEC_60309_2_three_16",
                            "format": "SOCKET",
                            "power_type": "AC_1_PHASE",
                            "voltage": 0,
                            "amperage": 0,
                            "tariff_id": "20028"
                        }
                    ],
                    "floor_level": "ONE"
                },
                {
                    "id": "b7e12fee28aee10b87ad52bcce0a59e6",
                    "uid": "A7CEFECC-313A-4554-877B-C3F8811AB8E7",
                    "evse_id": "IN*TCZ*1",
                    "status": "AVAILABLE",
                    "connectors": [
                        {
                            "id": "a75bc6b495119cb5ca93ee6fe2504107",
                            "standard": "IEC_60309_2_three_16",
                            "format": "SOCKET",
                            "power_type": "AC_1_PHASE",
                            "voltage": 0,
                            "amperage": 0,
                            "tariff_id": "20023"
                        },
                        {
                            "id": "0311253df2b61f5f2b5e986c7ba2af16",
                            "standard": "IEC_60309_2_three_16",
                            "format": "SOCKET",
                            "power_type": "AC_1_PHASE",
                            "voltage": 0,
                            "amperage": 0,
                            "tariff_id": "20023"
                        },
                        {
                            "id": "f742b15074545425a2ebafc7639319cd",
                            "standard": "IEC_60309_2_three_16",
                            "format": "SOCKET",
                            "power_type": "AC_1_PHASE",
                            "voltage": 0,
                            "amperage": 0,
                            "tariff_id": "20023"
                        }
                    ],
                    "floor_level": "ONE"
                },
                {
                    "id": "3d2542dc29da4512d061391db6a18377",
                    "uid": "F17195C3-7028-446A-B51D-B114FCAA7416",
                    "evse_id": "IN*TCZ*2",
                    "status": "AVAILABLE",
                    "connectors": [
                        {
                            "id": "3fdb36393efc724e179123693f1eac8f",
                            "standard": "IEC_60309_2_three_16",
                            "format": "CABLE",
                            "power_type": "AC_3_PHASE",
                            "voltage": 230,
                            "amperage": 16,
                            "tariff_id": "30119"
                        },
                        {
                            "id": "981fbad5d79c906a457c17b697cb3fe0",
                            "standard": "IEC_60309_2_three_16",
                            "format": "CABLE",
                            "power_type": "AC_3_PHASE",
                            "voltage": 230,
                            "amperage": 16,
                            "tariff_id": "30119"
                        }
                    ],
                    "floor_level": "ONE"
                },
                {
                    "id": "c3c210d715a1ff993dfff17583d6c14a",
                    "uid": "C6F821AF-9A2F-4833-AEC2-0A6E238968E1",
                    "evse_id": "IN*TCZ*2",
                    "status": "AVAILABLE",
                    "connectors": [
                        {
                            "id": "174787a373e815ae96d32db9271d7353",
                            "standard": "IEC_60309_2_three_16",
                            "format": "SOCKET",
                            "power_type": "AC_1_PHASE",
                            "voltage": 230,
                            "amperage": 16,
                            "tariff_id": "20078"
                        }
                    ],
                    "floor_level": ""
                },
                {
                    "id": "0a09fc5b643072dfc624d411cd4a388d",
                    "uid": "A5D8FA18-8B30-4FE3-A348-2BE93D9F43F4",
                    "evse_id": "IN*TCZ*2",
                    "status": "AVAILABLE",
                    "connectors": [
                        {
                            "id": "bd3e2326dc4484e9882bb79083ddca85",
                            "standard": "IEC_60309_2_three_16",
                            "format": "CABLE",
                            "power_type": "AC_3_PHASE",
                            "voltage": 230,
                            "amperage": 16,
                            "tariff_id": "2"
                        }
                    ],
                    "floor_level": "ONE"
                },
                {
                    "id": "4f1d51a9a3c7997abdb816f9eca3f5f6",
                    "uid": "4F6C1405-BC5F-4821-BB9E-4B9412CF5FFA",
                    "evse_id": "IN*TCZ*2",
                    "status": "AVAILABLE",
                    "connectors": [
                        {
                            "id": "713f81ab168658cb975f89d91513017d",
                            "standard": "IEC_60309_2_three_16",
                            "format": "SOCKET",
                            "power_type": "AC_1_PHASE",
                            "voltage": 230,
                            "amperage": 16,
                            "tariff_id": "20081"
                        },
                        {
                            "id": "7b2712deeb836f9a70b1d5e57d6ea783",
                            "standard": "IEC_60309_2_three_16",
                            "format": "SOCKET",
                            "power_type": "AC_1_PHASE",
                            "voltage": 230,
                            "amperage": 16,
                            "tariff_id": "20081"
                        }
                    ],
                    "floor_level": "ONE"
                },
                {
                    "id": "09032c50fce97ccab349ac8091a16192",
                    "uid": "089C1A72-05E7-4057-97F3-EE41CFDBF733",
                    "evse_id": "IN*TCZ*2",
                    "status": "AVAILABLE",
                    "connectors": [
                        {
                            "id": "ce3bd82963e62af6e35022c2f1a56d8a",
                            "standard": "IEC_60309_2_three_16",
                            "format": "SOCKET",
                            "power_type": "AC_1_PHASE",
                            "voltage": 230,
                            "amperage": 16,
                            "tariff_id": "20032"
                        },
                        {
                            "id": "7803649b3b8a873579551c922be65c29",
                            "standard": "IEC_60309_2_three_16",
                            "format": "SOCKET",
                            "power_type": "AC_1_PHASE",
                            "voltage": 230,
                            "amperage": 16,
                            "tariff_id": "20032"
                        },
                        {
                            "id": "ea5db5595b0e5e2101b9759960a6af32",
                            "standard": "IEC_60309_2_three_16",
                            "format": "SOCKET",
                            "power_type": "AC_1_PHASE",
                            "voltage": 230,
                            "amperage": 16,
                            "tariff_id": "20032"
                        }
                    ],
                    "floor_level": "ONE"
                }
            ],
            "id": "2b10508db844fada81778c8b1bce853e",
            "created_date": "2022-03-11T07:28:42.458+00:00",
            "last_modified_date": "2022-03-25T10:00:39.081+00:00",
            "location_id": "D5F5E912-CD27-49D5-8586-FB93CA65A134",
            "cpo_id": "1152ba0c0ff2057084051747267b49fd",
            "cpo_resource_id": "59371e3bef3cb74f510fed1e102b6737",
            "type": "PARKING_TOP",
            "name": "GJ | Vadodara | Charge+Zone Office2",
            "address": "401, Benison Complex, Opp. Shiv Mahal Palace, Old Padra Rd, Vadodara, Gujarat 390007",
            "city": "Vadodara",
            "postal_code": "123458",
            "country": "IND",
            "time_zone": "IST",
            "charging_when_closed": false,
            "last_modified_by": "admin",
            "rating": 0.0,
            "country_code": "IN",
            "party_id": "TCZ",
            "publish": true
        },
        {
            "coordinates": {
                "latitude": 22.0535,
                "longitude": 73.1202
            },
            "evses": [
                {
                    "id": "a7bb3ee3fbbae5c01787778098076129",
                    "uid": "36E41AFD-F583-46AB-9CA0-3803AA8074E1",
                    "evse_id": "IN*TCZ*20035",
                    "status": "AVAILABLE",
                    "connectors": [
                        {
                            "id": "5ab8cae9a07114e2de3a055dad3a2ea6",
                            "standard": "IEC_62196_T2_COMBO",
                            "format": "SOCKET",
                            "power_type": "DC",
                            "voltage": 230,
                            "amperage": 16,
                            "tariff_id": ""
                        },
                        {
                            "id": "dadd2d6f4acbf169ac7e865a6df06a1c",
                            "standard": "IEC_62196_T2_COMBO",
                            "format": "SOCKET",
                            "power_type": "DC",
                            "voltage": 230,
                            "amperage": 16,
                            "tariff_id": ""
                        }
                    ],
                    "floor_level": "ONE"
                }
            ],
            "id": "40de1813c36c701c579ec85f7fb60661",
            "created_date": "2022-03-22T06:49:36.420+00:00",
            "last_modified_date": "2022-03-25T10:00:38.987+00:00",
            "location_id": "F98662ED-D95B-4C56-9CBB-663B40BFB55A",
            "cpo_id": "1152ba0c0ff2057084051747267b49fd",
            "cpo_resource_id": "59371e3bef3cb74f510fed1e102b6737",
            "type": "PARKING_TOP",
            "name": "GJ | A'bad | Ahd-Mumbai - NH1",
            "address": "Zydus Hospital Rd, Thaltej,  Ahmedabad, Gujarat 380054",
            "city": "Ahmedabad",
            "postal_code": "123458",
            "country": "IND",
            "time_zone": "IST",
            "charging_when_closed": false,
            "last_modified_by": "admin",
            "rating": 0.0,
            "country_code": "IN",
            "party_id": "TCZ",
            "publish": true
        }
    ],
    "pageable": {
        "sort": [
            {
                "direction": "ASC",
                "property": "lastModifiedDate",
                "ignoreCase": false,
                "nullHandling": "NATIVE",
                "ascending": true,
                "descending": false
            }
        ],
        "pageNumber": 0,
        "pageSize": 10,
        "offset": 0,
        "paged": true,
        "unpaged": false
    },
    "totalElements": 18,
    "totalPages": 2,
    "last": false,
    "first": true,
    "sort": [
        {
            "direction": "ASC",
            "property": "lastModifiedDate",
            "ignoreCase": false,
            "nullHandling": "NATIVE",
            "ascending": true,
            "descending": false
        }
    ],
    "numberOfElements": 2,
    "size": 10,
    "number": 0,
    "empty": false
}

Response

CodeDescription
200OK
401Unauthorized
403Forbidden
404Not Found

Powered by BetterDocs