RetrieveScheduleItems

ApplicationService / RetrieveScheduleItems

Description: Retrieve layoutscheduleitems from current layout schedule

URL: http://{your-server-url}/api/v1/core/applications/layoutschedules/{layoutscheduleid}/scheduleitems

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, Schedule Manager

Rights:

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

Right	Require
Schedule_Management	Yes

Request Query Parameters:

Parameter	Type	Nullable	Description
scheduleitemids	int[]	True	comma separated values, eg. scheduleitemids=1,2,3
page	int	True	page number
rpp	int	True	records per page, default = 50, max = 500

Example: http://{your-server-url}/api/v1/core/applications/layoutschedules/{layoutscheduleid}/scheduleitems?scheduleitemids=1,2,3&page=100&rpp=100

Response:

Type: Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.Application.ApplicationResponse

Parameter	Type
Response.ScheduleItems	Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Applications.Schedule.ScheduleItem[]
Response.CurrentPage	int
Response.TotalPages	int
Response.Rpp	int

The following is an example response Xml body:

<ApplicationResponse xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.Application" 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>
  <Rpp>123</Rpp>
  <ScheduleItems xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Applications.Schedule">
    <a:ScheduleItem>
      <a:Disable>true</a:Disable>
      <a:Duration>123</a:Duration>
      <a:LayoutId>123</a:LayoutId>
      <a:LayoutName>String</a:LayoutName>
      <a:Properties 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:Properties>
      <a:position>123</a:position>
    </a:ScheduleItem>
  </ScheduleItems>
  <TotalPages>123</TotalPages>
</ApplicationResponse>

The following is an example response Json body:

{
	"DebugMessage":"String",
	"Errors":[
		{
			"Code":"String",
			"Message":"String",
			"StackTrace":"String"
		}
	],
	"Status":1,
	"CurrentPage":123,
	"Rpp":123,
	"ScheduleItems":[
		{
			"Disable":true,
			"Duration":123,
			"LayoutId":123,
			"LayoutName":"String",
			"Properties":[
				{
					"Key":"String",
					"Value":"String"
				}
			],
			"position":123
		}
	],
	"TotalPages":123
}