RetrieveCalendarFields

DatasourceService / RetrieveCalendarFields

Description: Get calendar fields by queries

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

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
Application_Management	Yes
Widget_Management	Yes

Request Query Parameters:

Parameter	Type	Nullable	Description
datasourceids	int[]	True	comma separated values, eg. datasourceids=1,2,3
fieldids	int[]	True	comma separated values, eg. fieldids=1,2,3
includereadonly	boolean	True	include read only resources, eg. includereadonly=true
page	int	True	page number
rpp	int	True	records per page, default = 50, max = 500

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

Response:

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

Parameter	Type
Response.CalendarFields	Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.DataSources.Calendar.CalendarField[]
Response.CurrentPage	int
Response.TotalPages	int
Response.Rpp	int

Enums:

Field	Name	Values
FieldType	Nexus.AppSpace.Service.Contract.Model.Enums.DataSource.Calendar.FieldType	Undefined = 0, String = 1, DateTime = 2

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>
  <CalendarFields xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.DataSources.Calendar">
    <a:CalendarField>
      <a:CalendarDataSourceId>123</a:CalendarDataSourceId>
      <a:FieldName>String</a:FieldName>
      <a:FieldType>DateTime</a:FieldType>
      <a:FieldTypeInfo>String</a:FieldTypeInfo>
      <a:Id>123</a:Id>
      <a:Position>123</a:Position>
    </a:CalendarField>
  </CalendarFields>
  <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,
	"CalendarFields":[
		{
			"CalendarDataSourceId":123,
			"FieldName":"String",
			"FieldType":2,
			"FieldTypeInfo":"String",
			"Id":123,
			"Position":123
		}
	],
	"CurrentPage":123,
	"Rpp":123,
	"TotalPages":123
}