Documentation Center

Viz Channel Branding User Guide

Version 5.0 | Published July 10, 2023 ©

POST Channel

Adds a channel to Promo Server configuration.

The response is a list of all channels that are configured.

Syntax

Syntax
POST /config/channels

Request

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

Response - New channel was added to the configured list of channels

HTTP/1.1  200 OK
Content-Type: application/vizrt.promoserver+xml; type=channelsList
<promoserver:channelsList xmlns:promoserver="http://www.vizrt.com/promoserver">
<promoserver:channelItem>
<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:channelItem>
<promoserver:channelItem>
<promoserver:refLink rel="self" type="application/vizrt.promoserver+xml; type=channel" href="http://localhost:9980/config/channels/TestCross" />
<promoserver:refLink rel="edit" type="application/vizrt.promoserver+xml; type=channel" href="http://localhost:9980/config/channels/TestCross" />
<promoserver:refLink rel="machineaddresses" type="application/vizrt.promoserver+xml; type=machineAddressesList" href="http://localhost:9980/config/channels/TestCross/machineaddresses" />
<promoserver:name>TestCross</promoserver:name>
</promoserver:channelItem>
<promoserver:channelItem>
<promoserver:refLink rel="self" type="application/vizrt.promoserver+xml; type=channel" href="http://localhost:9980/config/channels/TestNew" />
<promoserver:refLink rel="edit" type="application/vizrt.promoserver+xml; type=channel" href="http://localhost:9980/config/channels/TestNew" />
<promoserver:refLink rel="machineaddresses" type="application/vizrt.promoserver+xml; type=machineAddressesList" href="http://localhost:9980/config/channels/TestNew/machineaddresses" />
<promoserver:name>TestNew</promoserver:name>
</promoserver:channelItem>
</promoserver:channelsList>

Error Response - Channel already exists

HTTP/1.1  409 Conflict
Content-Type: application/xml; charset=utf-8
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">Element of name TestNew already exists</string>

Error Response - Invalid channel name

HTTP/1.1  400 Bad Request
Content-Type: application/xml; charset=utf-8
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">Input content is invalid: Channel name Test#2 is not valid</string>