API for hikvision face detection DS-k1T320EWX

sumanta · Feb 21, 2025

Hi,

I am trying to use the following hikvision device DS-K1T320EWX.
I am using the sdk provided by hikvision.
I am able to run GET /ISAPI/Intelligent/FDLib and get the following output.

"FDLib": [{ "FDID": "1", "faceLibType": "blackFD" }, { "FDID": "2", "faceLibType": "infraredFD"}]

What is the correct API to try to see all the faces that might be stored in fdid = 1 or fdid =2.
I tried using

a. GET /ISAPI/Intelligent/FDLib/1?start=0&count=5
b. GET /ISAPI/Intelligent/FDLib/1
c. GET /ISAPI/Intelligent/FDLib/1/record

None of them worked.

I am pretty new to Hikvision and so I am not able to understand if this is the correct approach.

Thx

trempa92 · Feb 21, 2025

POST

/ISAPI/Intelligent/FDLib/FDSearch?format=json

Body:

{
"searchResultPosition":0,
"maxResults":5,
"faceLibType":"blackFD",
"FDID":"1",
"FPID":"7"
}

sumanta · Feb 21, 2025

Thank you, a lot, for the response.

I get the following output.

Is modelData the actual image that is stored inside?
If it is not the actual image, how do we retrieve the image corresponding to the modelData ?

POST /ISAPI/Intelligent/FDLib/FDSearch?format=json request successful!

[2025-02-21 18:43:05.862][DBG] SimpleSTDCommandToDvr with out cmd[POST /ISAPI/Intelligent/FDLib/FDSearch?format=json], input size[117], max segment length[262144]
Search Library Response: Content-Type:multipart/form-data;boundary=MIME_boundary
--MIME_boundary
Content-Type: application/json
Content-Length:558

{
"statusCode": 1,
"statusString": "OK",
"subStatusCode": "ok",
"responseStatusStrg": "OK",
"numOfMatches": 1,
"totalMatches": 1,
"MatchList": [{
"FPID": "2",
"modelData": "RlI1MDIzMDYBAAAAAAAAAMTxKw0jzZ/8CDX/jRP/uaS+QabJw/osNOPdyy/yIsgfEAzyVPjt1iIUTgDUGQQg3LsbBw08Et8QBkEath6vAgfJLPkFzAv7Btrz5iBB8+1AAdMhzuLeJxrp3A31oSXfph365fjyMTG98QsYCtrh4gFCCxrqXV0Z/vctEFPYD++oC7DxFvMG9wX81xXZ0DjYK8UAAsw2OCg730dNHQQ42u9r2qsJyxL83ckaCZ7xDjHWnC9Y2C/08h3G1VU4Dl0R6SXuBK3dB0kIxR8WMSD6GPzzPx/sJtYbEak9i9Mv5dPLCFTDtBrq7P8H78Tq4+yzH98sE+ApE84M/Le2zxj698Y="
}]
}

trempa92 · Feb 22, 2025

This modeldata is not an actual image. You cannot convert to image.

You could get image if you search person.

POST /ISAPI/AccessControl/UserInfo/Search?format=json

Body:
{
"UserInfoSearchCond":{
"searchID":"1",
"searchResultPosition": 0,
"maxResults": 10
}
}

There you should have a picURL node which you GET to.

Terminal have 2 working scenarios, uploading image by file, or model data. Model data are face points in 3d. So you dont actually have an image on device but device will recognize user.

This option is more secure as you cannot open via 2d picture

trempa92 · Feb 22, 2025

I wonder why are you using SDK. You can do this all with lightweight API and digest auth

sumanta · Feb 22, 2025

trempa92 said:
I wonder why are you using SDK. You can do this all with lightweight API and digest auth

The reason is because I am not very clear about how to use the lightweight APIs. Once I finish the sdk work I will delve into using the lightweight API along with digest auth.
Thanks a lot lot again for pointing me out in the correct direction.

sumanta · Feb 22, 2025

Hello,

Could you also direct me as to how to upload an image and link it to the correct person with this device.
I have been able to create a person using the following API.

POST /ISAPI/AccessControl/UserInfo/Record?format=json with the following body.
{
"UserInfo": {
"employeeNo":"000132",
"name":"John Tukey",
"userType":"normal",
"doorRight":"1",
"RightPlan":[{"doorNo":1,"planTemplateNo":"1"}],
"gender":"male",
"localUIRight":false,
"maxOpenDoorTime":0,
"userVerifyMode":"",
"Valid":{
"enable":true,
"beginTime":"2025-02-22T00:00:00",
"endTime":"2035-02-22T23:59:59",
"timeType":"local"
}}
};

What is the correct API to upload an image which identifies this person?

I am not sure I understand how to do that.

I have attached my sample code which I have written but it does not seem to work.

trempa92 · Feb 22, 2025

Do you want to upload a jpg image or do you want to start capture on device to get modeldata?

For uploading an image to person:

POST /ISAPI/Intelligent/FDLib/FaceDataRecord?format=json

Body:

{
"faceURL": "C:\\Images\\image.jpg", - either local url or web url(Needs to be smaller than 200KB)
"faceLibType":"blackFD",
"FDID":"1",
"FPID":"15" -user ID
}

sumanta · Feb 22, 2025

trempa92 said:
Do you want to upload a jpg image or do you want to start capture on device to get modeldata?

For uploading an image to person:

POST /ISAPI/Intelligent/FDLib/FaceDataRecord?format=json

Body:

{
"faceURL": "C:\\Images\\image.jpg", - either local url or web url(Needs to be smaller than 200KB)
"faceLibType":"blackFD",
"FDID":"1",
"FPID":"15" -user ID
}

sumanta · Feb 22, 2025

Hello,

Thank you, a lot, for the reply.
I am currently trying to upload a jpg image.
Once I am successful, I will try to upload the model data to compare with these images.

I did try your last suggestion, but it failed.
I am attaching the C++ file that I wrote.
If you look at line number 426 and a few lines after you will see that I followed your suggestion.

1. I tried to put the direct file path for faceURL, it failed.
2. I converted to base64 encoding and then put the URL for faceURL. it failed.

C++:

#include <iostream>
#include <fstream>
#include <sstream>
#include <string>
#include <vector>
#include <cstring>
#include "public.h"
#include "CapPicture.h"
#include "rapidjson/document.h"  / Core JSON parsing
#include "rapidjson/error/en.h"  / Error handling (optional)
#include "unistd.h"
#include <iostream>
#include <fstream>
#include <curl/curl.h>
#include <string>

#define DVR_IP "10.0.0.10"   / Replace with your device IP
#define DVR_PORT 8000            / Replace with your device port
#define USERNAME "admin"         / Replace with your device username
#define PASSWORD "Ambition"         / Replace with your device password

using namespace std;
LONG lUserID = -1;  / Global User ID for login session

#include <iostream>
#include <fstream>
#include <vector>
#include <sstream>
#include <iomanip>

/ Base64 encoding table
static const std::string base64_chars =
    "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
    "abcdefghijklmnopqrstuvwxyz"
    "0123456789+/";

/ Function to encode binary data to Base64
std::string base64_encode(const std::vector<unsigned char> &data) {
    std::string encoded;
    int val = 0, valb = -6;

    for (unsigned char c : data) {
        val = (val << 8) + c;
        valb += 8;
        while (valb >= 0) {
            encoded.push_back(base64_chars[(val >> valb) & 0x3F]);
            valb -= 6;
        }
    }

    if (valb > -6) {
        encoded.push_back(base64_chars[((val << 8) >> (valb + 8)) & 0x3F]);
    }

    while (encoded.size() % 4) {
        encoded.push_back('=');
    }

    return encoded;
}

/ Function to read an image file and encode it as Base64 Data URL
std::string image_to_base64(const std::string &file_path) {
    / Open the image file in binary mode
    std::ifstream file(file_path, std::ios::binary);
    if (!file) {
        std::cerr << "Error: Could not open file " << file_path << std::endl;
        return "";
    }

    / Read file contents into a byte vector
    std::vector<unsigned char> buffer(std::istreambuf_iterator<char>(file), {});

    / Encode the binary data into Base64
    std::string base64_str = base64_encode(buffer);

    / Construct the Data URL
    return "data:image/jpeg;base64," + base64_str;
}


