Help Center

Menu

SOAP API asset service

The SOAP API asset service asset manages the asset functions of the SOAP server, including the creation and editing of assets, statuses, and tags. To add a SOAP API asset service, go to Web services  SOAP API asset 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 asset 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. This documentation will describe the Details screen, which is different for a SOAP API asset service.

Details screen

The Details screen allows you to configure the interface functions for the SOAP API asset 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. Select Edit on the Details screen.

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

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

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

Operations

CreateAsset

The CreateAsset operation will create an asset, specifying the asset type and location of the asset within the system. The parameters available for this operation are as follows.

CreateAssetSoapInput (CreateAsset)

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

TypeCode [AssetType]

The asset type of the asset to create. For example, page_standard for a standard page asset or metadata_schema for a metadata schema asset. This parameter is mandatory.

1

1

simple

Name [string]

The name of the asset to create.

0

1

simple

ParentID [string]

The asset ID of the parent where the new asset will be created, for example, 123. This will determine the location of the asset within the system. This parameter is mandatory.

1

1

simple

LinkType [LinkType]

The link type of the asset to create. For example, 1 for a menu link asset. This parameter is mandatory. The default value for this parameter is 1.

1

1

simple

LinkValue [string]

The value to associate with the asset link type.

0

1

simple

SortOrder [string]

The sort order position that this asset should take under its parent in the asset tree. The default value for this parameter is -1.

0

1

simple

IsDependant [string]

Indicates whether the created asset will be dependently linked to its parent asset. The value for this parameter should be either TRUE or FALSE (or 1 or 0). The default value for this parameter is 0.

0

1

simple

IsExclusive [string]

Indicates whether the created asset will be exclusively linked to its parent asset. An exclusively linked asset will only be able to exist under one parent. The value for this parameter should be either TRUE or FALSE (or 1 or 0). The default value for this parameter is 0.

0

1

simple

FileName [string]

The name of a file when creating a file asset type. For example, image.jpg.

0

1

simple

FileContentBase64 [string]

The encoded base64 string of a file to upload.

0

1

simple

AttributeInfo [AttributeInfo]

The attribute information to use for the created asset. NOTE: This is a complexType parameter, requiring multiple elements. Read the [Parameters] appendix for more information.

0

/

complex
Example 1. CreateAsset 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:CreateAsset>
      <TypeCode>text_file</TypeCode>
      <Name>New File</Name>
      <ParentID>100</ParentID>
      <LinkType>1</LinkType>
      <LinkValue>link value</LinkValue>
      <SortOrder>5</SortOrder>
      <IsDependant>1</IsDependant>
      <IsExclusive>0</IsExclusive>
      <FileName>file.txt</FileName>
      <FileContentBase64>VGhpcyBpcyBhIHRlc3QgZmlsZQ==</FileContentBase64>
      <AttributeInfo>
        <AttributeName>allow_unrestricted</AttributeName>
        <AttributeValue>0</AttributeValue>
      </AttributeInfo>
    </ns1:CreateAsset>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

CreateAssetSoapOutput (CreateAssetResponse)

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

NewAssetID [string]

0

1

simple

CreateMessage [string]

0

1

simple
Example 2. CreateAsset 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:CreateAssetResponse>
      <NewAssetID>200</NewAssetID>
      <CreateMessage>Asset was created successfully. Link id #350</CreateMessage>
    </ns1:CreateAssetResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

CloneAsset

The CloneAsset operation will clone an asset to a specified location within the system. The parameters available for this operation are as follows.

CloneAssetSoapInput (CloneAsset)

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

AssetID [string]

The asset ID of the asset to clone. This parameter is mandatory.

1

1

simple

NewParentID [string]

The asset ID of the new parent where the asset will be cloned. This parameter is mandatory.

1

1

simple

NumberOfClone [integer]

The number of clones to create. The default value for this parameter is 1.

0

1

simple

PositionUnderNewParent [integer]

The relative position that this cloned asset should take under its new parent in theasset tree. The default value for this parameter is -1.

0

1

simple

LinkType [LinkType]

The link type of the asset to create. The default value for this parameter is 1.

0

1

simple
Example 3. CloneAsset 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:CloneAsset>
      <AssetID>100</AssetID>
      <NewParentID>150</NewParentID>
      <NumberOfClone>1</NumberOfClone>
      <PositionUnderNewParent>1</PositionUnderNewParent>
      <LinkType>1</LinkType>
    </ns1:CloneAsset>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

