@datafire/cambase v6.0.0

@datafire/cambase

Client library for Cambase.io

Installation and Usage

npm install --save @datafire/cambase

let cambase = require('@datafire/cambase').create();

.then(data => {
  console.log(data);
});

Description

Cambase.io is a project by Evercam.io in order to make it easier for software developers to have a reliable, up to date source of model hardware information available via a public API.

Actions

api.v1.models.json.get

Fetches all Models

cambase.api.v1.models.json.get({}, context)

Input

• input object
  • page integer: Page number
  • order string: Sort order

Output

Output schema unknown

api.v1.models.json.post

Creates a new Model

cambase.api.v1.models.json.post({
  "vendor_id": "",
  "model[model]": ""
}, context)

Input

• input object
  • vendor_id required string: Vendor ID
  • modelmodel required string: Model
  • modelshape string: Shape
  • modelresolution string: Resolution
  • modelonvif string: ONVIF
  • modelpsia string: PSIA
  • modelptz string: PTZ
  • modelinfrared string: Infrared
  • modelvarifocal string: Varifocal
  • modelsd_card string: SD Card
  • modelupnp string: UPnP
  • modelaudio_in string: UPnP
  • modelaudio_out string: UPnP
  • modeldefault_username string: Default Username
  • modeldefault_password string: Default Password
  • modeljpeg_url string: JPEG URL
  • modelh264_url string: H264 URL
  • modelmjpeg_url string: MJPEG URL

Output

Output schema unknown

api.v1.models.search.json.get

Searches all Models

cambase.api.v1.models.search.json.get({}, context)

Input

• input object
  • page integer: Page number
  • qmodel_cont string: Model
  • qmanufacturer_name_cont string: Vendor
  • qshape_eq string: Shape
  • qresolution_eq string: Resolution
  • qonvif_true string: ONVIF
  • qpsia_true string: PSIA
  • qptz_true string: PTZ
  • qinfrared_true string: Infrared
  • qvarifocal_true string: Varifocal
  • qsd_card_true string: SD Card
  • qupnp_true string: UPnP
  • qaudio_in_true string: Audio In
  • qaudio_out_true string: Audio Out

Output

Output schema unknown

api.v1.models.id.json.get

Fetches a single Model

cambase.api.v1.models.id.json.get({
  "id": 0
}, context)

Input

• input object
  • id required integer: Model ID

Output

Output schema unknown

api.v1.models.id.json.patch

Updates an existing Model

cambase.api.v1.models.id.json.patch({
  "id": "",
  "vendor_id": ""
}, context)

Input

• input object
  • id required string: Model ID
  • vendor_id required string: Vendor ID
  • modelmodel string: Model
  • modelshape string: Shape
  • modelresolution string: Resolution
  • modelonvif string: ONVIF
  • modelpsia string: PSIA
  • modelptz string: PTZ
  • modelinfrared string: Infrared
  • modelvarifocal string: Varifocal
  • modelsd_card string: SD Card
  • modelupnp string: UPnP
  • modelaudio_in string: Audio In
  • modelaudio_out string: Audio Out
  • modeldefault_username string: Default Username
  • modeldefault_password string: Default Password
  • modeljpeg_url string: JPEG URL
  • modelh264_url string: H264 URL
  • modelmjpeg_url string: MJPEG URL

Output

Output schema unknown

api.v1.models.id.json.put

Updates an existing Model

cambase.api.v1.models.id.json.put({
  "id": "",
  "vendor_id": ""
}, context)

Input

• input object
  • id required string: Model ID
  • vendor_id required string: Vendor ID
  • modelmodel string: Model
  • modelshape string: Shape
  • modelresolution string: Resolution
  • modelonvif string: ONVIF
  • modelpsia string: PSIA
  • modelptz string: PTZ
  • modelinfrared string: Infrared
  • modelvarifocal string: Varifocal
  • modelsd_card string: SD Card
  • modelupnp string: UPnP
  • modelaudio_in string: Audio In
  • modelaudio_out string: Audio Out
  • modeldefault_username string: Default Username
  • modeldefault_password string: Default Password
  • modeljpeg_url string: JPEG URL
  • modelh264_url string: H264 URL
  • modelmjpeg_url string: MJPEG URL

