Auto Tracking System
Web API Specifications

Version 2.0
July, 2022
Panasonic Connect Co., Ltd.

9Auto Tracking System Web API Specifications Version 1.9

Table of Contents
1

Introduction.................................................................................................................... 3
1.1

2

3

4

Purpose of this Document ........................................................................................................... 3

Interface ........................................................................................................................ 4
2.1

Specifications ............................................................................................................................... 4

2.2

Format.......................................................................................................................................... 4

2.3

List of Commands ........................................................................................................................ 5

Details of Commands .................................................................................................... 6
3.1

Camera Control ........................................................................................................................... 6

3.2

Camera Setting ............................................................................................................................ 7

3.2.1

Acquiring the Settings ............................................................................................................ 7

3.2.2

Changing the Settings ........................................................................................................... 9

3.3

Tracking ......................................................................................................................................11

3.4

Target ......................................................................................................................................... 12

3.5

Angle .......................................................................................................................................... 13

3.6

Camera State ............................................................................................................................. 14

3.7

Image ......................................................................................................................................... 16

3.8

Tracking Control......................................................................................................................... 18

3.9

Camera Control View................................................................................................................. 19

3.10

Set Face Recognition ................................................................................................................ 20

3.11

Get Face Recognition ................................................................................................................ 21

3.12

Edit Face Recognition................................................................................................................ 23

3.13

Clip Face Image ......................................................................................................................... 24

3.14

Auto Face Search ...................................................................................................................... 25

3.15

Auto Zoom ................................................................................................................................. 26

3.16

Preset......................................................................................................................................... 27

Processing of Error Commands .................................................................................. 28© 2014-2019 Panasonic. All Rights Reserved.

2 of 28

9Auto Tracking System Web API Specifications Version 1.9

1Introduction

1.1 Purpose of this Document
This document stipulates the specifications of the IFs used for communication between the Web
applications configuring the Auto Tracking System and external systems.

© 2014-2019 Panasonic. All Rights Reserved.

3 of 28

9Auto Tracking System Web API Specifications Version 1.9

2Interface

2.1 Specifications
In this document, the communication IFs specified as Web APIs conform to the communication
specifications of HTTP1.1, and the control for the system is implemented in the form of HTTP requests
issued to the URLs on the Web server. Excluding some commands (Register Scene File), all HTTP
requests are issued as the GET method.

2.2 Format
The format (URL) of control commands provided to an external system as a Web API is specified as
below.
[Transmission]
http://[IP Address]:[PortNo]/cgi-bin/auto_tracking?cmd=[Command]&[Parameter]=[Value]&…

No.
1
2

Name
IP Address
PortNo3

Command

4

Parameter

5

Value

Table 2.2-1 Details of Transmission Format

Description
This is the IP address of the Web application.
This is the standby port number of the Web application (default:
1337)
This is the control command string.
A list of commands that can be used is provided in 2.3 List of Commands.
This is the control command parameter. You can use an "&" tospecify several parameters.
Since it is specified in each command, refer to each section in 3
Details of Commands.
This is the value set in the control command parameter.
Since it is specified in each command, refer to each section in 3
Details of Commands.

[Reception]
The following three patterns are specified for the format of the response data received by an external
system.
Pattern 1: Return of only the response value
200 OK [Response]:[Response value]

Pattern 2: Return of the response value and response parameter value (string)
200 OK [Response]:[Response value],[Parameter]:[Parameter value], [Parameter]:[Parameter value],...

Pattern 3: Return of the response value and response parameter value (binary data)
200 OK [Response]:[Response value],[Binary data]© 2014-2019 Panasonic. All Rights Reserved.

4 of 28

9Auto Tracking System Web API Specifications Version 1.9
Table 2.2-2 Details of Reception Format
Description

Relatedcommand

No.

Name

1

Response"resp" is saved as a fixed string.

All commands

2

Response value"ack" or "nack" is saved as the response value.

All commands

3

Parameter

Since it is specified in each command, refer to eachsection in 3 Details of Commands.

Camera Control
Camera Setting
Camera State, etc.

4

Parameter value

Since it is specified in each command, refer to eachsection in 3 Details of Commands.

Camera Control
Camera Setting
Camera State, etc.

5Binary data

Since it is specified in each command, refer to eachsection in 3 Details of Commands.

ThumbnailImage

2.3 List of Commands
This section describes the list of commands stipulated in these specifications.
For details on each command, refer to 3 Details of Commands.
No.
1