CloneAssetSoapOutput (CloneAssetResponse)

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

CloneAssetResult [string]

0

1

simple
Example 4. CloneAsset response
TEXT<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:CloneAssetResponse>
      <CloneAssetResult>Asset Cloned</CloneAssetResult>
    </ns1:CloneAssetResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GetAllStatuses

The GetAllStatuses operation will return all statuses of assets within Matrix. There are no parameters available for this operation.

GetAllStatusesSoapInput (GetAllStatuses)

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

/

/

/

simple
Example 5. GetAllStatuses 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:GetAllStatuses />
  </SOAP-ENV:Body>
 </SOAP-ENV:Envelope>

GetAllStatusesSoapOutput (GetAllStatusesResponse)

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

GetAllStatusesResult [StatusDescription]

0

/

complex
Example 6. GetAllStatuses 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:GetAllStatusesResponse>
      <GetAllStatusesResult>
        <StatusValue>1</StatusValue>
        <StatusDescription>Archived</StatusDescription>
      </GetAllStatusesResult>
      <GetAllStatusesResult>
        <StatusValue>2</StatusValue>
        <StatusDescription>Under Construction</StatusDescription>
      </GetAllStatusesResult>
      <GetAllStatusesResult>
        <StatusValue>4</StatusValue>
        <StatusDescription>Pending Approval</StatusDescription>
      </GetAllStatusesResult>
      <GetAllStatusesResult>
        <StatusValue>8</StatusValue>
        <StatusDescription>Approved</StatusDescription>
      </GetAllStatusesResult>
      <GetAllStatusesResult>
        <StatusValue>16</StatusValue>
        <StatusDescription>Live</StatusDescription>
      </GetAllStatusesResult>
      <GetAllStatusesResult>
        <StatusValue>32</StatusValue>
        <StatusDescription>Live Approval</StatusDescription>
      </GetAllStatusesResult>
      <GetAllStatusesResult>
        <StatusValue>64</StatusValue>
        <StatusDescription>Editing</StatusDescription>
      </GetAllStatusesResult>
      <GetAllStatusesResult>
        <StatusValue>128</StatusValue>
        <StatusDescription>Editing Approval</StatusDescription>
      </GetAllStatusesResult>
      <GetAllStatusesResult>
        <StatusValue>256</StatusValue>
        <StatusDescription>Editing Approved</StatusDescription>
      </GetAllStatusesResult>
    </ns1:GetAllStatusesResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GetAsset

The GetAsset operation will return an asset object specified by its asset ID. The parameters available for this operation are as follows.

GetAssetSoapInput (GetAsset)

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

AssetID [string]

The asset ID of the asset to return. This parameter is mandatory.

1

1

simple
Example 7. GetAsset 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:GetAsset>
      <AssetID>100</AssetID>
    </ns1:GetAsset>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GetAssetSoapOutput (GetAssetResponse)

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

GetAssetResult [string]

0

1

simple
Example 8. GetAsset 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:GetAssetResponse>
      <GetAssetResult><Site><id>100</id><version>0.1.2</version><name>Site</name><short_name>Site</short_name><status>16</status><languages /><charset /><force_secure /><created>1298244661</created><created_userid>12</created_userid><updated>1306200425</updated><updated_userid>12</updated_userid><published>1298246105</published><published_userid>12</published_userid><status_changed>1298246105</status_changed><status_changed_userid>12</status_changed_userid><_is_cacheable /><vars><name><attrid>113</attrid><type>text</type><value>Site</value><is_contextable>1</is_contextable><use_default>1</use_default></name></vars><_available_keywords /><data_path_suffix>assets/site/0015/100</data_path_suffix><data_path>/home/example/data/private/assets/site/0015/100</data_path><data_path_public>/home/example/matrix_installs/matrix_dev/data/public/assets/site/0015/100</data_path_public><_ser_attrs /><_tmp><use_system_version /></_tmp></Site></GetAssetResult>
    </ns1:GetAssetResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GetAssetFromURL

The GetAssetFromURL operation will return an asset object specified by its URL. The parameters available for this operation are as follows:

GetAssetFromURLSoapInput (GetAssetFromURL)

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

URL [string]

URL: The URL of the asset to return. This parameter is mandatory.

1

1

simple
Example 9. GetAssetFromURL 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:GetAssetFromURL>
      <URL>http://www.example.com</URL>
    </ns1:GetAssetFromURL>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GetAssetFromURLSoapOutput (GetAssetFromURLResponse)

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