Output

Output schema unknown

api.v1.recorders.json.get

Fetches all Recorders

cambase.api.v1.recorders.json.get({}, context)

Input

• input object
  • page integer: Page number
  • order string: Sort order

Output

Output schema unknown

api.v1.recorders.json.post

Creates a new Recorder

cambase.api.v1.recorders.json.post({
  "vendor_id": "",
  "recorder[model]": "",
  "recorder[name]": "",
  "recorder[recorder_type]": ""
}, context)

Input

• input object
  • vendor_id required string: Vendor ID
  • recordermodel required string: Model
  • recordername required string: Name
  • recorderrecorder_type required string: Type
  • recorderresolution string: Resolution
  • recorderonvif string: ONVIF
  • recorderpsia string: PSIA
  • recorderptz string: PTZ
  • recorderdiscontinued string: Discontinued
  • recordersupport_3rdparty string: 3rd pparty Camera Support
  • recordersd_card string: SD Card
  • recorderupnp string: UPnP
  • recorderhot_swap string: Hot Swap
  • recorderhdmi string: HDMI Support
  • recorderdigital_io string: Digital I/O
  • recorderaudio_in string: Audio In
  • recorderaudio_out string: Audio Out
  • recorderinput_channels string: Input Channels
  • recorderplayback_channels string: Playback Channels
  • recorderusb string: USB Ports
  • recordersdhc string: SD Card (GB)
  • recordermobile_access string: Mobile Access
  • recorderalarms string: Alarms
  • recorderraid_support string: Raid Support
  • recorderstorage string: Internal Storage
  • recorderadditional_information string: Additional Information
  • recorderdefault_username string: Default Username
  • recorderdefault_password string: Default Password
  • recorderjpeg_url string: JPEG URL
  • recorderh264_url string: H264 URL
  • recordermjpeg_url string: MJPEG URL
  • recorderofficial_url string: Official URL

Output

Output schema unknown

api.v1.recorders.search.json.get

Searches all Recorders

cambase.api.v1.recorders.search.json.get({}, context)

Input

• input object
  • page integer: Page number
  • qmodel_cont string: Model
  • qvendor_name_cont string: Vendor
  • qsdhc_eq string: SD Card (GB)
  • qtype_eq string: Type
  • qresolution_eq string: Resolution
  • qinput_channels_eq string: Input Channels
  • qplayback_channels_eq string: Playback Channels
  • qonvif_true string: ONVIF
  • qpsia_true string: PSIA
  • qptz_true string: PTZ
  • qsd_card_true string: SD Card
  • qupnp_true string: UPnP
  • qaudio_in_true string: Audio In
  • qaudio_out_true string: Audio Out
  • qhdmi_true string: HDMI Support
  • qhot_swap_true string: Hot Swap
  • qsupport_3rdparty_true string: 3rd pparty Camera Support
  • qdigital_io_true string: Digital I/O

Output

Output schema unknown

api.v1.recorders.id.json.get

Fetches a single Recorder

cambase.api.v1.recorders.id.json.get({
  "id": 0
}, context)

Input

• input object
  • id required integer: Recorder ID

Output

Output schema unknown

api.v1.recorders.id.json.patch

Updates an existing Recorder

cambase.api.v1.recorders.id.json.patch({
  "id": "",
  "vendor_id": "",
  "recorder[model]": "",
  "recorder[name]": "",
  "recorder[recorder_type]": ""
}, context)

Input

