Platform API

<back to all web services

GetSettingsForAppliance

Returns system settings for a specified appliance.

Requires Authentication 
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eros.Subtle.Canvara.WebAPIModel.ServiceModel

Namespace Global

    Namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

        '''<Summary>
        '''Returns system settings for a specified appliance.
        '''</Summary>
        <Api(Description:="Returns system settings for a specified appliance.")>
        Public Partial Class GetSettingsForAppliance
            '''<Summary>
            '''The appliance ID to return settings for.
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="The appliance ID to return settings for.", IsRequired:=true, Name:="ApplianceId", ParameterType:="query")>
            Public Overridable Property ApplianceId As Guid

            '''<Summary>
            '''A list of the setting Id's that are to be retrieved.
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="A list of the setting Id's that are to be retrieved.", IsRequired:=true, Name:="SettingIds", ParameterType:="query")>
            Public Overridable Property SettingIds As List(Of Guid) = New List(Of Guid)
        End Class
    End Namespace
End Namespace

VB.NET GetSettingsForAppliance DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/GetSettingsForAppliance HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetSettingsForAppliance xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <ApplianceId>00000000-0000-0000-0000-000000000000</ApplianceId>
  <SettingIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </SettingIds>
</GetSettingsForAppliance>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfSettingsModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <SettingsModel>
    <SettingId>00000000-0000-0000-0000-000000000000</SettingId>
    <SettingName>String</SettingName>
    <SettingValue>String</SettingValue>
  </SettingsModel>
</ArrayOfSettingsModel>