API GPS Tracking Software. White Label

Custom event

GET /get_custom_events

Definition

Query String

lang	string Validation default: en	required
user_api_hash	string Validation default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS	required

Responses application/json

200 400 401 500

Schema
Example
expand all

object
items	object	optional
events	object	optional
total	integer Validation {pagination}	optional
per_page	integer Validation {pagination}	optional
current_page	integer Validation {pagination}	optional
last_page	integer Validation {pagination}	optional
from	integer Validation {pagination}	optional
to	integer Validation {pagination}	optional
next_page_url	null string Validation {pagination}	optional
prev_page_url	null string Validation {pagination}	optional
url	string Validation {pagination}	optional
data	string	optional
id	string	optional
user_id	string	optional
protocol	string	optional
conditions	array[object]	optional
tag	string	optional
type	string	optional
tag_value	string	optional
message	string	optional
always	string	optional
tags	array[object]	optional
event_custom_id	string	optional
tag	string	optional
status	integer	optional

{
  "items": {
    "events": {
      "total": 1,
      "per_page": 10,
      "current_page": 1,
      "last_page": 1,
      "next_page_url": null,
      "prev_page_url": null,
      "from": 1,
      "to": 1,
      "data": [
        {
          "id": "1",
          "user_id": "2",
          "protocol": "osmand",
          "conditions": [
            {
              "tag": "speed",
              "type": "2",
              "tag_value": "110"
            }
          ],
          "message": "Message",
          "always": "1",
          "tags": [
            {
              "event_custom_id": "1",
              "tag": "speed"
            }
          ]
        }
      ],
      "url": "/api/get_custom_events"
    }
  },
  "status": 1
}

Schema
Example
expand all

object
status	integer	optional
errors	object	optional

{
  "status": 0,
  "errors": {}
}

Schema
Example
expand all

object
status	integer	optional
error	string	optional

{
  "status": 0,
  "error": "No language selected."
}

Schema
Example
expand all

GET /add_custom_event_data

Definition

Query String

lang	string Validation default: en	required
user_api_hash	string Validation default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS	required

Responses application/json

200 400 401 500

Schema
Example
expand all

object
protocols	array[object]	optional
id	string	optional
value	string	optional
types	array[object]	optional
id	string	optional
value	string	optional
status	integer	optional

{
  "protocols": [
    {
      "id": "adm",
      "value": "adm"
    },
    {
      "id": "apel",
      "value": "apel"
    },
    {
      "id": "aplicom",
      "value": "aplicom"
    },
    {
      "id": "appello",
      "value": "appello"
    }
  ],
  "types": [
    {
      "id": "1",
      "value": "Equals to (=)"
    },
    {
      "id": "2",
      "value": "Greater than (>)"
    },
    {
      "id": "3",
      "value": "Less than (<)"
    }
  ],
  "status": 1
}

Schema
Example
expand all

object
status	integer	optional
errors	object	optional

{
  "status": 0,
  "errors": {}
}

Schema
Example
expand all

object
status	integer	optional
error	string	optional

{
  "status": 0,
  "error": "No language selected."
}

Schema
Example
expand all

POST /add_custom_event

Definition

Query String

lang	string Validation default: en	required
user_api_hash	string Validation default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS	required

Request Body multipart/form-data

schema
Example
expand all

object Validation {customEventPost}
protocol	string	required
message	string	required
tag	array[string]	optional
type	array[integer]	optional
tag_value	array[string]	optional
show_always	integer	optional

Responses application/json

200 400 401 500

Schema
Example
expand all

object Validation {success}
status	integer	optional

Schema
Example
expand all

object
status	integer	optional
errors	object	optional

{
  "status": 0,
  "errors": {}
}

Schema
Example
expand all

object
status	integer	optional
error	string	optional

{
  "status": 0,
  "error": "No language selected."
}

Schema
Example
expand all

GET /edit_custom_event_data

Definition

Query String

lang	string Validation default: en	required
user_api_hash	string Validation default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS	required
custom_event_id	integer	required

Responses application/json

200 400 401 500

Schema
Example
expand all

object
item	object	optional
id	integer	optional
user_id	integer	optional
protocol	string	optional
conditions	array[object]	optional
tag	string	optional
type	string	optional
tag_value	string	optional
message	string	optional
always	integer
protocols	array[object]	optional
id	string	optional
value	string	optional
types	array[object]	optional
id	string	optional
value	string	optional
status	integer	optional

{
  "item": {
    "id": 1,
    "user_id": 2,
    "protocol": "osmand",
    "conditions": [
      {
        "tag": "speed",
        "type": "2",
        "tag_value": "110"
      }
    ],
    "message": "Message",
    "always": 1
  },
  "protocols": [
    {
      "id": "adm",
      "value": "adm"
    },
    {
      "id": "apel",
      "value": "apel"
    },
    {
      "id": "aplicom",
      "value": "aplicom"
    },
    {
      "id": "appello",
      "value": "appello"
    },
    {
      "id": "aquila",
      "value": "aquila"
    },
    {
      "id": "ardi01",
      "value": "ardi01"
    }
  ],
  "types": [
    {
      "id": "1",
      "value": "Equals to (=)"
    },
    {
      "id": "2",
      "value": "Greater than (>)"
    },
    {
      "id": "3",
      "value": "Less than (<)"
    }
  ],
  "status": 1
}

Schema
Example
expand all

object
status	integer	optional
errors	object	optional

{
  "status": 0,
  "errors": {}
}

Schema
Example
expand all

object
status	integer	optional
error	string	optional

{
  "status": 0,
  "error": "No language selected."
}

Schema
Example
expand all

POST /edit_custom_event

Definition

Query String

lang	string Validation default: en	required
user_api_hash	string Validation default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS	required

Request Body multipart/form-data

schema
Example
expand all

object
id	integer Validation {ObjectID}	required
protocol	string Validation {customEventPost}	required
message	string Validation {customEventPost}	required
tag	array[string] Validation {customEventPost}	optional
type	array[integer] Validation {customEventPost}	optional
tag_value	array[string] Validation {customEventPost}	optional
show_always	integer Validation show_always	optional

Responses application/json

200 400 401 500

Schema
Example
expand all

object Validation {success}
status	integer	optional

Schema
Example
expand all

object
status	integer	optional
errors	object	optional

{
  "status": 0,
  "errors": {}
}

Schema
Example
expand all

object
status	integer	optional
error	string	optional

{
  "status": 0,
  "error": "No language selected."
}

Schema
Example
expand all

GET /destroy_custom_event

Definition

Query String

lang	string Validation default: en	required
user_api_hash	string Validation default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS	required
custom_event_id	integer	required

Responses

200 400 401 500

Schema
Example
expand all

object Validation {success}
status	integer	optional

Schema
Example
expand all

object
status	integer	optional
errors	object	optional

{
  "status": 0,
  "errors": {}
}

Schema
Example
expand all

object
status	integer	optional
error	string	optional

{
  "status": 0,
  "error": "No language selected."
}

Schema
Example
expand all

MODEL customEventPost

schema
Example
expand all

object
protocol	string	required
message	string	required
message	array[string]	optional
tag	array[string]	optional
type	array[integer]	optional
tag_value	array[string]	optional
show_always	integer	optional

	Previous
	Alert

Next
Geofence

Platform

Applications

Resources

Company

This website uses cookies.
See our Privacy Policy to learn more.

Welcome

Authentication

Device

Sensor

Service

Event

History

Alert

Custom event

Geofence

Route

Report

Map icon

Driver

Command

GPRS Template

SMS Template

Task

Setup

Platform

Applications

Resources

Company