bool SendFaceImageToFDLib(const std::string& deviceIP, const std::string& username, const std::string& password,
                          const std::string& fdid, const std::string& fpid, const std::string& faceImagePath) {
    CURL* curl = curl_easy_init();
    if (!curl) {
        std::cerr << "Failed to initialize cURL" << std::endl;
        return false;
    }

    / API URL
    std::string url = "http://" + deviceIP + "/ISAPI/Intelligent/FDLib/FDSetUp?format=json";

    / Setup authentication
    std::string authHeader = username + ":" + password;

    / JSON metadata (FaceDataRecord)
    std::string faceDataRecord = "{\"faceLibType\":\"blackFD\",\"FDID\":\"" + fdid + "\",\"FPID\":\"" + fpid + "\"}";

    / Create multipart form-data
    curl_mime* mime = curl_mime_init(curl);
    curl_mimepart* part;

    / Add FaceDataRecord JSON
    part = curl_mime_addpart(mime);
    curl_mime_name(part, "FaceDataRecord");
    curl_mime_data(part, faceDataRecord.c_str(), CURL_ZERO_TERMINATED);
    curl_mime_type(part, "application/json");

    / Add Image File
    part = curl_mime_addpart(mime);
    curl_mime_name(part, "img");
    curl_mime_filedata(part, faceImagePath.c_str());
    curl_mime_type(part, "image/jpeg");

    / Set cURL options
    curl_easy_setopt(curl, CURLOPT_URL, url.c_str());
    curl_easy_setopt(curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
    curl_easy_setopt(curl, CURLOPT_USERPWD, authHeader.c_str());
    curl_easy_setopt(curl, CURLOPT_MIMEPOST, mime);
    curl_easy_setopt(curl, CURLOPT_VERBOSE, 1L);  / Enable debug output

    / Perform the request
    CURLcode res = curl_easy_perform(curl);
    if (res != CURLE_OK) {
        std::cerr << "Failed to upload face image: " << curl_easy_strerror(res) << std::endl;
        curl_mime_free(mime);
        curl_easy_cleanup(curl);
        return false;
    }

    std::cout << "Face image uploaded successfully!" << std::endl;

    / Cleanup
    curl_mime_free(mime);
    curl_easy_cleanup(curl);
    return true;
}

void CheckAndPrintError() {
    DWORD err = NET_DVR_GetLastError();
    if (err != 0) {
        std::cout << "Error: " << err << std::endl;
    }
}


bool SendXMLRequest(const char* method, const char* url, const char* xmlData, char* responseBuffer, DWORD responseSize) {
    NET_DVR_XML_CONFIG_INPUT inputParam = {0};
    NET_DVR_XML_CONFIG_OUTPUT outputParam = {0};

    std::string fullRequest = std::string(method) + " " + url;
    inputParam.dwSize = sizeof(inputParam);
    inputParam.lpRequestUrl = (void*)(fullRequest.c_str());
    inputParam.dwRequestUrlLen = strlen(fullRequest.c_str());
    inputParam.lpInBuffer = (void*)xmlData;
    inputParam.dwInBufferSize = xmlData ? strlen(xmlData) : 0;

    outputParam.dwSize = sizeof(outputParam);
    outputParam.lpOutBuffer = responseBuffer;
    outputParam.dwOutBufferSize = responseSize;

    if (!NET_DVR_STDXMLConfig(lUserID, &inputParam, &outputParam)) {
        std::cout << fullRequest << " request failed!" << std::endl;
        CheckAndPrintError();
        return false;
    }

    std::cout << fullRequest << " request successful!" << std::endl;
    return true;
}

/ Convert image file to Base64
std::string ConvertImageToBase64(const std::string& imagePath) {
    std::ifstream file(imagePath, std::ios::binary);
    if (!file) {
        std::cerr << "Error: Unable to open image file: " << imagePath << std::endl;
        return "";
    }

    std::ostringstream base64Stream;
    base64Stream << file.rdbuf();
    std::string imageData = base64Stream.str();

    / Convert to Base64 (Use a proper Base64 encoder here if required)
    return imageData;
}

/ Send person details and image to Hikvision FDLib
bool SendPersonWithPicture(const std::string& name, const std::string& personID, const std::string& imagePath) {
    char responseBuffer[8192] = {0};

    / Convert image to Base64
    std::string base64Image = ConvertImageToBase64(imagePath);
    if (base64Image.empty()) {
        std::cerr << "Error: Failed to convert image to Base64!" << std::endl;
        return false;
    }

    / Construct XML payload
    std::string xmlPayload = R"(
        <FaceAppendData version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
            <bornTime>1990-01-01</bornTime>
            <name>)" + name + R"(</name>
            <sex>male</sex>
            <province>California</province>
            <city>Los Angeles</city>
            <certificateType>ID</certificateType>
            <certificateNumber>)" + personID + R"(</certificateNumber>
            <PersonInfoExtendList>
                <PersonInfoExtend>
                    <id>1</id>
                    <enable>true</enable>
                    <name>Company</name>
                    <value>XYZ Corp</value>
                </PersonInfoExtend>
            </PersonInfoExtendList>
            <caseInfo>Security Alert</caseInfo>
            <customHumanID>)" + personID + R"(</customHumanID>
            <phoneNumber>+1234567890</phoneNumber>
            <RegionCoordinatesList>
                <RegionCoordinates>
                    <positionX>100</positionX>
                    <positionY>150</positionY>
                </RegionCoordinates>
            </RegionCoordinatesList>
            <faceLibType>blackFD</faceLibType>
            <faceURL>data:image/jpeg;base64,)" + base64Image + R"(</faceURL>
        </FaceAppendData>)";

    / Send request to add person to blackFD
    bool success = SendXMLRequest("POST", "/ISAPI/Intelligent/FDLib/blackFD/picture", xmlPayload.c_str(), responseBuffer, sizeof(responseBuffer));

    if (success) {
        std::cout << "Person successfully added to blackFD: " << name << std::endl;
    } else {
        std::cerr << "Failed to add person to blackFD!" << std::endl;
    }

    return success;
}


bool InitAndLogin() {
    / Initialize SDK
    if (!NET_DVR_Init()) {
        std::cout << "SDK Initialization Failed!" << std::endl;
        return false;
    }

    / Set connection timeout and reconnection options
    NET_DVR_SetConnectTime(2000, 1);
    NET_DVR_SetReconnect(10000, true);

    / Login to the device
    NET_DVR_USER_LOGIN_INFO loginInfo = {0};
    NET_DVR_DEVICEINFO_V40 deviceInfo = {0};
    
    strcpy(loginInfo.sDeviceAddress, DVR_IP);
    strcpy(loginInfo.sUserName, USERNAME);
    strcpy(loginInfo.sPassword, PASSWORD);
    loginInfo.wPort = DVR_PORT;
    loginInfo.bUseAsynLogin = false;

    lUserID = NET_DVR_Login_V40(&loginInfo, &deviceInfo);
    if (lUserID < 0) {
        std::cout << "Login failed!" << std::endl;
        CheckAndPrintError();
        return false;
    }

    std::cout << "Login successful!" << std::endl;
    return true;
}


void GetSystemCapabilities() {
    char response[4194304] = {0};
    SendXMLRequest("GET", "/ISAPI/System/capabilities", nullptr, response, sizeof(response));
    std::cout << "System Capabilities Response: " << response << std::endl;
}

void GetFaceLibraryCapabilities() {
    char response[2048] = {0};
    SendXMLRequest("GET", "/ISAPI/Intelligent/FDLib/capabilities", nullptr, response, sizeof(response));
    std::cout << "Capabilities Response: " << response << std::endl;
}

void GetDeviceCapabilities() {
    char response[2048] = {0};
    std::string XmlPayload = R"(<AcsAbility version="2.0">
                  <!--opt, specify child nodes about access control capabilities to be returned-->
                 </AcsAbility>)";
    bool res = NET_DVR_GetDeviceAbility(lUserID,
             ACS_ABILITY,
            nullptr,
            0,
            response,
            sizeof(response));
    std::cout << "Capabilities Response: " << response << std::endl;
}

