EDU-7441: Add new Partner API Documentation.#8
Conversation
jaygee-lvt
force-pushed
the
EDU-7441_PartenerAPI
branch
from
f7436de to
466e33f
Compare
| | PUT | `UpdateCameraPosition` | This endpoint is deprecated. Use the PATCH request.** Updates a camera's PTZF. | <pre>{<br> "pan": "<integer>",<br> "tilt": "<integer>",<br> "zoom": "<integer>",<br> "focus": "<integer>"<br>}</pre> | | ||
| | PATCH | `UpdateCameraPosition2` | Sets a camera's position relative to its current position, unless the absolute query parameter is passed. Some camera models do not support focus. If the focus is sent, it will be ignored. | `Accepted` | |
There was a problem hiding this comment.
Should these be urls rather than just names?
There was a problem hiding this comment.
These are just names at this time.
borksson
left a comment
borksson
left a comment
There was a problem hiding this comment.
I think one section might be missing a link, but the other comments are just discussion points not necessarily needed to be changes
| - An account with LVT. | ||
| - Partnership agreement with LVT. | ||
|
|
||
| ### QUICK START GUIDE | ||
|
|
||
| 1. Sign up as an LVT customer. |
There was a problem hiding this comment.
Could you have an account and not be signed up as a customer?
There was a problem hiding this comment.
That is something we want to avoid unless there is a partner agreement.
| ### Events | ||
| An event, sometimes referred to as an alertEvent, is a collection of security alerts that are triggered in the same time frame and are grouped together and handled as a single incident. | ||
| - **Gateway Handling:** The API gateway provides initial handling for common issues, such as rate limiting, distributed denial of service (DDoS) attacks, and authentication failures. | ||
| - The Partner API utilizes standard error handling mechanisms consistent with other LVT applications, including the alerts-service, mediator, and other services within the federated graph. This ensures a consistent approach to error reporting and resolution across the ecosystem. |
There was a problem hiding this comment.
Do our partners know the difference between the public api and the alerts-service or mediator? Is this an implementation detail they should know about?
There was a problem hiding this comment.
I will remove this from the documentation.
| in to the stream using the `streamId` provided in the response. | ||
| ### 500-Level Errors | ||
|
|
||
| #### Refreshing a stream |
There was a problem hiding this comment.
Just curious on why we decided to remove all this help regarding managing streams, do our clients not need this information or will it be moved to a different guide?
There was a problem hiding this comment.
Jason and I spoke about this and we will be separating out the Streaming information into it's own document in a similar way to the Web RTC and the Webhook documentation.
| * Available protocols for the camera can be found by the `GET /cameras/{cameraId}/protocols` endpoint. | ||
| | METHOD | ENDPOINT | DESCRIPTION | PAYLOAD EXAMPLE | | ||
| |--------|----------|-------------|-----------------| | ||
| | GET | `/liveUnits` | This endpoint returns all the Live Units accessible by the specified client. | <pre><br>{<br> "items": [<br> {<br> "id": "<uuid>",<br> "clientId": "<uuid>",<br> "gpsLocation": {<br> "latitude": "<float>",<br> "longitude": "<float>"<br> },<br> "locationId": "<uuid>",<br> "name": "<string>"<br> }<br> ],<br> "nextCursorUri": "<uri>",<br> "totalResults": "<integer>",<br> "itemsCount": "<integer>"<br>}</pre> | |
There was a problem hiding this comment.
Should the endpoint be /v1/liveUnits instead?
5 participants
Purpose
What is the purpose of this PR? PUblish the Partner API documentation we created through 2025.
What is the associated Jira ticket? EDU-7441 for the LED Team