VCC Data Models for use with Third Party Integrations

01/10/2024 5:03 pm EST

Summary

This describes the data model third party software should use to pass data in to Video Control Center.  

This data model can be found in the DevOps BoldGroupNuget package under the VideoControlCenter.Models NuGet.


Data Classes

When sending this data model to VCC, everything follows from the VccVideoRequest class.  This is the class that should be serialized to JSON or XML and passed to VCC.

VccVideoRequest

Base Class for all data to be send to VCC.

Members

  • Operator
    • Required
    • Type: VccOperator class
    • Description: The operator making the request
  • Customer
    • Required 
    • Type: VccCustomer class
    • Description: The alarm customer related to the request
  • Alarm
    • Optional
    • Type: VccAlarm class
    • Description: The alarm information related to the request
  • Search
    • Optional
    • Type: VccSearch class
    • Description: The search results related to the request
  • Devices
    • Optional
    • Type: List<VccDevice>
    • Description: The devices releated to the request
  • Containers
    • Optional
    • Type: List<VccContainer>
    • Description: The containers related to the request
  • Binaries
    • Optional
    • Type: List<VccBinary>
    • Description: The binaries related to the request
  • Message
    • Optional
    • Type: VccMessage class
    • Description: The message associated with the request


VccOperator

Represents an alarm operator

Members

  • Id 
    • Not Currently Used
    • Type: string
    • Description: The operator ID
  • Name 
    • Conditional 
      • Only used when launching the Sureview external viewer. 
      • Not used otherwise.
    • Type: string
    • Description: The operator's username to use with external players
  • Password 
    • Conditional
      • Only used for launching Sureview external viewer.
      • Not used otherwise.
    • Type: string
    • Description: The operator's password to use with external players
  • Extension
    • Conditional
      • Only used for one specific Manitou customer for their external viewer. 
      • Not used otherwise.
    • Type: string
    • Description: The operator's phone extension to use with external players
  • TranslationStrings 
    • Only used with Advanced Integration.
      • This is passed in only using Advanced Integration with a separate message to inform VCC of user information.
    • Type: Dictionary<string, string>
    • Description: User's translation strings for localization.


VccCustomer

Represents an alarm customer for VCC.

Members

  • SerialNo
    • Required
    • Type: int
    • Description: The unique numeric identifier for the customer
      • Used for associating videos with a customer.
  • CustomerId
    • Required 
    • Type: string
    • Description: The unique display identifier for the customer
      • Used for associating videos with a customer
  • Name
    • Required
    • Type: string
    • Description: The customer's name
      • Used for associating videos with a customer
  • TimezoneOffset 
    • Required
    • Type: int
    • Description: The offset (in minutes) from GMT for the customer
  • VideoDateTime
    • Required
    • Type: DateTime
    • Description: Date and time for the video
      • Used in video card title text.
  • DateFormat (optional) (Only used for Manitou legacy video types.)
    • Optional
      • Only used for Manitou legacy video types.
      • Not used for native VCC video.
    • Type: string
    • Description: A format mask to be used for displaying dates for this customer


VccAlarm

Represents an alarm that is reported to the VCC