void getFaceLibInfo(int lUserID) {
    / Construct the request URL
    /std::string url = "/ISAPI/Intelligent/FDLib";
    std::string url = "/ISAPI/FaceRecognition/FDLib";

    / Prepare the input parameters structure
    NET_DVR_XML_CONFIG_INPUT netDvrXmlConfigInput = {0};
    netDvrXmlConfigInput.lpRequestUrl = (void*) (malloc((url.length()+ 1) * sizeof(char)));
    strcpy((char*)(netDvrXmlConfigInput.lpRequestUrl), url.c_str());
    netDvrXmlConfigInput.dwRequestUrlLen = url.length();
    netDvrXmlConfigInput.lpInBuffer = nullptr;  / No additional input data
    netDvrXmlConfigInput.dwInBufferSize = 0;
    netDvrXmlConfigInput.dwSize = sizeof(netDvrXmlConfigInput);

    / Prepare output structures
    char responseBuffer[8192] = {0}; / Allocate buffer for the response
    char statusBuffer[1024] = {0};   / Allocate buffer for status message

    NET_DVR_XML_CONFIG_OUTPUT struXMLOutput = {0};
    struXMLOutput.dwSize = sizeof(struXMLOutput);
    struXMLOutput.lpOutBuffer = responseBuffer;
    struXMLOutput.dwOutBufferSize = sizeof(responseBuffer);
    struXMLOutput.lpStatusBuffer = statusBuffer;
    struXMLOutput.dwStatusSize = sizeof(statusBuffer);

    SendXMLRequest("GET", "/ISAPI/Intelligent/FDLib?count=1", nullptr, responseBuffer, sizeof(responseBuffer));
    / Execute ISAPI request
    if (!NET_DVR_STDXMLConfig(lUserID,&netDvrXmlConfigInput, &struXMLOutput)) {
        std::cout << "NET_DVR_STDXMLConfig failed! Error: " << NET_DVR_GetLastError() << std::endl;
        return;
    }

    / Print the response
    std::cout << "Device Face Library Info Response: " << responseBuffer << std::endl;
    std::cout << "Response Status: " << statusBuffer << std::endl;
}

void CreateFaceLibrary() {
    char response1[8192] = {0};
    char response2[2048] = {0};
    const char* createXML = R"(<FaceLibrary><name>TestLib</name><type>ordinary</type></FaceLibrary>)";

    SendXMLRequest("GET", "/ISAPI/Intelligent/FDLib?start=0&count=5", nullptr, response1, sizeof(response1));
    std::cout << "Get Library Response: " << response1 << std::endl;

    SendXMLRequest("POST", "/ISAPI/Intelligent/FDLib", createXML, response2, sizeof(response2));
    std::cout << "Create Library Response: " << response2 << std::endl;
}

string SearchFaceLibrary() {
    char response1[2048] = {0};
    char response2[2048] = {0};
    char response3[32768] = {0};
    char response4[2048] = {0};
    char response5[2048] = {0};
    char response6[2048] = {0};
    char response7[2048] = {0};

    SendXMLRequest("GET", "/ISAPI/Intelligent/FDLib?start=0&count=5", nullptr, response1, sizeof(response1));
    std::cout << "Search Library Response: " << response1 << std::endl;

    /SendXMLRequest("GET", "/ISAPI/Intelligent/FDLib/2?start=0&count=5", nullptr, response2, sizeof(response2));
    /std::cout << "Search Library Response: " << response2 << std::endl;

    char* createJSON = R"({
    "searchResultPosition":0,
    "maxResults":5,
    "faceLibType":"blackFD",
    "FDID":"1",
    "FPID":"2"
    })";

    SendXMLRequest("POST", "/ISAPI/Intelligent/FDLib/FDSearch?format=json", createJSON, response2, sizeof(response2));
    std::cout << "Search Library Response: " << response2 << std::endl;

    createJSON = R"({
    "UserInfoSearchCond":{
    "searchID":"1",
    "searchResultPosition": 0,
    "maxResults": 10
    }
    })";

    SendXMLRequest("POST", "/ISAPI/AccessControl/UserInfo/Search?format=json", createJSON, response3, sizeof(response3));
    std::cout << "Search Library Response: " << response3 << std::endl;

    SendXMLRequest("GET", "/ISAPI/AccessControl/UserInfo/capabilities?format=json", nullptr, response4, sizeof(response4));
    std::cout << "Search Library Response: " << response4 << std::endl;

    SendXMLRequest("GET", "/ISAPI/AccessControl/FaceRecognizeMode?format=json", nullptr, response5, sizeof(response5));
    std::cout << "Search Library Response: " << response5 << std::endl;

    SendXMLRequest("GET", "/ISAPI/Intelligent/FDLib/capabilities?format=json", nullptr, response6, sizeof(response6));
    std::cout << "Search Library Response: " << response6 << std::endl;

    createJSON = R"({
    "UserInfo":{
        "employeeNo":"000132",
        "name":"John Tukey",
        "userType":"normal",
        "doorRight":"1",
        "RightPlan":[{"doorNo":1,"planTemplateNo":"1"}],
        "gender":"male",
        "localUIRight":false,
        "maxOpenDoorTime":0,
        "userVerifyMode":"",
        "Valid":{
            "enable":true,
            "beginTime":"2025-02-22T00:00:00",
            "endTime":"2035-02-22T23:59:59",
            "timeType":"local"
        }}
    })";
    SendXMLRequest("POST", "/ISAPI/AccessControl/UserInfo/Record?format=json", createJSON, response6, sizeof(response6));
    std::cout << "Search Library Response: " << response6 << std::endl;

    std::string file_path = "./face.jpg";  / Change this to your image path
    std::string base64_url = image_to_base64(file_path);

    if (!base64_url.empty()) {
        std::cout << "Base64 Data URL:\n" << base64_url << std::endl;
    }
    / Correct JSON string
    std::string imgJSON = R"({
            "faceURL": ")" + base64_url + R"(",
            "faceLibType": "blackFD",
            "FDID": "1",
            "FPID": "000132"
        })";

    SendXMLRequest("POST", "/ISAPI/Intelligent/FDLib/FaceDataRecord?format=json", imgJSON.c_str(), response7, sizeof(response7));
    std::cout << "Search Library Response: " << response7 << std::endl;

    rapidjson::Document doc;
    doc.Parse(response1);

    if (!doc.HasMember("FDLib") || !doc["FDLib"].IsArray()) {
        std::cerr << "Invalid response format!" << std::endl;
        return "";
    }

    for (const auto& lib : doc["FDLib"].GetArray()) {
        if (lib.HasMember("FDID") && lib["FDID"].IsString()) {
            std::cout << "Found Face Library ID: " << lib["FDID"].GetString() << std::endl;
            return lib["FDID"].GetString(); / Return first FDID found
        }
    }

    return "";
}

void EditFaceLibrary(const char* fdID) {
    char response[2048] = {0};
    std::string url = "/ISAPI/Intelligent/FDLib/" + std::string(fdID);
    const char* editXML = R"(<FaceLibrary><name>UpdatedLib</name></FaceLibrary>)";
    SendXMLRequest("PUT", url.c_str(), editXML, response, sizeof(response));
    std::cout << "Edit Library Response: " << response << std::endl;
}

void DeleteFaceLibrary(const char* fdID) {
    char response[2048] = {0};
    std::string url = "/ISAPI/Intelligent/FDLib/" + std::string(fdID);
    SendXMLRequest("DELETE", url.c_str(), nullptr, response, sizeof(response));
    std::cout << "Delete Library Response: " << response << std::endl;
}

void LogoutAndCleanup() {
    if (lUserID >= 0) {
        NET_DVR_Logout(lUserID);
        std::cout << "Logged out successfully!" << std::endl;
    }
    NET_DVR_Cleanup();
}


