<?php namespace dtos;
use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};
/** @description Returns system settings for a specified appliance. */
// @Api(Description="Returns system settings for a specified appliance.")
class GetSettingsForAppliance implements JsonSerializable
{
public function __construct(
/** @description The appliance ID to return settings for. */
// @ApiMember(DataType="Guid", Description="The appliance ID to return settings for.", IsRequired=true, Name="ApplianceId", ParameterType="query")
/** @var string */
public string $ApplianceId='',
/** @description A list of the setting Id's that are to be retrieved. */
// @ApiMember(DataType="Guid", Description="A list of the setting Id's that are to be retrieved.", IsRequired=true, Name="SettingIds", ParameterType="query")
/** @var array<string>|null */
public ?array $SettingIds=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ApplianceId'])) $this->ApplianceId = $o['ApplianceId'];
if (isset($o['SettingIds'])) $this->SettingIds = JsonConverters::fromArray('Guid', $o['SettingIds']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ApplianceId)) $o['ApplianceId'] = $this->ApplianceId;
if (isset($this->SettingIds)) $o['SettingIds'] = JsonConverters::toArray('Guid', $this->SettingIds);
return empty($o) ? new class(){} : $o;
}
}
PHP GetSettingsForAppliance DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>