Panasonic AW-SF100/SF200 AW-SF100 API Documentation - Page 4

Interface

Page 4 highlights

Auto Tracking System Web API Specifications Version 1.6 2 Interface 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]&... Table 2.2-1 Details of Transmission Format No. Name Description 1 IP Address This is the IP address of the Web application. 2 PortNo This is the standby port number of the Web application (default: 1337) 3 Command This is the control command string. A list of commands that can be used is provided in 2.3 List of Commands. 4 Parameter This is the control command parameter. You can use an "&" to specify several parameters. Since it is specified in each command, refer to each section in 3 Details of Commands. 5 Value 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] Confidential © 2014-2015 Panasonic. All Rights Reserved. 4 of 24

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24

Auto Tracking System Web API Specifications
Version 1.6
Confidential
© 2014-2015 Panasonic. All Rights Reserved.
4 of 24
2
Interface
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]&…
Table 2.2-1 Details of Transmission Format
No.
Name
Description
1
IP Address
This is the IP address of the Web application.
2
PortNo
This is the standby port number of the Web application (default:
1337)
3
Command
This is the control command string.
A list of commands that can be used is provided in
2.3
List of Commands
.
4
Parameter
This is the control command parameter. You can use an "&" to
specify several parameters.
Since it is specified in each command, refer to each section in
3
Details of Commands
.
5
Value
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]