RetrieveContentPlayoutSchedules

 

DatasourceService / RetrieveContentPlayoutSchedules

 

Description: Get content playout schedule by queries

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

Method: GET

Token Required: True


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

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

Rights:

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

Right Require
Application_Management Yes
Widget_Management Yes

Request Query Parameters:
Parameter Type Nullable Description
Ids int[] True comma separated values, eg. ids=1,2,3
mzids int[] True comma separated values, eg. mzids=1,2,3
mzallocids int[] True comma separated values, eg. mzallocids=1,2,3
includereadonly boolean True include read only resources, eg. includereadonly=true
page int True page number
rpp int True records per page, default = 50, max = 500

Example: http://{your-server-url}/api/v1/core/datasources/mediazones/contentplayoutschedules?Ids=1,2,3&mzids=1,2,3&mzallocids=1,2,3


Response:

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

Parameter Type
Response.ContentPlayoutSchedules Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.DataSources.MediaZone.ContentPlayoutSchedule[]
Response.CurrentPage int
Response.TotalPages int
Response.Rpp int

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>
  <ContentPlayoutSchedules xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.DataSources.MediaZone">
    <a:ContentPlayoutSchedule>
      <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.2529565Z</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.2529565Z</a:StartDate>
        <a:Transition>None</a:Transition>
      </a:MediaSchedulePlayoutProperty>
      <a:MediaZoneAllocId>123</a:MediaZoneAllocId>
    </a:ContentPlayoutSchedule>
  </ContentPlayoutSchedules>
  <CurrentPage>123</CurrentPage>
  <Rpp>123</Rpp>
  <TotalPages>123</TotalPages>
</DatasourceResponse>

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