RetrieveApplication

 

ApplicationService / RetrieveApplication

 

Description: Retrieve application

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

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

Rights:

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

Right Require
Application_Management Yes

Response:

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

Parameter Type
Response.Application Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Applications.Application

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>
  <Application xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Applications">
    <a:AppClassId>123</a:AppClassId>
    <a:CreatedDate>2014-11-20T17:57:37.211529Z</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>
  </Application>
</ApplicationResponse>

The following is an example response Json body:
{
	"DebugMessage":"String",
	"Errors":[
		{
			"Code":null,
			"Message":null
		}
	],
	"Status":1,
	"Application":{
		"AppClassId":123,
		"CreatedDate":"\/Date(1416506257211)\/",
		"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
	}
}