/* Options:
Date: 2026-04-04 01:06:09
Version: 8.52
Tip: To override a DTO option, remove "//" prefix before updating
BaseUrl: https://pfapi.pstpf.com.au/api

//Package: 
//AddServiceStackTypes: True
//AddResponseStatus: False
//AddImplicitVersion: 
//AddDescriptionAsComments: True
IncludeTypes: GetDimensionsAndValues.*
//ExcludeTypes: 
//InitializeCollections: False
//TreatTypesAsStrings: 
//DefaultImports: java.math.*,java.util.*,java.io.InputStream,net.servicestack.client.*
*/

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Get a list of dimensions and their values (active) for a licensee, as well as any standard dimensions.
*/
@Route(Path="/dimensions/includevalues", Verbs="GET")
@Api(Description="Get a list of dimensions and their values (active) for a licensee, as well as any standard dimensions.")
open class GetDimensionsAndValues : IReturn<GetDimensionsListResponse>
{
    /**
    * Licensee Id to retrieve dimensions for.
    */
    @ApiMember(DataType="Guid", Description="Licensee Id to retrieve dimensions for.", Name="LicenseeId", ParameterType="query")
    open var LicenseeId:UUID? = null
    companion object { private val responseType = GetDimensionsListResponse::class.java }
    override fun getResponseType(): Any? = GetDimensionsAndValues.responseType
}

@ApiResponse(Description="A list of dimensions")
open class GetDimensionsListResponse
{
    /**
    * List of dimensions.
    */
    @ApiMember(DataType="List<DimensionModel>", Description="List of dimensions.", Name="Dimensions", ParameterType="query")
    open var Dimensions:ArrayList<DimensionModel>? = null

    open var ResponseStatus:ResponseStatus? = null
}

open class DimensionModel
{
    /**
    * Id of the Dimension itself.
    */
    @ApiMember(DataType="Guid", Description="Id of the Dimension itself.", Name="DimensionId")
    open var DimensionId:UUID? = null

    /**
    * Dimension name.
    */
    @ApiMember(DataType="string", Description="Dimension name.", Name="Name")
    open var Name:String? = null

    /**
    * Dimension description.
    */
    @ApiMember(DataType="string", Description="Dimension description.", Name="Description")
    open var Description:String? = null

    /**
    * Dimension shortened name.
    */
    @ApiMember(DataType="string", Description="Dimension shortened name.", Name="ShortName")
    open var ShortName:String? = null

    /**
    * 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")
    open var HasTrafficLightForValues:Boolean? = null

    /**
    * 
    */
    @ApiMember(DataType="bool", Description="", Name="HasImage")
    open var HasImage:Boolean? = null

    /**
    * Owner Id of the dimension.
    */
    @ApiMember(DataType="Guid", Description="Owner Id of the dimension.", Name="OwnerContactId")
    open var OwnerContactId:UUID? = null

    /**
    * Record status of the dimension.
    */
    @ApiMember(DataType="string", Description="Record status of the dimension.", Name="RecordStatus")
    open var RecordStatus:String? = null

    /**
    * Dimension values for this dimension.
    */
    @ApiMember(DataType="List<DimensionValueModel>", Description="Dimension values for this dimension.", Name="DimensionValues")
    open var DimensionValues:ArrayList<DimensionValueModel>? = null

    /**
    * Id that links this dimension to an object.
    */
    @ApiMember(Description="Id that links this dimension to an object.")
    open var ObjectConnectionId:UUID? = null
}

open class DimensionValueModel
{
    /**
    * Id of the dimension value.
    */
    @ApiMember(DataType="Guid", Description="Id of the dimension value.", Name="DimensionValueId", ParameterType="body")
    open var DimensionValueId:UUID? = null

    /**
    * Dimension Id this value is for.
    */
    @ApiMember(Description="Dimension Id this value is for.", ParameterType="body")
    open var DimensionId:UUID? = null

    /**
    * Name of the dimension value.
    */
    @ApiMember(Description="Name of the dimension value.", ParameterType="body")
    open var Name:String? = null

    /**
    * Description of the dimension value.
    */
    @ApiMember(Description="Description of the dimension value.", ParameterType="body")
    open var Description:String? = null

    /**
    * Short Name for the dimension value.
    */
    @ApiMember(Description="Short Name for the dimension value.", ParameterType="body")
    open var ShortName:String? = null

    /**
    * Id of the colour associated.
    */
    @ApiMember(Description="Id of the colour associated.", ParameterType="body")
    open var TrafficLightId:UUID? = null

    /**
    * Colour associated with the dimension value.
    */
    @ApiMember(Description="Colour associated with the dimension value.", ParameterType="body")
    open var TrafficLightColour:String? = null

    /**
    * Id that links this dimension value to an object.
    */
    @ApiMember(Description="Id that links this dimension value to an object.", ParameterType="body")
    open var ObjectConnectionId:UUID? = null

    /**
    * Owner Id of the dimension value.
    */
    @ApiMember(Description="Owner Id of the dimension value.", ParameterType="body")
    open var OwnerContactId:UUID? = null

    /**
    * Record status of the dimension value.
    */
    @ApiMember(Description="Record status of the dimension value.", ParameterType="body")
    open var RecordStatus:String? = null
}