The xAssets API - Method : SpecialAssetMerge

Summary

Merge a list of assets into a single asset. A single asset is selected as the merge target, and the remaining assets in the list are merged onto it

Parameters

Parameter : sXML

A XML structure in the format required by the Asset Disposal API function SpecialBulkDisposal. This determines how the merged asset records are disposed of

Parameter : sArguments

0
AssetID which will be the template we are merging into (the PRIMARY asset)
1
StatusID we are disposing the other assets to
2
not used
3
mergeassetfields - flag signalling we have to walk through the asset records and update any fields which are NULL in the primary and have a value in another asset
4
transactions - flag signalling that purchase transactions have to be merged
5
specificationchilddata - flag signalling that specification detail data has to be merged
6
delete - flag signalling that the MERGE assets must be permanently deleted instead of disposed of
7
combine flag - 1 to add the quantities and procurement amounts, 0 to preserve the primary asset (1 to add assets together, 0 to solve duplicates)
8
list of fields which will receive static values, ^ separated
9
list of values for the fields listed in 8, ^ separated
10
spare

11+ onwards = assetid of each asset being merged into sarg(0). If sArguments(11) contains commas then that one parameter is used as a list

Returns

If successful, an empty string is returned. If an error occurred, the return value contains the error message.

Syntax and Examples

Restful syntax with Microsoft Visual Basic

Example 1 - Merge assets 3,4,5 and 6 into asset 2

There is no restful call for this API operation - use a SOAP method instead

SOAP Syntax with Microsoft Visual Basic

Example 1 - Merge assets 3,4,5 and 6 into asset 2


    Try

        ErrorMessage = ""

        Return w.WebSaveSpecial(_hash, _username, _db, _ip, "", "SpecialAssetMerge", {"6", "6", "", "1", "1", "1", "0", "1", "Notes", "Asset merged", "", "3,4,5,6"}, False, _dns, _port, _scheme, _nonce, _noncedate)

    Catch ex As Exception
        ErrorMessage = ex.Message
        Return "
    End Try

                            

AMSX Syntax

Example 1 - Merge assets 3,4,5 and 6 into asset 2


    SaveSpecial "SpecialAssetMerge","", "6", "6", "", "1", "1", "1", "0", "1", "Notes", "Asset merged", "", "3,4,5,6"
                        

XCS Syntax

Example 1 - Merge assets 3,4,5 and 6 into asset 2


    Dim ret as String = Server.SaveSpecial("SpecialAssetMerge","", "6", "6", "", "1", "1", "1", "0", "1", "Notes", "Asset merged", "", "3,4,5,6")
    If ret = " Or ret.Substring(0, 8) = "special=" Then
        MsgBox("Save operation completed.", vbInformation, "Save Data")
    Else
        MsgBox("Save operation failed:" & ret, vbExclamation, "Save Data")
    End If
                        

Download the Visual Studio API Samples Project

Return to the API Index Page

© xAssets 2023 All rights reserved.