RetrieveCalendarEntries

DatasourceService / RetrieveCalendarEntries

Description: Get calendar entries by queries

URL: http://{your-server-url}/api/v1/core/datasources/calendars/entries

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
entryids	int[]	True	comma separated values, eg. entryids=1,2,3
datasourceids	int[]	True	comma separated values, eg. datasourceids=1,2,3
startdate	string	True	format: yyyyMMddhhmm
enddate	string	True	format: yyyyMMddhhmm
includereadonly	boolean	True	include read only resources, eg. includereadonly=true
page	int	True	page number

Example: http://{your-server-url}/api/v1/core/datasources/calendars/entries?rpp=100&entryids=1,2,3&datasourceids=1,2,3

Response:

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

Parameter	Type
Response.CalendarEntries	Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.DataSources.Calendar.CalendarEntry[]
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>
  <CalendarEntries xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.DataSources.Calendar">
    <a:CalendarEntry>
      <a:CalendarDataSourceId>123</a:CalendarDataSourceId>
      <a:Description>String</a:Description>
      <a:EndDate>2014-08-06T16:20:35.3950572Z</a:EndDate>
      <a:Id>123</a:Id>
      <a:IsReminderRequired>true</a:IsReminderRequired>
      <a:KeyValuePairs 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:KeyValuePairs>
      <a:Location>String</a:Location>
      <a:Position>123</a:Position>
      <a:RemindInMinutes>123</a:RemindInMinutes>
      <a:StartDate>2014-08-06T16:20:35.3950572Z</a:StartDate>
      <a:Title>String</a:Title>
    </a:CalendarEntry>
  </CalendarEntries>
  <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,
	"CalendarEntries":[
		{
			"CalendarDataSourceId":123,
			"Description":"String",
			"EndDate":"\/Date(1407342035395)\/",
			"Id":123,
			"IsReminderRequired":true,
			"KeyValuePairs":[
				{
					"Key":"String",
					"Value":"String"
				}
			],
			"Location":"String",
			"Position":123,
			"RemindInMinutes":123,
			"StartDate":"\/Date(1407342035395)\/",
			"Title":"String"
		}
	],
	"CurrentPage":123,
	"Rpp":123,
	"TotalPages":123
}