RetrieveWidgets

ApplicationService / RetrieveWidgets

Description: Retrieve user accessible widget

URL: http://{your-server-url}/api/v1/core/applications/widgets

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

Rights:

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

Right	Require
Widget Management	Yes

Request Query Parameters:

Parameter	Type	Nullable	Description
widgetname	string	True	widget name
type	Contract.Model.Enums.Application.ElementType	True	widget type
includereadonly	boolean	True	include read only resources, eg. includereadonly=true
appname	string	True	application name
datasourceids	int[]	True	comma separated values, eg. datasourceids=1,2,3
widgetids	int[]	True	comma separated values, eg. widgetids=1,2,3
appids	int[]	True	comma separated values, eg. appids=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/widgets?widgetname=string&appname=string&datasourceids=1,2,3

Response:

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

Parameter	Type
Response.Widgets	Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Applications.Widget[]

Enums:

Field	Name	Values
Type	Nexus.AppSpace.Service.Contract.Model.Enums.Application.ElementType	MediaZone = 0, TextTicker = 1, RSSTicker = 2, DateTime = 3, WeatherInfo = 4, RSSViewer = 5, PlainText = 6, InfoMenu = 7, Button = 8, HTMLSnippet = 9, EventCalendar = 10, CloneWidget = 11, SlideBar = 12, FlashContainer = 13, WayFinder = 14, TableListing = 15, MediaTicker = 16, KeyPad = 17, MediaContainer = 18, RemoteControl = 19, ExtensionWidget = 20, SIPWidget = 21

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>
  <Widgets xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Applications">
    <a:Widget>
      <a:ApplicationId>123</a:ApplicationId>
      <a:AssetDatasourceId>123</a:AssetDatasourceId>
      <a:DatasourceId>123</a:DatasourceId>
      <a:Guid>11111111-1111-1111-1111-111111111111</a:Guid>
      <a:Id>123</a:Id>
      <a:Name>String</a:Name>
      <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:Type>SIPWidget</a:Type>
    </a:Widget>
  </Widgets>
</ApplicationResponse>

The following is an example response Json body:

{
	"DebugMessage":"String",
	"Errors":[
		{
			"Code":"String",
			"Message":"String",
			"StackTrace":"String"
		}
	],
	"Status":1,
	"Widgets":[
		{
			"ApplicationId":123,
			"AssetDatasourceId":123,
			"DatasourceId":123,
			"Guid":"11111111-1111-1111-1111-111111111111",
			"Id":123,
			"Name":"String",
			"Properties":[
				{
					"Key":"String",
					"Value":"String"
				}
			],
			"Type":21
		}
	]
}