Difference between revisions of "API Apply Camera Preset"
IVSWikiBlue (talk | contribs) (Created page with "This API call applies an existing preset to the specified camera. ===Resource URL=== <pre>http://valt.example.com/api/v3/presets/{camera}/apply</pre> ''Replace {camera} with...") |
(No difference)
|
Latest revision as of 16:21, 11 June 2026
This API call applies an existing preset to the specified camera.
Contents
Resource URL
http://valt.example.com/api/v3/presets/{camera}/apply
Replace {camera} with the ID of the camera.
Resource Information
| Method | POST |
| Headers | Content-Type: application/json |
| Response Type | JSON |
| Authentication Required | Yes |
Parameters
Path Parameters
| Parameter | Description | Example |
|---|---|---|
| camera | The ID of the camera to apply the preset to. | 1 |
Request Body
| Field Name | Type | Description | Required | Example | |
|---|---|---|---|---|---|
| preset | string (UUID) | The UUID of the preset to apply. | Yes | "7b931a86-2142-4121-a6f8-2e3197d4c5bf" | |
Response
| Code | Reason |
|---|---|
| 200 | Preset Applied Successfully |
| 400 | Invalid Request (See Response for Specific Error) |
| 401 | Unauthorized |
| 500 | Internal Server Error |
| Field | Type | Description |
|---|---|---|
| id | int | The ID of the applied 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.
https://ivstest1.ad.ipivs.com/api/v3/presets/1/apply?access_token=e82632d19c523678fea3d1016c6df9e9
{
"preset": "7b931a86-2142-4121-a6f8-2e3197d4c5bf"
}
Successful Response
Sample response is shown with line breaks to make it more readable. Actual responses will not include line breaks.
{
"id": "7b931a86-2142-4121-a6f8-2e3197d4c5bf",
"message": "Preset applied"
}
Failure Response
Sample response is shown with line breaks to make it more readable. Actual responses will not include line breaks.
{
"error": {
"code": 500,
"message": "Internal Server Error"
}
}