RetrieveMediaZoneScheduleByMediazoneId

 

DatasourceService / RetrieveMediaZoneScheduleByMediazoneId

 

Description: Get media zone schedule item by mediazone id

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

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

Request Query Parameters:
Parameter Type Nullable Description
rpp int True records per page, default = 50, max = 500
page int True page number

Example: http://{your-server-url}/api/v1/core/datasources/mediazones/{mediazoneid}/schedules?rpp=100&page=100


Response:

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

Parameter Type
Response.TotalPages int
Response.Rpp int
Response.MediaZoneSchedule Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.DataSources.MediaZone.MediaZoneSchedule
Response.CurrentPage int

Enums:
Field Name Values
Days Nexus.AppSpace.Service.Contract.Model.Enums.DataSource.MediaZone.Day Undefined = 0, Mon = 2, Tue = 4, Wed = 8, Thu = 16, Fri = 32, Sat = 64, Sun = 128, Everyday = 254

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>
  <CurrentPage>123</CurrentPage>
  <MediaZoneSchedule xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.DataSources.MediaZone">
    <a:AllowDuplicates>true</a:AllowDuplicates>
    <a:AutoAdd>true</a:AutoAdd>
    <a:Days>Everyday</a:Days>
    <a:Description>String</a:Description>
    <a:EndDate>2014-08-06T16:20:35.4520975Z</a:EndDate>
    <a:Id>123</a:Id>
    <a:IsExclusive>true</a:IsExclusive>
    <a:MediaZoneId>123</a:MediaZoneId>
    <a:MetaData xmlns:b="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO">
      <b:KeyValuePair>
        <b:Key>String</b:Key>
        <b:Value>String</b:Value>
      </b:KeyValuePair>
    </a:MetaData>
    <a:Name>String</a:Name>
    <a:Position>123</a:Position>
    <a:StartDate>2014-08-06T16:20:35.4520975Z</a:StartDate>
    <a:Static>true</a:Static>
    <a:TimeSpans>
      <a:MediaZoneScheduleTimeSpan>
        <a:EndTime>2014-08-06T16:20:35.4520975Z</a:EndTime>
        <a:Id>123</a:Id>
        <a:LoopCount>123</a:LoopCount>
        <a:ScheduleId>123</a:ScheduleId>
        <a:StartTime>2014-08-06T16:20:35.4520975Z</a:StartTime>
        <a:Type>123</a:Type>
      </a:MediaZoneScheduleTimeSpan>
    </a:TimeSpans>
    <a:UsergroupId>123</a:UsergroupId>
  </MediaZoneSchedule>
  <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,
	"CurrentPage":123,
	"MediaZoneSchedule":{
		"AllowDuplicates":true,
		"AutoAdd":true,
		"Days":254,
		"Description":"String",
		"EndDate":"\/Date(1407342035452)\/",
		"Id":123,
		"IsExclusive":true,
		"MediaZoneId":123,
		"MetaData":[
			{
				"Key":"String",
				"Value":"String"
			}
		],
		"Name":"String",
		"Position":123,
		"StartDate":"\/Date(1407342035452)\/",
		"Static":true,
		"TimeSpans":[
			{
				"EndTime":"\/Date(1407342035452)\/",
				"Id":123,
				"LoopCount":123,
				"ScheduleId":123,
				"StartTime":"\/Date(1407342035452)\/",
				"Type":123
			}
		],
		"UsergroupId":123
	},
	"Rpp":123,
	"TotalPages":123
}