Skip to main content

SubjectsApi

All URIs are relative to http://localhost

MethodHTTP requestDescription
clearDbDELETE /user/subjects/clear-dbClear all DB or by prefix depending on the use case.
createSubjectPOST /user/subjects/createCreate new subject and insert it to the database
createSubjectFromScannerImagesPOST /user/subjects/create-from-fingers-scanner-imagesCreate new subject and insert it to the database
getMultimodalSubjectByOperationIdGET /user/subjects/multimodal/operation/{uuid}Get subject information by UUID
getSubjectByOperationIdGET /user/subjects/operation/{uuid}Get subject information by UUID
getSubjectsEnrolledModalitiesGET /user/subjects/modality/typesModalities to which the subject has already been enrolled
getSubjectsIdListGET /user/subjects/id-listGet subjects' id list
getSubjectsQRCodeBySubjectIdGET /user/subjects/qrcode/{subjectid}QR code of the MegaMatcherId template
getTemplateModalitiesPOST /user/subjects/qrcode/modalitiesReturns modality types in the the template
reextractSubjectPOST /user/subjects/reextract-subjectAllows 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​

NameTypeDescriptionNotes
prefixStringSubject prefix[optional] [default to null]

Return type​

null (empty response body)

Authorization​

user-basic, user-oauth

HTTP request headers​

  • Content-Type: Not defined
  • Accept: /

createSubject​

MultimodalSubject createSubject(CreateSubjectRequest)

Create new subject and insert it to the database

Parameters​

NameTypeDescriptionNotes
CreateSubjectRequestCreateSubjectRequest

Return type​

MultimodalSubject

Authorization​

user-basic, user-oauth

HTTP request headers​

  • Content-Type: application/json
  • Accept: application/json, /

createSubjectFromScannerImages​

MultimodalSubject createSubjectFromScannerImages(CreateSubjectFromScannerImagesRequest)

Create new subject and insert it to the database

Parameters​

NameTypeDescriptionNotes
CreateSubjectFromScannerImagesRequestCreateSubjectFromScannerImagesRequest

Return type​

MultimodalSubject

Authorization​

user-basic, user-oauth

HTTP request headers​

  • Content-Type: application/json
  • Accept: application/json, /

getMultimodalSubjectByOperationId​

MultimodalSubject getMultimodalSubjectByOperationId(uuid)

Get subject information by UUID

Parameters​

NameTypeDescriptionNotes
uuidStringUUID of subject's operation[default to null]

Return type​

MultimodalSubject

Authorization​

user-basic, user-oauth

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json, /

getSubjectByOperationId​

Subject getSubjectByOperationId(uuid)

Get subject information by UUID

Parameters​

NameTypeDescriptionNotes
uuidStringUUID with which subject was created[default to null]

Return type​

Subject

Authorization​

user-basic, user-oauth

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json, /

getSubjectsEnrolledModalities​

EnrolledModalities getSubjectsEnrolledModalities(subjectId)

Modalities to which the subject has already been enrolled

Parameters​

NameTypeDescriptionNotes
subjectIdStringSubject's id[default to null]

Return type​

EnrolledModalities

Authorization​

user-basic, user-oauth

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json, /

getSubjectsIdList​

List getSubjectsIdList(prefix, subjectId, size)

Get subjects' id list

Parameters​

NameTypeDescriptionNotes
prefixStringPrefix to filter subject ids with[optional] [default to null]
subjectIdStringSubject id to filter subject ids with[optional] [default to null]
sizeIntegerSize of subject list[optional] [default to 10]

Return type​

List

Authorization​

user-basic, user-oauth

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json, /

getSubjectsQRCodeBySubjectId​

SubjectQRCode getSubjectsQRCodeBySubjectId(subjectid, modalities)

QR code of the MegaMatcherId template

Parameters​

NameTypeDescriptionNotes
subjectidStringQR code which to use to verify[default to null]
modalitiesListSubject's modality[optional] [default to null] [enum: FACE_MODALITY, VOICE_MODALITY, FINGERS_MODALITY, UNRECOGNIZED]

Return type​

SubjectQRCode

Authorization​

user-basic, user-oauth

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json, /

getTemplateModalities​

TemplateModalities getTemplateModalities(GetTemplateModalitiesRequest)

Returns modality types in the the template

Parameters​

NameTypeDescriptionNotes
GetTemplateModalitiesRequestGetTemplateModalitiesRequest

Return type​

TemplateModalities

Authorization​

user-basic, user-oauth

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​

NameTypeDescriptionNotes
ReextractSubjectRequestReextractSubjectRequest

Return type​

MultimodalSubject

Authorization​

user-basic, user-oauth

HTTP request headers​

  • Content-Type: application/json
  • Accept: application/json, /