POST api/biometricface/enrol

This method is used to create (aka enrol) a new user account.

Request Information

URI Parameters

None.

Body Parameters

The model contiaing details of the subject to enrol.

EnrolModel
NameDescriptionTypeAdditional information
Name

string

None.

Photos

Collection of string

None.

Request Formats

application/json, text/json

Sample:
{
  "Name": "sample string 1",
  "Photos": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<EnrolModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QikFace.WebApi.Models.Public">
  <Name>sample string 1</Name>
  <Photos xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Photos>
</EnrolModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

If successful a GUID representing the ID of the newly enrolled subject. In the event of a failure an error message is returned.

string

Response Formats

application/json, text/json

Sample:
"sample string"

application/xml, text/xml

Sample:
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string</string>