vtpl-api

Engine APIs

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.4
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import vtpl_api 

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import vtpl_api

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import vtpl_api
from vtpl_api.rest import ApiException
from pprint import pprint


# Defining host is optional and default to http://v2.videonetics.com:5000
configuration.host = "http://v2.videonetics.com:5000"
# Create an instance of the API class
api_instance = vtpl_api.EnginesApi(vtpl_api.ApiClient(configuration))
where = '{\"eventDetails.engineTaskId\":\"5c1956e925b6b30001103eaa\",\"eventDetails.sourceId\":\"5c1956e925b6b30001103eab\"}' # str | The where clause takes a JSON as a string with one or many properties of the anprEvent model. Example:   * To find anprEvents with engineTaskId equal 5c1956e925b6b30001103eaa, use /anprEvents?where={\"eventDetails.engineTaskId\":\"5c1956e925b6b30001103eaa\"}   * To find anprEvents with engineTaskId equal 5c1956e925b6b30001103eaa and sourceId equal 5c1956e925b6b30001103eab, use /anprEvents?where={\"eventDetails.engineTaskId\":\"5c1956e925b6b30001103eaa\",\"eventDetails.sourceId\":\"5c1956e925b6b30001103eab\"} (optional)
sort = 'sort=-eventDetails.startTimeStamp' # str | The sort query parameter sorts the result set in ascending and desending order by one of the property of the result set. Example:   * To sort anprEvents by startTimeStamp in eventDetails IN ASCEDING order, use /anprEvents?sort=eventDetails.startTimeStamp   * To sort anprEvents by startTimeStamp in eventDetails IN DECENDING order, use /anprEvents?sort=-eventDetails.startTimeStamp   * Please note the - (minus) sign in front of the eventDetails.startTimeStamp, that indicates inverse of ASCENDING (optional)
max_results = maxResults=5 # int | The maxResults query parameter limits results equal to # of maxResults. Example:   * To get latest anprEvent among whole anprEvents, use /anprEvents?maxResults=1   * To limit anprEvents to 5, use /anprEvents?maxResults=5 (optional)
embedded = '{\"eventSnaps\":1}' # str | The embedded clause takes a JSON as a string with eventSnaps argument. Example:   * 'To find anprEvents with eventSnap object. use /anprEvents?embedded={\"eventSnaps\":1}' (optional)

try:
    # Get all anprEvents
    api_response = api_instance.anpr_events_get(where=where, sort=sort, max_results=max_results, embedded=embedded)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnginesApi->anpr_events_get: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://v2.videonetics.com:5000