Name
Camera Control

2
3
4
5
6
7
8
9

Camera Setting
Tracking
TargetAngle
Camera State
Image
Tracking Control
Camera Control View

10

Set Face Recognition

11

Get Face Recognition

12
13
14
15
16

Edit Face Recognition
Clip Face Image
Auto Face SearchAuto Zoom
PresetTable 2.3-1 List of Commands
Description
Used to establish a connection or disconnect the connection withthe target camera.
Used to acquire or change the settings of the target camera.
Used to start or stop the tracking process.
Used to set the display position of the tracking process target.
Used to perform PTZ control (automatic) of the target camera.
Used to acquire the state information of the camera.
Used to acquire a shot of camera images.
Used to enable or disable the tracking process.
Used to establish a connection or disconnect the connection withthe target camera, and to display the tracking applications on thescreen.
Used to acquire the system information set(face recognition information).
Used to acquire the system information list
(face recognition information).
Used to edit the system information (face recognition information).
Used to extract the face image data.
Used to set auto the face search
Used to set the auto zoom
Used to set, clear or recall the preset position© 2014-2019 Panasonic. All Rights Reserved.

5 of 28

9Auto Tracking System Web API Specifications Version 1.9

3

Details of Commands

3.1 Camera Control
The Camera Control command is used to start or stop communication with the target camera. The list oftransmission parameters is as shown below.
Table 3.1-1 List of Transmission Parameters
Name

Usage

Type

Description

id

MandatoryIntegervalue

This is the camera ID.

control

Mandatory

StringEither start or stop is saved.

The reception response parameter during communication with the camera is specified as below.
message:[1]The information shown below is saved in [1].
Table 3.1-2 List of Values
No.
1

Name
messageType
StringDescription
In the case of a negative acknowledgment, the cause issaved as a message.

Command example:
In this example, the command is sent to the camera with ID = 1 of Auto Tracking System running on
the PC with IP address 192.168.0.200.
Communication start
http://192.168.0.200:1337/cgi-bin/auto_tracking?cmd=CameraControl&id=1&control=startCommunication stop
http://192.168.0.200:1337/cgi-bin/auto_tracking?cmd=CameraControl&id=1&control=stop© 2014-2019 Panasonic. All Rights Reserved.

6 of 28

9Auto Tracking System Web API Specifications Version 1.9

3.2 Camera Setting
The Camera Setting command is used to acquire or change the settings of the camera managed by
Tracking Control.

3.2.1 Acquiring the Settings
The list of transmission parameters during acquisition of camera settings is described below.
Table 3.2-1 List of Transmission Parameters
Name
id

Usage

Type

MandatoryInteger value

Description
This is the camera ID.

The reception response parameters during acquisition of camera settings are specified as below.
id:[1],name:[2],ip_addr:[3],zoom:[4],height:[5],distance:[6],angle:[7],angle_mode:[8],angle_zoom:[9],detection:[10],lost:[11],lost_action_wait_sec:[12],auto_start:[13],sensitivity:[14],disable_area[15],detect_area[16],template_matching_level[17],scene_file_name:[18],face_recognition_id:[19]The camera setting information is saved in the below-mentioned format at the locations corresponding
to the numbers enclosed within "[ ]". Note that when the camera ID is invalid, "nack", which indicates anegative acknowledgment, is saved, and the response parameter described above is not saved.
Table 3.2-2 List of Values
No.

Name

Type
Integer value

Description1

idThis is the camera ID.

2

name

StringThis is the name of the camera.

3

ip_addrStringThis is the IP address or host name of the camera.

4

zoom

Integer value

This is the upper-limit value (0 to 100) of
magnification during the tracking process.

5

heightInteger value

This is the installation height of the camera (T.B.D)

6

distance

Integer value

7

angle

Integer value

8

angle_mode

Integer value

This is the installation distance of the camera fromthe platform (T.B.D)
This is the installation distance of the camera fromthe platform (T.B.D)
Indicates the automatic calculation setting of theAngle command for the Upper Body, Full Body, andFull Shot by delimiting with a comma.
0: Manual (use the value set by the user)
1: AutoExample:When automatic setting is made only for the Upper
Body: 1,0,0
When automatic setting is made only for the Full
Shot: 0,0,1© 2014-2019 Panasonic. All Rights Reserved.

7 of 28

9Auto Tracking System Web API Specifications Version 1.9
No.

Name

Type

angle_zoom

9Integer value

10

detection

String11

lostString12