GetAssetFromURLResult [string]

0

1

simple
Example 10. GetAssetFromURL 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:GetAssetFromURLResponse>
      <GetAssetFromURLResult><Site><id>100</id><version>0.1.2</version><name>Site</name><short_name>Site</short_name><status>16</status><languages /><charset /><force_secure /><created>1298244661</created><created_userid>12</created_userid><updated>1306200425</updated><updated_userid>12</updated_userid><published>1298246105</published><published_userid>12</published_userid><status_changed>1298246105</status_changed><status_changed_userid>12</status_changed_userid><_is_cacheable /><vars><name><attrid>113</attrid><type>text</type><value>Site</value><is_contextable>1</is_contextable><use_default>1</use_default></name></vars><_available_keywords /><data_path_suffix>assets/site/0015/100</data_path_suffix><data_path>/home/example/data/private/assets/site/0015/100</data_path><data_path_public>/home/example/matrix_installs/matrix_dev/data/public/assets/site/0015/100</data_path_public><_ser_attrs /><_tmp><use_system_version /></_tmp></Site></GetAssetFromURLResult>
    </ns1:GetAssetFromURLResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GetAssetTypeAttribute

The GetAssetTypeAttribute operation will return the details of attributes belonging to a specified asset type. The parameters available for this operation are as follows:

GetAssetTypeAttributeSoapInput (GetAssetTypeAttribute)

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

TypeCode [AssetType]

TypeCode: The asset type of the attributes to return. This parameter is mandatory.

1

1

simple

AttributeDetail [AttributeDetail]

AttributeDetail: The attribute details to return. For example, name or default_type_code. The attribute details available are outlined in the table below. The default value for this parameter is Array ('name', 'type').

0

/

simple
AttributeDetail Description

attrid

ID of the attribute.

type_code

Asset type code of the attribute.

owning_type_code

Owning asset type code of the attribute.

name

Name of the attribute.

type

The attribute type (e.g. text, float etc.)

uniq

Attribute is unique.

parameters_type_code

Parameters type code for the attribute.

parameters_val

Parameter options of attribute.

default_type_code

Default asset type code of the attribute.

default_val

Default value of attribute.

description

Description of attribute.

is_admin

Attribute is for administrative use.

is_contextable

Attribute is contextable.
Example 11. GetAssetTypeAttribute 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:GetAssetTypeAttribute>
      <TypeCode>comment</TypeCode>
      <AttributeDetail>name</AttributeDetail>
      <AttributeDetail>attrid</AttributeDetail>
    </ns1:GetAssetTypeAttribute>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GetAssetTypeAttributeSoapOutput (GetAssetTypeAttributeResponse)

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

GetAssetTypeAttributeResult [AttributeProperty]

0

/

complex
Example 12. GetAssetTypeAttribute 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:GetAssetTypeAttributeResponse>
      <GetAssetTypeAttributeResult>
        <AttributeName>name</AttributeName>
        <AttributeID>2173</AttributeID>
      </GetAssetTypeAttributeResult>
       <GetAssetTypeAttributeResult>
        <AttributeName>comment</AttributeName>
        <AttributeID>2175</AttributeID>
      </GetAssetTypeAttributeResult>
      <GetAssetTypeAttributeResult>
        <AttributeName>rating</AttributeName>
        <AttributeID>2176</AttributeID>
      </GetAssetTypeAttributeResult>
      <GetAssetTypeAttributeResult>
        <AttributeName>short_name</AttributeName>
        <AttributeID>2174</AttributeID>
      </GetAssetTypeAttributeResult>
    </ns1:GetAssetTypeAttributeResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GetAssetTypeDescendants

The GetAssetTypeDescendants operation will return the details of descendants of a specified asset type. The parameters available for this operation are as follows:

GetAssetTypeDescendantsSoapInput (GetAssetTypeDescendants)

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

TypeCode [AssetType]

The asset type of the descendants to return. This parameter is mandatory.

1

1

simple
Example 13. GetAssetTypeDescendants 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:GetAssetTypeDescendants>
      <TypeCode>form</TypeCode>
    </ns1:GetAssetTypeDescendants>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GetAssetTypeDescendantsSoapOutput (GetAssetTypeDescendantsResponse)

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

GetAssetTypeDescendantsResponse [AssetType]

0

/

