Viz Channel Branding User Guide

Version 5.0 | Published July 10, 2023 ©

GET Status of Machine Address

Returns the status for a specific machine address for the channel.

The following status codes can be returned for the system:

  • OK - Connection successful to Media Sequencer

  • CHANNEL_NOT_FOUND - Connection successful, but the channel could not be found

  • NO_VALID_DATA_FOUND - Connection successful, but the storage of Viz Channel Branding could not be found

  • CONNECTION_REJECTED - Connection was rejected

  • CONNECTION_TIMED_OUT - Connection timed out

Syntax

GET /config/channels/{channel}/machineaddresses/{address}/status

Request

GET /config/channels/Test/machineaddresses/localhost/status HTTP/1.1

Response - Status returned

HTTP/1.1 200 OK
Content-Type: application/vizrt.promoserver+xml; type=machineAddressStatus
<promoserver:machineAddressStatus xmlns:promoserver="http://www.vizrt.com/promoserver">
<promoserver:status>OK</promoserver:status>
</promoserver:machineAddressStatus>

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 - Address 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 localhost could not be found</string>

Disallowed Actions

This end-point does not allow POST, PUT or DELETE, and will return a 'HTTP/1.1 405 Method Not Allowed'.