bool UploadFacePicture(LONG userID, const std::string& imagePath, const std::string& faceLibId) {
    if (userID < 0) {
        std::cerr << "Invalid user ID!" << std::endl;
        return false;
    }

    if (faceLibId.empty()) {
        std::cerr << "No valid Face Library found!" << std::endl;
        return false;
    }


    / Open image file
    std::ifstream file(imagePath, std::ios::binary | std::ios::ate);
    if (!file.is_open()) {
        std::cerr << "Error: Unable to open image file: " << imagePath << std::endl;
        return false;
    }

    size_t fileSize = file.tellg();
    file.seekg(0, std::ios::beg);
    std::vector<char> imageData(fileSize);
    file.read(imageData.data(), fileSize);
    file.close();

    / Step 1: Initialize upload
    NET_DVR_FACELIB_COND faceLibCond = {0};
    faceLibCond.dwSize = sizeof(NET_DVR_FACELIB_COND);
    / Assign the retrieved Face Library ID
    /strncpy(faceLibCond.szFDID, faceLibId.c_str(), sizeof(faceLibCond.szFDID) - 1);
    /strncpy(faceLibCond.szFDID, faceLibId.c_str(), NET_SDK_MAX_FDID_LEN);  / FDID dynamically retrieved
    strncpy(faceLibCond.szFDID, faceLibId.c_str(), faceLibId.length());  / FDID dynamically retrieved
    /faceLibCond.dwFaceLibType = 0;  / Default type
    /faceLibCond.dwUploadType = 39;  / IMPORT_DATA_TO_FACELIB

    / Set other parameters
    faceLibCond.byConcurrent = 0;  / Disable concurrent processing
    faceLibCond.byCover = 1;       / Enable overwriting if full
    faceLibCond.byCustomFaceLibID = 0;  / Use system-generated FaceLibID

    / Identity Key (if required, else set to empty)
    memset(faceLibCond.byIdentityKey, 0, sizeof(faceLibCond.byIdentityKey));


    LONG uploadHandle = NET_DVR_UploadFile_V40(
            userID,  / From NET_DVR_Login_V40
            39,      / dwUploadType: IMPORT_DATA_TO_FACELIB
            &faceLibCond, / lpInBuffer: Pointer to our condition structure
            sizeof(NET_DVR_FACELIB_COND), / dwInBufferSize: Size of structure
            imageData.data(), / sFileName: Path to image file
            nullptr, / lpOutBuffer: Optional output buffer (nullptr if not used)
            0        / dwOutBufferSize: 0 since we are not using an output buffer
            );


    if (uploadHandle < 0) {
        std::cerr << "Upload init failed! Error: " << NET_DVR_GetLastError() << std::endl;
        return false;
    }

    / Step 2: Send face data using NET_DVR_UploadSend
    NET_DVR_SEND_PARAM_IN sendParam = {0};
    / Fill sendParam with the data to upload

    int result = NET_DVR_UploadSend(uploadHandle, &sendParam, NULL);
    if (result < 0) {
        std::cerr << "UploadSend failed! Error: " << NET_DVR_GetLastError() << std::endl;
        NET_DVR_UploadClose(uploadHandle);
        return false;
    }


    / Step 3: Monitor upload progress
    DWORD progress = 0;
    while (progress != 1) {
        if (!NET_DVR_GetUploadState(uploadHandle, &progress)) {
            std::cerr << "Error getting upload state: " << NET_DVR_GetLastError() << std::endl;
            NET_DVR_UploadClose(uploadHandle);
            return false;
        }
        std::cout << "Upload progress: " << progress * 100 << "%" << std::endl;
        sleep(500);
    }

    / Step 4: Retrieve upload result
    char resultBuffer[256] = {0};  / Buffer to receive upload result
    if (!NET_DVR_GetUploadResult(uploadHandle, resultBuffer, sizeof(resultBuffer))) {
        std::cerr << "Error retrieving upload result: " << NET_DVR_GetLastError() << std::endl;
        NET_DVR_UploadClose(uploadHandle);
        return false;
    } else {
        std::cout << "Upload successful! Picture ID: " << resultBuffer << std::endl;
    }



    / Step 5: Close upload session
    NET_DVR_UploadClose(uploadHandle);
    return true;
}


int Demo_Capture()
{
    if (!InitAndLogin()) return -1;

    GetSystemCapabilities();
    GetFaceLibraryCapabilities();
    string faceLibID = SearchFaceLibrary();

    if (faceLibID.empty()) {
        std::cerr << "No valid Face Library found!" << std::endl;
        return false;
    }

    /GetDeviceCapabilities();
    /UploadFacePicture(lUserID, "./face.jpg", faceLibID);
     / Add a person to the blackFD library
    std::string deviceIP = "10.0.0.10";  / Replace with your device IP
    std::string username = "admin";
    std::string password = "Ambition";
    std::string fdid = "1";   / Face Library ID
    std::string fpid = "000132";  / Unique Face ID
    std::string faceImagePath = "face.jpg";  / Image file path

    /bool success = SendFaceImageToFDLib(deviceIP, username, password, fdid, fpid, faceImagePath);
    /return success ? 0 : 1;

    /SendPersonWithPicture("John Doe", "123456", "face.jpg");
  /  SearchFaceLibrary();
    
    / Assuming an FDLib ID is retrieved from the search response
   / const char* testFDID = "3";  / Replace with actual ID
/    EditFaceLibrary(testFDID);
    /DeleteFaceLibrary(testFDID);

    LogoutAndCleanup();
    return 0;
}

trempa92 · Feb 22, 2025

I dont see any attachment

sumanta · Feb 22, 2025

trempa92 said:
I dont see any attachment

I realized that the files are not uploading. Hence I added the code directly. I am able to view the code. Can you please confirm that you are able to see it.
I have reposted the code here again. Please look at the following snippet in the code below.

std::string file_path = "./face.jpg"; / Change this to your image path
std::string base64_url = image_to_base64(file_path);

if (!base64_url.empty()) {
std::cout << "Base64 Data URL:\n" << base64_url << std::endl;
}
/ Correct JSON string
std::string imgJSON = R"({
"faceURL": ")" + base64_url + R"(",
"faceLibType": "blackFD",
"FDID": "1",
"FPID": "000132"
})";

SendXMLRequest("POST", "/ISAPI/Intelligent/FDLib/FaceDataRecord?format=json", imgJSON.c_str(), response7, sizeof(response7));
std::cout << "Search Library Response: " << response7 << std::endl;

C++:

#include <iostream>
#include <fstream>
#include <sstream>
#include <string>
#include <vector>
#include <cstring>
#include "public.h"
#include "CapPicture.h"
#include "rapidjson/document.h"  / Core JSON parsing
#include "rapidjson/error/en.h"  / Error handling (optional)
#include "unistd.h"
#include <iostream>
#include <fstream>
#include <curl/curl.h>
#include <string>

#define DVR_IP "10.0.0.10"   / Replace with your device IP
#define DVR_PORT 8000            / Replace with your device port
#define USERNAME "admin"         / Replace with your device username
#define PASSWORD "Ambition"         / Replace with your device password

using namespace std;
LONG lUserID = -1;  / Global User ID for login session

#include <iostream>
#include <fstream>
#include <vector>
#include <sstream>
#include <iomanip>

/ Base64 encoding table
static const std::string base64_chars =
    "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
    "abcdefghijklmnopqrstuvwxyz"
    "0123456789+/";

/ Function to encode binary data to Base64
std::string base64_encode(const std::vector<unsigned char> &data) {
    std::string encoded;
    int val = 0, valb = -6;

    for (unsigned char c : data) {
        val = (val << 8) + c;
        valb += 8;
        while (valb >= 0) {
            encoded.push_back(base64_chars[(val >> valb) & 0x3F]);
            valb -= 6;
        }
    }

    if (valb > -6) {
        encoded.push_back(base64_chars[((val << 8) >> (valb + 8)) & 0x3F]);
    }

    while (encoded.size() % 4) {
        encoded.push_back('=');
    }

    return encoded;
}

/ Function to read an image file and encode it as Base64 Data URL
std::string image_to_base64(const std::string &file_path) {
    / Open the image file in binary mode
    std::ifstream file(file_path, std::ios::binary);
    if (!file) {
        std::cerr << "Error: Could not open file " << file_path << std::endl;
        return "";
    }

    / Read file contents into a byte vector
    std::vector<unsigned char> buffer(std::istreambuf_iterator<char>(file), {});

    / Encode the binary data into Base64
    std::string base64_str = base64_encode(buffer);

    / Construct the Data URL
    return "data:image/jpeg;base64," + base64_str;
}


