Skip to end of banner
Go to start of banner

Request Methods

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 16 Next »

SDK service requests simply invoke a standard report, available on all other Galooli platforms, thus ensuring full compatibility between all of our solutions.

Please see below a list of available methods and match reports.

(warning) SDK services do not support detailed reports

(warning) Currently, the SDK tools are unable to provide information about addresses

Assets Report

Method
Assets_Report

Report Name
General Reports - Assets

Description
Asset-based report

Parameter Description

  • Base URL: https://sdk.galooli-systems.com/Json/

  • Request Method: Assets_Report

  • Common Parameters: userName=[MY USER]&password=[MY PASSWORD]

  • Requested Fields: requestedPropertiesStr=[fieldName]

  • Requested Last Gmt Update Time: lastGmtUpdateTime=[YYYY-MM-DD HH:MM:SS]

Unique for the "Asset” report.
By default, when you run the URL of the Asset Report, no date is required, so the measurement starts on 01-01-2000 by default, so you will receive data for all assets, even if they have not been updated.

Sometimes it is not necessary to receive all the units, but only those that have been updated since the last update (i.e. to maintain the "last" status of the units).

The following link provides more information about the "Last GMT Update Time" usage:
Asset Reporting Behavior In The SDK

  • Requested Asset object: requestedUnits=[o/f/g/u ID]

Request Example

https://sdk.galooli-systems.com/Json/Assets_Report?userName=userName=[MY USER]&password=[MY PASSWORD]&requestedPropertiesStr=[fieldName]&lastGmtUpdateTime=[YYYY-MM-DD HH:MM:SS]&requestedUnits=[o/f/g/u ID]

Results Structure

{
  "MaxGmtUpdateTime": "2022-12-25 09:52:29",
  "CommonResult": {
    "ResultDescription": "",
    "ResultCode": 0,
    "DataSet": [
      [
        "1131199",
        "Truck 7",
        "Disconnected"
      ],
      [
        "1131204",
        "Truck 9",
        "Disconnected"
      ]
    ]
  }
}

Summary Report

Method
Summary_Report 

Report Name
General Reports - Summary

Description
Daily accumulated information report

Parameter Description

  • Base URL: https://sdk.galooli-systems.com/Json/

  • Request Method: Summary_Report

  • Common Parameters: userName=[MY USER]&password=[MY PASSWORD]

  • Requested Fields: requestedPropertiesStr=[fieldName]

  • Date and Time Stamp:startDate=[YYYY-MM-DD HH:MM:SS]&endDate=[YYYY-MM-DD HH:MM:SS]

  • Requested Asset Object: requestedUnits=[o/f/g/u ID]

Request Example

https://sdk.galooli-systems.com/Json/Summary_Report?userName=userName=[MY USER]&password=[MY PASSWORD]&requestedPropertiesStr=[fieldName]&startDate=[YYYY-MM-DD HH:MM:SS]&endDate=[YYYY-MM-DD HH:MM:SS]&requestedUnits=[o/f/g/u ID]

Results Structure

{
   "CommonResult":{
      "ResultDescription":"",
      "ResultCode":0,
      "DataSet":[
         [
            "Zimbabwe 2",
            "2022-12-23",
            "2022-12-23",
            "1"
         ],
         [
            "Zimbabwe 2",
            "2022-12-24",
            "2022-12-24",
            "1"    
         ]
      ]
   }
}

Events Report

Method
Events_Report     

Report Name
General Reports - Events

Description
Shows depth information for the selected unit/group/cluster/organization events

Parameter Description

  • Base URL: https://sdk.galooli-systems.com/Json/

  • Request Method: Events_Report

  • Common Parameters: userName=[MY USER]&password=[MY PASSWORD]

  • Requested Fields: requestedPropertiesStr=[fieldName]

  • Date and Time Stamp:startTime=[YYYY-MM-DD HH:MM:SS]&endTime=[YYYY-MM-DD HH:MM:SS]

  • Requested Asset Object: requestedUnits=[o/f/g/u ID]

Request Example

https://sdk.galooli-systems.com/Json/Events_Report?userName=userName=[MY USER]&password=[MY PASSWORD]&requestedPropertiesStr=[fieldName]&startTime=[YYYY-MM-DD HH:MM:SS]&endTime=[YYYY-MM-DD HH:MM:SS]&requestedEvents=any&requestedUnits=[o/f/g/u ID]

Results Structure

{
   "CommonResult":{
      "ResultDescription":"",
      "ResultCode":0,
      "DataSet":[
         [
            "Colombia 2",
            "2022-12-24 12:07:53",
            "Battery Full On Solar",
            ""
         ],
         [
            "Colombia 2",
            "2022-12-24 12:24:53",
            "Battery Full On Solar",
            ""
         ],
         [
            "Colombia 2",
            "2022-12-24 12:45:53",
            "Battery Full On Solar",
            ""
         ]
      ]
   }
}

Trip Report

Method
Trip_Report 

Report Name
Fleet - Trips

Description
Shows trips that are made by the selected unit/group/cluster according to the chosen period

Parameter Description

  • Base URL: https://sdk.galooli-systems.com/Json/

  • Request Method: Trip_Report

  • Common Parameters: userName=[MY USER]&password=[MY PASSWORD]

  • Requested Fields: requestedPropertiesStr=[fieldName]

  • Date and Time Stamp:startTime=[YYYY-MM-DD HH:MM:SS]&endTime=[YYYY-MM-DD HH:MM:SS]

  • Requested Asset object: requestedUnits=[o/f/g/u ID]

