| All Verbs | /api/dimensionvalues/object/{ObjectId} |
|---|
<?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 DimensionValueModel implements JsonSerializable
{
public function __construct(
/** @description Id of the dimension value. */
// @ApiMember(DataType="Guid", Description="Id of the dimension value.", Name="DimensionValueId", ParameterType="body")
/** @var string */
public string $DimensionValueId='',
/** @description Dimension Id this value is for. */
// @ApiMember(Description="Dimension Id this value is for.", ParameterType="body")
/** @var string */
public string $DimensionId='',
/** @description Name of the dimension value. */
// @ApiMember(Description="Name of the dimension value.", ParameterType="body")
/** @var string|null */
public ?string $Name=null,
/** @description Description of the dimension value. */
// @ApiMember(Description="Description of the dimension value.", ParameterType="body")
/** @var string|null */
public ?string $Description=null,
/** @description Short Name for the dimension value. */
// @ApiMember(Description="Short Name for the dimension value.", ParameterType="body")
/** @var string|null */
public ?string $ShortName=null,
/** @description Id of the colour associated. */
// @ApiMember(Description="Id of the colour associated.", ParameterType="body")
/** @var string */
public string $TrafficLightId='',
/** @description Colour associated with the dimension value. */
// @ApiMember(Description="Colour associated with the dimension value.", ParameterType="body")
/** @var string|null */
public ?string $TrafficLightColour=null,
/** @description Id that links this dimension value to an object. */
// @ApiMember(Description="Id that links this dimension value to an object.", ParameterType="body")
/** @var string */
public string $ObjectConnectionId='',
/** @description Owner Id of the dimension value. */
// @ApiMember(Description="Owner Id of the dimension value.", ParameterType="body")
/** @var string */
public string $OwnerContactId='',
/** @description Record status of the dimension value. */
// @ApiMember(Description="Record status of the dimension value.", ParameterType="body")
/** @var string|null */
public ?string $RecordStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['DimensionValueId'])) $this->DimensionValueId = $o['DimensionValueId'];
if (isset($o['DimensionId'])) $this->DimensionId = $o['DimensionId'];
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['Description'])) $this->Description = $o['Description'];
if (isset($o['ShortName'])) $this->ShortName = $o['ShortName'];
if (isset($o['TrafficLightId'])) $this->TrafficLightId = $o['TrafficLightId'];
if (isset($o['TrafficLightColour'])) $this->TrafficLightColour = $o['TrafficLightColour'];
if (isset($o['ObjectConnectionId'])) $this->ObjectConnectionId = $o['ObjectConnectionId'];
if (isset($o['OwnerContactId'])) $this->OwnerContactId = $o['OwnerContactId'];
if (isset($o['RecordStatus'])) $this->RecordStatus = $o['RecordStatus'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->DimensionValueId)) $o['DimensionValueId'] = $this->DimensionValueId;
if (isset($this->DimensionId)) $o['DimensionId'] = $this->DimensionId;
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->Description)) $o['Description'] = $this->Description;
if (isset($this->ShortName)) $o['ShortName'] = $this->ShortName;
if (isset($this->TrafficLightId)) $o['TrafficLightId'] = $this->TrafficLightId;
if (isset($this->TrafficLightColour)) $o['TrafficLightColour'] = $this->TrafficLightColour;
if (isset($this->ObjectConnectionId)) $o['ObjectConnectionId'] = $this->ObjectConnectionId;
if (isset($this->OwnerContactId)) $o['OwnerContactId'] = $this->OwnerContactId;
if (isset($this->RecordStatus)) $o['RecordStatus'] = $this->RecordStatus;
return empty($o) ? new class(){} : $o;
}
}
class DimensionModel implements JsonSerializable
{
public function __construct(
/** @description Id of the Dimension itself. */
// @ApiMember(DataType="Guid", Description="Id of the Dimension itself.", Name="DimensionId")
/** @var string */
public string $DimensionId='',
/** @description Dimension name. */
// @ApiMember(DataType="string", Description="Dimension name.", Name="Name")
/** @var string|null */
public ?string $Name=null,
/** @description Dimension description. */
// @ApiMember(DataType="string", Description="Dimension description.", Name="Description")
/** @var string|null */
public ?string $Description=null,
/** @description Dimension shortened name. */
// @ApiMember(DataType="string", Description="Dimension shortened name.", Name="ShortName")
/** @var string|null */
public ?string $ShortName=null,
/** @description True if the values for the dimension should have colours associated with them. */
// @ApiMember(DataType="bool", Description="True if the values for the dimension should have colours associated with them.", Name="HasTrafficLightForValues")
/** @var bool|null */
public ?bool $HasTrafficLightForValues=null,
/** @description */
// @ApiMember(DataType="bool", Description="", Name="HasImage")
/** @var bool|null */
public ?bool $HasImage=null,
/** @description Owner Id of the dimension. */
// @ApiMember(DataType="Guid", Description="Owner Id of the dimension.", Name="OwnerContactId")
/** @var string */
public string $OwnerContactId='',
/** @description Record status of the dimension. */
// @ApiMember(DataType="string", Description="Record status of the dimension.", Name="RecordStatus")
/** @var string|null */
public ?string $RecordStatus=null,
/** @description Dimension values for this dimension. */
// @ApiMember(DataType="List<DimensionValueModel>", Description="Dimension values for this dimension.", Name="DimensionValues")
/** @var array<DimensionValueModel>|null */
public ?array $DimensionValues=null,
/** @description Id that links this dimension to an object. */
// @ApiMember(Description="Id that links this dimension to an object.")
/** @var string */
public string $ObjectConnectionId=''
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['DimensionId'])) $this->DimensionId = $o['DimensionId'];
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['Description'])) $this->Description = $o['Description'];
if (isset($o['ShortName'])) $this->ShortName = $o['ShortName'];
if (isset($o['HasTrafficLightForValues'])) $this->HasTrafficLightForValues = $o['HasTrafficLightForValues'];
if (isset($o['HasImage'])) $this->HasImage = $o['HasImage'];
if (isset($o['OwnerContactId'])) $this->OwnerContactId = $o['OwnerContactId'];
if (isset($o['RecordStatus'])) $this->RecordStatus = $o['RecordStatus'];
if (isset($o['DimensionValues'])) $this->DimensionValues = JsonConverters::fromArray('DimensionValueModel', $o['DimensionValues']);
if (isset($o['ObjectConnectionId'])) $this->ObjectConnectionId = $o['ObjectConnectionId'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->DimensionId)) $o['DimensionId'] = $this->DimensionId;
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->Description)) $o['Description'] = $this->Description;
if (isset($this->ShortName)) $o['ShortName'] = $this->ShortName;
if (isset($this->HasTrafficLightForValues)) $o['HasTrafficLightForValues'] = $this->HasTrafficLightForValues;
if (isset($this->HasImage)) $o['HasImage'] = $this->HasImage;
if (isset($this->OwnerContactId)) $o['OwnerContactId'] = $this->OwnerContactId;
if (isset($this->RecordStatus)) $o['RecordStatus'] = $this->RecordStatus;
if (isset($this->DimensionValues)) $o['DimensionValues'] = JsonConverters::toArray('DimensionValueModel', $this->DimensionValues);
if (isset($this->ObjectConnectionId)) $o['ObjectConnectionId'] = $this->ObjectConnectionId;
return empty($o) ? new class(){} : $o;
}
}
// @ApiResponse(Description="A list of dimensions (and values if they apply) for an object")
class GetObjectDimensionsResponse implements JsonSerializable
{
public function __construct(
/** @description List of dimensions. */
// @ApiMember(DataType="List<DimensionModel>", Description="List of dimensions.", Name="Dimensions", ParameterType="query")
/** @var array<DimensionModel>|null */
public ?array $Dimensions=null,
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Dimensions'])) $this->Dimensions = JsonConverters::fromArray('DimensionModel', $o['Dimensions']);
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Dimensions)) $o['Dimensions'] = JsonConverters::toArray('DimensionModel', $this->Dimensions);
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
return empty($o) ? new class(){} : $o;
}
}
/** @description Get a list of dimensionValues linked to a specified object */
// @Api(Description="Get a list of dimensionValues linked to a specified object")
class GetObjectDimensionValues implements JsonSerializable
{
public function __construct(
/** @description Licensee Id to retrieve dimensionValues for. */
// @ApiMember(DataType="Guid", Description="Licensee Id to retrieve dimensionValues for.", Name="LicenseeId", ParameterType="query")
/** @var string */
public string $LicenseeId='',
/** @description Object Id to retrieve dimensionValues for. */
// @ApiMember(DataType="Guid", Description="Object Id to retrieve dimensionValues for.", Name="ObjectId", ParameterType="query")
/** @var string */
public string $ObjectId=''
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['LicenseeId'])) $this->LicenseeId = $o['LicenseeId'];
if (isset($o['ObjectId'])) $this->ObjectId = $o['ObjectId'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->LicenseeId)) $o['LicenseeId'] = $this->LicenseeId;
if (isset($this->ObjectId)) $o['ObjectId'] = $this->ObjectId;
return empty($o) ? new class(){} : $o;
}
}
PHP GetObjectDimensionValues 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 /api/dimensionvalues/object/{ObjectId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetObjectDimensionValues xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<LicenseeId>00000000-0000-0000-0000-000000000000</LicenseeId>
<ObjectId>00000000-0000-0000-0000-000000000000</ObjectId>
</GetObjectDimensionValues>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetObjectDimensionsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<Dimensions xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
<d2p1:DimensionModel>
<d2p1:Description>String</d2p1:Description>
<d2p1:DimensionId>00000000-0000-0000-0000-000000000000</d2p1:DimensionId>
<d2p1:DimensionValues>
<d2p1:DimensionValueModel>
<d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField>
<d2p1:_x003C_DimensionId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_DimensionId_x003E_k__BackingField>
<d2p1:_x003C_DimensionValueId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_DimensionValueId_x003E_k__BackingField>
<d2p1:_x003C_Name_x003E_k__BackingField>String</d2p1:_x003C_Name_x003E_k__BackingField>
<d2p1:_x003C_ObjectConnectionId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_ObjectConnectionId_x003E_k__BackingField>
<d2p1:_x003C_OwnerContactId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_OwnerContactId_x003E_k__BackingField>
<d2p1:_x003C_RecordStatus_x003E_k__BackingField>String</d2p1:_x003C_RecordStatus_x003E_k__BackingField>
<d2p1:_x003C_ShortName_x003E_k__BackingField>String</d2p1:_x003C_ShortName_x003E_k__BackingField>
<d2p1:_x003C_TrafficLightColour_x003E_k__BackingField>String</d2p1:_x003C_TrafficLightColour_x003E_k__BackingField>
<d2p1:_x003C_TrafficLightId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_TrafficLightId_x003E_k__BackingField>
</d2p1:DimensionValueModel>
</d2p1:DimensionValues>
<d2p1:HasImage>false</d2p1:HasImage>
<d2p1:HasTrafficLightForValues>false</d2p1:HasTrafficLightForValues>
<d2p1:Name>String</d2p1:Name>
<d2p1:ObjectConnectionId>00000000-0000-0000-0000-000000000000</d2p1:ObjectConnectionId>
<d2p1:OwnerContactId>00000000-0000-0000-0000-000000000000</d2p1:OwnerContactId>
<d2p1:RecordStatus>String</d2p1:RecordStatus>
<d2p1:ShortName>String</d2p1:ShortName>
</d2p1:DimensionModel>
</Dimensions>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</GetObjectDimensionsResponse>