The xAssets API - Method : GetHomeCurrencyValue


Get a converted value at a specified date for the currency provided


Parameter : sArguments

CurrencyCode, such as GBP, USD
Date for the desired valuation. Should be provided in the form dd-MMM-yyyy or optionally with a time in the form dd-MMM-yyyy HH:mm:ss
Value to convert, this should itself represent an amount in the HomeCurrencyCode of the system


The converted amount in the currency code supplied

Syntax and Examples

Restful syntax with Microsoft Visual Basic

Example 1

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

        Public Sub Main()


                '   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 & ""
                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=GetHomeCurrencyValue
                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("Finished - Press enter to close")
                Catch ex As Exception
                Console.WriteLine("Error:" & ex.Message & " - Press enter to close")
            End Try


        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

            Return ""

        End Function
    End Module

SOAP Syntax with Microsoft Visual Basic

Example 1


        ErrorMessage = ""

        Return w.WebCommandProcessorArray(_hash, _username, _db, _ip, "GetHomeCurrencyValue", {}, _dns, _port, _scheme, _nonce, _noncedate)

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

AMSX Syntax

Example 1

    Set xml = CommandProcessor "GetHomeCurrencyValue"

XCS Syntax

Example 1

    Dim xml As String = Server.API("GetHomeCurrencyValue")

Download the Visual Studio API Samples Project

Return to the API Index Page

© xAssets 2024 All rights reserved.