bool SendFaceImageToFDLib(const std::string& deviceIP, const std::string& username, const std::string& password,
                          const std::string& fdid, const std::string& fpid, const std::string& faceImagePath) {
    CURL* curl = curl_easy_init();
    if (!curl) {
        std::cerr << "Failed to initialize cURL" << std::endl;
        return false;
    }

    / API URL
    std::string url = "http://" + deviceIP + "/ISAPI/Intelligent/FDLib/FDSetUp?format=json";

    / Setup authentication
    std::string authHeader = username + ":" + password;

    / JSON metadata (FaceDataRecord)
    std::string faceDataRecord = "{\"faceLibType\":\"blackFD\",\"FDID\":\"" + fdid + "\",\"FPID\":\"" + fpid + "\"}";

    / Create multipart form-data
    curl_mime* mime = curl_mime_init(curl);
    curl_mimepart* part;

    / Add FaceDataRecord JSON
    part = curl_mime_addpart(mime);
    curl_mime_name(part, "FaceDataRecord");
    curl_mime_data(part, faceDataRecord.c_str(), CURL_ZERO_TERMINATED);
    curl_mime_type(part, "application/json");

    / Add Image File
    part = curl_mime_addpart(mime);
    curl_mime_name(part, "img");
    curl_mime_filedata(part, faceImagePath.c_str());
    curl_mime_type(part, "image/jpeg");

    / Set cURL options
    curl_easy_setopt(curl, CURLOPT_URL, url.c_str());
    curl_easy_setopt(curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
    curl_easy_setopt(curl, CURLOPT_USERPWD, authHeader.c_str());
    curl_easy_setopt(curl, CURLOPT_MIMEPOST, mime);
    curl_easy_setopt(curl, CURLOPT_VERBOSE, 1L);  / Enable debug output

    / Perform the request
    CURLcode res = curl_easy_perform(curl);
    if (res != CURLE_OK) {
        std::cerr << "Failed to upload face image: " << curl_easy_strerror(res) << std::endl;
        curl_mime_free(mime);
        curl_easy_cleanup(curl);
        return false;
    }

    std::cout << "Face image uploaded successfully!" << std::endl;

    / Cleanup
    curl_mime_free(mime);
    curl_easy_cleanup(curl);
    return true;
}

void CheckAndPrintError() {
    DWORD err = NET_DVR_GetLastError();
    if (err != 0) {
        std::cout << "Error: " << err << std::endl;
    }
}


bool SendXMLRequest(const char* method, const char* url, const char* xmlData, char* responseBuffer, DWORD responseSize) {
    NET_DVR_XML_CONFIG_INPUT inputParam = {0};
    NET_DVR_XML_CONFIG_OUTPUT outputParam = {0};

    std::string fullRequest = std::string(method) + " " + url;
    inputParam.dwSize = sizeof(inputParam);
    inputParam.lpRequestUrl = (void*)(fullRequest.c_str());
    inputParam.dwRequestUrlLen = strlen(fullRequest.c_str());
    inputParam.lpInBuffer = (void*)xmlData;
    inputParam.dwInBufferSize = xmlData ? strlen(xmlData) : 0;

    outputParam.dwSize = sizeof(outputParam);
    outputParam.lpOutBuffer = responseBuffer;
    outputParam.dwOutBufferSize = responseSize;

    if (!NET_DVR_STDXMLConfig(lUserID, &inputParam, &outputParam)) {
        std::cout << fullRequest << " request failed!" << std::endl;
        CheckAndPrintError();
        return false;
    }

    std::cout << fullRequest << " request successful!" << std::endl;
    return true;
}

/ Convert image file to Base64
std::string ConvertImageToBase64(const std::string& imagePath) {
    std::ifstream file(imagePath, std::ios::binary);
    if (!file) {
        std::cerr << "Error: Unable to open image file: " << imagePath << std::endl;
        return "";
    }

    std::ostringstream base64Stream;
    base64Stream << file.rdbuf();
    std::string imageData = base64Stream.str();

    / Convert to Base64 (Use a proper Base64 encoder here if required)
    return imageData;
}

/ Send person details and image to Hikvision FDLib
bool SendPersonWithPicture(const std::string& name, const std::string& personID, const std::string& imagePath) {
    char responseBuffer[8192] = {0};

    / Convert image to Base64
    std::string base64Image = ConvertImageToBase64(imagePath);
    if (base64Image.empty()) {
        std::cerr << "Error: Failed to convert image to Base64!" << std::endl;
        return false;
    }

    / Construct XML payload
    std::string xmlPayload = R"(
        <FaceAppendData version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
            <bornTime>1990-01-01</bornTime>
            <name>)" + name + R"(</name>
            <sex>male</sex>
            <province>California</province>
            <city>Los Angeles</city>
            <certificateType>ID</certificateType>
            <certificateNumber>)" + personID + R"(</certificateNumber>
            <PersonInfoExtendList>
                <PersonInfoExtend>
                    <id>1</id>
                    <enable>true</enable>
                    <name>Company</name>
                    <value>XYZ Corp</value>
                </PersonInfoExtend>
            </PersonInfoExtendList>
            <caseInfo>Security Alert</caseInfo>
            <customHumanID>)" + personID + R"(</customHumanID>
            <phoneNumber>+1234567890</phoneNumber>
            <RegionCoordinatesList>
                <RegionCoordinates>
                    <positionX>100</positionX>
                    <positionY>150</positionY>
                </RegionCoordinates>
            </RegionCoordinatesList>
            <faceLibType>blackFD</faceLibType>
            <faceURL>data:image/jpeg;base64,)" + base64Image + R"(</faceURL>
        </FaceAppendData>)";

    / Send request to add person to blackFD
    bool success = SendXMLRequest("POST", "/ISAPI/Intelligent/FDLib/blackFD/picture", xmlPayload.c_str(), responseBuffer, sizeof(responseBuffer));

    if (success) {
        std::cout << "Person successfully added to blackFD: " << name << std::endl;
    } else {
        std::cerr << "Failed to add person to blackFD!" << std::endl;
    }

    return success;
}


bool InitAndLogin() {
    / Initialize SDK
    if (!NET_DVR_Init()) {
        std::cout << "SDK Initialization Failed!" << std::endl;
        return false;
    }

    / Set connection timeout and reconnection options
    NET_DVR_SetConnectTime(2000, 1);
    NET_DVR_SetReconnect(10000, true);

    / Login to the device
    NET_DVR_USER_LOGIN_INFO loginInfo = {0};
    NET_DVR_DEVICEINFO_V40 deviceInfo = {0};
    
    strcpy(loginInfo.sDeviceAddress, DVR_IP);
    strcpy(loginInfo.sUserName, USERNAME);
    strcpy(loginInfo.sPassword, PASSWORD);
    loginInfo.wPort = DVR_PORT;
    loginInfo.bUseAsynLogin = false;

    lUserID = NET_DVR_Login_V40(&loginInfo, &deviceInfo);
    if (lUserID < 0) {
        std::cout << "Login failed!" << std::endl;
        CheckAndPrintError();
        return false;
    }

    std::cout << "Login successful!" << std::endl;
    return true;
}


void GetSystemCapabilities() {
    char response[4194304] = {0};
    SendXMLRequest("GET", "/ISAPI/System/capabilities", nullptr, response, sizeof(response));
    std::cout << "System Capabilities Response: " << response << std::endl;
}

void GetFaceLibraryCapabilities() {
    char response[2048] = {0};
    SendXMLRequest("GET", "/ISAPI/Intelligent/FDLib/capabilities", nullptr, response, sizeof(response));
    std::cout << "Capabilities Response: " << response << std::endl;
}

void GetDeviceCapabilities() {
    char response[2048] = {0};
    std::string XmlPayload = R"(<AcsAbility version="2.0">
                  <!--opt, specify child nodes about access control capabilities to be returned-->
                 </AcsAbility>)";
    bool res = NET_DVR_GetDeviceAbility(lUserID,
             ACS_ABILITY,
            nullptr,
            0,
            response,
            sizeof(response));
    std::cout << "Capabilities Response: " << response << std::endl;
}

void getFaceLibInfo(int lUserID) {
    / Construct the request URL
    /std::string url = "/ISAPI/Intelligent/FDLib";
    std::string url = "/ISAPI/FaceRecognition/FDLib";

    / Prepare the input parameters structure
    NET_DVR_XML_CONFIG_INPUT netDvrXmlConfigInput = {0};
    netDvrXmlConfigInput.lpRequestUrl = (void*) (malloc((url.length()+ 1) * sizeof(char)));
    strcpy((char*)(netDvrXmlConfigInput.lpRequestUrl), url.c_str());
    netDvrXmlConfigInput.dwRequestUrlLen = url.length();
    netDvrXmlConfigInput.lpInBuffer = nullptr;  / No additional input data
    netDvrXmlConfigInput.dwInBufferSize = 0;
    netDvrXmlConfigInput.dwSize = sizeof(netDvrXmlConfigInput);

    / Prepare output structures
    char responseBuffer[8192] = {0}; / Allocate buffer for the response
    char statusBuffer[1024] = {0};   / Allocate buffer for status message

    NET_DVR_XML_CONFIG_OUTPUT struXMLOutput = {0};
    struXMLOutput.dwSize = sizeof(struXMLOutput);
    struXMLOutput.lpOutBuffer = responseBuffer;
    struXMLOutput.dwOutBufferSize = sizeof(responseBuffer);
    struXMLOutput.lpStatusBuffer = statusBuffer;
    struXMLOutput.dwStatusSize = sizeof(statusBuffer);

    SendXMLRequest("GET", "/ISAPI/Intelligent/FDLib?count=1", nullptr, responseBuffer, sizeof(responseBuffer));
    / Execute ISAPI request
    if (!NET_DVR_STDXMLConfig(lUserID,&netDvrXmlConfigInput, &struXMLOutput)) {
        std::cout << "NET_DVR_STDXMLConfig failed! Error: " << NET_DVR_GetLastError() << std::endl;
        return;
    }

    / Print the response
    std::cout << "Device Face Library Info Response: " << responseBuffer << std::endl;
    std::cout << "Response Status: " << statusBuffer << std::endl;
}

