RetrieveTextTickerItems

DatasourceService / RetrieveTextTickerItems

Description: Get text ticker items by queries

URL: http://{your-server-url}/api/v1/core/datasources/texttickers/items

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
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
itemids	int[]	True	comma separated values, eg. itemids=1,2,3
datasourceids	int[]	True	comma separated values, eg. datasourceids=1,2,3

Example: http://{your-server-url}/api/v1/core/datasources/texttickers/items?page=100&rpp=100&itemids=1,2,3

Response:

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

Parameter	Type
Response.TextTickerItems	Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.DataSources.TextTicker.TextTickerItem[]
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>
  <CurrentPage>123</CurrentPage>
  <Rpp>123</Rpp>
  <TextTickerItems xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.DataSources.TextTicker">
    <a:TextTickerItem>
      <a:Caption>String</a:Caption>
      <a:CreatedDate>2014-08-06T16:20:35.4160721Z</a:CreatedDate>
      <a:Disable>true</a:Disable>
      <a:Id>123</a:Id>
      <a:Position>123</a:Position>
      <a:Properties>String</a:Properties>
      <a:TextTickerDataSourceId>123</a:TextTickerDataSourceId>
    </a:TextTickerItem>
  </TextTickerItems>
  <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,
	"Rpp":123,
	"TextTickerItems":[
		{
			"Caption":"String",
			"CreatedDate":"\/Date(1407342035416)\/",
			"Disable":true,
			"Id":123,
			"Position":123,
			"Properties":"String",
			"TextTickerDataSourceId":123
		}
	],
	"TotalPages":123
}