Class	Method	HTTP request	Description
EnginesApi	anpr_events_get	GET /anprEvents	Get all anprEvents
EnginesApi	anpr_events_id_get	GET /anprEvents/{id}	Get anprEvent by id
EnginesApi	anpr_events_post	POST /anprEvents	Create an anprEvent
EnginesApi	atccs_events_get	GET /atccsEvents	Get all Automatic Traffic Count Events
EnginesApi	atccs_events_id_get	GET /atccsEvents/{id}	Get Automatic Traffic Count Event by id
EnginesApi	atccs_events_post	POST /atccsEvents	Create an Automatic Traffic Count Event
EnginesApi	capabilities_get	GET /capabilities	Get all capabilities of engines
EnginesApi	capabilities_post	POST /capabilities	Create a capability
EnginesApi	central_face_database_get	GET /centralFaceDatabase	Get Central Face Database address
EnginesApi	central_face_database_id_delete	DELETE /centralFaceDatabase/{id}	Delete central face database
EnginesApi	central_face_database_id_get	GET /centralFaceDatabase/{id}	Get central face database by id
EnginesApi	central_face_database_id_patch	PATCH /centralFaceDatabase/{id}	Patch central face database
EnginesApi	central_face_database_post	POST /centralFaceDatabase	Create a centralFaceDatabase address
EnginesApi	clips_get	GET /clips	Get all unprocesed clips
EnginesApi	clips_id_get	GET /clips/{id}	Get clip by id
EnginesApi	clips_post	POST /clips	Create an unprocesed clip
EnginesApi	crowd_abnormality_events_get	GET /crowdAbnormalityEvents	Get all crowdAbnormalityEvents
EnginesApi	crowd_abnormality_events_id_get	GET /crowdAbnormalityEvents/{id}	Get crowdAbnormalityEvent by id
EnginesApi	crowd_abnormality_events_post	POST /crowdAbnormalityEvents	Create a crowdAbnormalityEvent
EnginesApi	crowd_dispersion_events_get	GET /crowdDispersionEvents	Get all crowdDispersionEvents
EnginesApi	crowd_dispersion_events_id_get	GET /crowdDispersionEvents/{id}	Get crowdDispersionEvent by id
EnginesApi	crowd_dispersion_events_post	POST /crowdDispersionEvents	Create a crowdDispersionEvent
EnginesApi	crowd_formation_events_get	GET /crowdFormationEvents	Get all crowdFormationEvents
EnginesApi	crowd_formation_events_id_get	GET /crowdFormationEvents/{id}	Get crowdFormationEvent by id
EnginesApi	crowd_formation_events_post	POST /crowdFormationEvents	Create a crowdFormationEvent
EnginesApi	driver_on_call_events_get	GET /driverOnCallEvents	Get all driverOnCallEvents
EnginesApi	driver_on_call_events_id_get	GET /driverOnCallEvents/{id}	Get driverOnCallEvent by id
EnginesApi	driver_on_call_events_post	POST /driverOnCallEvents	Create a driverOnCallEvent
EnginesApi	engine_tasks_get	GET /engineTasks	Get all engineTasks
EnginesApi	engine_tasks_id_delete	DELETE /engineTasks/{id}	Delete an engine task
EnginesApi	engine_tasks_id_get	GET /engineTasks/{id}	Get engine task by id
EnginesApi	engine_tasks_id_patch	PATCH /engineTasks/{id}	Patch an engine task
EnginesApi	engine_tasks_post	POST /engineTasks	Create an engineTask
EnginesApi	engines_get	GET /engines	Get all engine details
EnginesApi	engines_id_delete	DELETE /engines/{id}	Delete an engine
EnginesApi	engines_id_get	GET /engines/{id}	Get engine by id
EnginesApi	engines_post	POST /engines	Create an engine
EnginesApi	event_snaps_get	GET /eventSnaps	Get all eventSnaps
EnginesApi	event_snaps_id_get	GET /eventSnaps/{id}	Get eventSnap by id
EnginesApi	event_snaps_post	POST /eventSnaps	Create an eventSnap
EnginesApi	face_events_get	GET /faceEvents	Get all faceEvents
EnginesApi	face_events_id_get	GET /faceEvents/{id}	Get faceEvent by id
EnginesApi	face_events_post	POST /faceEvents	Create a faceEvent
EnginesApi	face_snaps_get	GET /faceSnaps	Get all faceSnaps
EnginesApi	face_snaps_post	POST /faceSnaps	Create a faceSnap
EnginesApi	fancy_lp_events_get	GET /fancyLPEvents	Get all Fancy License Plate Events
EnginesApi	fancy_lp_events_id_get	GET /fancyLPEvents/{id}	Get Fancy License Plate Event by id
EnginesApi	fancy_lp_events_post	POST /fancyLPEvents	Create a Fancy License Plate Event
EnginesApi	intrusion_detection_cloud_events_get	GET /intrusionDetectionCloudEvents	Get all intrusionDetectionCloudEvents
EnginesApi	intrusion_detection_cloud_events_id_get	GET /intrusionDetectionCloudEvents/{id}	Get intrusionDetectionCloudEvent by id
EnginesApi	intrusion_detection_cloud_events_post	POST /intrusionDetectionCloudEvents	Create a intrusionDetectionCloudEvent
EnginesApi	intrusion_detection_edge_events_get	GET /intrusionDetectionEdgeEvents	Get all intrusionDetectionEdgeEvents
EnginesApi	intrusion_detection_edge_events_id_get	GET /intrusionDetectionEdgeEvents/{id}	Get intrusionDetectionEdgeEvent by id
EnginesApi	intrusion_detection_edge_events_post	POST /intrusionDetectionEdgeEvents	Create a intrusionDetectionEdgeEvent
EnginesApi	no_helmet_events_get	GET /noHelmetEvents	Get all No Helmet Events
EnginesApi	no_helmet_events_id_get	GET /noHelmetEvents/{id}	Get No Helmet Event by id
EnginesApi	no_helmet_events_post	POST /noHelmetEvents	Create an No Helmet Event
EnginesApi	no_lp_events_get	GET /noLPEvents	Get all No License Plate Events
EnginesApi	no_lp_events_id_get	GET /noLPEvents/{id}	Get No License Plate Event by id
EnginesApi	no_lp_events_post	POST /noLPEvents	Create a No License Plate Event
EnginesApi	no_seat_belt_events_get	GET /noSeatBeltEvents	Get all noSeatBeltEvents
EnginesApi	no_seat_belt_events_id_get	GET /noSeatBeltEvents/{id}	Get noSeatBeltEvent by id
EnginesApi	no_seat_belt_events_post	POST /noSeatBeltEvents	Create a noSeatBeltEvent
EnginesApi	people_collapsing_events_get	GET /peopleCollapsingEvents	Get all peopleCollapsingEvents
EnginesApi	people_collapsing_events_id_get	GET /peopleCollapsingEvents/{id}	Get peopleCollapsingEvent by id
EnginesApi	people_collapsing_events_post	POST /peopleCollapsingEvents	Create a peopleCollapsingEvent
EnginesApi	people_detail_events_get	GET /peopleDetailEvents	Get all peopleDetailEvents
EnginesApi	people_detail_events_id_get	GET /peopleDetailEvents/{id}	Get peopleDetailEvent by id
EnginesApi	people_detail_events_post	POST /peopleDetailEvents	Create a peopleDetailEvent
EnginesApi	people_on_road_events_get	GET /peopleOnRoadEvents	Get all People On Road Events
EnginesApi	people_on_road_events_id_get	GET /peopleOnRoadEvents/{id}	Get People On Road Event by id
EnginesApi	people_on_road_events_post	POST /peopleOnRoadEvents	Create a People On Road Event
EnginesApi	registered_faces_get	GET /registeredFaces	Get Registered Faces
EnginesApi	registered_faces_id_delete	DELETE /registeredFaces/{id}	Delete a Registered Face
EnginesApi	registered_faces_id_get	GET /registeredFaces/{id}	Get Registered Face
EnginesApi	registered_faces_id_patch	PATCH /registeredFaces/{id}	Patch a Registered Face
EnginesApi	registered_faces_post	POST /registeredFaces	Create a Registered Face
EnginesApi	snaps_get	GET /snaps	Get all unprocesed snaps
EnginesApi	snaps_id_get	GET /snaps/{id}	Get snap by id
EnginesApi	snaps_post	POST /snaps	Create a unprocesed snap
EnginesApi	sub_systems_get	GET /subSystems	Get all Sub System details
EnginesApi	sub_systems_id_delete	DELETE /subSystems/{id}	Delete a Sub System
EnginesApi	sub_systems_id_get	GET /subSystems/{id}	Get Sub System by id
EnginesApi	sub_systems_id_patch	PATCH /subSystems/{id}	Patch a Sub System
EnginesApi	sub_systems_post	POST /subSystems	Create a Sub System
EnginesApi	vehicle_congestion_events_get	GET /vehicleCongestionEvents	Get all Vehicle Congestion Events
EnginesApi	vehicle_congestion_events_id_get	GET /vehicleCongestionEvents/{id}	Get Vehicle Congestion Event by id
EnginesApi	vehicle_congestion_events_post	POST /vehicleCongestionEvents	Create a Vehicle Congestion Event