Members

  • AlarmNo
    • Required
    • Type: int
    • Description: The alarm number (unique identifier)
      • Used for associating videos with a specific alarm.
  • UtcAlarmTime 
    • Optional
    • Type: DateTime
    • Description: The timestamp of the alarm in UTC time
      • Used for labeling alarm video headers with the alarm time
      • Uses time now if excluded.
  • TimezoneOffset
    • Optional
      • Only used for Manitou legacy video types.
      • Not used for native VCC video types.
    • Type: int
    • Description: The number of minutes offset the customer is from UTC
  • EventCodeId
    • Optional
    • Type: string
    • Description: The event code of the alarm
      • Used in:
        • Labeling alarm video
        • Displaying external Pelco video
        • Logging back to automation (for Advanced Integration)
  • EventCategory
    • Optional
    • Type: string
    • Description: The event category of the alarm
      • Used in logging back to automation (for Advanced Integration)
  • EventName 
    • Optional
    • Type: string
    • Description: The name of the event
      • Used in:
        • Labeling alarm video
        • Displaying external Pelco video
        • Logging back to automation (for Advanced Integration)
  • EventArea
    • Optional
    • Type: string
    • Description: The area in which the alarm occurred
      • Used in:
        • Labeling alarm video
        • Displaying external Pelco video
        • Logging back to automation (for Advanced Integration)
  • EventZone
    • Optional
    • Type: string
    • Description: The zone in which the alarm occurred
      • Used in:
        • Labeling alarm video
        • Displaying external Pelco video
        • Logging back to automation (for Advanced Integration)
  • EventSensor 
    • Required
    • Type: string
    • Description: The sensor which triggered the alarm
      • Used in:
        • Associating video to a specific alarm
        • Labeling alarm video
        • Logging back to automation (for Advanced Integration)
  • LogSequence
    • Required
    • Type: int
    • Description: The sequence number of the activity log which represents this alarm
      • Used in associating video to a specific alarm
  • PreTime 
    • Not Used
    • Type: int
    • Description: The pre-alarm time
  • PostTime
    • Not Used
    • Type: int
    • Description: The post-alarm time
  • SystemNo
    • Optional
    • Type: int
    • Description: The system number of the customer on which the alarm occurred
      • Used in logging information back to automation (for Advanced Integration)
  • TransitterNo
    • Optional
    • Type: string
    • Description: The transmitter No the reported the alarm
      • Used in logging information back to automation (for Advanced Integration)
  • TransmitterId
    • Conditional
      • Only used for one specific Manitou customer
      • Not used otherwise.
    • Type: string
    • Description: The transmitter Id the reported the alarm
  • TransmiterVideoType 
    • Conditional
      • Only used for launching alarm video using the Sureview external viewer
    • Type: string
    • Description: The video type of the video for the alarm
  • ReceiverLinePrefix 
    • Not Used
    • Type: string
    • Description: The receiver line prefix of the reporting receiver line
  • TransmitterTypeId
    • Not Used
    • Type: string
    • Description: The transmitter type ID
  • Tag
    • Conditional
      • Only used for launching alarm video using the Sureview external viewer.
    • Type: string
    • Description: A unique tag for the alarm


VccSearch

Represents a search query

Members

  • SearchFrom 
    • Required
    • Type: DateTime
    • Description: The starting date of the search)
  • SearchTo
    • Required
    • Type: DateTime
    • Description: The ending date of the search


VccDevice