simple
Example 14. GetAssetTypeDescendants 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:GetAssetTypeDescendantsResponse>
      <GetAssetTypeDescendantsResult>form_email</GetAssetTypeDescendantsResult>
      <GetAssetTypeDescendantsResult>form_ecommerce</GetAssetTypeDescendantsResult>
    </ns1:GetAssetTypeDescendantsResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GetAssetsInfo

The GetAssetsInfo operation will return the general information (asset ID, type, name etc) of a set of assets. The parameters available for this operation are as follows:

GetAssetsInfoSoapInput (GetAssetsInfo)

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

AssetIDs [string]

The asset IDs of the assets being queried.

0

/

simple

FinderAttributes [string]

Enter attributes to return specific information from the assets. For example, children to return the assetIDs of the children of the assets.

0

/

simple

RootNode [string]

Enter a root node ID to specify the attribute values to return forassets linked under multiple assets. This is useful when calling the lineage of an asset - the values of which will vary depending on the root node of the asset.

0

1

simple
Example 15. GetAssetsInfo 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:GetAssetsInfo>
      <AssetIDs>101</AssetIDs>
      <AssetIDs>105</AssetIDs>
      <FinderAttributes>children</FinderAttributes>
      <FinderAttributes>lineage</FinderAttributes>
      <RootNode>100</RootNode>
    </ns1:GetAssetsInfo>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GetAssetsInfoSoapOutput (GetAssetsInfoResponse)

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

GetAssetsInfoResult [AssetFinderInfo]

0

/

complex
Example 16. GetAssetsInfo 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:GetAssetsInfoResponse>
      <GetAssetsInfoResult>
        <AssetID>101</AssetID>
        <AssetType>page_standard</AssetType>
        <AssetTypeAncestor>page</AssetTypeAncestor>
        <AssetName>About</AssetName>
        <AssetChildren>102</AssetChildren>
        <AssetLineage>
          <LinkID>348</LinkID>
          <LinkType>1</LinkType>
          <Lineage>
            <AssetID>70</AssetID>
            <AssetName>Site</AssetName>
            <Order>0</Order>
          </Lineage>
        </AssetLineage>
      </GetAssetsInfoResult>
      <GetAssetsInfoResult>
        <AssetID>105</AssetID>
        <AssetType>page_standard</AssetType>
        <AssetTypeAncestor>page</AssetTypeAncestor>
        <AssetName>Contact</AssetName>
        <AssetChildren>106</AssetChildren>
        <AssetLineage>
          <LinkID>382</LinkID>
          <LinkType>1</LinkType>
          <Lineage>
            <AssetID>70</AssetID>
            <AssetName>Site</AssetName>
            <Order>0</Order>
          </Lineage>
        </AssetLineage>
      </GetAssetsInfoResult>
    </ns1:GetAssetsInfoResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GetAttributeValuesByName

The GetAttributeValuesByName operation will return attribute values of a selected asset type, specified by the attribute name. The parameters available for this operation are as follows:

GetAttributeValuesByNameSoapInput (GetAttributeValuesByName)

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

AssetIDs [string]

The asset IDs of the assets being queried.

0

/

simple

TypeCode [AssetType]

The asset type of the attributes to return. This parameter is mandatory.

1

1

simple

AttributeName [string]

The name of the asset attribute to return attribute values from. This parameter is mandatory.

1

1

simple
Example 17. GetAttributeValuesByName 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:GetAttributeValuesByName>
      <AssetIDs>101</AssetIDs>
      <AssetIDs>105</AssetIDs>
      <TypeCode>page_standard</TypeCode>
      <AttributeName>name</AttributeName>
    </ns1:GetAttributeValuesByName>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GetAttributeValuesByNameSoapOutput (GetAttributeValuesByNameResponse)

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

GetAttributeValuesByNameResult [AttributeValueInfo]

0

/

complex
Example 18. GetAttributeValuesByName 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:GetAttributeValuesByNameResponse>
      <GetAttributeValuesByNameResult>
        <AssetID>101</AssetID>
        <AttributeValue>About</AttributeValue>
      </GetAttributeValuesByNameResult>
      <GetAttributeValuesByNameResult>
        <AssetID>105</AssetID>
        <AttributeValue>Contact</AttributeValue>
      </GetAttributeValuesByNameResult>
    </ns1:GetAttributeValuesByNameResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GetAssetAvailableKeywords

The GetAssetAvailableKeywords operation will return all available keywords of a specified asset. The parameters available for this operation are as follows:

GetAssetAvailableKeywordsSoapInput (GetAssetAvailableKeywords)

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

AssetID [string]

