Online Collect Data

When the access control device is connected to the client software or platform via the network, you can collect data (including ID card information, card information, face data, and fingerprint) on the client software or platform remotely. The online collected data will be uploaded to the client software or platform in real time.

  • Make sure you have called NET_DVR_Init to initialize the development environment.

  • Make sure you have called NET_DVR_Login_V40 to log in to the device.

Figure 1 Programming Flow of Online Collecting Data

  1. Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/AccessControl/capabilities for getting the access control capability to check whether the device supports configuring online data collection rules.

    The access control capability is returned in XML_Cap_AccessControl by lpOutputParam.

    If the device supports, the node <isSupportCaptureRule> is returned in the capability message and its value is "true", and then you can perform the following steps.

    Otherwise, rule configuration of online data collection is not supported, please end this task.

  2. Configure online data collection rules.
    1. Optional: Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/AccessControl/CaptureRule/capabilities?format=json for getting the configuration capability of online data collection rules.

      The capability is returned in the message JSON_CaptureRuleCap by lpOutputParam.

    2. Optional: Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/AccessControl/CaptureRule?format=json for getting default or configured rule parameters of online data collection for reference.

      The rule parameters are returned in the message JSON_CaptureRule by lpOutputParam.

    3. Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/AccessControl/CaptureRule?format=json and set lpInputParam to JSON_CaptureRule for setting rule parameters of online data collection.
  3. Optional: Configure preset parameters of online data collection.
    1. Check the access control capability XML_Cap_AccessControl to know whether the device supports configuring preset parameters of online data collection.

      If the device supports, the node <isSupportCapturePresetParam> is in the capability message and its value is "true", and then you can continue to set preset parameters.

      Otherwise, preset configuration of online data collection is not supported.

    2. Optional: Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/AccessControl/CapturePresetParam/capabilities?format=json for getting the configuration capability of preset parameters of online data collection.

      The configuration capability is returned in the message JSON_CapturePresetCap by lpOutputParam.

    3. Optional: Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/AccessControl/CapturePresetParam?format=json for getting default or configured preset parameters of online data collection for reference.

      The preset parameters are returned in the message JSON_CapturePreset by lpOutputParam.

    4. Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/AccessControl/CapturePresetParam?format=json and set lpInputParam to the message JSON_CapturePreset for setting preset parameters of online data collection.
    Note:

    The preset parameters are used to display custom information on the device UI during data collection. Currently, it only supports displaying the name of the person whose data is being collected. The preset parameters should be configured again for each collection.

  4. Perform the following operation(s) to collect ID card information, card information, face data, or fingerprint online.
    Option Description

    Collect ID Card Information

    1. Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/AccessControl/capabilities for getting the access control capability to check whether the device supports online collecting ID card information.

      The capability is returned in the message XML_Cap_AccessControl by lpOutputParam. If the device supports, the node <isSupportCaptureCardInfo> will be returned and its value is "true", and then you can perform the following steps.

      Otherwise, online collecting ID card information is not supported by the device, please end this task.

    2. Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/AccessControl/CaptureIDInfo/capabilities?format=json for getting the capability of online collecting ID card information.

      The capability is returned in the message JSON_IdentityInfoCap by lpOutputParam.

    3. Call NET_DVR_STDXMLConfig to pass through the request URL: POST /ISAPI/AccessControl/CaptureIDInfo?format=json and set lpInputParam to the message JSON_IdentityInfoCond for online collecting ID card information.

      The online collected ID card information is returned in the message JSON_IdentityInfo by lpOutputParam.

    Collect Card Information

    1. Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/AccessControl/capabilities for getting the access control capability to check whether the device supports online collecting card information.

      The capability is returned in the message XML_Cap_AccessControl by lpOutputParam. If the device supports, the node <isSupportCaptureIDInfo> will be returned and its value is "true", and then you can perform the following steps.

      Otherwise, online collecting card information is not supported by the device, please end this task.

    2. Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/AccessControl/CaptureCardInfo/capabilities?format=json for getting the capability of online collecting card information.

      The capability is returned in the message JSON_CardInfoCap by lpOutputParam.

    3. Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/AccessControl/CaptureCardInfo?format=json for online collecting the card information.

      The online collected card information is returned in the message JSON_CardInfo_Collection by lpOutputParam.

    Collect Face Data

    1. Call NET_DVR_GetDeviceAbility, set dwAbilityType to "ACS_ABILITY", and set pInBuf to XML_Desc_AcsAbility for getting the access control capability to know the supported parameters of online collecting face data.

      The capability is returned in the message XML_AcsAbility by pOutBuf. The related node is <CaptureFace>.

    2. Call NET_DVR_StartRemoteConfig with "NET_DVR_CAPTURE_FACE_INFO" (command No.: 2510) and set lpInBuffer to the structure NET_DVR_CAPTURE_FACE_COND for setting up persistent connection and set callback function (fRemoteConfigCallback) for online collecting face data.

      The online collected face data is returned in the structure NET_DVR_CAPTURE_FACE_CFG by lpBuffer of the callback function.

    3. Call NET_DVR_StopRemoteConfig to disconnect the persistent connection and finishing online collecting face data.

    Collect Fingerprint

    Refer to Collect Fingerprint

Call NET_DVR_Logout and NET_DVR_Cleanup to log out of the device and release the resources.