lost_action_wait_sec

Integer value

13

auto_start

Integer value

14

sensitivity

Integer value

Description
Indicates the magnification value (0 to 100) during
manual setting for the Upper Body, Full Body, andFull Shot by delimiting with a comma.
Example:All 100%: 100, 100, 100
This is the execution setting of the DETECT
process. Either of the following values is saved.
"manual": Manual"auto": Auto
This is the process setting during LOST detection.
Either of the following values is saved.
"home": The HOME position is called"none": No operation is performed.
The standby time (seconds) until the HOME positionis called after LOST detection is saved.
This is the automatic execution setting of the
Tracking process after the Detect process.
Either 0 (disabled) or 1(enabled) is saved.
This is the dead-zone setting of the tracking region.
The information about the region in which theautomatic tracking process is not allowed to start issaved by delimiting with a comma.
0: Indicates the information of the top left position (X15

disable_area

Integer value

16

detect_area

Integer value

17

template_matching_level

Integer value

18

scene_file_name

String19

face_recognition_id

Integer value

coordinate) of the region information.
1: Indicates the information of the top left position (Ycoordinate) of the region information.
2: Indicates the width of the region information.
3: Indicates the height of the region information.

The coordinate information of the top end andbottom end of the automatic detection setting regionis saved by delimiting with a comma.
0: Indicates the information of the top end position(Y coordinate) of the region information.
1: Indicates the information of the bottom end
position (Y coordinate) of the region information.
2: Indicates the width of the region information.
3: Indicates the height of the region information.
This is the template processing priority level (1 to10) of the tracking process.
This is the scene file name that is used as a
tracking process parameter. A blank character (" ")is saved in the default state.
This is the ID of the image for the facial recognition.
Set -1 to cancel face selection.
If the image is not set, NULL is saved.

Command example:
In this example, the command is sent to the camera with ID = 1 of Auto Tracking System running on
the PC with IP address 192.168.0.200.
© 2014-2019 Panasonic. All Rights Reserved.

8 of 28

9Auto Tracking System Web API Specifications Version 1.9
Acquiring the Settings
http://192.168.0.200:1337/cgi-bin/auto_tracking?cmd=CameraSetting&id=1

3.2.2 Changing the Settings
The list of transmission parameters when changing the camera settings is described below.
Table 3.2-3 List of Transmission Parameters
Name

Usage

Type

id

MandatoryInteger value

nameOptional

Stringip_addr

Optional

Stringzoom

Optional

Integer value

heightOptional

Integer value

distance

Optional

Integer value

angle

Optional

Integer value

angle_mode

Optional

Integer value

angle_zoom

Optional

Integer value

detection

Optional

Stringlost

Optional

Stringlost_action_wait_sec

Optional

Integer value

auto_start

Optional

Integer value

sensitivity

Optional

Integer value

disable_area

Optional

Integer value

Description
This is the camera ID.
This is the name of thecamera.
This is the IP address or hostname of the camera.
This is the upper-limit value(0 to 100) of magnification
during the tracking process.
This is the installation height ofthe camera (T.B.D)
This is the installation
distance of the camera fromthe platform (T.B.D)
This is the installation
distance of the camera fromthe platform (T.B.D)
For details on the setting
value, refer to 3.2.1
Acquiring the Settings.
For details on the setting
value, refer to 3.2.1
Acquiring the Settings.
For details on the setting
string, refer to 3.2.1
Acquiring the Settings.
For details on the setting
string, refer to 3.2.1
Acquiring the Settings.
For details on the setting
value, refer to 3.2.1
Acquiring the Settings.
For details on the setting
value, refer to 3.2.1
Acquiring the Settings.
For details on the setting
value, refer to 3.2.1
Acquiring the Settings.
For details on the setting
value, refer to 3.2.1© 2014-2019 Panasonic. All Rights Reserved.

9 of 28

9Auto Tracking System Web API Specifications Version 1.9
Name

Usage

Type

Description
Acquiring the Settings.

detect_area

Optional

Integer value

template_matching_level

Optional

Integer value

scene_file_name

Optional

Stringface_recognition_id

Optional

Integer value

For details on the setting
value, refer to 3.2.1
Acquiring the Settings.
For details on the setting
value, refer to 3.2.1
Acquiring the Settings.
For details on the setting
value, refer to 3.2.1
Acquiring the Settings.
For details on the setting
value, refer to 3.2.1
Acquiring the Settings.