void CreateFaceLibrary() {
    char response1[8192] = {0};
    char response2[2048] = {0};
    const char* createXML = R"(<FaceLibrary><name>TestLib</name><type>ordinary</type></FaceLibrary>)";

    SendXMLRequest("GET", "/ISAPI/Intelligent/FDLib?start=0&count=5", nullptr, response1, sizeof(response1));
    std::cout << "Get Library Response: " << response1 << std::endl;

    SendXMLRequest("POST", "/ISAPI/Intelligent/FDLib", createXML, response2, sizeof(response2));
    std::cout << "Create Library Response: " << response2 << std::endl;
}

string SearchFaceLibrary() {
    char response1[2048] = {0};
    char response2[2048] = {0};
    char response3[32768] = {0};
    char response4[2048] = {0};
    char response5[2048] = {0};
    char response6[2048] = {0};
    char response7[2048] = {0};

    SendXMLRequest("GET", "/ISAPI/Intelligent/FDLib?start=0&count=5", nullptr, response1, sizeof(response1));
    std::cout << "Search Library Response: " << response1 << std::endl;

    /SendXMLRequest("GET", "/ISAPI/Intelligent/FDLib/2?start=0&count=5", nullptr, response2, sizeof(response2));
    /std::cout << "Search Library Response: " << response2 << std::endl;

    char* createJSON = R"({
    "searchResultPosition":0,
    "maxResults":5,
    "faceLibType":"blackFD",
    "FDID":"1",
    "FPID":"2"
    })";

    SendXMLRequest("POST", "/ISAPI/Intelligent/FDLib/FDSearch?format=json", createJSON, response2, sizeof(response2));
    std::cout << "Search Library Response: " << response2 << std::endl;

    createJSON = R"({
    "UserInfoSearchCond":{
    "searchID":"1",
    "searchResultPosition": 0,
    "maxResults": 10
    }
    })";

    SendXMLRequest("POST", "/ISAPI/AccessControl/UserInfo/Search?format=json", createJSON, response3, sizeof(response3));
    std::cout << "Search Library Response: " << response3 << std::endl;

    SendXMLRequest("GET", "/ISAPI/AccessControl/UserInfo/capabilities?format=json", nullptr, response4, sizeof(response4));
    std::cout << "Search Library Response: " << response4 << std::endl;

    SendXMLRequest("GET", "/ISAPI/AccessControl/FaceRecognizeMode?format=json", nullptr, response5, sizeof(response5));
    std::cout << "Search Library Response: " << response5 << std::endl;

    SendXMLRequest("GET", "/ISAPI/Intelligent/FDLib/capabilities?format=json", nullptr, response6, sizeof(response6));
    std::cout << "Search Library Response: " << response6 << std::endl;

    createJSON = R"({
    "UserInfo":{
        "employeeNo":"000132",
        "name":"John Tukey",
        "userType":"normal",
        "doorRight":"1",
        "RightPlan":[{"doorNo":1,"planTemplateNo":"1"}],
        "gender":"male",
        "localUIRight":false,
        "maxOpenDoorTime":0,
        "userVerifyMode":"",
        "Valid":{
            "enable":true,
            "beginTime":"2025-02-22T00:00:00",
            "endTime":"2035-02-22T23:59:59",
            "timeType":"local"
        }}
    })";
    SendXMLRequest("POST", "/ISAPI/AccessControl/UserInfo/Record?format=json", createJSON, response6, sizeof(response6));
    std::cout << "Search Library Response: " << response6 << std::endl;

    std::string file_path = "./face.jpg";  / Change this to your image path
    std::string base64_url = image_to_base64(file_path);

    if (!base64_url.empty()) {
        std::cout << "Base64 Data URL:\n" << base64_url << std::endl;
    }
    / Correct JSON string
    std::string imgJSON = R"({
            "faceURL": ")" + base64_url + R"(",
            "faceLibType": "blackFD",
            "FDID": "1",
            "FPID": "000132"
        })";

    SendXMLRequest("POST", "/ISAPI/Intelligent/FDLib/FaceDataRecord?format=json", imgJSON.c_str(), response7, sizeof(response7));
    std::cout << "Search Library Response: " << response7 << std::endl;

    rapidjson::Document doc;
    doc.Parse(response1);

    if (!doc.HasMember("FDLib") || !doc["FDLib"].IsArray()) {
        std::cerr << "Invalid response format!" << std::endl;
        return "";
    }

    for (const auto& lib : doc["FDLib"].GetArray()) {
        if (lib.HasMember("FDID") && lib["FDID"].IsString()) {
            std::cout << "Found Face Library ID: " << lib["FDID"].GetString() << std::endl;
            return lib["FDID"].GetString(); / Return first FDID found
        }
    }

    return "";
}

void EditFaceLibrary(const char* fdID) {
    char response[2048] = {0};
    std::string url = "/ISAPI/Intelligent/FDLib/" + std::string(fdID);
    const char* editXML = R"(<FaceLibrary><name>UpdatedLib</name></FaceLibrary>)";
    SendXMLRequest("PUT", url.c_str(), editXML, response, sizeof(response));
    std::cout << "Edit Library Response: " << response << std::endl;
}

void DeleteFaceLibrary(const char* fdID) {
    char response[2048] = {0};
    std::string url = "/ISAPI/Intelligent/FDLib/" + std::string(fdID);
    SendXMLRequest("DELETE", url.c_str(), nullptr, response, sizeof(response));
    std::cout << "Delete Library Response: " << response << std::endl;
}

void LogoutAndCleanup() {
    if (lUserID >= 0) {
        NET_DVR_Logout(lUserID);
        std::cout << "Logged out successfully!" << std::endl;
    }
    NET_DVR_Cleanup();
}


bool UploadFacePicture(LONG userID, const std::string& imagePath, const std::string& faceLibId) {
    if (userID < 0) {
        std::cerr << "Invalid user ID!" << std::endl;
        return false;
    }

    if (faceLibId.empty()) {
        std::cerr << "No valid Face Library found!" << std::endl;
        return false;
    }


    / Open image file
    std::ifstream file(imagePath, std::ios::binary | std::ios::ate);
    if (!file.is_open()) {
        std::cerr << "Error: Unable to open image file: " << imagePath << std::endl;
        return false;
    }

    size_t fileSize = file.tellg();
    file.seekg(0, std::ios::beg);
    std::vector<char> imageData(fileSize);
    file.read(imageData.data(), fileSize);
    file.close();

    / Step 1: Initialize upload
    NET_DVR_FACELIB_COND faceLibCond = {0};
    faceLibCond.dwSize = sizeof(NET_DVR_FACELIB_COND);
    / Assign the retrieved Face Library ID
    /strncpy(faceLibCond.szFDID, faceLibId.c_str(), sizeof(faceLibCond.szFDID) - 1);
    /strncpy(faceLibCond.szFDID, faceLibId.c_str(), NET_SDK_MAX_FDID_LEN);  / FDID dynamically retrieved
    strncpy(faceLibCond.szFDID, faceLibId.c_str(), faceLibId.length());  / FDID dynamically retrieved
    /faceLibCond.dwFaceLibType = 0;  / Default type
    /faceLibCond.dwUploadType = 39;  / IMPORT_DATA_TO_FACELIB

    / Set other parameters
    faceLibCond.byConcurrent = 0;  / Disable concurrent processing
    faceLibCond.byCover = 1;       / Enable overwriting if full
    faceLibCond.byCustomFaceLibID = 0;  / Use system-generated FaceLibID

    / Identity Key (if required, else set to empty)
    memset(faceLibCond.byIdentityKey, 0, sizeof(faceLibCond.byIdentityKey));


    LONG uploadHandle = NET_DVR_UploadFile_V40(
            userID,  / From NET_DVR_Login_V40
            39,      / dwUploadType: IMPORT_DATA_TO_FACELIB
            &faceLibCond, / lpInBuffer: Pointer to our condition structure
            sizeof(NET_DVR_FACELIB_COND), / dwInBufferSize: Size of structure
            imageData.data(), / sFileName: Path to image file
            nullptr, / lpOutBuffer: Optional output buffer (nullptr if not used)
            0        / dwOutBufferSize: 0 since we are not using an output buffer
            );


    if (uploadHandle < 0) {
        std::cerr << "Upload init failed! Error: " << NET_DVR_GetLastError() << std::endl;
        return false;
    }

    / Step 2: Send face data using NET_DVR_UploadSend
    NET_DVR_SEND_PARAM_IN sendParam = {0};
    / Fill sendParam with the data to upload

    int result = NET_DVR_UploadSend(uploadHandle, &sendParam, NULL);
    if (result < 0) {
        std::cerr << "UploadSend failed! Error: " << NET_DVR_GetLastError() << std::endl;
        NET_DVR_UploadClose(uploadHandle);
        return false;
    }


    / Step 3: Monitor upload progress
    DWORD progress = 0;
    while (progress != 1) {
        if (!NET_DVR_GetUploadState(uploadHandle, &progress)) {
            std::cerr << "Error getting upload state: " << NET_DVR_GetLastError() << std::endl;
            NET_DVR_UploadClose(uploadHandle);
            return false;
        }
        std::cout << "Upload progress: " << progress * 100 << "%" << std::endl;
        sleep(500);
    }

    / Step 4: Retrieve upload result
    char resultBuffer[256] = {0};  / Buffer to receive upload result
    if (!NET_DVR_GetUploadResult(uploadHandle, resultBuffer, sizeof(resultBuffer))) {
        std::cerr << "Error retrieving upload result: " << NET_DVR_GetLastError() << std::endl;
        NET_DVR_UploadClose(uploadHandle);
        return false;
    } else {
        std::cout << "Upload successful! Picture ID: " << resultBuffer << std::endl;
    }



    / Step 5: Close upload session
    NET_DVR_UploadClose(uploadHandle);
    return true;
}


