JSON_OfflineCaptureCap

OfflineCaptureCap capability message in JSON format

{
  "OfflineCaptureCap":{
    "isSuportDownloadOfflineCaptureInfoTemplate":true, 
/*optional, whether it supports downloading template of offline user list: "true"-yes, this node is not returned-no*/
    "isSuportUploadOfflineCaptureInfo":true, 
/*optional, whether it supports uploading offline user list: "true"-yes, this node is not returned-no*/
    "isSupportDownloadCaptureData":true, 
/*optional, whether it supports downloading collected data: "true"-yes, this node is not returned-no*/
    "isSupportDeleteAllData":true, 
/*optional, whether it supports deleting all collected data: "true"-yes, this node is not returned-no*/
    "isSupportDeleteTheData":true, 
/*optional, whether it supports deleting specific collected data: "true"-yes, this node is not returned-no*/
    "SearchTask":{
      "supportFunction":{
/*required, string, supported methods, actually supported methods will be returned*/
        "@opt":["put", "get", "delete", "post"]
      }, 
      "searchID":{
/*required, string, search ID which is used to check whether the upper-layer clients are the same one*/
        "@min":0, 
        "@max":0
      }, 
      "maxResults":{
        "@min":0, 
        "@max":0
      }, 
      "captureNoList":{
        "maxSize":0, 
        "@min":0, 
        "@max":0
      }, 
      "searchType":{
        "@opt":["new", "modified"]
      }, 
      "DataCollections":{
/*optional, array, matched data information that has been searched*/
        "maxSize":0, 
        "captureNo":{
/*optional, integer, collection No.*/
          "@min":0, 
          "@max":0
        }, 
        "name":{
/*optional, string, name*/
          "@min":0, 
          "@max":0
        }, 
        "employeeNo":{
/*optional, string, employee No.*/
          "@min":0, 
          "@max":0
        }, 
        "CardNoList":{
/*optional, string, card No. list*/
          "maxSize":0, 
          "cardNo":{
            "@min": 0,
            "@max": 0
          },
          "cardType": {   
/*optional, string, card type: "TypeA_M1", "TypeA_CPU", "TypeB", "ID_125K", "FelicaCard", "DesfireCard"*/
            "@opt":["TypeA_M1","TypeA_CPU","TypeB","ID_125K","FelicaCard","DesfireCard"]
          }
        }, 
        "IDCardNo":{
/*optional, string, ID card No.*/
          "@min":0, 
          "@max":0
        }, 
        "FingerprintList":{
          "fingerprintID":{
            "@min":0, 
            "@max":0
          }, 
          "fingerprint":{
/*optional, fingerprint information, it is encoded using base64*/
            "@min":0, 
            "@max":0
          }
        }, 
        "FaceFeature":{
/*optional, string, facial feature information*/
          "isSupportFaceRegion":true, 
/*optional, whether it supports facial feature area*/
          "isSupportCommonPoint":true
/*optional, whether it supports feature point coordinates (e.g., left eye, right eye, left mouth corner, right mouth corner, nose)*/
        }, 
        "isSupportRiskMark":true, 
/*optional, whether it supports risk data mark*/
        "dataType":{
/*optional, data type*/
          "@opt":["new", "modified","normal"]
        },
        "IdentityInfo":{
/*identity information*/
          "chnName":{
/*optional, string, Chinese name*/
            "@min":0, 
            "@max":0
          }, 
          "enName":{
/*optional, string, English name*/
            "@min":0, 
            "@max":0
          }, 
          "sex":{
/*optional, string, gender: "male", "female"*/
            "@opt":["male", "female"]
          }, 
          "birth":{
/*optional, string, data of birth, e.g., "1990-02-24"*/
            "@min":0, 
            "@max":0
          }, 
          "addr":{
/*optional, string, address*/
            "@min":0, 
            "@max":0
          }, 
          "IDCardNo":{
/*optional, string, ID card No.*/
            "@min":0, 
            "@max":0
          }, 
          "issuingAuthority":{
/*optional, string, issuing authority*/
            "@min":0, 
            "@max":0
          }, 
          "startDate":{
/*optional, string, start date of validity period*/
            "@min":0, 
            "@max":0
          }, 
          "endDate":{
/*optional, string, end date of validity period*/
            "@min":0, 
            "@max":0
          }, 
          "passNo":{
/*optional, string, entry-exit permit No.*/
            "@min":0, 
            "@max":0
          }, 
          "issueNumber":{
/*optional, string, issued times*/
            "@min":0, 
            "@max":0
          }, 
          "certificateType":{
/*optional, string, certificate type*/
            "@min":0, 
            "@max":0
          }, 
          "permanentResidenceCardNo":{
/*optional, string, permanent resident visa No.*/
            "@min":0, 
            "@max":0
          }, 
          "nationalityOrAreaCode":{
/*optional, string, country/region code*/
            "@min":0, 
            "@max":0
          }, 
          "version":{
/*optional, string, certificate version No.*/
            "@min":0, 
            "@max":0
          }, 
          "receivingAuthorityCode":{
/*optional, string, acceptance authority code*/
            "@min":0, 
            "@max":0
          }, 
          "FingerprintList":{
            "maxSize":0, 
            "fingerprint":{
/*optional, string, fingerprint information, which should be encoded by Base64*/
              "@min":0, 
              "@max":0
            }
          }, 
          "pic":{
/*optional, string, certificate picture information, which should be encoded by Base64, encrypted and decrypted by a specific decryption library*/
            "@min":0, 
            "@max":0
          }
        }, 
        "CardIssueStatus":{
/*optional, issuing status list of cards containing face pictures and fingerprints*/
          "@size":0, 
/*optional, capability of number of elements in the array*/
          "face":{
/*optional, boolean, card issuing status of the face picture: true-with card issued, false-without card issued*/
            "@opt":[true, false]
          }, 
          "fingprint1":{
/*optional, boolean, card issuing status of the fingerprint 1: true-with card issued, false-without card issued*/
            "@opt":[true, false]
          }, 
          "fingprint2":{
/*optional, boolean, card issuing status of the fingerprint 2: true-with card issued, false-without card issued*/
            "@opt":[true, false]
          }
        }
      }
    }, 
    "RuleInfo":{
/*rule list, which lists rules for collecting different types of data*/
      "reqAdminRights":[true,false], 
/*required, boolean, whether the administrator permission is required: "true"-yes, "false"-no*/
      "enableCardNoLenAuto":[true,false], 
/*optional, boolean, whether to enable length self-adaption of the card serial No.*/
      "maxSize":0, 
      "supportFunction":{
/*required, string, supported methods, actually supported methods will be returned*/
        "@opt":["put", "get", "delete", "post"]
      }, 
      "dataType":{
/*required, string, data type: "name", "employeeNo"-employee No., "IDCardNo"-ID card No., "IDCardSerialNo"-ID card serial No.,  "IDCardDetails"-ID card details, "card", "fingprint"-fingerprint, "face"*/
        "@opt":["name","employeeNo","IDCardNo","IDCardSerialNo", "IDCardDetails","card", "fingprint", "face"]
      }, 
      "enable":[true, false], 
/*required, string, whether to collect and display: "true"-collect and display, "false"-not collect and display*/
      "uniqueCheck":[true, false], 
/*dependency, boolean, whether to enable uniqueness verification: "true"-yes, "false" (default) or this node is not returned-no. This field is valid when dataType is "name". For other data types, the field is the read-only optional parameter*/
      "len":[{
/*dependency, integer, data length. If dataType is "name", it refers to the name length and the default value is 128. For other data types, this field is the read-only optional parameter. This node will not be returned if it is not supported. The capability list will be returned according to the data type*/
        "dataType":"", 
        "@min":0, 
        "@max":0
      }], 
      "num":[{
/*dependency, integer, number of collected data, this field is valid when dataType is "fingerprint" or "card". The capability list will be returned according to the data type*/
        "dataType":"", 
        "@min":0, 
        "@max":0
      }], 
      "fingerprintIDs":{
/*dependency, integer, No. list of collected fingerprints, this field is valid when dataType is "fingerprint"*/
        "maxSize":0, 
        "@min":0, 
        "@max":0
      },
      "enableLocalIssueCard":  {
/*optional, boolean, whether to enable issuing smart cards locally*/
        "@opt": [true,false]
      },
      "isLocalStorage":  {
/*optional, boolean, whether to store face picture and fingerprint information in the device locally*/
        "@opt": [true,false]
      }
    }, 
    "CaptureProgress":{
      "supportFunction":{
/*required, string, supported methods, actually supported methods will be returned*/
        "@opt":["put", "get", "delete", "post"]
      }, 
      "reqCaptureNum":{
/*optional, integer, total number of persons to be collected*/
        "@min":0, 
        "@max":0
      }, 
      "completelyCaptureNum":{
/*optional, integer, number of completely collected persons*/
        "@min":0, 
        "@max":0
      }, 
      "partiallyCaptureNum":{
/*optional, integer, number of partially collected persons*/
        "@min":0, 
        "@max":0
      }, 
      "reqFaceNum":{
/*optional, integer, number of faces to be collected*/
        "@min":0, 
        "@max":0
      }, 
      "faceNum":{
/*optional, integer, number of collected faces*/
        "@min":0, 
        "@max":0
      }, 
      "reqFingerprintNum":{
/*optional, integer, number of fingerprints to be collected*/
        "@min":0, 
        "@max":0
      }, 
      "fingerprintNum":{
/*optional, integer, number of collected fingerprints*/
        "@min":0, 
        "@max":0
      }, 
      "reqCardNum":{
/*optional, integer, number of cards to be collected*/
        "@min":0, 
        "@max":0
      }, 
      "cardNum":{
/*optional, integer, number of collected cards*/
        "@min":0, 
        "@max":0
      }, 
      "reqIDCardNum":{
/*optional, integer, number of ID cards to be collected*/
        "@min":0, 
        "@max":0
      }, 
      "IDCardNum":{
/*optional, integer, number of collected ID cards*/
        "@min":0, 
        "@max":0
      },
      "reqIssueNum":{
/*optional, int, number of persons to be issued with smart cards*/
        "@min": 0,
        "@max": 0
      },
      "IssuedNum":{
/*optional, int, number of persons that have been issued with smart cards*/
        "@min": 0,
        "@max": 0
      }
    }, 
    "DataOutput":{
      "supportFunction":{
/*required, string, supported methods, actually supported methods will be returned*/
        "@opt":["put", "get", "delete", "post"]
      }, 
      "password":{
/*required, string, password for exporting*/
        "@min":0, 
        "@max":0
      }, 
      "type":{
/*optional, string, exporting method, the default method is "USB"*/
        "@opt":"USB"
      }, 
      "progress":{
/*required, integer, exporting progress*/
        "@min":0, 
        "@max":0
      }
    }
  }
}