Members

  • SerialNo 
    • Required
    • Type: int
    • Description: The numeric unique identifier for this device
      • Used in:
        • Identifying and labeling device video
        • Exporting reference images to automation (Advanced Integration)
        • Logging information back to automation (Advanced Integration)
  • DeviceId
    • Required
    • Type: string
    • Description: The displayed unique identifier for this device
      • Used in:
        • Identifying and labeling device video
        • Exporting reference images to automation (Advanced Integration)
        • Logging information back to automation (Advanced Integration)
  • UnitId (conditional) (only used for one specific Manitou customer. Not used otherwise)
    • Conditional
      • Only used for one specific Manitou customer.
      • Not used otherwise.
    • Type: string
    • Description: The unit ID for this device
  • UnitSubId 
    • Conditional
      • Only used for one specific Manitou customer.
      • Not used otherwise.
    • Type: string
    • Description: The unit SubID for this device
  • SystemNo
    • Required
    • Type: int
    • Description: The system number in which this device exists
      • Used in:
        • Identifying and labeling device video
        • Exporting reference images to automation (Advanced Integration)
        • Logging information back to automation (Advanced Integration)
  • TransmitterId (required) (Used in identifying device video, and logging information back to automation)
    • Required
    • Type: string
    • Description: The transmitter ID associated with this device
      • Used in:
        • Identifying device video
        • Logging information back to automation (Advanced Integration)
  • TransmitterNo
    • Required
    • Type: string
    • Description: The transmitter No associated with this device
      • Used in:
        • Identifying and labeling device video
        • Exporting reference images to automation (Advanced Integration)
        • Logging information back to automation (Advanced Integration)
  • TransmitterDescription
    • Not Used
    • Type: string
    • Description: The transmitter description associated with this device
  • Area
    • Optional
    • Type: string
    • Description: The area for this device
      • Used in labeling device video
  • Zone
    • Optional
    • Type: string
    • Description: The zone for this device
      • Used in labeling device video
  • Description
    • Optional
    • Type: string
    • Description: The description of this device
      • Used in labeling device video
  • Address (required) (Network address or identifier of camera to connect to)
    • Required
    • Type: string
    • Description: The address of this device
      • Depending on device type: 
        • IP address or
        • Web Address or
        • Site identifier
      • See VCC Video Device Integrations for more information on setting up particular video types.
  • Options
    • Required
    • Type: string
    • Description: The options string for this device
      • Camera specific options for connecting to a camera.
        • e.g. username, password, ports, camera name, etc.
        • See VCC Video Device Integrations for options strings for particular video types.
  • AlarmNo
    • Not Used
    • Type: int
    • Description: The alarm number for this device
  • DeviceType 
    • Required
    • Type: VccDeviceType enum
    • Description: The type of this device
      • Typically, will be one of:
        • Camera
        • VideoSequence
        • Container
  • MediaType
    • Required
    • Type: string
    • Description: The media type of this device
      • See VCC Video Device Integrations for details for particular video types.
  • BjsData
    • Conditional
      • Used only for legacy Manitou video types
      • Not used otherwise.
    • Type: byte[]
    • Description: A Bold Javascript binary to use when displaying this device
  • Disabled
    • Required
    • Type: bool
    • Description: True if this device is disabled
      • VCC will not display video devices tagged as disabled.


VccContainer

Represents a container of multiple devices

Members

  • ContainerId
    • Required
    • Type: string
    • Description: The unique identifier of the container
  • SubContainers 
    • Optional
    • Type: List<VccContainer>
    • Description: The list of containers contained by this container
  • Devices
    • Optional
    • Type: List<VccDevice>
    • Description: The list of devices contained by this container


VccBinary

Represents a binary object to be displayed by the VCC

Members

  • BinaryType (required) (String describing media type. e.g. jpg, mpg, etc.)
    • Required
    • Type: string
    • Description: The type of binary data
      • jpg
      • mpg
      • etc.
  • BinaryData
    • Required
    • Type: byte[]
    • Description: The physical binary data
  • EvDate
    • Required
    • Type: DateTime
    • Description: The event date to which this binary data applies
  • FrameNumber 
    • Optional
    • Type: int
    • Description: If this binary data is a frame of video, this specifies the frame number
  • FrameSize 
    • Required
    • Type: int
    • Description: The size of the frame
  • AvFormat 
    • Required
    • Type: VccAudioVideoFormat enum
    • Description: The format of this binary data
  • Activity
    • Optional
    • Type: VccActivity class
    • Description: The activity log information related to this binary content


VccMessage

Represents a message to the VCC

Currently only supports:


    • Notification that VCC should close alarm video currently being viewed
    • Additional binary log data (Advanced Integration)

Members

  • MesageType 
    • Required
    • Type: VccMessageType enum
    • Description: The type of the message
  • MessageText 
    • Not currently used
    • Type: string
    • Description: The text of the message


VccActivity

Represents an customer activity entry

Members

  • DateTime
    • Required
    • Type: DateTime
    • Description: The activity timestamp
  • UtcTime
    • Required
    • Type: DateTime
    • Description: The activity UTC timestamp
  • EventNo
    • Required
    • Type: int
    • Description: The activity event number
  • SerialNo
    • Required
    • Type: int
    • Description: The event serial number
  • Sequence
    • Required
    • Type: int
    • Description: The sequence number of the activity (allows grouping of events to an event number)
  • BinaryObjectType
    • Required
    • Type: string
    • Description: The binary type of the activity
  • Text
    • Required
    • Type: string
    • Description: The description of the activity
Was this article helpful?
Thank you for your feedback!
User Icon

Thank you! Your comment has been submitted for approval.

Copyright © 2024-26 Bold Group All rights reserved.