The reception response when changing the camera settings is saved as either "ack", which indicates a
positive acknowledgment, or "nack", which indicates a negative acknowledgment.
Command example:
In this example, the command is sent to the camera with ID = 1 of Auto Tracking System running on
the PC with IP address 192.168.0.200.
Changing camera namehttp://192.168.0.200:1337/cgi-bin/auto_tracking?cmd=CameraSetting&id=1&name=AW-HE70
Enabling face recognition
http://192.168.0.200:1337/cgi-bin/auto_tracking?cmd=CameraSetting&id=1&face_recognition=1
Disabling face recognition
http://192.168.0.200:1337/cgi-bin/auto_tracking?cmd=CameraSetting&id=1&face_recognition=0
Setting face recognition data
http://192.168.0.200:1337/cgi-bin/auto_tracking?cmd=CameraSetting&id=1&face_recognition_id=4
Cancelling face recognition data
http://192.168.0.200:1337/cgi-bin/auto_tracking?cmd=CameraSetting&id=1&face_recognition_id=-1© 2014-2019 Panasonic. All Rights Reserved.

10 of 28

9Auto Tracking System Web API Specifications Version 1.9

3.3 Tracking
The Tracking command is used to start or stop the tracking process. The list of transmission parameters
is as shown below.
Table 3.3-1 List of Transmission Parameters
Name

Usage

Type

id

MandatoryInteger value

process

Mandatory

StringDescription
This is the camera ID.
Either start or stop is saved.

The reception response is saved as either "ack", which indicates a positive acknowledgment, or "nack",
which indicates a negative acknowledgment.

Command example:
In this example, the command is sent to the camera with ID = 1 of Auto Tracking System running on
the PC with IP address 192.168.0.200.
Start tracking
http://192.168.0.200:1337/cgi-bin/auto_tracking?cmd=Tracking&id=1&process=start
Stop tracking
http://192.168.0.200:1337/cgi-bin/auto_tracking?cmd=Tracking&id=1&process=stop© 2014-2019 Panasonic. All Rights Reserved.

11 of 28

9Auto Tracking System Web API Specifications Version 1.9

3.4 Target
The Target command is used to set the display position of the tracking process target.
Table 3.4-1 List of Transmission Parameters
Name

Usage

Type

id

MandatoryInteger value

position_x

MandatoryInteger value

position_y

MandatoryInteger value

Description
This is the camera ID.
This is the X coordinate of the specified display position.
(Specify in the range of 0 to 639)
This is the Y coordinate of the specified display position.
(Specify in the range of 0 to 359)

The reception response is saved as either "ack", which indicates a positive acknowledgment, or "nack",
which indicates a negative acknowledgment.

Command example:
In this example, the command is sent to the camera with ID = 1 of Auto Tracking System running on
the PC with IP address 192.168.0.200.
Setting position of the tracking process target
http://192.168.0.200:1337/cgi-bin/auto_tracking?cmd=Target&id=1&position_x=320&position_y=180© 2014-2019 Panasonic. All Rights Reserved.

12 of 28

9Auto Tracking System Web API Specifications Version 1.9

3.5 Angle
The Angle command is used for capturing the image of the person, who is the tracking target, by using
any one of Upper Body / Full Body / Full / Zoom OFF when the PTZ control that is decided inaccordance with the camera settings to be controlled is executed automatically. The list of transmission
parameters is as shown below.
Table 3.5-1 List of Transmission Parameters
Name

Usage

Type

id

MandatoryInteger value

mode

Mandatory

StringDescription
This is the camera ID.
Any one of upper / body / full / off is saved.

The reception response is saved as either "ack", which indicates a positive acknowledgment, or "nack",
which indicates a negative acknowledgment.

Command example:
In this example, the command is sent to the camera with ID = 1 of Auto Tracking System running on
the PC with IP address 192.168.0.200.
Setting angle
http://192.168.0.200:1337/cgi-bin/auto_tracking?cmd=Angle&id=1&mode=upper© 2014-2019 Panasonic. All Rights Reserved.

13 of 28

9Auto Tracking System Web API Specifications Version 1.9

3.6 Camera StateThe Camera State command is used to acquire the automatic tracking process state of the camera
managed by Tracking Control. The list of transmission parameters is as shown below.
Table 3.6-1 List of Transmission Parameters
Name
id

Usage

Type

MandatoryInteger value

Description
This is the camera ID.

