Apply an asynchronous video placement result
curl -X POST "https://api.spkey.co/rtsp-cameras/example_string/ApplyPlacementResult" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
-H "X-API-Key: YOUR_API_KEY" \
-d '{
"cameraId": "example_string",
"aggregateVersion": 42,
"placementGeneration": 42,
"status": "running",
"workerId": "example_string",
"error": "example_string",
"internalSecret": "example_string"
}'
import requests
import json
url = "https://api.spkey.co/rtsp-cameras/example_string/ApplyPlacementResult"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (JWT)",
"X-API-Key": "YOUR_API_KEY"
}
data = {
"cameraId": "example_string",
"aggregateVersion": 42,
"placementGeneration": 42,
"status": "running",
"workerId": "example_string",
"error": "example_string",
"internalSecret": "example_string"
}
response = requests.post(url, headers=headers, json=data)
print(response.json())
const response = await fetch("https://api.spkey.co/rtsp-cameras/example_string/ApplyPlacementResult", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (JWT)",
"X-API-Key": "YOUR_API_KEY"
},
body: JSON.stringify({
"cameraId": "example_string",
"aggregateVersion": 42,
"placementGeneration": 42,
"status": "running",
"workerId": "example_string",
"error": "example_string",
"internalSecret": "example_string"
})
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"encoding/json"
)
func main() {
data := []byte(`{
"cameraId": "example_string",
"aggregateVersion": 42,
"placementGeneration": 42,
"status": "running",
"workerId": "example_string",
"error": "example_string",
"internalSecret": "example_string"
}`)
req, err := http.NewRequest("POST", "https://api.spkey.co/rtsp-cameras/example_string/ApplyPlacementResult", bytes.NewBuffer(data))
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN (JWT)")
req.Header.Set("X-API-Key", "YOUR_API_KEY")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api.spkey.co/rtsp-cameras/example_string/ApplyPlacementResult')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN (JWT)'
request['X-API-Key'] = 'YOUR_API_KEY'
request.body = '{
"cameraId": "example_string",
"aggregateVersion": 42,
"placementGeneration": 42,
"status": "running",
"workerId": "example_string",
"error": "example_string",
"internalSecret": "example_string"
}'
response = http.request(request)
puts response.body
{
"success": true,
"aggregateId": "example_string",
"version": 3.14,
"event": {
"type": "RtspCameraPlaced",
"data": {
"cameraId": "example_string",
"workerId": "example_string",
"placementGeneration": 42,
"sourceEventVersion": 42,
"placedAt": "example_string"
}
}
}
{
"error": "Forbidden",
"message": "You don't have permission to access this resource",
"code": 403
}
{
"error": "Unprocessable Entity",
"message": "The request was well-formed but contains semantic errors",
"code": 422,
"details": [
{
"field": "password",
"message": "Password must be at least 8 characters long"
}
]
}
POST
/rtsp-cameras/{id}/ApplyPlacementResultPOST
Base URLstring
Target server for requests. Edit to use your own host.
Bearer Token (JWT)
Bearer Tokenstring
RequiredJWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.
JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.
API Key (header: X-API-Key)
X-API-Keystring
RequiredAPI key for B2B organization access. Provided during organization onboarding.
API key for B2B organization access. Provided during organization onboarding.
path
idstring
RequiredRTSP camera UUID (aggregate id)
Content-Typestring
RequiredThe media type of the request body
Options: application/json
cameraIdstring
RequiredMin length: 1
statusstring
RequiredOptions: running, failed, released
workerIdstring
Min length: 1
errorstring
Min length: 1
internalSecretstring
RequiredMin length: 1
Request Preview
Response
Response will appear here after sending the request
Authentication
header
Authorizationstring
RequiredBearer token (JWT). JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.
header
X-API-Keystring
RequiredAPI Key for authentication. API key for B2B organization access. Provided during organization onboarding.
Path Parameters
idstring
RequiredRTSP camera UUID (aggregate id)
Body
application/json
statusstring
RequiredAllowed values:
runningfailedreleasedResponses
successboolean
RequiredaggregateIdstring
Requiredversionnumber
Requiredeventstring
RequiredWas this page helpful?