| All Verbs | /api/dimensionvalues/{DimensionId} |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
/**
* Get a list of dimensionValues for a specified dimension
*/
@Api(Description="Get a list of dimensionValues for a specified dimension")
open class GetDimensionValuesList
{
/**
* Licensee Id to retrieve dimensionValues for.
*/
@ApiMember(DataType="Guid", Description="Licensee Id to retrieve dimensionValues for.", Name="LicenseeId", ParameterType="query")
open var LicenseeId:UUID? = null
/**
* Dimension Id to retrieve dimensionValues for.
*/
@ApiMember(DataType="Guid", Description="Dimension Id to retrieve dimensionValues for.", Name="DimensionId", ParameterType="query")
open var DimensionId:UUID? = null
/**
* RecordStatus of dimensionValues to retrieve. If not set 'A' active dimensionValues are retrieved.
*/
@ApiMember(DataType="string", Description="RecordStatus of dimensionValues to retrieve. If not set 'A' active dimensionValues are retrieved.", Name="RecordStatus", ParameterType="query")
open var RecordStatus:String? = null
}
@ApiResponse(Description="A list of dimension values")
open class GetDimensionValuesListResponse
{
/**
* List of dimensionValues.
*/
@ApiMember(DataType="List<DimensionValueModel>", Description="List of dimensionValues.", Name="DimensionValues", ParameterType="query")
open var DimensionValues:ArrayList<DimensionValueModel>? = null
open var ResponseStatus:ResponseStatus? = 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
}
Kotlin GetDimensionValuesList DTOs
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/dimensionvalues/{DimensionId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
RecordStatus: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
DimensionValues:
[
{
Name: String,
Description: String,
ShortName: String,
TrafficLightColour: String,
RecordStatus: String
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}