Documentation Center

Viz Channel Branding User Guide

Version 5.1 | Published October 26, 2023 ©

PUT Channel

Edit channel configuration.

Channel Name can't be changed

New machine address must exist in channel configuration

Syntax

PUT /config/channels/{channelName}

Request

PUT /config/channels/Test HTTP/1.1
Content-Type: application/vizrt.promoserver+xml; type=channel
<promoserver:channel xmlns:promoserver="http://www.vizrt.com/promoserver">
<promoserver:name>Test</promoserver:name>
<promoserver:machineAddressInUse>localhost</promoserver:machineAddressInUse>
</promoserver:channel>

Response - Machine address used for channel updated

HTTP/1.1 200 OK
Content-Type: application/vizrt.promoserver+xml; type=channel<?xml version="1.0" encoding="utf-8"?>
<promoserver:channel xmlns:promoserver="http://www.vizrt.com/promoserver">
<promoserver:refLink rel="self" type="application/vizrt.promoserver+xml; type=channel" href="http://localhost:9980/config/channels/Test" />
<promoserver:refLink rel="edit" type="application/vizrt.promoserver+xml; type=channel" href="http://localhost:9980/config/channels/Test" />
<promoserver:refLink rel="machineaddresses" type="application/vizrt.promoserver+xml; type=machineAddressesList" href="http://localhost:9980/config/channels/Test/machineaddresses" />
<promoserver:name>Test</promoserver:name>
<promoserver:machineAddressInUse>localhost</promoserver:machineAddressInUse>
</promoserver:channel>

Error Response - Machine address does not exists

HTTP/1.1 400 Bad Request
Content-Type: application/xml; charset=utf-8
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">Machine address localhost is not configured for channel</string>

Error Response - Channel not found

HTTP/1.1 404 Not Found
Content-Type: application/xml; charset=utf-8
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">Element Test could not be found</string>

Error Response - Channel name can not be updated

HTTP/1.1 400 Bad Request
Content-Type: application/xml; charset=utf-8
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">Input content can't be used to update channel: Channel Name can't be changed</string>