Adapter - NeoFace Watch
This page describes version 2.0.7 of the adapter.
Overview
This adapter interfaces with a NeoFace Watch system to get or process images and manage watchlists, persons and their photos.
Properties
| Name |
Display |
Is Required |
Comments |
Type |
Default Value |
Maximum Value |
Minimum Value |
Maximum Length |
Minimum Length |
| contactBasicServiceAddress |
Contact Base Service Address |
True |
The URL of the Neoface Watch service (e.g. http://172.24.100.10:8786/NEC.Identity.NeoFace.API.Watch/). |
string |
http:// |
|
|
1024 |
1 |
| serviceLogin |
Service Login |
True |
The login id for Neoface Watch services. |
string |
|
|
|
1024 |
1 |
| servicePassword |
Service Password |
True |
The password for Neoface Watch services. |
password |
|
|
|
1024 |
1 |
Commands
Get Subject Image (getSubjectImage)
Get the image for the specified subject.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| imageId |
Subject Id |
The subject id. |
True |
string |
Response Properties
| Name |
Description |
Type |
| imageId |
The image id. |
string |
| image |
The base64 encoded image string. |
string |
Get Face Image (getFaceImage)
Get the face image from a match.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| matchId |
Match Id |
The match id to get the image for. |
True |
string |
Response Properties
| Name |
Description |
Type |
| matchId |
The match id. |
string |
| image |
The base64 encoded image string. |
string |
Get Frame Image (getFrameImage)
Get the frame image from a match.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| matchId |
Match Id |
The match id to get the image for. |
True |
string |
Response Properties
| Name |
Description |
Type |
| matchId |
The match id. |
string |
| image |
The base64 encoded image string. |
string |
Get Faces from Photo (getFacesFromPhoto)
Find the count of faces and neoface face features from a photo.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| image |
Image |
The base64 encoded input image. |
True |
string |
Response Properties
| Name |
Description |
Type |
| faceCount |
Number of faces found in the input image. |
string |
| face |
First face's feature bytes. |
string |
CaptureImage (captureImage)
Trigger a Photo capture by a Neoface Camera.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| camera |
Camera |
Camera that needs to capture image. |
True |
string |
Response Properties
| Name |
Description |
Type |
| frame |
Camera captured image frame bytes. |
string |
| face |
Camera captured face features. |
string |
Match Images (matchImages)
Compare two images to see if they match the same face.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| scannedimage |
Scanned Image |
First image to match. |
True |
string |
| cameraimage |
Camera Image |
Second image to match. |
True |
string |
Response Properties
| Name |
Description |
Type |
| score |
Image match score (0-1). |
string |
| face |
Face features from second Image. |
string |
| subjectId |
If the image is found in Neoface, subjectId of the person. |
string |
| subjectPhotoId |
If the image is found in Neoface, subjectphotoId of the face. |
string |
Find Person (findPerson)
Find a subject using an image.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| image |
Image |
Input image. |
True |
string |
| scoreThreshold |
Score Threshold |
If the score is less than this value the command will fail. |
False |
string |
Response Properties
| Name |
Description |
Type |
| firstName |
First Name of Person found in Neoface. |
string |
| lastName |
Last Name of Person found in Neoface. |
string |
| subjectId |
SubjectId of Person found in Neoface. |
string |
| watchlist |
Watchlist in which the Person is enrolled in Neoface. |
string |
| enrollmentDate |
The date person was enrolled in Neoface. |
string |
| matchFeatureScore |
The date person was enrolled in Neoface. |
string |
| custom1 |
Custom Field 1. |
string |
| custom2 |
Custom Field 2. |
string |
| custom3 |
Custom Field 3. |
string |
| custom4 |
Custom Field 4. |
string |
| custom5 |
Custom Field 5. |
string |
| custom6 |
Custom Field 6. |
string |
| custom7 |
Custom Field 7. |
string |
| custom8 |
Custom Field 8. |
string |
| custom9 |
Custom Field 9. |
string |
| custom10 |
Custom Field 10. |
string |
| custom11 |
Custom Field 11. |
string |
| custom12 |
Custom Field 12. |
string |
Find Person by Features (findPersonByFeatures)
Find a subject using Neoface feature bytes for face.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| scannedFace |
Scanned Face |
Features or face to look for in Neoface. |
True |
string |
| scoreThreshold |
Score Threshold |
If the score is less than this value fail the command. |
False |
string |
Response Properties
| Name |
Description |
Type |
| firstName |
First Name of Person found in Neoface. |
string |
| lastName |
Last Name of Person found in Neoface. |
string |
| subjectId |
SubjectId of Person found in Neoface. |
string |
| watchlist |
Watchlist in which the Person is enrolled in Neoface. |
string |
| enrollmentDate |
The date person was enrolled in Neoface. |
string |
| matchFeatureScore |
The Feature Match Score. |
string |
| custom1 |
Custom Field 1. |
string |
| custom2 |
Custom Field 2. |
string |
| custom3 |
Custom Field 3. |
string |
| custom4 |
Custom Field 4. |
string |
| custom5 |
Custom Field 5. |
string |
| custom6 |
Custom Field 6. |
string |
| custom7 |
Custom Field 7. |
string |
| custom8 |
Custom Field 8. |
string |
| custom9 |
Custom Field 9. |
string |
| custom10 |
Custom Field 10. |
string |
| custom11 |
Custom Field 11. |
string |
| custom12 |
Custom Field 12. |
string |
Enroll Person (enrollPerson)
Enroll a subject.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| frame |
Frame |
Image frame bytes. |
True |
string |
| firstname |
First Name |
First Name for subject to be enrolled. |
True |
string |
| lastname |
Last Name |
Last Name for subject to be enrolled. |
True |
string |
| watchlist |
Watchlist |
Watchlist in which subject should be enrolled. |
True |
string |
| customfield1 |
Custom Field 1 |
Custom Field 1. |
False |
string |
| customfield2 |
Custom Field 2 |
Custom Field 2. |
False |
string |
| customfield3 |
Custom Field 3 |
Custom Field 3. |
False |
string |
| customfield4 |
Custom Field 4 |
Custom Field 4. |
False |
string |
| customfield5 |
Custom Field 5 |
Custom Field 5. |
False |
string |
| customfield6 |
Custom Field 6 |
Custom Field 6. |
False |
string |
| customfield7 |
Custom Field 7 |
Custom Field 7. |
False |
string |
| customfield8 |
Custom Field 8 |
Custom Field 8. |
False |
string |
| customfield9 |
Custom Field 9 |
Custom Field 9. |
False |
string |
| customfield10 |
Custom Field 10 |
Custom Field 10. |
False |
string |
| customfield11 |
Custom Field 11 |
Custom Field 11. |
False |
string |
| customfield12 |
Custom Field 12 |
Custom Field 12. |
False |
string |
Response Properties
| Name |
Description |
Type |
| enrollstatus |
0/1 - Enrollment Status. |
string |
| subjectid |
SubjectId of Enrolled Person. |
string |
| matchsubjectid |
Match Subject Id. |
string |
| matchsubjectphotoid |
Match Subject Photo Id. |
string |
| enrollmessage |
Detailed error / message for enrollment operation. |
string |
Update Person (updatePerson)
Update a subject.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| subjectid |
Subject Id |
SubjectID of person to update |
True |
string |
| firstname |
First Name |
First Name for subject to be updated. |
False |
string |
| lastname |
Last Name |
Last Name for subject to be updated. |
False |
string |
| notes |
Notes |
Notes for subject to be updated. |
False |
string |
| watchlist |
Watch List |
Watch list in which subject should be updated. |
False |
string |
| customfield1 |
Custom Field 1 |
Custom Field 1. |
False |
string |
| customfield2 |
Custom Field 2 |
Custom Field 2. |
False |
string |
| customfield3 |
Custom Field 3 |
Custom Field 3. |
False |
string |
| customfield4 |
Custom Field 4 |
Custom Field 4. |
False |
string |
| customfield5 |
Custom Field 5 |
Custom Field 5. |
False |
string |
| customfield6 |
Custom Field 6 |
Custom Field 6. |
False |
string |
| customfield7 |
Custom Field 7 |
Custom Field 7. |
False |
string |
| customfield8 |
Custom Field 8 |
Custom Field 8. |
False |
string |
| customfield9 |
Custom Field 9 |
Custom Field 9. |
False |
string |
| customfield10 |
Custom Field 10 |
Custom Field 10. |
False |
string |
| customfield11 |
Custom Field 11 |
Custom Field 11. |
False |
string |
| customfield12 |
Custom Field 12 |
Custom Field 12. |
False |
string |
Response Properties
| Name |
Description |
Type |
| updatestatus |
0/1 - Update Status. |
string |
| updatemessage |
Detailed error / message for update operation. |
string |
Find WatchList (findWatchlist)
Find a watchlist by name.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| watchlistname |
Watchlist name |
Watchlist name to look for. Create one if it does not exist. |
True |
string |
Response Properties
| Name |
Description |
Type |
| watchlistid |
The watchlist Id of the watchlist found. Create one if it does not exist. |
string |
Find Or Create Watchlist (findOrCreateWatchlist)
Find or create a watchlist by name.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| watchlistName |
Watchlist Name |
Watchlist name to look for. Create one if it does not exist. |
True |
string |
Response Properties
| Name |
Description |
Type |
| watchlistid |
The watchlist Id of the watchlist found. |
string |
Add photo to Subject (addPhotoToSubject)
Add a photo to an existing subject.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| inputimage |
Input Image |
Photo that needs to be added to the subject. |
True |
string |
| subjectid |
SubjectId |
SubjectId to which photo needs to be added. |
True |
string |
Response Properties
| Name |
Description |
Type |
| status |
Result of operation. |
string |
| resultType |
Result Type as returned from NeoFace. |
string |
| resultDetails |
Result details as returned from NeoFace. |
string |
| resultMessage |
Result message as returned from NeoFace. |
string |
Search Subject (searchSubject)
Search a subject.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| firstName |
First Name |
First Name of the subject. |
False |
string |
| lastName |
Last Name |
Last Name of the subject. |
False |
string |
| middleName |
Middle Name |
Middle Name of the subject. |
False |
string |
| title |
Title |
Title of the subject. |
False |
string |
Response Properties
| Name |
Description |
Type |
| numberOfSubjects |
Number of subjects found. |
string |
| subjectIds |
Comma separated list of subject ids found. |
string |
Match Existing Subject (matchExistingSubject)
Find if a given image belongs to a particular subject (subjectid).
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| inputImage |
Input Image |
The image to match. |
True |
string |
| subjectId |
Subject Id |
Subject Id to match against. |
True |
string |
Response Properties
| Name |
Description |
Type |
| score |
Match Score (0-1). |
string |
| subjectId |
Subject Id of the matched subject. |
string |
| subjectPhotoId |
Subject Photo Id of the matched subject. |
string |
| status |
Error / success details of the operation. |
string |
Get Subject Image Count (getSubjectImageCount)
Return the number of images for the specified subject.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| subjectId |
Subject Id |
The subject id to look for. |
True |
string |
Response Properties
| Name |
Description |
Type |
| imageCount |
The number of images the subject has. |
string |
| status |
The status of the request. |
string |
Get Enrolled Image by Subject Id (getEnrolledImageBySubjectId)
Find enrolled image for a given Subject ID.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| subjectId |
SubjectID |
Subject ID to look for. |
True |
string |
Response Properties
| Name |
Description |
Type |
| image |
The enrolled image for given SubjectId. |
string |
| status |
Status of request. |
string |
Get Matched Image (getMatchedImage)
Find image by Neoface MatchId.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| matchid |
Match ID |
Neoface Match Id. |
True |
string |
Response Properties
| Name |
Description |
Type |
| image |
Image found |
string |
| status |
Status of request - Error / success messages. |
string |
Returns all subject information for a given Subject ID.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| subjectId |
Subject Id |
Subject ID to look for. |
True |
string |
Response Properties
| Name |
Description |
Type |
| firstName |
First Name of Person found in Neoface. |
string |
| lastName |
Last Name of Person found in Neoface. |
string |
| subjectId |
SubjectId of Person found in Neoface. |
string |
| watchlist |
Watchlist in which the Person is enrolled in Neoface. |
string |
| enrollmentDate |
The date person was enrolled in Neoface. |
string |
| matchFeatureScore |
The date person was enrolled in Neoface. |
string |
| custom1 |
Custom Field 1. |
string |
| custom2 |
Custom Field 2. |
string |
| custom3 |
Custom Field 3. |
string |
| custom4 |
Custom Field 4. |
string |
| custom5 |
Custom Field 5. |
string |
| custom6 |
Custom Field 6. |
string |
| custom7 |
Custom Field 7. |
string |
| custom8 |
Custom Field 8. |
string |
| custom9 |
Custom Field 9. |
string |
| custom10 |
Custom Field 10. |
string |
| custom11 |
Custom Field 11. |
string |
| custom12 |
Custom Field 12. |
string |
Release History
| Version |
Type |
Description |
Tracking # |
Date |
| 2.0.1 |
Initial |
First release in the Adapter Type store. |
|
|
| 2.0.6 |
Maintenance |
Updated third-party components and improved maintainability. |
NAP-11518 |
|
| 2.0.7 |
Maintenance |
Updated third-party components and improved maintainability. |
NAP-23945 |
2022-11-30 |
Categories