int Demo_Capture()
{
    if (!InitAndLogin()) return -1;

    GetSystemCapabilities();
    GetFaceLibraryCapabilities();
    string faceLibID = SearchFaceLibrary();

    if (faceLibID.empty()) {
        std::cerr << "No valid Face Library found!" << std::endl;
        return false;
    }

    /GetDeviceCapabilities();
    /UploadFacePicture(lUserID, "./face.jpg", faceLibID);
     / Add a person to the blackFD library
    std::string deviceIP = "10.0.0.10";  / Replace with your device IP
    std::string username = "admin";
    std::string password = "Ambition";
    std::string fdid = "1";   / Face Library ID
    std::string fpid = "000132";  / Unique Face ID
    std::string faceImagePath = "face.jpg";  / Image file path

    /bool success = SendFaceImageToFDLib(deviceIP, username, password, fdid, fpid, faceImagePath);
    /return success ? 0 : 1;

    /SendPersonWithPicture("John Doe", "123456", "face.jpg");
  /  SearchFaceLibrary();
    
    / Assuming an FDLib ID is retrieved from the search response
   / const char* testFDID = "3";  / Replace with actual ID
/    EditFaceLibrary(testFDID);
    /DeleteFaceLibrary(testFDID);

    LogoutAndCleanup();
    return 0;
}

trempa92 · Feb 24, 2025

Oh what a mess

For starters, why are you doing "SendXMLRequest" while its clearly a json

Im doing everything in C# or flutter.

Can you try with POSTMAN?

If the postman work, then you are doing something wrong with your methods.

sumanta · Feb 26, 2025

Hi,

I am trying to use the following API, and it does not seem to finish. If I want the data for the last 'x' secs, what modifications do I have to make to the API call

path = '

http://10.0.0.10/ISAPI/Event/notification/alertStream

'
response = session.get(path, stream=True)

The call is being tried on postman.
If I write the code in python/flutter will there be any changes in the call?

trempa92 · Feb 27, 2025

Well, postman is using simple get which closes connection. You need active http listener such as /events, or tcp event listener.

trempa92 · Feb 27, 2025

And you started in c++ , now you are talking about python or flutter. The heck

trempa92 · Feb 27, 2025

If you need solution done, i can do it for you, already got android app done that manages hikvision acs and anpr. Hit me up ill supply you demo license

sumanta · 2025-05-02T15:53:23-0400

Hi,

I am trying to call the post API (curl command provided) for DS-K1320EWX device
curl --location '

http://10.0.0.10/ISAPI/AccessControl/AcsEvent?format=json

' \
--header 'Content-Type: application/json' \
--data '{
"AcsEventCond": {
"searchID": "38c9de7c-b9a7-4f68-2168",
"searchResultPosition": 0,
"maxResults": 1000,
"major": 0,
"minor": 0,
"startTime": "2025-05-01T15:00:00+05:30",
"endTime": "2025-05-02T23:59:59+05:30"
}
}'

but I am getting incorrect data. Some samples are provided below.

