SOAP API design lookup service

The SOAP API design lookup service asset manages the lookup functions of the SOAP server, including applying and removing designs and paint layouts.

To add a SOAP API design lookup service, go to Web services  SOAP API file retrieval service. For the API to work, it must be created under a SOAP server asset. The API will then be available to enable on the Details screen of the SOAP server.

You can configure the settings of the SOAP API design lookup service on its associated asset screens. The majority of these screens are similar to those for a standard page. They are described in the Asset screens documentation. In this documentation, we will describe the Details screen, which is different for a SOAP API design lookup service.

Details screen

The Details screen allows you to configure the interface functions for the SOAP API design lookup service.

Read the Asset screens documentation for more information about the Status, Future status, Thumbnail, and Details sections.

Interface settings

This section allows you to control which functions the SOAP API asset service will provide when enabled on a SOAP server.

To enable the functions for the SOAP asset service:

  1. Click Edit on the Details screen.

  2. Select the Enabled checkbox beside the function list you want to make available on the API.

  3. Click Save to make the selected functions available to use.

The Operations section below contains a full explanation of each function.

Operations

ApplyDesign

ApplyDesignSoapInput (ApplyDesign)

Elements - Parameter [Param Type] Description Min Occurs Max Occurs Type

DesignID [string]

The asset ID of the design asset to apply. This parameter is mandatory.

1

1

simple

AssetID [string]

The asset ID of the asset to apply the Design to. This parameter is mandatory.

1

1

simple

DesignType [string]

The design type of the design to apply. This value can be Frontend, OverrideFrontend, Login, OverrideLogin, UserDefined or OverrideUserDefined. This parameter is mandatory.

1

1

simple

UserDefinedDesignName [string]

The user defined design name, when applying a user-defined design.

0

1

simple

Example 1. ApplyDesign request
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
  <SOAP-ENV:Body>
    <ns1:ApplyDesign>
      <DesignID>150</DesignID>
      <AssetID>100</AssetID>
      <DesignType>UserDefined</DesignType>
      <UserDefinedDesignName>my_design</UserDefinedDesignName>
    </ns1:ApplyDesign>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

ApplyDesignSoapOutput (ApplyDesignResponse)

Elements - Parameter [Param Type] Min Occurs Max Occurs Type

ApplyDesignResult [boolean]

0

1

simple

Example 2. ApplyDesign response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
  <SOAP-ENV:Body>
    <ns1:ApplyDesignResponse>
      <ApplyDesignResult>true</ApplyDesignResult>
    </ns1:ApplyDesignResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

RemoveDesign

RemoveDesignSoapInput (RemoveDesign)

Elements - Parameter [Param Type] Description Min Occurs Max Occurs Type

DesignID [string]

The asset ID of the design asset to remove. This parameter is mandatory.

1

1

simple

AssetID [string]

The asset ID of the asset from which to remove the design. This parameter is mandatory.

1

1

simple

DesignType [string]

The design type of the design to remove. This value can be Frontend, OverrideFrontend, Login, OverrideLogin, UserDefined or OverrideUserDefined.

0

1

simple

UserDefinedDesignName [string]

The user defined design name, when removing a user-defined design.

0

1

simple

Example 3. RemoveDesign request
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
  <SOAP-ENV:Body>
    <ns1:RemoveDesign>
      <DesignID>150</DesignID>
      <AssetID>100</AssetID>
      <DesignType>Frontend</DesignType>
    </ns1:RemoveDesign>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

RemoveDesignSoapOutput (RemoveDesignResponse)

Elements - Parameter [Param Type] Min Occurs Max Occurs Type

RemoveDesignResult [boolean]

0

1

simple

Example 4. RemoveDesign response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
  <SOAP-ENV:Body>
    <ns1:RemoveDesignResponse>
      <RemoveDesignResult>true</RemoveDesignResult>
    </ns1:RemoveDesignResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GetDesignFromURL

GetDesignFromURLInput (GetDesignFromURL)

Elements - Parameter [Param Type] Description Min Occurs Max Occurs Type

URL [string]

The URL to query, excluding the HTTP protocol. For example \www.mysite.com/page or \mysite.com/site1/page. This parameter is mandatory.

1

1

simple

DesignType [string]

The design type of the design to return. This allows you to specify the design type when an asset has multiple designs. This value can be Frontend, OverrideFrontend, Login, OverrideLogin, UserDefined or OverrideUserDefined.

0

1

simple

UserDefinedDesignName [string]

The user-defined design name, when returning a user-defined design.

0

1

simple

Example 5. GetDesignFromURL request
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
  <SOAP-ENV:Body>
    <ns1:GetDesignFromURL>
      <URL>www.example.com</URL>
      <DesignType>UserDefined</DesignType>
      <UserDefinedDesignName>my_design</UserDefinedDesignName>
    </ns1:GetDesignFromURL>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GetDesignFromURLOutput (GetDesignFromURLResponse)

Elements - Parameter [Param Type] Min Occurs Max Occurs Type

GetDesignFromURLResult [DesignLinkSummary]

0

1

complex

Example 6. GetDesignFromURL response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
  <SOAP-ENV:Body>
    <ns1:GetDesignFromURLResponse>
      <GetDesignFromURLResult>
        <DesignID>27</DesignID>
        <TypeCode>ees_login_design</TypeCode>
      </GetDesignFromURLResult>
    </ns1:GetDesignFromURLResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