The asset ID of the asset from which to return available keywords. Use this parameter or TypeCode.

1

1

simple

TypeCode [AssetType]

The asset type to return the available keywords of. For example, page_standard for a standard page asset or metadata_schema for a metadata schema asset. Use this parameter or AssetID.

1

1

simple
Example 19. GetAssetAvailableKeywords request (AssetID)
<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:GetAssetAvailableKeywords>
      <AssetID>150</AssetID>
    </ns1:GetAssetAvailableKeywords>
  </SOAP-ENV:Body>
</SOAP=ENV:Envelope>
Example 20. GetAssetAvailableKeywords request (TypeCode)
<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:GetAssetAvailableKeywords>
      <TypeCode>page_standard</TypeCode>
    </ns1:GetAssetAvailableKeywords>
  </SOAP-ENV:Body>
</SOAP=ENV:Envelope>

GetAssetAvailableKeywordsSoapOutput (GetAssetAvailableKeywordsResponse)

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

GetAssetAvailableKeywordsResult [string]

0

/

simple
Example 21. GetAssetAvailableKeywords 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:GetAssetAvailableKeywordsResponse>
      <GetAssetAvailableKeywordsResult>asset_assetid</GetAssetAvailableKeywordsResult>
      <GetAssetAvailableKeywordsResult>asset_name</GetAssetAvailableKeywordsResult>
      <GetAssetAvailableKeywordsResult>asset_type</GetAssetAvailableKeywordsResult>
      <GetAssetAvailableKeywordsResult>asset_short_name</GetAssetAvailableKeywordsResult>
      <GetAssetAvailableKeywordsResult>asset_version</GetAssetAvailableKeywordsResult>
      <GetAssetAvailableKeywordsResult>asset_version_major</GetAssetAvailableKeywordsResult>
      <GetAssetAvailableKeywordsResult>asset_status_description</GetAssetAvailableKeywordsResult>
      <GetAssetAvailableKeywordsResult>asset_status_colour</GetAssetAvailableKeywordsResult>
      <GetAssetAvailableKeywordsResult>asset_attribute_name</GetAssetAvailableKeywordsResult>
    </ns1:GetAssetAvailableKeywordsResponse>
   </SOAP-ENV:Body>
</SOAP=ENV:Envelope>

GetPaintLayoutAvailableKeywords

The GetAssetAvailableKeywords operation will return the keywords of a Paint Layout asset, including any configured conditional keywords. The parameters available for this operation are as follows:

GetPaintLayoutAvailableKeywordsSoapInput (GetPaintLayoutAvailableKeywords)

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

AssetID [string]

The asset ID of the paint layout from which to return available keywords.

1

1

simple

TypeCode [AssetType]

An optional parameter to specify a customized asset type format for which to return the available keywords.

1

1

simple
Example 22. GetPaintLayoutAvailableKeywords 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:GetPaintLayoutAvailableKeywords>
      <AssetID>123</AssetID>
      <TypeCode>page_standard</TypeCode>
    </ns1:GetPaintLayoutAvailableKeywords>
  </SOAP-ENV:Body>
</SOAP=ENV:Envelope>

GetPaintLayoutAvailableKeywordsSoapOutput (GetPaintLayoutAvailableKeywordsResponse)

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

GetPaintLayoutAvailableKeywordsResult [string]

0

/

simple
Example 23. GetPaintLayoutAvailableKeywords 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:GetPaintLayoutAvailableKeywordsResponse>
      <GetPaintLayoutAvailableKeywordsResult>asset_assetid</GetPaintLayoutAvailableKeywordsResult>
      <GetPaintLayoutAvailableKeywordsResult>asset_contents</GetPaintLayoutAvailableKeywordsResult>
      <GetPaintLayoutAvailableKeywordsResult>asset_created</GetPaintLayoutAvailableKeywordsResult>
      ...
      <GetPaintLayoutAvailableKeywordsResult>begin_condition_1</GetPaintLayoutAvailableKeywordsResult>
      <GetPaintLayoutAvailableKeywordsResult>begin_condition_1%&lt;br /&gt;%else_condition_1%&lt;br /&gt;%end_condition_1</GetPaintLayoutAvailableKeywordsResult>
      <GetPaintLayoutAvailableKeywordsResult>condition_1</GetPaintLayoutAvailableKeywordsResult>
      <GetPaintLayoutAvailableKeywordsResult>else_condition_1</GetPaintLayoutAvailableKeywordsResult>
      <GetPaintLayoutAvailableKeywordsResult>end_condition_1</GetPaintLayoutAvailableKeywordsResult>
    </ns1:GetPaintLayoutAvailableKeywordsResponse>
  </SOAP-ENV:Body>
