Haivision Media Platform

Edit a Session

Edits the specified session.

Authorizations: Sessions - EDIT

Requests

PUT /apis/sessions/:sessionId
{
  "title": "InfoDevSource2",
  "description": "UDP",
  "syncrecord": true
}

Response

Success

{
  "data": {
    "title": "InfoDevSource2",
    "description": "UDP",
    "syncrecord": true,
    "active": false,
    "id": "2f8dce6d-fd8b-459e-890f-97965c88df40",
    "ctime": 1393533035,
    "mtime": 1399059859,
    "duration": 0,
    "recording": false,
    "movieTrackCount": 1,
    "sources": [
      "f4327f7b-3917-4533-b844-8818741cb0bd"
    ]
  }
}

Error

Code

Payload

 Description

400

{"code":"010001", "name":"InputValidation",
"message":<Error message>, "httpStatusCode":400}

Supplied data was insufficient or incorrect.

403

{"code":"040006", "name":"SessionHidden",
"message": "Session hidden", "httpStatusCode":403}

Session is hidden and requester does not own the session.

404

{"code":"040006", "name":"SessionNotFound",
"message":"Session not found",
"httpStatusCode":404}

Session with UUID sessionId not found.

500

{"code":"070000", "name":"InternalServer",
"message":"Internal Server Error",
"httpStatusCode":500}

Updating the session failed. Please see calypso.log for more details.