Request Example

https://sdk.galooli-systems.com/Json/Trip_Report?userName=[MY USER]&password=[MY PASSWORD]&requestedPropertiesStr=[fieldName]&startDate=[YYYY-MM-DD HH:MM:SS]&endDate=[YYYY-MM-DD HH:MM:SS]&requestedUnits=[o/f/g/u ID]

 Results Structure

{
   "CommonResult":{
      "ResultDescription":"",
      "ResultCode":0,
      "DataSet":[
         [
            "Car14",
            "2022-12-24 12:07:25",
            "2022-12-24 12:08:01",
            "0.08",
            "11",
            "00:00:10",
            "00:00:00"
         ],
         [
            "Car14",
            "2022-12-24 12:18:55",
            "2022-12-24 12:25:50",
            "3.79",
            "20.62",
            "00:04:49",
            "00:00:00"
         ]
      ]
   }
}

POI Trip Report

Method
POI_Trip_Report  

Report Name
Fleet - Geofence Activity

Description
A summary report that provides details of all the interactions of the vehicles with the geofence locations

Parameter Description

  • Base URL: https://sdk.galooli-systems.com/Json/

  • Request Method: Trip_Report

  • Common Parameters: userName=[MY USER]&password=[MY PASSWORD]

  • Requested Fields:requestedPropertiesStr=[fieldName]

  • Date and Time Stamp:startTime=[YYYY-MM-DD HH:MM:SS]&endTime=[YYYY-MM-DD HH:MM:SS]

  • Requested Asset object: requestedUnits=[o/f/g/u ID]

Request Example

https://sdk.galooli-systems.com/Json/Trip_Report?userName=userName=[MY USER]&password=[MY PASSWORD]&requestedPropertiesStr=[fieldName]&startDate=[YYYY-MM-DD HH:MM:SS]&endDate=[YYYY-MM-DD HH:MM:SS]&requestedUnits=[o/f/g/u ID]

Results Structure

{
   "CommonResult":{
      "ResultDescription":"",
      "ResultCode":0,
      "DataSet":[
         [
            "1165932",
            "",
            "2022-12-24 12:07:25",
            "2022-12-24 12:08:01",
            "00:00:36",
            "0.08",
            "",
            ""
         ],
         [
            "1165932",
            "",
            "2022-12-24 12:18:55",
            "2022-12-24 12:25:50",
            "00:06:55",
            "3.79",
            "",
            ""
         ]
      ]
   }
}

Admin POI Report

Method
Admin_POI_Report 

Report Name
System Reports - POI

Description
General information about existing POIs in the selected group/cluster

Parameter Description

  • Base URL: https://sdk.galooli-systems.com/Json/

  • Request Method: Admin_POI_Report

  • Common Parameters: userName=[MY USER]&password=[MY PASSWORD]

  • Requested Fields: requestedPropertiesStr=[fieldName]

Request Example

https://sdk.galooli-systems.com/Json/Admin_POI_Report?userName=[MY USER]&password=[MY PASSWORD]&requestedPropertiesStr=[fieldName]

Results Structure

{
   "CommonResult":{
      "ResultDescription":"",
      "ResultCode":0,
      "DataSet":[
         [
            "TEST",
            "Point",
            "Yes",
            "44.60119891525624",
            "21.87109055034186",
            "Undefined"
         ]
      ]
   }
}

Service Log Report

Method
Service_Log_Report

Report Name
Service Log Report

Description
An overview of all changes made to summary fields data via the service log tool

Parameter Description

  • Base URL: https://sdk.galooli-systems.com/json/

  • Request Method: Service_Log_Report

  • Common Parameters: userName=[MY USER]&password=[MY PASSWORD]

  • Requested Fields: requestedPropertiesStr=[fieldName]

    • The following fields are currently supported:

      • service_log_time_stamp

      • service_log_comment1/2/3

      • service_log_value

      • service_log_edited_fields

      • service_log_update_time

  • Date and Time Stamp: startTime=[YYYY-MM-DD HH:MM:SS]&endTime=[YYYY-MM-DD HH:MM:SS]

  • Requested Asset object: requestedUnits=[o/f/g/u ID]

Request Example

https://sdk.galooli-systems.com/json/Service_Log_Report?userName=[MY USER]&password=[MY PASSWORD]&requestedPropertiesStr=[fieldName]_time&startTime=[YYYY-MM-DD HH:MM:SS]&endTime=[YYYY-MM-DD HH:MM:SS]&requestedUnits=[o/f/g/u ID]

Results Structure

{
    "CommonResult": {
        "ResultDescription": "",
        "ResultCode": 0,
        "DataSet": [
            [
                "2024-07-16",
                "111111 - Test",
                "Vandalism",
                "Approved",
                "2",
                "1",
                "Site Down Time",
                "2024-07-16 12:49:21"
            ],
            [
                "2024-07-16",
                "8000000 TEST GALOOLI",
                "Disconnection - Without Outage",
                "Approved",
                "4.5",
                "8",
                "Site Down Time",
                "2024-07-16 12:50:46"
            ],
            ]
        ]
    }
}
  • No labels