IVSWikiBlue at 21:21, 11 June 2026

2026-06-11T21:21:44Z

IVSWikiBlue at 21:21, 11 June 2026

2026-06-11T21:21:20Z

IVSWikiBlue: Created page with "This API call creates a new preset for the specified camera. ===Resource URL===

http://valt.example.com/api/v3/presets/{camera}/add

''Replace {camera} with the ID..."

2026-06-11T21:13:27Z

Created page with "This API call creates a new preset for the specified camera. ===Resource URL=== <pre>http://valt.example.com/api/v3/presets/{camera}/add</pre> ''Replace {camera} with the ID..."

New page

This API call creates a new preset for the specified camera.

===Resource URL===
<pre>http://valt.example.com/api/v3/presets/{camera}/add</pre>
''Replace {camera} with the ID of the camera.''

===Resource Information===
{|class="wikitable"
|'''Method'''
|POST
|-
|'''Headers'''
|Content-Type: application/json
|-
|'''Response Type'''
|JSON
|-
|'''Authentication Required'''
|Yes
|}

===Parameters===
====Path Parameters====
{|class="wikitable"
!Parameter
!Description
!Example
|-
|'''camera'''
|The ID of the camera to create the preset for.
|1
|}

====Request Body====
{|class="wikitable"
!colspan="2"|Field Name
!Type
!Description
!Required
!Example
|-
|colspan="2"|'''name'''
|string
|The name of the new preset.
|Yes
|"Preset 1"
|-
|colspan="2"|'''data'''
|string
|The PTZ (pan, tilt, zoom) data for the preset, formatted as a query string.
|No
|"pan=12.8&tilt=-0.99&zoom=1"
|}

===Response===

{|class="wikitable"
!Code
!Reason
|-
|200
|Preset Created Successfully
|-
|400
|Invalid Request (See Response for Specific Error)
|-
|401
|Unauthorized
|-
|500
|Internal Server Error
|}

{|class="wikitable"
|+JSON Response
!Field
!Type
!Description
|-
|'''id'''
|int
|The ID of the newly created preset.
|-
|'''message'''
|string
|Status message confirming the result.
|}

==Examples==
===Request===
The sample JSON body below is formatted with line breaks and indentation to make it easier to read. This is '''not''' required.
<pre>https://ivstest1.ad.ipivs.com/api/v3/presets/1/add?access_token=e82632d19c523678fea3d1016c6df9e9</pre>
<nowiki>
{
"name": "Preset 1",
"data": "pan=12.8&tilt=-0.99&zoom=1"
}
</nowiki>

===Successful Response===
Sample response is shown with line breaks to make it more readable. Actual responses will not include line breaks.
<nowiki>
{
"id": 15,
"message": "Preset added"
}
</nowiki>

===Failure Response===
Sample response is shown with line breaks to make it more readable. Actual responses will not include line breaks.
<nowiki>
{
"error": {
"code": 500,
"message": "Internal Server Error"
}
}
</nowiki>

← Older revision		Revision as of 21:21, 11 June 2026
Line 1:		Line 1:
−	This API call creates a new preset for the specified camera.	+	This API call creates a new preset for the specified camera at its current pan, tilt, and zoom.

	===Resource URL===		===Resource URL===

API Create Camera Preset - Revision history

IVSWikiBlue at 21:21, 11 June 2026

IVSWikiBlue at 21:21, 11 June 2026

IVSWikiBlue: Created page with "This API call creates a new preset for the specified camera. ===Resource URL===
http://valt.example.com/api/v3/presets/{camera}/add
''Replace {camera} with the ID..."

@@ Line 45: / Line 45: @@
 |Yes
 |"Preset 1"
 |}
@@ Line 93: / Line 87: @@
   <nowiki>
+{
-   "name": "Preset 1",
+   "name": "Preset 1"
+}
 </nowiki>