RetrieveLayouts

ApplicationService / RetrieveLayouts

Description: Retrieve layouts from current application

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

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

Rights:

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

Right	Require
Application_Management	Yes

Request Query Parameters:

Parameter	Type	Nullable	Description
includereadonly	boolean	True	include read only resources, eg. includereadonly=true
layoutids	int[]	True	comma separated values, eg. layoutids=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/{applicationid}/layouts?layoutids=1,2,3&page=100&rpp=100

Response:

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

Parameter	Type
Response.Layouts	Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Applications.Layout[]
Response.CurrentPage	int
Response.TotalPages	int
Response.Rpp	int

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>
  <CurrentPage>123</CurrentPage>
  <Layouts xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Applications">
    <a:Layout>
      <a:ApplicationId>123</a:ApplicationId>
      <a:AspectRatio>1000</a:AspectRatio>
      <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:WidgetPlacements>
        <a:WidgetPlacement>
          <a:Color>String</a:Color>
          <a:Height>1000</a:Height>
          <a:Left>1000</a:Left>
          <a:MetaData 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:MetaData>
          <a:Opacity>1000</a:Opacity>
          <a:Top>1000</a:Top>
          <a:TransitionInType>String</a:TransitionInType>
          <a:TransitionOutType>String</a:TransitionOutType>
          <a:WidgetId>123</a:WidgetId>
          <a:WidgetName>String</a:WidgetName>
          <a:Width>1000</a:Width>
        </a:WidgetPlacement>
      </a:WidgetPlacements>
    </a:Layout>
  </Layouts>
  <Rpp>123</Rpp>
  <TotalPages>123</TotalPages>
</ApplicationResponse>

The following is an example response Json body:

{
	"DebugMessage":"String",
	"Errors":[
		{
			"Code":"String",
			"Message":"String",
			"StackTrace":"String"
		}
	],
	"Status":1,
	"CurrentPage":123,
	"Layouts":[
		{
			"ApplicationId":123,
			"AspectRatio":1000,
			"Guid":"11111111-1111-1111-1111-111111111111",
			"Id":123,
			"Name":"String",
			"Properties":[
				{
					"Key":"String",
					"Value":"String"
				}
			],
			"WidgetPlacements":[
				{
					"Color":"String",
					"Height":1000,
					"Left":1000,
					"MetaData":[
						{
							"Key":"String",
							"Value":"String"
						}
					],
					"Opacity":1000,
					"Top":1000,
					"TransitionInType":"String",
					"TransitionOutType":"String",
					"WidgetId":123,
					"WidgetName":"String",
					"Width":1000
				}
			]
		}
	],
	"Rpp":123,
	"TotalPages":123
}