SubjectsApi
All URIs are relative to http://localhost
| Method | HTTP request | Description |
|---|---|---|
| clearDb | DELETE /user/subjects/clear-db | Clear all DB or by prefix depending on the use case. |
| createSubject | POST /user/subjects/create | Create new subject and insert it to the database |
| getMultimodalSubjectByOperationId | GET /user/subjects/multimodal/operation/{uuid} | Get subject information by UUID |
| getSubjectByOperationId | GET /user/subjects/operation/{uuid} | Get subject information by UUID |
| getSubjectsEnrolledModalities | GET /user/subjects/modality/types | Modalities to which the subject has already been enrolled |
| getSubjectsIdList | GET /user/subjects/id-list | Get subjects' id list |
| getSubjectsQRCodeBySubjectId | GET /user/subjects/qrcode/{subjectid} | QR code of the MegaMatcherId template |
| getTemplateModalities | POST /user/subjects/qrcode/modalities | Returns modality types in the the template |
| reextractSubject | POST /user/subjects/reextract-subject | Allows to reextract the template to the current version for the best accuracy |
clearDb
clearDb(prefix)
Clear all DB or by prefix depending on the use case.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| prefix | String | Subject prefix | [optional] [default to null] |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
createSubject
MultimodalSubject createSubject(CreateSubjectRequest)
Create new subject and insert it to the database
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| CreateSubjectRequest | CreateSubjectRequest |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json, /
getMultimodalSubjectByOperationId
MultimodalSubject getMultimodalSubjectByOperationId(uuid)
Get subject information by UUID
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| uuid | String | UUID of subject's operation | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, /
getSubjectByOperationId
Subject getSubjectByOperationId(uuid)
Get subject information by UUID
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| uuid | String | UUID with which subject was created | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, /
getSubjectsEnrolledModalities
EnrolledModalities getSubjectsEnrolledModalities(subjectId)
Modalities to which the subject has already been enrolled
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| subjectId | String | Subject's id | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, /
getSubjectsIdList
List getSubjectsIdList(prefix, subjectId, size)
Get subjects' id list
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| prefix | String | Prefix to filter subject ids with | [optional] [default to null] |
| subjectId | String | Subject id to filter subject ids with | [optional] [default to null] |
| size | Integer | Size of subject list | [optional] [default to 10] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, /
getSubjectsQRCodeBySubjectId
SubjectQRCode getSubjectsQRCodeBySubjectId(subjectid, modalities)
QR code of the MegaMatcherId template
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| subjectid | String | QR code which to use to verify | [default to null] |
| modalities | List | Subject's modality | [optional] [default to null] [enum: FACE_MODALITY, VOICE_MODALITY, FINGERS_LEFT_HAND_MODALITY, FINGERS_RIGHT_HAND_MODALITY, UNRECOGNIZED] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, /
getTemplateModalities
TemplateModalities getTemplateModalities(GetTemplateModalitiesRequest)
Returns modality types in the the template
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| GetTemplateModalitiesRequest | GetTemplateModalitiesRequest |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json, /
reextractSubject
MultimodalSubject reextractSubject(ReextractSubjectRequest)
Allows to reextract the template to the current version for the best accuracy
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ReextractSubjectRequest | ReextractSubjectRequest |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json, /