The reception response parameters are specified as below.
id:[1],connection:[2],detection:[3],tracking:[4],lost:[5],angle:[6],preset:[7],angle_type:[8],target_p
osition[9],target_position_area:[10],pan_tilt_limit:[11] ,face_recognition:[12],auto_face_search[13],auto_zoom[14]The camera state information is saved in the below-mentioned format at the locations corresponding to
the numbers enclosed within "[ ]". Note that when the camera ID is invalid, "nack", which indicates anegative acknowledgment, is saved, and the response parameter described above is not saved.
Table 3.6-2 List of Values
No.

Name

Type

1

id

Integer value

2

connection

Integer value3

detection

Integer value

4

tracking

Integer value

5

lost

Integer value

6

angle

Integer value

7

presetInteger value

Description
This is the camera ID.
Indicates the communication state with the camera.
0: No communication, or communication disruption
1: Communication in progress
Indicates the detection state of the tracking target.
0: The tracking target is not detected
1: The tracking target is already detected
Indicates the execution state of the tracking process.
0: The tracking process has stopped
1: The tracking process is being executed
Indicates the existence of LOST detection for the
tracking target.
0: LOST not detected
1: LOST detected
Indicates the feasibility of executing the Angle command.
0: Angle request is possible
1: Angle request is not possible
Indicates the feasibility of execution of the Preset
command (playback) for Home, Preset 1, and Preset 2
by delimiting with a comma.
0: Cannot be executed
1: Can be executed
Example:Can be executed only for Home: 1,0,0
Can be executed only for Preset 2: 0,0,1© 2014-2019 Panasonic. All Rights Reserved.

14 of 28

9Auto Tracking System Web API Specifications Version 1.9

8angle_type

Integer value

9target_position

Integer value

10target_position_area

Integer value

11

pan_tilt_limit

Integer value

Indicates the type of the angle of view during automatic
tracking execution.
0: Upper Body Shot
1: Full Body Shot
2: Full Shot
3: Control Off
Indicates the coordinate information of the control center of
the tracking target by delimiting with a comma.
Example:X coordinate of the control center: 100
Y coordinate of the control center: 200=> 100,200
Indicates the information about the region in which theposition of the tracking target can be set.
Example:X coordinate of the top left position of the region: 100
Y coordinate of the top left position of the region: 200
Width of the region information: 500
Height of the region information: 300=> 100,200,300,500
Indicates the setting state of the Pan/Tilt range of motion bydelimiting with a comma.
0: Release
1: SetExample:Set only the upper direction：1,0,0,0
Set all direction：1,1,1,1

12

face_recognition

Integer value

13

auto_face_searchInteger value

14

auto_zoom

Integer value

This is the setting of the facial recognition.
Either 0 (disabled) or 1(enabled) is saved.
This is the setting of the Auto Face Search.
Either 0 (disabled) or 1(enabled) is saved.
This is the setting of the Auto Zoom.
Either 0 (disabled) or 1(enabled) is saved.

Command example:
In this example, the command is sent to the camera with ID = 1 of Auto Tracking System running on
the PC with IP address 192.168.0.200.
Acquiring state of the camera
http://192.168.0.200:1337/cgi-bin/auto_tracking?cmd=CameraState&id=1© 2014-2019 Panasonic. All Rights Reserved.

15 of 28

9Auto Tracking System Web API Specifications Version 1.9

3.7 ImageThe Image command is used to acquire a frame image of camera images. The command format is set
as binary data configured by a header including the tracking process information, and a data part inwhich Jpeg-format binary data is saved. The list of transmission parameters is as shown below.
Table 3.7-1 List of Transmission Parameters
Name
id

Usage

Type

MandatoryInteger value

Description
This is the camera ID.

The reception response during a positive acknowledgment is set as binary data having the contents
specified below. Note that when the camera ID is invalid, "nack", which indicates a negative
acknowledgment is saved for a request corresponding to a camera ID with which either nocommunication is being performed, or the communication has been disrupted, and binary data is not
saved.
Table 3.7-2 Reception Response Data Configuration
Name

Byte

Type

Description

Command information

32

ASCII

The type of command data and the command
name are saved as "response,GetImage". "0" issaved in the region in which no string is saved.

Camera ID

2

ASCII

The information of IDs from "01" to "99" is saved.

Display magnification

3

ASCII

The magnification information [%] is saved
as "000" to "100".

Tracking target
rectangle information

32

ASCII

Tracking region
rectangle information

32

ASCII

Facial detection
rectangle information

32

ASCII

Upper body detection
rectangle information

32

ASCII