</SOAP=ENV:Envelope>

GetAssetAvailableStatuses

The GetAssetAvailableStatuses operation will return all available statuses of a specified asset. The parameters available for this operation are as follows:

GetAssetAvailableStatusesSoapInput (GetAssetAvailableStatuses)

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

AssetID [string]

The asset ID of the asset to return available statuses from. This parameter is mandatory.

1

1

simple
Example 24. GetAssetAvailableStatuses 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:GetAssetAvailableStatuses>
      <AssetID>150</AssetID>
    </ns1:GetAssetAvailableStatuses>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GetAssetAvailableStatusesSoapOutput (GetAssetAvailableStatusesResponse)

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

GetAssetAvailableStatusesResult [StatusDescription]

0

/

complex
Example 25. GetAssetAvailableStatuses 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:GetAssetAvailableStatusesResponse>
      <GetAssetAvailableStatusesResult>
        <StatusValue>16</StatusValue>
        <StatusDescription>Approve and Make Live</StatusDescription>
      </GetAssetAvailableStatusesResult>
      <GetAssetAvailableStatusesResult>
        <StatusValue>1</StatusValue>
        <StatusDescription>Archive</StatusDescription>
      </GetAssetAvailableStatusesResult>
    </ns1:GetAssetAvailableStatusesResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GetAssetWebPaths

The GetAssetWebPaths operation will return all web paths of a specified asset. The parameters available for this operation are as follows:

GetAssetWebPathsSoapInput (GetAssetWebPaths)

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

AssetID [string]

The asset ID of the asset to return web paths from. This parameter is mandatory.

1

1

simple
Example 26. GetAssetWebPaths 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:GetAssetWebPaths>
      <AssetID>100</AssetID>
    </ns1:GetAssetWebPaths>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GetAssetWebPathsSoapOutput (GetAssetWebPathsResponse)

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

GetAssetWebPathsResult [string]

0

/

simple
Example 27. GetAssetWebPaths 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:GetAssetWebPathsResponse>
      <GetAssetWebPathsResult>home</GetAssetWebPathsResult>
    </ns1:GetAssetWebPathsResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GetAssetURLs

The GetAssetURLs operation will return all URLs associated with a specified asset. The parameters available for this operation are as follows:

GetAssetURLsSoapInput (GetAssetURLs)

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

AssetID [string]

The asset ID of the asset to return URLs from. This parameter is mandatory.

1

1

simple

RootPathAssetID [string]

Enter a root ID to specify the URL to return for an asset linked under multiple assets.

0

1

simple
Example 28. GetAssetURLs 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:GetAssetURLs>
      <AssetID>150</AssetID>
      <RootPathAssetID>100</RootPathAssetID>
    </ns1:GetAssetURLs>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GetAssetURLsSoapOutput (GetAssetURLsResponse)

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

GetAssetURLsResult [string]

0

/

simple
Example 29. GetAssetURLs 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:GetAssetURLsResponse>
      <GetAssetURLsResult>http://www.example.com/home</GetAssetURLsResult>
      <GetAssetURLsResult>http://www.mysite.com/home</GetAssetURLsResult>
    </ns1:GetAssetURLsResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GetPageContents

The GetPageContents operation will return the page content, web path and URL of a specified asset. The parameters available for this operation are as follows:

GetPageContentsSoapInput (GetPageContents)

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

AssetID [string]

The asset ID of the asset to return the page contents of. This parameter is mandatory.

1

1

simple

RootNodeID [string]

Enter a root node ID to specify the content to return for an asset linked under multiple assets.

0

1

simple
Example 30. GetPageContents 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:GetPageContents>
      <AssetID>100</AssetID>
      <RootNodeID>70</RootNodeID>
    </ns1:GetPageContents>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GetPageContentsSoapOutput (GetPageContentsResponse)

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

PageContent [string]

1

1

simple

PageURL [string]

0

1

simple

PageWebPath [string]

0

1

simple
Example 31. GetPageContents 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:GetPageContentsResponse>
      <PageContent> <div id="content_div_72">The content on our Home page.</div> </PageContent>
      <PageURL>http://www.example.com/home</PageURL>
      <PageWebPath>home</PageWebPath>
    </ns1:GetPageContentsResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GetTags

