Documentation for Face PSIM 1.0.1.

Previous page Get analytical data  List of possible errors of the Face recognition server Next page

General request format:

POST http://AxxonPSIM_user_login:AxxonPSIM_user_password@IP address:port/firserver/GetAnalitycByTime

Request parameters:

ParameterRequiredParameter description
server_idYes

Identifier of the Face recognition server in Face PSIM

minAgeNo

Minimum age of persons

If not specified, then age is not taken into account

maxAge No

Maximum age of persons

If not specified, then age is not taken into account

dateTimeFrom YesTime in UTC+0 format starting from which you want to get the data
dateTimeTo YesTime in UTC+0 format up to which you want to get the data
cameraIds No

Camera IDs in Face PSIM

If not specified, then results for all cameras are displayed

genders Yes

Gender of persons:  0—Unknown, 1—Males, 2—Females

If parameter value is empty, then all results are displayed regardless of gender

returnLocalTimeNo

Time format of the face capture: 0—time in UTC+0 format, 1—local time of the server

If not specified, then returnLocalTime=0

timePeriodNo

Type of grouping of analytical data: 0—by hour, 1—by day, 2—by month, 3—by year

If not specified, then timePeriod=0

Request example:

POST http://1:1@127.0.0.1:10000/firserver/GetAnalitycByTime

{
  "server_id": "1",
  "minAge": 20,
  "maxAge": 30,
  "dateTimeFrom": "2019-02-25T21:00:00.000",
  "dateTimeTo": "2019-03-29T20:59:59.000",
  "cameraIds": [
    "1"
  ],
  "genders": [
    0,
    1,
    2
  ],
  "returnLocalTime" : 0,
  "timePeriod" : 0
}

Request headlines:

Headline Headline description
AllowReturns the HTTP method used in request
Content-LengthShows the size of characters in bytes received in the request
Content-TypeReturns the type of received request
ServerSpecifies the server from which the request comes
Access-Control-Request-MethodReturns the HTTP method that can be used in the request
Access-Control-OriginShows if the server response can be accessed by the code that sends a request from this source
DateShows the time of the request

Response example:

{
    "Rows": [
        {
            "timestamp": "2019-02-27T180000.000",
            "value": [
                {
                    "age": 27,
                    "gender": {
                        "males": 10,
                        "females": 9,
                        "unknown": 0
  					},
					"smile": {
 						"males": 3,
 						"females": 1,
						"unknown": 0
					},
					"angry": {
						"males": 1,
  						"females": 2,
  						"unknown": 0
                	},
					"fear": {
 						"males": 1,
 						"females": 2,
						"unknown": 0
					},
					"happiness": {
						"males": 1,
  						"females": 1,
  						"unknown": 0
                	},
					"neutral": {
 						"males": 2,
 						"females": 1,
						"unknown": 0
					},
					"sadness": {
						"males": 1,
  						"females": 1,
  						"unknown": 0
                	},
					"surprise": {
						"males": 1,
  						"females": 1,
  						"unknown": 0
                	}
				}
            ]
        }
    ]
    "Response": {
        "Status": "SUCCESS"
    }
}

Response parameters:

ParameterParameter description
RowsList of unique faces
timestampTime of first access in UTC+0 format
valueList of additional face characteristics (for more details, see Get the recognition protocol)
ResponseResponse
StatusStatus of the completed request: SUCCESS—successful, if error—see List of possible errors of the Face recognition server
  • No labels