The rectangle information (X, Y coordinates,
width, height) of the tracking target is saved in
the format described below. "0" is saved in theregion in which no string is saved.
Example:100,200,300,600
Note that when the rectangle information does notexist on the process, "0" is saved for each parameter.
The rectangle information (X, Y coordinates,
width, height) of the tracking region is saved in
the format described below. "0" is saved in theregion in which no string is saved.
Example:1000,250,800,600
Note that when the rectangle information does notexist on the process, "0" is saved for each parameter.
The rectangle information (X, Y coordinates,
width, height) of the detected face is saved in
the format described below. "0" is saved in theregion in which no string is saved.
Example:100,200,80,80
The rectangle information (X, Y coordinates,
width, height) of the detected upper body issaved in the format described below. "0" is© 2014-2019 Panasonic. All Rights Reserved.

16 of 28

9Auto Tracking System Web API Specifications Version 1.9
saved in the region in which no string is saved.
Example:200,200,160,160
Frame image

Variable

BinaryThe JPG binary of the frame image is saved.

Command example:
In this example, the command is sent to the camera with ID = 1 of Auto Tracking System running on
the PC with IP address 192.168.0.200.
Acquiring a frame image and rectangle information
http://192.168.0.200:1337/cgi-bin/auto_tracking?cmd=Image&id=1© 2014-2019 Panasonic. All Rights Reserved.

17 of 28

9Auto Tracking System Web API Specifications Version 1.9

3.8 Tracking Control
The Tracking Control command is used to enable or disable the tracking process.
The list of transmission parameters is as shown below.
Table 3.8-1 List of Transmission Parameters
Name
id

Usage

Type

MandatoryInteger value

Description
This is the camera ID.
Either on or off is saved.
The processing contents during parameter setting aresame as those described below:
For "on"• Camera Setting: detection = auto

enableMandatory

String• Tracking: process = start
For "off"• Camera Setting: detection = manual• Tracking: process = stop

The reception response is saved as either "ack", which indicates a positive acknowledgment, or "nack",
which indicates a negative acknowledgment.

Command example:
In this example, the command is sent to the camera with ID = 1 of Auto Tracking System running on
the PC with IP address 192.168.0.200.
Enable tracking process
http://192.168.0.200:1337/cgi-bin/auto_tracking?cmd=TrackingControl&id=1&enable=on
Disable tracking process
http://192.168.0.200:1337/cgi-bin/auto_tracking?cmd=TrackingControl&id=1&enable=off© 2014-2019 Panasonic. All Rights Reserved.

18 of 28

9Auto Tracking System Web API Specifications Version 1.9

3.9 Camera Control View
The Camera Control View command is used for starting or stopping communication with the target
camera, and for changing the screen display content of the tracking software. The list of transmission
parameters is as shown below.
This command can be used only when the tracking software is a native application and the version is
3.* or lower.
Table 3.9-1 List of Transmission Parameters
Name
id

Usage

Type

MandatoryInteger value

Description
This is the camera ID.
Either start or stop is saved.

control

Mandatory

String

The process for starting communication with the camera is
executed when "start" is specified, and the Camera View
screen of the camera is displayed when the process is
successful. If the process fails, the screen display is not
updated.
The process for stopping communication with the camera
is executed when "stop" is specified, and the Camera
Select screen is displayed when the process is
successful. If the process fails, the screen display is not
updated.

The reception response is saved as either "ack", which indicates a positive acknowledgment, or "nack",
which indicates a negative acknowledgment.

Command example:
In this example, the command is sent to the camera with ID = 1 of Auto Tracking System running on
the PC with IP address 192.168.0.200.
Display the Camera View screen
http://192.168.0.200:1337/cgi-bin/auto_tracking?cmd=CameraControlView&id=1&control=start
Display the Camera Select screen
http://192.168.0.200:1337/cgi-bin/auto_tracking?cmd=CameraControlView&id=1&control=stop© 2014-2019 Panasonic. All Rights Reserved.

19 of 28

3.10 Set Face Recognition

9Auto Tracking System Web API Specifications Version 1.9

The Face Recognition command is used to change the enable/disable setting of the Face Recognition
function.
A list of parameters to be sent is shown below.
Table 3.10-1 List of Transmission Parameters
Name

Usage

Type

id

MandatoryInteger value

mode

Mandatory

StringDescription
This is the camera ID.
This is the setting of the Face Recognition.
Either 0 (disabled) or 1(enabled) is saved.

