JVC VN-E4U API Guide - Page 18

API for Acquiring/Changing Parameters of VN-E4, 5.1. Explanatory Notes

Get JVC VN-E4U - 4 Channel Network Encoder PDF manuals and user guides
UPC - 046838021015
View all JVC VN-E4U manuals
Add to My Manuals
Save this manual to your list of manuals

Page 18 highlights

5. API for Acquiring/Changing Parameters of VN-E4 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. 5.1. Explanatory Notes (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 (2) Setting parameters When multiple acquirings are performed at one time, a response will be returned for each setting. ParamA.ParamB.ParamC&200 OK ParamA.ParamB.ParamD&200 OK ● 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 ParamA.ParamB.ParamD&200 OK 18

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79
  • 80
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.1. Explanatory Notes
5. API for Acquiring/Changing Parameters of VN-E4