RetrieveApplications

ApplicationService / RetrieveApplications

Description: Retrieve Applications

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

Method: GET

Token Required: True

Request Headers:

token: {token}
currentaccountid: {accountid - optional and default value is user's own account}
content-type: application/json or content-type: application/xml

Required Roles:

Portal Administrator, Account Administrator, Account Owner, Content Administrator

Rights:

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

Right	Require
Application_Management	Yes

Request Query Parameters:

Parameter	Type	Nullable	Description
appname	string	True	application name
type	Contract.Model.Enums.Application.Type	True	application type, eg. type=passive
appids	int[]	True	comma separated values, eg. appids=1,2,3
networkids	int[]	True	comma separated values, eg. networkids=1,2,3
includereadonly	boolean	True	include read only resources, eg. includereadonly=true
extguids	Guid[]	True	comma separated values, eg. extguids=xxxx-xxxx-xxxx-xxxx,xxxx-xxxx-xxxx-xxxx
ispublic	boolean	True	to retrieve public app if value is true and vice versa, eg. ispublic=true
page	int	True	page number
rpp	int	True	records per page, default = 50, max = 500

Example: http://{your-server-url}/api/v1/core/applications?appname=string&appids=1,2,3&networkids=1,2,3

Response:

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

Parameter	Type	Comment
Response.Applications	Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Applications.Application[]	Layouts, Widgets and Schedules only return id
Response.CurrentPage	int
Response.TotalPages	int
Response.Rpp	int

Enums:

Field	Name	Values
Type	Nexus.AppSpace.Service.Contract.Model.Enums.Application.Type	Custom = 0, Passive = 1, Interactive = 2, VideoWall = 3
TemplateType	Nexus.AppSpace.Service.Contract.Model.Enums.Application.PassiveType	Instance = 0, ApplicationTemplate = 1, LayoutTemplate = 2

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 i:nil="true" />
      <Message i:nil="true" />
    </Error>
  </Errors>
  <Status xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages">Success</Status>
  <Applications xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Applications">
    <a:Application>
      <a:AppClassId>123</a:AppClassId>
      <a:CreatedDate>2014-11-20T17:57:37.146483Z</a:CreatedDate>
      <a:Height>1000</a:Height>
      <a:Id>123</a:Id>
      <a:LayoutSchedules>
        <a:LayoutSchedule>
          <a:Id>123</a:Id>
        </a:LayoutSchedule>
      </a:LayoutSchedules>
      <a:Layouts>
        <a:Layout>
          <a:Id>123</a:Id>
        </a:Layout>
      </a:Layouts>
      <a:Name>String</a:Name>
      <a:NetworkId>123</a:NetworkId>
      <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:TemplateType>LayoutTemplate</a:TemplateType>
      <a:Type>VideoWall</a:Type>
      <a:Widgets>
        <a:Widget>
          <a:Id>123</a:Id>
        </a:Widget>
      </a:Widgets>
      <a:Width>1000</a:Width>
    </a:Application>
  </Applications>
  <CurrentPage>123</CurrentPage>
  <Rpp>123</Rpp>
  <TotalPages>123</TotalPages>
</ApplicationResponse>

The following is an example response Json body:

{
	"DebugMessage":"String",
	"Errors":[
		{
			"Code":null,
			"Message":null
		}
	],
	"Status":1,
	"Applications":[
		{
			"AppClassId":123,
			"CreatedDate":"\/Date(1416506257146)\/",
			"Height":1000,
			"Id":123,
			"LayoutSchedules":[
				{
					"Id":123
				}
			],
			"Layouts":[
				{
					"Id":123
				}
			],
			"Name":"String",
			"NetworkId":123,
			"Properties":[
				{
					"Key":"String",
					"Value":"String"
				}
			],
			"TemplateType":2,
			"Type":3,
			"Widgets":[
				{
					"Id":123
				}
			],
			"Width":1000
		}
	],
	"CurrentPage":123,
	"Rpp":123,
	"TotalPages":123
}