Notifications

Get list of Notification

Query Parameters

category string required

Category of notification. GENERAL | DRIVER_BEHAVIOR | ADAS | DMS

startDate date-time required

Format ISO (2000-12-31T00:00:00.000Z) in UTC+07 Timezone

endDate date-time required

Format ISO (2000-12-31T00:00:00.000Z) in UTC+07 Timezone

licensePlate string required

Can be added multiple times

limit string

Limit of data shown in a page. Default is 10

page string

Page of data shown. Default is 1

Responses

• 200
• 400
• 401

---

Success

application/json

Schema

Example (from schema)

With data

---

Schema

message string
metadata object
page number
count number
total_count number
total_page number
data object
paginated_result object[]
Array [
alertType string
alertCode number
date string
latitude number
longitude number
licensePlate string
driverName string
geolocation string
threshold string
actual string
image string[]
video string[]
]
ids number[]

{
  "message": "string",
  "metadata": {
    "page": 0,
    "count": 0,
    "total_count": 0,
    "total_page": 0
  },
  "data": {
    "paginated_result": [
      {
        "alertType": "string",
        "alertCode": 0,
        "date": "string",
        "latitude": 0,
        "longitude": 0,
        "licensePlate": "string",
        "driverName": "string",
        "geolocation": "string",
        "threshold": "string",
        "actual": "string",
        "image": [
          "string"
        ],
        "video": [
          "string"
        ]
      }
    ],
    "ids": [
      0
    ]
  }
}

{
  "message": "Success",
  "metadata": {
    "count": 1,
    "page": 1,
    "total_count": 1,
    "total_page": 1
  },
  "data": {
    "paginated_result": [
      {
        "alertType": "Exceeded Idle Time",
        "alertCode": 1,
        "date": "2023-04-14T07:12:00.000Z",
        "latitude": -7.2688883,
        "longitude": 112.7502666,
        "licensePlate": "L 123 TES",
        "driverName": "Budi",
        "geolocation": [
          "Monas",
          "Gelora Bung Karno"
        ],
        "threshold": "60 min",
        "actual": "960 min",
        "image": [
          "https://example.com/image.png"
        ],
        "video": [
          "https://example.com/video.mp4"
        ]
      }
    ]
  },
  "ids": [
    1
  ]
}

Bad Request

application/json

Schema

Example (from schema)

Expired Token

Bad Token

---

Schema

code string
message string
detail string

{
  "code": "string",
  "message": "string",
  "detail": "string"
}

{
  "code": "E-V1/1-03",
  "message": "An error occurred while executing query",
  "detail": "Context creation failed: jwt expired"
}

{
  "code": "E-V1/1-03",
  "message": "An error occurred while executing query",
  "detail": "Context creation failed: jwt malformed"
}

Unauthorized Request

application/json

Schema

Example (from schema)

Example

---

Schema

code string
message string

{
  "code": "string",
  "message": "string"
}

{
  "code": "E-G1/1-01",
  "message": "Authentication token is required"
}

Loading...