JVC 4ch Network Encoder VN-E4 - Manual (Page 18)

18
5. API for Acquiring/Changing Parameters of VN-E4 _
5.1. Explanatory Notes
This section provides a description of API for acquiring/changing the parameters of VN-E4. Make use of the API explained in this section in
the way as mentioned in Section 4.
(1) Acquiring parameters
● Specify API in GET line according to the format below when acquiring a parameter from VN-E4.
/api/param?ParamA.ParamB.ParamC
It is possible to acquire multiple parameters at a time. Parameters are segmented using &. Do not insert
space before and after &.
/api/param?ParamA.ParamB.ParamC&ParamA.ParamD.ParamE
The upper limit of this character string is 1024 bytes. The maximum number of parameters that can be
acquired at a time is 5.
● When acquisition is successfully completed, values will be shown in the Body of the response, followed by
returning a "&200 OK" response.
Example:
ParamA.ParamB.ParamC=Data&200 OK
When an error occurs, an error code will be returned instead of indicating a value in the Body of the
response.
Example:
ParamA.ParamB.ParamC&401 Unauthorized
When multiple acquirings are performed at one time, a response will be returned for each setting.
ParamA.ParamB.ParamC&200 OK<CRLF>
ParamA.ParamB.ParamD&200 OK<CRLF>
(2) Setting parameters
● Specify API in GET according to the format below when setting a parameter for VN-E4.
/api/param?ParamA.ParamB.ParamC=Data
Parameter values are indicated using =. Do not insert space before and after =.
It is possible to perform multiple settings at a time. Parameters are segmented using &. Do not insert space
before and after &.
/api/param?ParamA.ParamB.ParamC=Data&ParamA.ParamB.ParamD=Data
The upper limit of this character string is 1024 bytes. The maximum number of parameters that can be set at
a time is 5.
● Response will be in the following format.
ParamA.ParamB.ParamC&200 OK
An error code will be returned when setting is not properly performed. Example:
ParamA.ParamB.ParamC&401 Unauthorized
When multiple settings are performed at one time, a response will be returned for each setting.
ParamA.ParamB.ParamC&200 OK<CRLF>
ParamA.ParamB.ParamD&200 OK<CRLF>
5. AP
5.1. Explanatory Notes