ApplyAssetPaintLayout

ApplyAssetPaintLayoutInput (ApplyAssetPaintLayout)

Elements - Parameter [Param Type] Description Min Occurs Max Occurs Type

PaintLayoutID [string]

The asset ID of the paint layout asset to apply. This parameter is mandatory.

1

1

simple

AssetID [string]

The asset ID of the asset to apply the Paint Layout to.

0

1

simple

PaintLayoutType [string]

The paint layout type of the paint Layout to apply. This allows you to specify the paint layout type when an asset has multiple paint layouts. This value can be OverrideFrontend, Frontend or UserDefined. This parameter is mandatory.

1

1

simple

AssetURL [string]

The URL of the asset to apply the paint layout to. This parameter is useful when applying a URL specific paint layout.

0

1

simple

PaintLayoutCode [string]

The paint layout code to set on the paint layout being applied. This parameter is useful when applying a UserDefined paint layout.

0

1

simple

Example 7. ApplyAssetPaintLayout request
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
  <SOAP-ENV:Body>
    <ns1:ApplyAssetPaintLayout>
      <PaintLayoutID>150</PaintLayoutID>
      <AssetID>100</AssetID>
      <PaintLayoutType>UserDefined</PaintLayoutType>
      <AssetURL>www.example.com/site</AssetURL>
      <PaintLayoutCode>User1</PaintLayoutCode>
    </ns1:ApplyAssetPaintLayout>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

ApplyAssetPaintLayoutOutput (ApplyAssetPaintLayoutResponse)

Elements - Parameter [Param Type] Min Occurs Max Occurs Type

ApplyAssetPaintLayoutResult [boolean]

0

1

simple

Example 8. ApplyAssetPaintLayout response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
  <SOAP-ENV:Body>
    <ns1:ApplyAssetPaintLayoutResponse>
      <ApplyAssetPaintLayoutResult>true</ApplyAssetPaintLayoutResult>
    </ns1:ApplyAssetPaintLayoutResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

RemoveAssetPaintLayout

RemoveAssetPaintLayoutInput (RemoveAssetPaintLayout)

Elements - Parameter [Param Type] Description Min Occurs Max Occurs Type

PaintLayoutID [string]

The asset ID of the paint layout asset to remove. This parameter is mandatory.

1

1

simple

AssetID [string]

The asset ID of the asset to remove the paint layout from.

0

1

simple

PaintLayoutType [string]

The paint layout type of the paint layout to remove. This allows you to specify the paint layout type when an asset has multiple paint layouts. This value can be OverrideFrontend, Frontend or UserDefined. This parameter is mandatory.

1

1

simple

AssetURL [string]

The URL of the asset to remove the paint layout from. This parameter is useful when removing a URL specific paint layout.

0

1

simple

PaintLayoutCode [string]

The paint layout code of the paint layout being removed. This parameter is useful when removing a UserDefined paint layout.

0

1

simple

Example 9. RemoveAssetPaintLayout request
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
  <SOAP-ENV:Body>
    <ns1:RemoveAssetPaintLayout>
      <PaintLayoutID>150</PaintLayoutID>
      <AssetID>100</AssetID>
      <PaintLayoutType>Frontend</PaintLayoutType>
      <AssetURL>www.example.com/site</AssetURL>
    </ns1:RemoveAssetPaintLayout>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

RemoveAssetPaintLayoutOutput (RemoveAssetPaintLayoutResponse)

Elements - Parameter [Param Type] Min Occurs Max Occurs Type

RemoveAssetPaintLayoutResult [boolean]

0

1

simple

Example 10. RemoveAssetPaintLayout response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
  <SOAP-ENV:Body>
    <ns1:RemoveAssetPaintLayoutResponse>
      <RemoveAssetPaintLayoutResult>true</RemoveAssetPaintLayoutResult>
    </ns1:RemoveAssetPaintLayoutResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GetPaintLayoutFromURL

GetPaintLayoutFromURLInput (GetPaintLayoutFromURL)

Elements - Parameter [Param Type] Description Min Occurs Max Occurs Type

URL [string]

The URL to return the paint layout asset from. This parameter is mandatory.

1

1

simple

PaintLayoutType [string]

The paint layout type of the paint layout to return. This allows you to specify the paint layout type when an asset has multiple paint layouts. This value can be OverrideFrontend, Frontend or UserDefined. This parameter is mandatory.

1

1

simple

PaintLayoutCode [string]

The paint layout code of the paint layout to return. This parameter is useful when removing a UserDefined paint layout.

0

1

simple

Example 11. GetPaintLayoutFromURL request
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
  <SOAP-ENV:Body>
    <ns1:GetPaintLayoutFromURL>
      <URL>www.example.com/site</URL>
      <PaintLayoutType>Frontend</PaintLayoutType>
    </ns1:GetPaintLayoutFromURL>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GetPaintLayoutFromURLOutput (GetPaintLayoutFromURLResponse)

Elements - Parameter [Param Type] Min Occurs Max Occurs Type

GetPaintLayoutFromURLResult [string]

0

1

simple

Example 12. GetPaintLayoutFromURL response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
  <SOAP-ENV:Body>
    <ns1:GetPaintLayoutFromURLResponse>
      <AssetID>240</AssetID>
    </ns1:GetPaintLayoutFromURLResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

© 2015- Squiz Pty Ltd