The reception response is saved as either "ack", which indicates a positive acknowledgment, or "nack",
which indicates a negative acknowledgment.

Command example:
In this example, the command is sent to the camera with ID = 1 of Auto Tracking System running on
the PC with IP address 192.168.0.200.
Face Recognition OFF
http://192.168.0.200:1337/cgi-bin/auto_tracking?cmd=FaceRecognition&id=1&mode=0
Face Recognition ON
http://192.168.0.200:1337/cgi-bin/auto_tracking?cmd=FaceRecognition&id=1&mode=1© 2014-2019 Panasonic. All Rights Reserved.

20 of 28

9Auto Tracking System Web API Specifications Version 1.9

3.11 Get Face Recognition
The Get Face Recognition command is used to acquire the list of face recognition information
corresponding to the page no., search string, and number of elements per page. The list of transmission
parameters is as shown below.
Table 3.11-1 List of Transmission Parameters
Name

Usage

Type

Description

page

MandatoryInteger value

query

Optional

Stringdata_num

MandatoryInteger value

This is the specified page no.
This is the search string.
This is the specified number of elements per page.

The reception response is saved as either "ack", which indicates a positive acknowledgment, or "nack",
which indicates a negative acknowledgment.
The reception response parameters are specified as below.
data_list:[1],page_num:[2]The list information is saved in the below-mentioned format at the locations corresponding to thenumbers enclosed within "[ ]". Note that when the specified parameter is invalid, "nack", which indicatesa negative acknowledgment, is saved, and the response parameter described above is not saved.
Table 3.11-2 Reception Response Data Configuration
No.

Name

Type

