Description: Retrieve layoutschedules from current application
URL: http://{your-server-url}/api/v1/core/applications/{applicationid}/layoutschedules
Method: GET
Token Required: True
content-type: application/json or content-type: application/xml
currentaccountid: {accountid - optional and default value is user's own account}
token: {token}
Portal Administrator, Account Administrator, Account Owner, Content Administrator, Schedule Manager
Type: Nexus.AppSpace.Service.Contract.Model.Enums.Rights.Rights
Right | Require |
---|---|
Schedule_Management | Yes |
Parameter | Type | Nullable | Description |
---|---|---|---|
layoutscheduleids | int[] | True | comma separated values, eg. layoutscheduleids=1,2,3 |
schedulename | string | True | schedule name |
page | int | True | page number |
rpp | int | True | records per page, default = 50, max = 500 |
includereadonly | boolean | True | include read only resources, eg. includereadonly=true |
Example: http://{your-server-url}/api/v1/core/applications/{applicationid}/layoutschedules?layoutscheduleids=1,2,3&schedulename=string&page=100
Type: Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.Application.ApplicationResponse
Parameter | Type |
---|---|
Response.LayoutSchedules | Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Applications.LayoutSchedule[] |
Response.CurrentPage | int |
Response.TotalPages | int |
Response.Rpp | int |
<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> <LayoutSchedules xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Applications"> <a:LayoutSchedule> <a:ApplicationId>123</a:ApplicationId> <a:Disable>true</a:Disable> <a:EndDate>2014-11-20T17:57:37.2625701Z</a:EndDate> <a:Id>123</a:Id> <a:IsExclusive>true</a:IsExclusive> <a:IsNoEndDate>true</a:IsNoEndDate> <a:Name>String</a:Name> <a:Position>123</a:Position> <a:RecurrencePatterns xmlns:b="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Applications.Schedule"> <b:RecurrencePattern> <b:DaysToPlay xmlns:c="http://schemas.datacontract.org/2004/07/System"> <c:DayOfWeek>Saturday</c:DayOfWeek> </b:DaysToPlay> <b:EndTime>2014-11-20T17:57:37.2635657Z</b:EndTime> <b:IsAllDayEvent>true</b:IsAllDayEvent> <b:PlayOnAllDays>true</b:PlayOnAllDays> <b:StartTime>2014-11-20T17:57:37.2635657Z</b:StartTime> </b:RecurrencePattern> </a:RecurrencePatterns> <a:ScheduleItems xmlns:b="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Applications.Schedule"> <b:ScheduleItem> <b:Disable>true</b:Disable> <b:Duration>123</b:Duration> <b:LayoutId>123</b:LayoutId> <b:LayoutName>String</b:LayoutName> <b:Properties xmlns:c="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO"> <c:KeyValuePair> <c:Key>String</c:Key> <c:Value>String</c:Value> </c:KeyValuePair> </b:Properties> <b:position>123</b:position> </b:ScheduleItem> </a:ScheduleItems> <a:ScheduleMode>roundRobin</a:ScheduleMode> <a:StartDate>2014-11-20T17:57:37.2625701Z</a:StartDate> <a:TagExpression>String</a:TagExpression> <a:UseRecurrencePattern>true</a:UseRecurrencePattern> </a:LayoutSchedule> </LayoutSchedules> <Rpp>123</Rpp> <TotalPages>123</TotalPages> </ApplicationResponse>
{ "DebugMessage":"String", "Errors":[ { "Code":"String", "Message":"String", "StackTrace":"String" } ], "Status":1, "CurrentPage":123, "LayoutSchedules":[ { "ApplicationId":123, "Disable":true, "EndDate":"\/Date(1416506257262)\/", "Id":123, "IsExclusive":true, "IsNoEndDate":true, "Name":"String", "Position":123, "RecurrencePatterns":[ { "DaysToPlay":[ 6 ], "EndTime":"\/Date(1416506257263)\/", "IsAllDayEvent":true, "PlayOnAllDays":true, "StartTime":"\/Date(1416506257263)\/" } ], "ScheduleItems":[ { "Disable":true, "Duration":123, "LayoutId":123, "LayoutName":"String", "Properties":[ { "Key":"String", "Value":"String" } ], "position":123 } ], "ScheduleMode":1, "StartDate":"\/Date(1416506257262)\/", "TagExpression":"String", "UseRecurrencePattern":true } ], "Rpp":123, "TotalPages":123 }