The GetTags operation will retrieve the Thesaurus Terms that have been tagged on a specified asset. The parameters available for this operation are as follows:

GetTagsSoapInput (GetTags)

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

AssetID [string]

The asset ID of the asset of which to retrieve the tagged terms. This parameter is mandatory.

1

1

simple

ThesaurusID [string]

The ID of a Thesaurus asset(s); allows you to filter the return tagged terms to specific Thesauri.

0

-
Example 32. GetTags 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:GetTags>
      <AssetID>86</AssetID>
      <ThesaurusID>132</ThesaurusID>
    </ns1:GetTags>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GetTagsSoapOutput (GetTagsResponse)

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

GetTagsResult [TagDetails]

0

-

complex
Example 33. GetTags 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:GetTagsResponse>
      <GetTagsResult>
        <TagID>132:4</TagID>
        <TagName>News</TagName>
        <ThesaurusID>132</ThesaurusID>
        <Weight>1</Weight>
        <LinkID>290</LinkID>
      </GetTagsResult>
      <GetTagsResult>
        <TagID>132:9</TagID>
        <TagName>Australia</TagName>
        <ThesaurusID>132</ThesaurusID>
        <Weight>1</Weight>
        <LinkID>312</LinkID>
      </GetTagsResult>
    </ns1:GetTagsResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

SetAttributeValue

The SetAttributeValue operation will set an attribute value of a specified asset. The parameters available for this operation are as follows:

SetAttributeValueSoapInput (SetAttributeValue)

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

AssetID [string]

The asset ID of the asset on which to set the attribute value. This parameter is mandatory.

1

1

simple

AttributeName [string]

The name of the asset attribute on which to set the attribute value. This parameter is mandatory.

1

1

simple

AttributeValue [string]

The attribute value of the asset. This parameter is mandatory.

1

1

simple
Example 34. SetAttributeValue 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:SetAttributeValue>
      <AssetID>100</AssetID>
      <AttributeName>short_name</AttributeName>
      <AttributeValue>New Short Name</AttributeValue>
    </ns1:SetAttributeValue>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

SetAttributeValueSoapOutput (SetAttributeValueResponse)

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

SetAttributeValueResult [string]

0

1

simple
Example 35. SetAttributeValue 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:SetAttributeValueResponse>
      <SetAttributeValueResult>New Short Name</SetAttributeValueResult>
    </ns1:SetAttributeValueResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

SetTag

The SetTag operation will set a thesaurus Term tag for a specified asset. The parameters available for this operation are as follows:

SetTagSoapInput (SetTag)

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

AssetID [string]

The asset ID of the asset on which to set the tag. This parameter is mandatory.

1

1

simple

ThesaurusID [string]

The asset ID of the thesaurus that holds the thesaurus term to tag. This parameter is mandatory.

1

1

simple

TagName [string]

The name of the thesaurus term to tag. This parameter is mandatory.

1

1

simple

Weight [string]

The weight of the tag as an integer. This will determine the importance of the tag in relation to other tags set for the asset. The default value for this parameter is 1.

0

1

simple

CascadeTagChange [string]

Indicates whether to cascade the set tag onto all children of the selected asset. The value for this parameter should be either TRUE or FALSE (or 1 or 0). The default value for this parameter is 0.

0

1

simple
Example 36. SetTag 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:SetTag>
      <AssetID>100</AssetID>
      <ThesaurusID>200</ThesaurusID>
      <TagName>Tag</TagName>
      <Weight>3</Weight>
      <CascadeTagChange>1</CascadeTagChange>
    </ns1:SetTag>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

SetTagSoapOutput (SetTagResponse)

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

SetTagResult [boolean]

0

1

simple
Example 37. SetTag 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:SetTagResponse>
      <SetTagResult>true</SetTagResult>
    </ns1:SetTagResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

SetAssetStatus

The SetAssetStatus operation will set the Status for a specified asset. The parameters available for this operation are as follows:

SetAssetStatusSoapInput (SetAssetStatus)

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

AssetID [string]

The asset ID of the asset on which to set the status. This parameter is mandatory.

1

1

simple

StatusValue [string]

The value of the status to set. For example, enter 16 to set the status as Live. Read the Asset statuses and categories documentation for more information on the available status values.

1

1

simple

DependantsOnly [boolean]

Indicates whether the status being set should only cascade to dependant assets or also to the asset’s non-dependant children. The value for this parameter should be either TRUE or FALSE (or 1 or 0). The default value for this parameter is TRUE.