Documentation For Models

• AnprEvent
• AnprEventsResponse
• AtccsEvent
• AtccsEventsResponse
• Attire
• CapabilitiesResponse
• Capability
• CapabilityType
• CentralFaceDatabase
• CentralFaceDatabaseResponse
• Clip
• ClipsResponse
• Color
• Command
• Commands
• Config
• CrowdAbnormalityEvent
• CrowdAbnormalityEventsResponse
• CrowdDispersionEvent
• CrowdDispersionEventsResponse
• CrowdFormationEvent
• CrowdFormationEventsResponse
• DefaultResponse
• DestinationEndPoint
• DestinationEndPointDestinationList
• DestinationType
• DestinationTypeWithCaption
• DriverOnCallEvent
• DriverOnCallEventsResponse
• Engine
• EngineStatusCommand
• EngineTask
• EngineTaskLineSetting
• EngineTaskZoneSetting
• EngineTasksResponse
• EnginesResponse
• Event
• EventDetails
• EventSnapsResponse
• EventType
• EvidenceConfig
• Extra
• FaceCategory
• FaceEvent
• FaceEventWithEventSnaps
• FaceEventWithRegisteredFaceSnaps
• FaceEventsResponse
• FaceEventsWithEventSnapsResponse
• FaceFeatureRequestCommand
• FaceFeatureResponseCommand
• FaceSnap
• FaceSnapWithRegisteredFaceSnaps
• FaceSnapsResponse
• FancyLPEvent
• FancyLPEventsResponse
• Gender
• IntrusionDetectionCloudEvent
• IntrusionDetectionCloudEventsResponse
• IntrusionDetectionEdgeEvent
• IntrusionDetectionEdgeEventsResponse
• Line
• LineType
• Links
• LinksSelf
• LinksSelfSelf
• Meta
• MetaAnprEvent
• MetaAtccsEvent
• MetaCrowdFormationEvent
• MetaDriverOnCallEvent
• MetaFaceEvent
• MetaFancyLPEvent
• MetaNoHelmetEvent
• MetaNoLPEvent
• MetaNoSeatBeltEvent
• MetaPeopleDetailEvent
• MetaPeopleOnRoadEvent
• MetaVehicleCongestionEvent
• NoHelmetEvent
• NoHelmetEventsResponse
• NoLPEvent
• NoLPEventsResponse
• NoSeatBeltEvent
• NoSeatBeltEventsResponse
• PeopleCollapsingEvent
• PeopleCollapsingEventsResponse
• PeopleDetailEvent
• PeopleDetailEventWithSnaps
• PeopleDetailEventWithSnapsResponse
• PeopleDetailEventsResponse
• PeopleOnRoadEvent
• PeopleOnRoadEventsResponse
• RegisteredFace
• RegisteredFaceWithFaceSnaps
• RegisteredFaceWithSnapsResponse
• RegisteredFacesResponse
• ScheduleSource
• Snap
• SnapUploadModel
• SnapsResponse
• SourceEndPoint
• SourceEndPointSourceList
• SourceType
• SourceTypeWithCaption
• SubSystem
• SubSystemStatusCommand
• SubSystemsResponse
• UploadSnap
• VehicleClass
• VehicleCongestionEvent
• VehicleCongestionEventsResponse
• Vertex
• Zone
• ZoneType

Documentation For Authorization

All endpoints do not require authorization.

Author