| All Verbs | /api/dimensions/ |
|---|
import Foundation
import ServiceStack
/**
* Get a list of dimensions for a licensee, as well as any standard dimensions
*/
// @Api(Description="Get a list of dimensions for a licensee, as well as any standard dimensions")
public class GetDimensionsList : Codable
{
/**
* Licensee Id to retrieve dimensions for.
*/
// @ApiMember(DataType="Guid", Description="Licensee Id to retrieve dimensions for.", Name="LicenseeId", ParameterType="query")
public var licenseeId:String
/**
* RecordStatus of dimensions to retrieve. If not set 'A' active dimensions are retrieved.
*/
// @ApiMember(DataType="string", Description="RecordStatus of dimensions to retrieve. If not set 'A' active dimensions are retrieved.", Name="RecordStatus", ParameterType="query")
public var recordStatus:String
required public init(){}
}
// @ApiResponse(Description="A list of dimensions")
public class GetDimensionsListResponse : Codable
{
/**
* List of dimensions.
*/
// @ApiMember(DataType="List<DimensionModel>", Description="List of dimensions.", Name="Dimensions", ParameterType="query")
public var dimensions:[DimensionModel]
public var responseStatus:ResponseStatus
required public init(){}
}
public class DimensionModel : Codable
{
/**
* Id of the Dimension itself.
*/
// @ApiMember(DataType="Guid", Description="Id of the Dimension itself.", Name="DimensionId")
public var dimensionId:String
/**
* Dimension name.
*/
// @ApiMember(DataType="string", Description="Dimension name.", Name="Name")
public var name:String
/**
* Dimension description.
*/
// @ApiMember(DataType="string", Description="Dimension description.", Name="Description")
public var Description:String
/**
* Dimension shortened name.
*/
// @ApiMember(DataType="string", Description="Dimension shortened name.", Name="ShortName")
public var shortName:String
/**
* 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")
public var hasTrafficLightForValues:Bool
/**
*
*/
// @ApiMember(DataType="bool", Description="", Name="HasImage")
public var hasImage:Bool
/**
* Owner Id of the dimension.
*/
// @ApiMember(DataType="Guid", Description="Owner Id of the dimension.", Name="OwnerContactId")
public var ownerContactId:String
/**
* Record status of the dimension.
*/
// @ApiMember(DataType="string", Description="Record status of the dimension.", Name="RecordStatus")
public var recordStatus:String
/**
* Dimension values for this dimension.
*/
// @ApiMember(DataType="List<DimensionValueModel>", Description="Dimension values for this dimension.", Name="DimensionValues")
public var dimensionValues:[DimensionValueModel]
/**
* Id that links this dimension to an object.
*/
// @ApiMember(Description="Id that links this dimension to an object.")
public var objectConnectionId:String
required public init(){}
}
public class DimensionValueModel : Codable
{
/**
* Id of the dimension value.
*/
// @ApiMember(DataType="Guid", Description="Id of the dimension value.", Name="DimensionValueId", ParameterType="body")
public var dimensionValueId:String
/**
* Dimension Id this value is for.
*/
// @ApiMember(Description="Dimension Id this value is for.", ParameterType="body")
public var dimensionId:String
/**
* Name of the dimension value.
*/
// @ApiMember(Description="Name of the dimension value.", ParameterType="body")
public var name:String
/**
* Description of the dimension value.
*/
// @ApiMember(Description="Description of the dimension value.", ParameterType="body")
public var Description:String
/**
* Short Name for the dimension value.
*/
// @ApiMember(Description="Short Name for the dimension value.", ParameterType="body")
public var shortName:String
/**
* Id of the colour associated.
*/
// @ApiMember(Description="Id of the colour associated.", ParameterType="body")
public var trafficLightId:String
/**
* Colour associated with the dimension value.
*/
// @ApiMember(Description="Colour associated with the dimension value.", ParameterType="body")
public var trafficLightColour:String
/**
* Id that links this dimension value to an object.
*/
// @ApiMember(Description="Id that links this dimension value to an object.", ParameterType="body")
public var objectConnectionId:String
/**
* Owner Id of the dimension value.
*/
// @ApiMember(Description="Owner Id of the dimension value.", ParameterType="body")
public var ownerContactId:String
/**
* Record status of the dimension value.
*/
// @ApiMember(Description="Record status of the dimension value.", ParameterType="body")
public var recordStatus:String
required public init(){}
}
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/dimensions/ 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
{
Dimensions:
[
{
Name: String,
Description: String,
ShortName: String,
HasTrafficLightForValues: False,
HasImage: False,
RecordStatus: String,
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
}
}
}