0

1

simple
Example 38. SetAssetStatus 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:SetAssetStatus>
      <AssetID>100</AssetID>
      <StatusValue>16</StatusValue>
      <DependantsOnly>1</DependantsOnly>
    </ns1:SetAssetStatus>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

SetAssetStatusSoapOutput (SetAssetStatusResponse)

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

SetAssetStatusResult [boolean]

0

1

simple
Example 39. SetAssetStatus 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:SetAssetStatusResponse>
      <SetAssetStatusResult>true</SetAssetStatusResult>
    </ns1:SetAssetStatusResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

SetAssetWebPaths

The SetAssetWebPaths operation will set the web path of a specified asset. The parameters available for this operation are as follows:

SetAssetWebPathsSoapInput (SetAssetWebPaths)

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

AssetID [string]

The asset ID of the asset of which to set the web path(s). This parameter is mandatory.

1

1

simple

Path [string]

The web path to set on the asset. You can set multiple path parameters to apply multiple web paths to the specified asset.

0

/

simple

AddRemaps [boolean]

Indicates whether to automatically add remaps for web paths that are changed on the asset. The value for this parameter should be either TRUE or FALSE (or 1 or 0). The default value for this parameter is TRUE.

0

1

simple
Example 40. SetAssetWebPaths 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:SetAssetWebPaths>
      <AssetID>100</AssetID>
      <Path>home</Path>
      <Path>welcome</Path>
      <AddRemaps>1</AddRemaps>
    </ns1:SetAssetWebPaths>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

SetAssetWebPathsSoapOutput (SetAssetWebPathsResponse)

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

RSetAssetWebPathsResult [boolean]OW

0

1

simple
Example 41. SetAssetWebPaths 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:SetAssetWebPathsResponse>
      <SetAssetWebPathsResult>true</SetAssetWebPathsResult>
    </ns1:SetAssetWebPathsResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

TrashAsset

The TrashAsset operation will send a specified asset to the trash. The parameters available for this operation are as follows:

TrashAssetSoapInput (TrashAsset)

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

AssetID [string]

The asset ID of the asset to send to the trash. This parameter is mandatory.

1

1

simple
Example 42. TrashAsset 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:TrashAsset>
      <AssetID>100</AssetID>
    </ns1:TrashAsset>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

TrashAssetSoapOutput (TrashAssetResponse)

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

TrashAssetResult [boolean]

0

1

simple
Example 43. TrashAsset 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:TrashAssetResponse>
      <TrashAssetResult>true</TrashAssetResult>
    </ns1:TrashAssetResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

LoginUser

The LoginUser operation will log a user into the system. The parameters available for this operation are as follows:

LoginUserSoapInput (LoginUser)

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

Username [string]

The username of the user account.

1

1

simple

Password [string]

The password of the user account.

1

1

simple

After a successful login, this operation will return SessionID and SessionKey parameters as tokens of the user session. These parameters can be passed into Matrix by the user to log into the previous authentication session:

http://example.com?SESSION_ID=[SessionID]&SOAP_SESSION_KEY=[SessionKey]
If you are using Matrix 5.2.0 or higher, these parameters must be sent as POST request variables.
Example 44. LoginUser 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:LoginUser>
      <Username>User</Username>
      <Password>pass123</Password>
    </ns1:LoginUser>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

LoginUserSoapOutput (LoginUserResponse)

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

SessionID [string]

1

1

simple

SessionKey [string]

1

1

simple
Example 45. LoginUser 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:LoginUserResponse>
      <SessionID>924r52ha6216rh68r5265r3r36s6e25d</SessionID>
      <SessionKey>7w91rh72a3d07y2sa03b6905bg86220d</SessionKey>
    </ns1:LoginUserResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GetUserIdByUsername

The GetUserIdByUsername operation will return the asset ID of a specified User asset. The parameters available for this operation are as follows:

GetUserIdByUsernameSoapInput (GetUserIdByUsername)

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

Username [string]

The username of the user asset of which to return the asset ID.

1

1

simple
Example 46. GetUserIdByUsername 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:GetUserIdByUsername>
      <Username>User</Username>
    </ns1:GetUserIdByUsername>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GetUserIdByUsernameSoapOutput (GetUserIdByUsernameResponse)

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

AssetID [string]

1

1

simple
Example 47. GetUserIdByUsername 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:GetUserIdByUsernameResponse>
      <AssetID>230</AssetID>
    </ns1:GetUserIdByUsernameResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>