• input object
  • id required string: Recorder ID
  • vendor_id required string: Vendor ID
  • recordermodel required string: Model
  • recordername required string: Name
  • recorderrecorder_type required string: Type
  • recorderresolution string: Resolution
  • recorderonvif string: ONVIF
  • recorderpsia string: PSIA
  • recorderptz string: PTZ
  • recorderdiscontinued string: Discontinued
  • recordersupport_3rdparty string: 3rd pparty Camera Support
  • recordersd_card string: SD Card
  • recorderupnp string: UPnP
  • recorderhot_swap string: Hot Swap
  • recorderhdmi string: HDMI Support
  • recorderdigital_io string: Digital I/O
  • recorderaudio_in string: Audio In
  • recorderaudio_out string: Audio Out
  • recorderinput_channels string: Input Channels
  • recorderplayback_channels string: Playback Channels
  • recorderusb string: USB Ports
  • recordersdhc string: SD Card (GB)
  • recordermobile_access string: Mobile Access
  • recorderalarms string: Alarms
  • recorderraid_support string: Raid Support
  • recorderstorage string: Internal Storage
  • recorderadditional_information string: Additional Information
  • recorderdefault_username string: Default Username
  • recorderdefault_password string: Default Password
  • recorderjpeg_url string: JPEG URL
  • recorderh264_url string: H264 URL
  • recordermjpeg_url string: MJPEG URL
  • recorderofficial_url string: Official URL

Output

Output schema unknown

api.v1.recorders.id.json.put

Updates an existing Recorder

cambase.api.v1.recorders.id.json.put({
  "id": "",
  "vendor_id": "",
  "recorder[model]": "",
  "recorder[name]": "",
  "recorder[recorder_type]": ""
}, context)

Input

• input object
  • id required string: Recorder ID
  • vendor_id required string: Vendor ID
  • recordermodel required string: Model
  • recordername required string: Name
  • recorderrecorder_type required string: Type
  • recorderresolution string: Resolution
  • recorderonvif string: ONVIF
  • recorderpsia string: PSIA
  • recorderptz string: PTZ
  • recorderdiscontinued string: Discontinued
  • recordersupport_3rdparty string: 3rd pparty Camera Support
  • recordersd_card string: SD Card
  • recorderupnp string: UPnP
  • recorderhot_swap string: Hot Swap
  • recorderhdmi string: HDMI Support
  • recorderdigital_io string: Digital I/O
  • recorderaudio_in string: Audio In
  • recorderaudio_out string: Audio Out
  • recorderinput_channels string: Input Channels
  • recorderplayback_channels string: Playback Channels
  • recorderusb string: USB Ports
  • recordersdhc string: SD Card (GB)
  • recordermobile_access string: Mobile Access
  • recorderalarms string: Alarms
  • recorderraid_support string: Raid Support
  • recorderstorage string: Internal Storage
  • recorderadditional_information string: Additional Information
  • recorderdefault_username string: Default Username
  • recorderdefault_password string: Default Password
  • recorderjpeg_url string: JPEG URL
  • recorderh264_url string: H264 URL
  • recordermjpeg_url string: MJPEG URL
  • recorderofficial_url string: Official URL

Output

Output schema unknown

api.v1.vendors.json.get

Fetches all Vendors

cambase.api.v1.vendors.json.get({}, context)

Input

• input object
  • page integer: Page number
  • order string: Sort order

Output

Output schema unknown

api.v1.vendors.json.post

Creates a new Vendor

cambase.api.v1.vendors.json.post({
  "vendor[name]": ""
}, context)

Input

• input object
  • vendorname required string: Name
  • vendorinfo string: Info.
  • vendorurl string: Website
  • vendormac string: MAC

Output

Output schema unknown

api.v1.vendors.id.json.get

Fetches a single Vendor

cambase.api.v1.vendors.id.json.get({
  "id": ""
}, context)

Input

• input object
  • id required string: Vendor ID
  • order string: Sort order

Output

Output schema unknown

api.v1.vendors.id.json.patch

Updates an existing Vendor

cambase.api.v1.vendors.id.json.patch({
  "id": ""
}, context)

Input

• input object
  • id required string: Vendor ID
  • vendorname string: Name
  • vendorinfo string: Info.
  • vendorurl string: Website
  • vendormac string: MAC

Output

Output schema unknown

api.v1.vendors.id.json.put

Updates an existing Vendor

cambase.api.v1.vendors.id.json.put({
  "id": ""
}, context)

Input

• input object
  • id required string: Vendor ID
  • vendorname string: Name
  • vendorinfo string: Info.
  • vendorurl string: Website
  • vendormac string: MAC

Output

Output schema unknown

Definitions

This integration has no definitions