RetrieveContentPlayoutSchedule

 

DatasourceService / RetrieveContentPlayoutSchedule

 

Description: Get content playout schedule by queries

URL: http://{your-server-url}/api/v1/core/datasources/mediazones/contentplayoutschedules/{contentplayoutscheduleid}

Method: GET

Token Required: True


Request Headers:
content-type: application/json or content-type: application/xml
token: {token}
currentaccountid: {accountid - optional and default value is user's own account}
Required Roles:

Portal Administrator, Account Administrator, Account Owner, Content Administrator, Widget Manager

Rights:

Type: Nexus.AppSpace.Service.Contract.Model.Enums.Rights.Rights

Right Require
Widget_Management Yes
Application_Management Yes

Response:

Type: Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.Datasource.DatasourceResponse

Parameter Type
Response.ContentPlayoutSchedule Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.DataSources.MediaZone.ContentPlayoutSchedule

The following is an example response Xml body:
<DatasourceResponse xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.Datasource" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <DebugMessage xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages">String</DebugMessage>
  <Errors xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages">
    <Error>
      <Code>String</Code>
      <Message>String</Message>
      <StackTrace>String</StackTrace>
    </Error>
  </Errors>
  <Status xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages">Success</Status>
  <ContentPlayoutSchedule xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.DataSources.MediaZone">
    <a:Id>123</a:Id>
    <a:MediaSchedulePlayoutProperty>
      <a:Approved>true</a:Approved>
      <a:AspectRatio>UniformFill</a:AspectRatio>
      <a:Custom>String</a:Custom>
      <a:DeletedAfterExpired>true</a:DeletedAfterExpired>
      <a:DurationMin>123</a:DurationMin>
      <a:DurationSec>123</a:DurationSec>
      <a:EndDate>2014-08-06T16:20:35.2679732Z</a:EndDate>
      <a:FrequencyCondition>Exactly</a:FrequencyCondition>
      <a:FrequencyPlayout>123</a:FrequencyPlayout>
      <a:FrequencyUnit>Minute</a:FrequencyUnit>
      <a:Playforever>true</a:Playforever>
      <a:PlayoutEffect>Pull_TrackIn</a:PlayoutEffect>
      <a:PlayoutTagsRule>String</a:PlayoutTagsRule>
      <a:StartDate>2014-08-06T16:20:35.2679732Z</a:StartDate>
      <a:Transition>None</a:Transition>
    </a:MediaSchedulePlayoutProperty>
    <a:MediaZoneAllocId>123</a:MediaZoneAllocId>
  </ContentPlayoutSchedule>
</DatasourceResponse>

The following is an example response Json body:
{
	"DebugMessage":"String",
	"Errors":[
		{
			"Code":"String",
			"Message":"String",
			"StackTrace":"String"
		}
	],
	"Status":1,
	"ContentPlayoutSchedule":{
		"Id":123,
		"MediaSchedulePlayoutProperty":{
			"Approved":true,
			"AspectRatio":3,
			"Custom":"String",
			"DeletedAfterExpired":true,
			"DurationMin":123,
			"DurationSec":123,
			"EndDate":"\/Date(1407342035267)\/",
			"FrequencyCondition":2,
			"FrequencyPlayout":123,
			"FrequencyUnit":5,
			"Playforever":true,
			"PlayoutEffect":7,
			"PlayoutTagsRule":"String",
			"StartDate":"\/Date(1407342035267)\/",
			"Transition":404
		},
		"MediaZoneAllocId":123
	}
}