Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

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
should be obtained
dateTimeTo YesTime in UTC+0 format
,
up to which you want to get the data
should be obtained
cameraIds No

Camera IDs in Face PSIM

If not specified, then results for all cameras are displayed

genders Yes

Gender of persons

whose data should be obtained

:  0

Unknown

—Unknown, 1

Males

—Males, 2

Females

—Females

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

returnLocalTimeNo

Time format of the face capture: 0

time

—time in UTC+0 format, 1

— local

—local time of the

Server

server

If not specified,

then returnLocalTime

then returnLocalTime=0

timePeriodNo

Type of grouping

the analytic

of analytical data: 0

by

—by hour, 1

by

—by day, 2

by

—by month, 3

by

—by year

If not specified,

then timePeriod

then timePeriod=0

Request example:

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

Code Block
{
  "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-OriginIndicates if Shows if the server response can be accessed by the code that sends the a request from this source can access the server response
DateShows the time of the request

Response example:

Expand
titleClick to expand...


Code Block
{
    "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
timestamp
First pass time
Time of first access in UTC+0 format
valueList of additional face characteristics (for more details, see
Getting
Get the recognition protocol)
ResponseResponse
Status
Completed
Status of the completed request
status
:
SUCCESS successful
SUCCESS—successful, if
error see
error—see List of possible errors of the Face
Recognition Server
recognition server