RetrieveMediaZoneSchedules

DatasourceService / RetrieveMediaZoneSchedules

Description: Get mediazone schedules by queries

URL: http://{your-server-url}/api/v1/core/datasources/mediazones/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
scheduleids	int[]	True	comma separated values, eg. scheduleids=1,2,3
mediazoneids	int[]	True	comma separated values, eg. mediazoneids=1,2,3
includereadonly	boolean	True	include read only resources, eg. includereadonly=true
page	int	True	page number

Example: http://{your-server-url}/api/v1/core/datasources/mediazones/schedules?rpp=100&scheduleids=1,2,3&mediazoneids=1,2,3

Response:

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

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