The xAssets API - Method : SpecialAssetUpdate

Summary

Update any single-ID-keyed table in the data model, including the Asset table, with full support for coded business rules in the API layer

Parameters

Parameter : sXML

Parameter : sArguments

Table name

KeyField (or blank to use the tables primary key field)

ID list - a comma separated list of IDs to be updated

FieldName

Value

FieldName ...

Value ...

Returns

If successful an empty string is returned. If an error occurred this function will return the error message.

Syntax and Examples

Restful syntax with Microsoft Visual Basic

Example 1 - Update the Asset table to set the Status to 12 for Assets 3,4 and 5


	
    Imports System.Text
    Imports Newtonsoft.Json.Linq
    Public Module Module1

        Public Sub Main()

            Try

                '   Enter your API key and company database name in these variables

                Dim _db As String = "mycompany"
                Dim apikey As String = "YOURAPIKEY"

                '   Open a web client to login

                Dim web As New System.Net.WebClient()

                Dim urlroot as String = "https://" & _db & ".yourxassetsplatform.xassets.net/api"
                Dim json As String = web.DownloadString(urlroot & "/api.ashx?apikey=" & apikey & "&database=" & _db & "&command=apilogon")

                '   Check the login for errors

                Dim o As JObject = JObject.Parse(json)
                Dim e As String = GetResultFromJson(o, "error")
                If e <> "" Then
                    Throw New Exception(e)
                End If

                '   Store the login hash, nonce and noncedate

                Dim hash As String = GetResultFromJson(o, "hash")
                Dim nonce As String = GetResultFromJson(o, "nonce")
                Dim noncedate As Date = CDate(GetResultFromJson(o, "noncetime"))

                If hash = "" Then
                    Throw New Exception("Unexpected error - a hash was not returned from the API logon process")
                End If

                Console.WriteLine("Logged on OK")

                '   Open a new web client to perform the API call

                web = New System.Net.WebClient()

                '   Add the authorization header

                web.Headers.Add("Authorization", "Bearer " & hash)
                web.Headers.Add("Sec", _db & "|" & nonce & "|" & Format(noncedate, "dd-MMM-yyyy HH:mm:ss") & "|" & Format(noncedate, "fff"))

                '   Perform the actual API call

                Dim url as String = urlroot & "/api.ashx?command=SpecialAssetUpdate&arg0=Asset&arg1=AssetID&arg2=3,4,5&arg3=StatusID&arg4=12
                Dim data As String = web.DownloadString(url.ToString)

                '   Parse and output the data

                Dim ob As JObject = JObject.Parse(data)
                Dim err As String = GetResultFromJson(ob, "error")
                If err <> "" Then
                    Throw New Exception(err)
                End If
            
                Dim xml As String = GetResultFromJson(ob, "returncode")

                Console.WriteLine(xml)
                Console.WriteLine("Finished - Press enter to close")
            
                Catch ex As Exception
                Console.WriteLine("Error:" & ex.Message & " - Press enter to close")
            End Try

            Console.ReadLine()

        End Sub

        Private Function GetResultFromJson(o As JObject, sFind As String) As String

            For Each res As JObject In o.SelectTokens("data[*]")
                If res("type").Value(Of String) = sFind Then
                    Return res("value").ToString
                End If
            Next

            Return ""

        End Function
    End Module

SOAP Syntax with Microsoft Visual Basic

Example 1 - Update the Asset table to set the Status to 12 for Assets 3,4 and 5



    Try

        ErrorMessage = ""

        Return w.WebSaveSpecial(_hash, _username, _db, _ip, "", "SpecialAssetUpdate", {"Asset", "AssetID", "3,4,5", "StatusID", "12"}, False, _dns, _port, _scheme, _nonce, _noncedate)

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

AMSX Syntax

Example 1 - Update the Asset table to set the Status to 12 for Assets 3,4 and 5



    SaveSpecial "SpecialAssetUpdate","", "Asset", "AssetID", "3,4,5", "StatusID", "12"

XCS Syntax

Example 1 - Update the Asset table to set the Status to 12 for Assets 3,4 and 5



    Dim ret as String = Server.SaveSpecial("SpecialAssetUpdate","", "Asset", "AssetID", "3,4,5", "StatusID", "12")
    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