EventsListApi

API для получения всех событий пользователя.

Получение камеры с аналитикой

Получение списка камер по страницам и при необходимости выполнение поиска там, где у пользователя включена аналитика.

NONE

getCamerasWithAnalytics(page: Int, search: String?, completion: (PaginatedResponse<VMSCamera>?, VMSApiError?))

События

Получение меток

Получение списка меток.

CODE

getMarks(page: Int, request: VMSEventsRequest, completion: (PaginatedResponse<VMSEvent>?, VMSApiError?))

Получение событий

Получение списка событий.

CODE

getEvents(page: Int, request: VMSEventsRequest, completion: (PaginatedResponse<VMSEvent>?, VMSApiError?))

Получение событий аналитики

Получение списка событий аналитики.

CODE

getAnalyticEvents(page: Int, request: VMSEventsAnalyticRequest, completion: @escaping (PaginatedResponse<VMSEvent>?, VMSApiError?) -> Void)

Получение кейсов аналитики

Получение всех кейсов определенных типов аналитики. См. StaticsApi для получения всех доступных типов аналитики.

CODE

getAnalyticCases(page: Int, analyticCasesTypes: [String], completion: @escaping (PaginatedResponse<VMSAnalyticCase>?, VMSApiError?) -> Void)

Информация, необходимая для отправки запросов на получение событий

CODE

public struct VMSEventsRequest {
    public let cameraIds: [Int]
    public let types: [String]
    public let sortDirection: VMSSortDirection
    public let timePeriod: VMSEventTimePeriod?
}

types — если вы хотите получить метки, отправьте типы меток. Если вы хотите получить список событий, отправьте типы событий. Дополнительную информацию см. в StaticsApi

timePeriod — период времени, за который вам нужно брать события. Может быть specific или setManualy, в случае setManualy установите даты from и to соответственно

CODE

public struct VMSEventsAnalyticRequest {
    public let eventNames: [String]
    public let caseIds: [Int]
    public let cameraIds: [Int]
    public let analyticEventTypes: [String]
    public let sortDirection: VMSSortDirection
    public let timePeriod: VMSEventTimePeriod?
}

analyticEventTypes — типы событий аналитики. Подробную информацию см. в StaticsApi

eventNames — имя события, которое вы получаете из availableEvents объекта VMSAnalyticCase

timePeriod — период времени, за который вам нужно брать события. Может быть specific или setManualy, в случае setManualy установите даты from и to соответственно

CODE

public enum VMSSortDirection: String {
    case ascending = "asc"
    case descending = "desc"
}