{
"AcsEvent": {
"searchID": "38c9de7c-b9a7-4f68-2168",
"totalMatches": 105,
"responseStatusStrg": "MORE",
"numOfMatches": 30,
"InfoList": [
{
"major": 2,
"minor": 1024,
"time": "2025-05-02T02:21:25+05:30",
"type": 0,
"serialNo": 14088,
"currentVerifyMode": "invalid",
"mask": "unknown"
},
{
"major": 5,
"minor": 22,
"time": "2025-05-02T02:21:25+05:30",
"doorNo": 1,
"type": 0,
"serialNo": 14089,
"currentVerifyMode": "invalid",
"mask": "unknown"
},
{
"major": 1,
"minor": 1028,
"time": "2025-05-02T02:21:27+05:30",
"type": 0,
"serialNo": 14090,
"currentVerifyMode": "invalid",
"mask": "unknown"
},
{
"major": 2,
"minor": 1024,
"time": "2025-05-02T11:01:18+05:30",
"type": 0,
"serialNo": 14091,
"currentVerifyMode": "invalid",
"mask": "unknown"
},

I would need to have the data in the form

{
"AcsEvent": {
"searchID": "ad6b6ae7-5b7b-43cf-b2e8-8d9abe47d5bf",
"totalMatches": 11,
"responseStatusStrg": "OK",
"numOfMatches": 11,
"InfoList": [
{
"major": 5,
"minor": 104,
"time": "2025-05-02T17:42:27+05:30",
"cardType": 1,
"name": "b7aa4245ab0652c7e5ab1a8696d38021",
"cardReaderNo": 1,
"doorNo": 1,
"employeeNoString": "b0c533c44a107142faaf901aae670fd4",
"type": 0,
"serialNo": 14162,
"userType": "normal",
"currentVerifyMode": "face",
"mask": "no",
"pictureURL": "

http://10.0.0.10/LOCALS/pic/acsLinkCap/202505_00/02_174227_30104_0.jpeg@WEB000000000072

",
"FaceRect": {
"height": 0.671,
"width": 0.378,
"x": 0.325,
"y": 0.075
}
},
{
"major": 5,
"minor": 104,
"time": "2025-05-02T17:42:30+05:30",
"cardType": 1,
"name": "b7aa4245ab0652c7e5ab1a8696d38021",
"cardReaderNo": 1,
"doorNo": 1,
"employeeNoString": "b0c533c44a107142faaf901aae670fd4",
"type": 0,
"serialNo": 14163,
"userType": "normal",
"currentVerifyMode": "face",
"mask": "no",
"pictureURL": "

http://10.0.0.10/LOCALS/pic/acsLinkCap/202505_00/02_174230_30104_0.jpeg@WEB000000000073

",
"FaceRect": {
"height": 0.635,
"width": 0.357,
"x": 0.225,
"y": 0.201
}
},
{
"major": 5,
"minor": 75,
"time": "2025-05-02T17:42:36+05:30",
"cardType": 1,
"name": "b7aa4245ab0652c7e5ab1a8696d38021",
"cardReaderNo": 1,
"doorNo": 1,
"employeeNoString": "b0c533c44a107142faaf901aae670fd4",
"type": 0,
"serialNo": 14164,
"userType": "normal",
"currentVerifyMode": "face",
"attendanceStatus": "checkIn",
"label": "Check In",
"mask": "no",
"pictureURL": "

http://10.0.0.10/LOCALS/pic/acsLinkCap/202505_00/02_174236_30075_0.jpeg@WEB000000000074

",
"FaceRect": {
"height": 0.622,
"width": 0.35,
"x": 0.315,
"y": 0.304
}
},

It appears that iv would need to be created which I do not know how to do. Any guidance would be of immense help. If there is an alternate way of getting the event data with the details then also it would be very helpful.

trempa92 · 2025-05-02T23:40:55-0400

iv is not needed. Im not using curl so i cant tell. Im using CRUD within c# and flutter. Using digest authorization

sumanta · 2025-05-03T04:03:11-0400

I added the digest option as you could see in the command below. It seems to have no effect. Not sure if I am making some mistake or some suggestion of debugging this would be great.
In case I have made any mistake, hence I also created a python file and found the same result which showed it was not able to retrieve the information. I am pasting the python file below as I am unsure why I am unable to upload the file here.

(base) root@LAPTOP-2KFUO51R:/mnt/c/Users/suman/projects/hikvision-isapi-wrapper# curl --digest -u "admin:Ambition" \
--location '

http://10.0.0.10/ISAPI/AccessControl/AcsEvent?format=json

' \
--header 'Content-Type: application/json' \
--data '{
"AcsEventCond": {
"searchID": "38c9de7c-b9a7-4f68-2168",
"searchResultPosition": 0,
"maxResults": 1000,
"major": 0,
"minor": 0,
"startTime": "2025-05-01T15:00:00+05:30",
"endTime": "2025-05-02T23:59:59+05:30"
}
}'

Output
=====
{
"AcsEvent": {
"searchID": "38c9de7c-b9a7-4f68-2168",
"totalMatches": 105,
"responseStatusStrg": "MORE",
"numOfMatches": 30,
"InfoList": [{
"major": 2,
"minor": 1024,
"time": "2025-05-02T02:21:25+05:30",
"type": 0,
"serialNo": 14088,
"currentVerifyMode": "invalid",
"mask": "unknown"
}, {
"major": 5,
"minor": 22,
"time": "2025-05-02T02:21:25+05:30",
"doorNo": 1,
"type": 0,
"serialNo": 14089,
"currentVerifyMode": "invalid",
"mask": "unknown"
}, {
"major": 1,
"minor": 1028,
"time": "2025-05-02T02:21:27+05:30",
"type": 0,
"serialNo": 14090,
"currentVerifyMode": "invalid",
"mask": "unknown"
}, {
"major": 2,
"minor": 1024,
"time": "2025-05-02T11:01:18+05:30",
"type": 0,
"serialNo": 14091,
"currentVerifyMode": "invalid",
"mask": "unknown"
}, {
"major": 5,
"minor": 22,
"time": "2025-05-02T11:01:18+05:30",
"doorNo": 1,
"type": 0,
"serialNo": 14092,
"currentVerifyMode": "invalid",
"mask": "unknown"
}, {
"major": 1,
"minor": 1028,
"time": "2025-05-02T11:01:21+05:30",
"type": 0,
"serialNo": 14093,
"currentVerifyMode": "invalid",
"mask": "unknown"
}, {
"major": 2,
"minor": 39,
"time": "2025-05-02T11:02:00+05:30",
"type": 0,
"serialNo": 14094,
"currentVerifyMode": "invalid",
"mask": "unknown"
}, {
"major": 2,
"minor": 1031,
"time": "2025-05-02T11:02:01+05:30",
"type": 0,
"serialNo": 14095,
"currentVerifyMode": "invalid",
"mask": "unknown"
}, {
"major": 3,
"minor": 112,
"time": "2025-05-02T11:12:21+05:30",
"remoteHostAddr": "10.0.0.1",
"type": 0,
"serialNo": 14096,
"currentVerifyMode": "invalid",
"mask": "unknown"
}, {
"major": 2,
"minor": 1024,
"time": "2025-05-02T11:34:05+05:30",
"type": 0,
"serialNo": 14097,
"currentVerifyMode": "invalid",
"mask": "unknown"
}, {
"major": 5,
"minor": 22,
"time": "2025-05-02T11:34:05+05:30",
"doorNo": 1,
"type": 0,
"serialNo": 14098,
"currentVerifyMode": "invalid",
"mask": "unknown"
}, {
"major": 1,
"minor": 1028,
"time": "2025-05-02T11:34:07+05:30",
"type": 0,
"serialNo": 14099,
"currentVerifyMode": "invalid",
"mask": "unknown"
}, {
"major": 2,
"minor": 1024,
"time": "2025-05-02T11:36:59+05:30",
"type": 0,
"serialNo": 14100,
"currentVerifyMode": "invalid",
"mask": "unknown"
}, {
"major": 5,
"minor": 22,
"time": "2025-05-02T11:36:59+05:30",
"doorNo": 1,
"type": 0,
"serialNo": 14101,
"currentVerifyMode": "invalid",
"mask": "unknown"
}, {
"major": 1,
"minor": 1028,
"time": "2025-05-02T11:37:02+05:30",
"type": 0,
"serialNo": 14102,
"currentVerifyMode": "invalid",
"mask": "unknown"
}, {
"major": 2,
"minor": 1024,
"time": "2025-05-02T11:37:42+05:30",
"type": 0,
"serialNo": 14103,
"currentVerifyMode": "invalid",
"mask": "unknown"
}, {
"major": 5,
"minor": 22,
"time": "2025-05-02T11:37:42+05:30",
"doorNo": 1,
"type": 0,
"serialNo": 14104,
"currentVerifyMode": "invalid",
"mask": "unknown"
}, {
"major": 1,
"minor": 1028,
"time": "2025-05-02T11:37:43+05:30",
"type": 0,
"serialNo": 14105,
"currentVerifyMode": "invalid",
"mask": "unknown"
}, {
"major": 2,
"minor": 1024,
"time": "2025-05-02T11:39:32+05:30",
"type": 0,
"serialNo": 14106,
"currentVerifyMode": "invalid",
"mask": "unknown"
}, {
"major": 5,
"minor": 22,
"time": "2025-05-02T11:39:32+05:30",
"doorNo": 1,
"type": 0,
"serialNo": 14107,
"currentVerifyMode": "invalid",
"mask": "unknown"
}, {
"major": 1,
"minor": 1028,
"time": "2025-05-02T11:39:35+05:30",
"type": 0,
"serialNo": 14108,
"currentVerifyMode": "invalid",
"mask": "unknown"
}, {
"major": 2,
"minor": 1024,
"time": "2025-05-02T11:43:35+05:30",
"type": 0,
"serialNo": 14109,
"currentVerifyMode": "invalid",
"mask": "unknown"
}, {
"major": 5,
"minor": 22,
"time": "2025-05-02T11:43:35+05:30",
"doorNo": 1,
"type": 0,
"serialNo": 14110,
"currentVerifyMode": "invalid",
"mask": "unknown"
}, {
"major": 1,
"minor": 1028,
"time": "2025-05-02T11:43:37+05:30",
"type": 0,
"serialNo": 14111,
"currentVerifyMode": "invalid",
"mask": "unknown"
}, {
"major": 2,
"minor": 1024,
"time": "2025-05-02T12:00:48+05:30",
"type": 0,
"serialNo": 14112,
"currentVerifyMode": "invalid",
"mask": "unknown"
}, {
"major": 5,
"minor": 22,
"time": "2025-05-02T12:00:48+05:30",
"doorNo": 1,
"type": 0,
"serialNo": 14113,
"currentVerifyMode": "invalid",
"mask": "unknown"
}, {
"major": 2,
"minor": 1024,
"time": "2025-05-02T12:02:06+05:30",
"type": 0,
"serialNo": 14114,
"currentVerifyMode": "invalid",
"mask": "unknown"
}, {
"major": 5,
"minor": 22,
"time": "2025-05-02T12:02:06+05:30",
"doorNo": 1,
"type": 0,
"serialNo": 14115,
"currentVerifyMode": "invalid",
"mask": "unknown"
}, {
"major": 1,
"minor": 1028,
"time": "2025-05-02T12:02:09+05:30",
"type": 0,
"serialNo": 14116,
"currentVerifyMode": "invalid",
"mask": "unknown"
}, {
"major": 2,
"minor": 1024,
"time": "2025-05-02T12:04:48+05:30",
"type": 0,
"serialNo": 14117,
"currentVerifyMode": "invalid",
"mask": "unknown"
}]
}

Python file.
++++++++

import requests
from requests.auth import HTTPDigestAuth

url = "

http://10.0.0.10/ISAPI/AccessControl/AcsEvent?format=json

"

headers = {
"Content-Type": "application/json"
}

body = {
"AcsEventCond": {
"searchID": "abc123",
"searchResultPosition": 0,
"maxResults": 100,
"major": 0,
"minor": 0,
"startTime": "2025-05-01T00:00:00+05:30",
"endTime": "2025-05-02T23:59:59+05:30"
}
}

response = requests.post(
url,
headers=headers,
json=body,
auth=HTTPDigestAuth('admin', 'Ambition') # Digest Auth
)

print("Status:", response.status_code)
print("Response:", response.text)

API for hikvision face detection DS-k1T320EWX

n3wb

Getting comfortable

n3wb

Getting comfortable

Getting comfortable

n3wb

n3wb

Getting comfortable

n3wb

n3wb

Getting comfortable

n3wb

Getting comfortable

n3wb

Getting comfortable

Getting comfortable

Getting comfortable

n3wb

Getting comfortable

n3wb