Description
The face recognition information corresponding to the specified parameters is saved in the list format shown below. (Enclosethe entire list between "[" and "]", each record between "{" and"}", and express the information of each field of the record as[Field name]:[Field value]".)1

data_list

List information

Example:data_list:[{id:1,target_name:"Target001",face_contents:”[*]”},{id:2,target_name:"Target002",face_contents:”[*]”},{id:3,target_name:"Target003",face_contents:”[*]”}]* This information is obtained by converting the JPEG binary of
the face image data that is the source of the face recognition information into a BASE 64 string.

2

page_num

Integer value

This is the total number of pages of list information.

© 2014-2019 Panasonic. All Rights Reserved.

21 of 28

9Auto Tracking System Web API Specifications Version 1.9
Command example:
In this example, the command is sent to the camera with ID = 1 of Auto Tracking System running on
the PC with IP address 192.168.0.200.
Acquiring the list of face recognition data
http://192.168.0.200:1337/cgi-bin/auto_tracking?cmd=GetFaceRecognition&page=0&data_num=16© 2014-2019 Panasonic. All Rights Reserved.

22 of 28

9Auto Tracking System Web API Specifications Version 1.9

3.12 Edit Face Recognition
The Edit Face Recognition command is used to edit the face recognition information (them_face_recognition table on the database) that exists in the system. The list of transmission
parameters is as shown below.
Table 12-1 List of Transmission Parameters
Name

Usage

Type

Description

methodMandatory

Stringid

MandatoryInteger value

target_name

Mandatory

Stringface_contents

Mandatory

String

The following values are saved depending on thecontents of the editing operation:- Add: add- Update: edit
- Delete: remove
This parameter is mandatory for Update and Delete. Set
the identification ID of the target record.
This parameter is mandatory for Add and Update. Set
the target name of the target record.
This parameter is mandatory for Add and Update. Set
the information obtained by converting the JPEG binaryof the face image data of the target record into a BASE
64 string.

The reception response is saved as either "ack", which indicates a positive acknowledgment, or "nack",
which indicates a negative acknowledgment.
The reception response parameters are specified as below.
message:[1]The list information is saved in the below-mentioned format at the locations corresponding to thenumbers enclosed within "[ ]".
Table 3.12-2 Reception Response Data Configuration
No.
1

Name
messageType
StringDescription
When the process is successful (ack), "OK" is saved and when
the process fails (nack), the cause of failure of the process is
saved as a string.

© 2014-2019 Panasonic. All Rights Reserved.

23 of 28

9Auto Tracking System Web API Specifications Version 1.9

3.13 Clip Face Image
The Clip Face Image command is used for extraction of face image data from a JPEG-format input
image.
This command can be executed by posting the input image to the URL specified below.
http://[IP Address]:[portNo]/cgi-bin/auto_tracking?cmd=ClipFaceImage

Therefore, the input image must be transmitted as multi-part data such as that illustrated below.
-----------------------8d3439d84d3f4b0
Content-Disposition: form-data; name="file"; filename="input.jpg"
Content-Type: application/octet-stream(File content)-----------------------8d3439d84d3f4b0-Note that the reception response is saved as either "ack", which indicates a positive acknowledgment,
or "nack", which indicates a negative acknowledgment.
The reception response parameters are specified as below.
face_contents:[1]The extracted face image data is saved in the below-mentioned format at the locations corresponding to
the numbers enclosed within "[ ]". Note that when the input image data is invalid, or it is not possible toextract the face image, "nack", which indicates a negative acknowledgment, is saved, and the response
parameter described above is not saved.
Table 3.13-1 Reception Response Data Configuration
No.
1

Name
face_contents

Type
StringDescription
The information obtained by converting JPEG binary of theface image data into a BASE 64 string is saved.

© 2014-2019 Panasonic. All Rights Reserved.

24 of 28

3.14 Auto Face Search

9Auto Tracking System Web API Specifications Version 1.9

The Auto Face Search command is used to change the enable/disable setting of the Auto Face Searchfunction.
A list of parameters to be sent is shown below.
Table 3.14-1 List of Transmission Parameters
Name

Usage

Type

id

MandatoryInteger value

mode

Mandatory

StringDescription
This is the camera ID.
This is the setting of the Auto Face Search.
Either 0 (disabled) or 1(enabled) is saved.

The reception response is saved as either "ack", which indicates a positive acknowledgment, or "nack",
which indicates a negative acknowledgment.

Command example:
In this example, the command is sent to the camera with ID = 1 of Auto Tracking System running on
the PC with IP address 192.168.0.200.
Auto Face Search OFF
http://192.168.0.200:1337/cgi-bin/auto_tracking?cmd=AutoFaceSearch&id=1&mode=0
Auto Face Search ON
http://192.168.0.200:1337/cgi-bin/auto_tracking?cmd=AutoFaceSearch&id=1&mode=1© 2014-2019 Panasonic. All Rights Reserved.

25 of 28

9Auto Tracking System Web API Specifications Version 1.9

3.15 Auto Zoom

The Auto Zoom command is used to change the enable/disable setting of the Auto Zoom function.
A list of parameters to be sent is shown below.
Table 3.15-1 List of Transmission Parameters
Name

Usage

Type

id

MandatoryInteger value

mode

Mandatory

StringDescription
This is the camera ID.
This is the setting of the Auto Zoom.
Either 0 (disabled) or 1(enabled) is saved.

The reception response is saved as either "ack", which indicates a positive acknowledgment, or "nack",
which indicates a negative acknowledgment.

Command example:
In this example, the command is sent to the camera with ID = 1 of Auto Tracking System running on
the PC with IP address 192.168.0.200.
Auto Zoom OFF
http://192.168.0.200:1337/cgi-bin/auto_tracking?cmd=AutoZoom&id=1&mode=0
Auto Zoom ON
http://192.168.0.200:1337/cgi-bin/auto_tracking?cmd=AutoZoom&id=1&mode=1© 2014-2019 Panasonic. All Rights Reserved.

26 of 28

9Auto Tracking System Web API Specifications Version 1.9

3.16 Preset

The Preset command is used to set, clear or recall the preset area.
A list of parameters to be sent is shown below.
Table 3.16-1 List of Transmission Parameters
Name

Usage

Type

id

MandatoryInteger value

mode

Mandatory

Stringpreset_num

MandatoryInteger value

Description
This is the camera ID.
Preset mode
set / clear / recall
are designated.
Preset number(Specify in the range of 1 to 100)

The reception response is saved as either "ack", which indicates a positive acknowledgment, or "nack",
which indicates a negative acknowledgment.

Command example:
In this example, the command is sent to the camera with ID = 1 of Auto Tracking System running on
the PC with IP address 192.168.0.200.
Set the preset1 as this pan/tilt position
http://192.168.0.200:1337/cgi-bin/auto_tracking?cmd=Preset&id=1&mode=set&preset_num=1© 2014-2019 Panasonic. All Rights Reserved.

27 of 28

9Auto Tracking System Web API Specifications Version 1.9

4 Processing of Error Commands"nack", which indicates a negative acknowledgment, must be saved in the reception response to thetransmission of all error commands that are not specified in 3 Details of Commands.

© 2014-2019 Panasonic. All Rights Reserved.

28 of 28