| All Verbs | /api/unitofmeasures/ | ||
|---|---|---|---|
| All Verbs | /api/unitofmeasures/{ApplianceId} |
<?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};
class UOMModel implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $Code=null,
/** @var string|null */
public ?string $Name=null,
/** @var string|null */
public ?string $Description=null,
/** @var string|null */
public ?string $Symbol=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Code'])) $this->Code = $o['Code'];
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['Description'])) $this->Description = $o['Description'];
if (isset($o['Symbol'])) $this->Symbol = $o['Symbol'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Code)) $o['Code'] = $this->Code;
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->Description)) $o['Description'] = $this->Description;
if (isset($this->Symbol)) $o['Symbol'] = $this->Symbol;
return empty($o) ? new class(){} : $o;
}
}
// @ApiResponse(Description="List of UOM codes (Unit of Measure)")
class GetUOMCodeListResponse implements JsonSerializable
{
public function __construct(
/** @var array<UOMModel>|null */
public ?array $UOMCodes=null,
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['UOMCodes'])) $this->UOMCodes = JsonConverters::fromArray('UOMModel', $o['UOMCodes']);
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->UOMCodes)) $o['UOMCodes'] = JsonConverters::toArray('UOMModel', $this->UOMCodes);
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
return empty($o) ? new class(){} : $o;
}
}
/** @description Get a list of UOM codes (Unit of Measure) */
// @Api(Description="Get a list of UOM codes (Unit of Measure)")
class GetUOMCodeList implements JsonSerializable
{
public function __construct(
/** @description ApplianceId to narrow the UOM Code list down to relevant ones for the appliance. */
// @ApiMember(DataType="Guid", Description="ApplianceId to narrow the UOM Code list down to relevant ones for the appliance.", Name="ApplianceId", ParameterType="query")
/** @var string */
public string $ApplianceId=''
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ApplianceId'])) $this->ApplianceId = $o['ApplianceId'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ApplianceId)) $o['ApplianceId'] = $this->ApplianceId;
return empty($o) ? new class(){} : $o;
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/unitofmeasures/ HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
UOMCodes:
[
{
Code: String,
Name: String,
Description: String,
Symbol: String
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}