| All Verbs | /api/dimensions/object/{ObjectId} |
|---|
import 'package:servicestack/servicestack.dart';
class DimensionValueModel implements IConvertible
{
/**
* Id of the dimension value.
*/
// @ApiMember(DataType="Guid", Description="Id of the dimension value.", Name="DimensionValueId", ParameterType="body")
String? DimensionValueId;
/**
* Dimension Id this value is for.
*/
// @ApiMember(Description="Dimension Id this value is for.", ParameterType="body")
String? DimensionId;
/**
* Name of the dimension value.
*/
// @ApiMember(Description="Name of the dimension value.", ParameterType="body")
String? Name;
/**
* Description of the dimension value.
*/
// @ApiMember(Description="Description of the dimension value.", ParameterType="body")
String? Description;
/**
* Short Name for the dimension value.
*/
// @ApiMember(Description="Short Name for the dimension value.", ParameterType="body")
String? ShortName;
/**
* Id of the colour associated.
*/
// @ApiMember(Description="Id of the colour associated.", ParameterType="body")
String? TrafficLightId;
/**
* Colour associated with the dimension value.
*/
// @ApiMember(Description="Colour associated with the dimension value.", ParameterType="body")
String? TrafficLightColour;
/**
* Id that links this dimension value to an object.
*/
// @ApiMember(Description="Id that links this dimension value to an object.", ParameterType="body")
String? ObjectConnectionId;
/**
* Owner Id of the dimension value.
*/
// @ApiMember(Description="Owner Id of the dimension value.", ParameterType="body")
String? OwnerContactId;
/**
* Record status of the dimension value.
*/
// @ApiMember(Description="Record status of the dimension value.", ParameterType="body")
String? RecordStatus;
DimensionValueModel({this.DimensionValueId,this.DimensionId,this.Name,this.Description,this.ShortName,this.TrafficLightId,this.TrafficLightColour,this.ObjectConnectionId,this.OwnerContactId,this.RecordStatus});
DimensionValueModel.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
DimensionValueId = json['DimensionValueId'];
DimensionId = json['DimensionId'];
Name = json['Name'];
Description = json['Description'];
ShortName = json['ShortName'];
TrafficLightId = json['TrafficLightId'];
TrafficLightColour = json['TrafficLightColour'];
ObjectConnectionId = json['ObjectConnectionId'];
OwnerContactId = json['OwnerContactId'];
RecordStatus = json['RecordStatus'];
return this;
}
Map<String, dynamic> toJson() => {
'DimensionValueId': DimensionValueId,
'DimensionId': DimensionId,
'Name': Name,
'Description': Description,
'ShortName': ShortName,
'TrafficLightId': TrafficLightId,
'TrafficLightColour': TrafficLightColour,
'ObjectConnectionId': ObjectConnectionId,
'OwnerContactId': OwnerContactId,
'RecordStatus': RecordStatus
};
getTypeName() => "DimensionValueModel";
TypeContext? context = _ctx;
}
class DimensionModel implements IConvertible
{
/**
* Id of the Dimension itself.
*/
// @ApiMember(DataType="Guid", Description="Id of the Dimension itself.", Name="DimensionId")
String? DimensionId;
/**
* Dimension name.
*/
// @ApiMember(DataType="string", Description="Dimension name.", Name="Name")
String? Name;
/**
* Dimension description.
*/
// @ApiMember(DataType="string", Description="Dimension description.", Name="Description")
String? Description;
/**
* Dimension shortened name.
*/
// @ApiMember(DataType="string", Description="Dimension shortened name.", Name="ShortName")
String? ShortName;
/**
* 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")
bool? HasTrafficLightForValues;
/**
*
*/
// @ApiMember(DataType="bool", Description="", Name="HasImage")
bool? HasImage;
/**
* Owner Id of the dimension.
*/
// @ApiMember(DataType="Guid", Description="Owner Id of the dimension.", Name="OwnerContactId")
String? OwnerContactId;
/**
* Record status of the dimension.
*/
// @ApiMember(DataType="string", Description="Record status of the dimension.", Name="RecordStatus")
String? RecordStatus;
/**
* Dimension values for this dimension.
*/
// @ApiMember(DataType="List<DimensionValueModel>", Description="Dimension values for this dimension.", Name="DimensionValues")
List<DimensionValueModel>? DimensionValues;
/**
* Id that links this dimension to an object.
*/
// @ApiMember(Description="Id that links this dimension to an object.")
String? ObjectConnectionId;
DimensionModel({this.DimensionId,this.Name,this.Description,this.ShortName,this.HasTrafficLightForValues,this.HasImage,this.OwnerContactId,this.RecordStatus,this.DimensionValues,this.ObjectConnectionId});
DimensionModel.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
DimensionId = json['DimensionId'];
Name = json['Name'];
Description = json['Description'];
ShortName = json['ShortName'];
HasTrafficLightForValues = json['HasTrafficLightForValues'];
HasImage = json['HasImage'];
OwnerContactId = json['OwnerContactId'];
RecordStatus = json['RecordStatus'];
DimensionValues = JsonConverters.fromJson(json['DimensionValues'],'List<DimensionValueModel>',context!);
ObjectConnectionId = json['ObjectConnectionId'];
return this;
}
Map<String, dynamic> toJson() => {
'DimensionId': DimensionId,
'Name': Name,
'Description': Description,
'ShortName': ShortName,
'HasTrafficLightForValues': HasTrafficLightForValues,
'HasImage': HasImage,
'OwnerContactId': OwnerContactId,
'RecordStatus': RecordStatus,
'DimensionValues': JsonConverters.toJson(DimensionValues,'List<DimensionValueModel>',context!),
'ObjectConnectionId': ObjectConnectionId
};
getTypeName() => "DimensionModel";
TypeContext? context = _ctx;
}
// @ApiResponse(Description="A list of dimensions (and values if they apply) for an object")
class GetObjectDimensionsResponse implements IConvertible
{
/**
* List of dimensions.
*/
// @ApiMember(DataType="List<DimensionModel>", Description="List of dimensions.", Name="Dimensions", ParameterType="query")
List<DimensionModel>? Dimensions;
ResponseStatus? ResponseStatus;
GetObjectDimensionsResponse({this.Dimensions,this.ResponseStatus});
GetObjectDimensionsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Dimensions = JsonConverters.fromJson(json['Dimensions'],'List<DimensionModel>',context!);
ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
return this;
}
Map<String, dynamic> toJson() => {
'Dimensions': JsonConverters.toJson(Dimensions,'List<DimensionModel>',context!),
'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
};
getTypeName() => "GetObjectDimensionsResponse";
TypeContext? context = _ctx;
}
/**
* Get a list of dimensions linked to a specified object
*/
// @Api(Description="Get a list of dimensions linked to a specified object")
class GetObjectDimensions implements IConvertible
{
/**
* Licensee Id to retrieve dimensions for.
*/
// @ApiMember(DataType="Guid", Description="Licensee Id to retrieve dimensions for.", Name="LicenseeId", ParameterType="query")
String? LicenseeId;
/**
* Object Id to retrieve dimensions for.
*/
// @ApiMember(DataType="Guid", Description="Object Id to retrieve dimensions for.", Name="ObjectId", ParameterType="query")
String? ObjectId;
GetObjectDimensions({this.LicenseeId,this.ObjectId});
GetObjectDimensions.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
LicenseeId = json['LicenseeId'];
ObjectId = json['ObjectId'];
return this;
}
Map<String, dynamic> toJson() => {
'LicenseeId': LicenseeId,
'ObjectId': ObjectId
};
getTypeName() => "GetObjectDimensions";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
'DimensionValueModel': TypeInfo(TypeOf.Class, create:() => DimensionValueModel()),
'DimensionModel': TypeInfo(TypeOf.Class, create:() => DimensionModel()),
'List<DimensionValueModel>': TypeInfo(TypeOf.Class, create:() => <DimensionValueModel>[]),
'GetObjectDimensionsResponse': TypeInfo(TypeOf.Class, create:() => GetObjectDimensionsResponse()),
'List<DimensionModel>': TypeInfo(TypeOf.Class, create:() => <DimensionModel>[]),
'GetObjectDimensions': TypeInfo(TypeOf.Class, create:() => GetObjectDimensions()),
});
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/dimensions/object/{ObjectId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"LicenseeId":"00000000-0000-0000-0000-000000000000","ObjectId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Dimensions":[{"DimensionId":"00000000-0000-0000-0000-000000000000","Name":"String","Description":"String","ShortName":"String","HasTrafficLightForValues":false,"HasImage":false,"OwnerContactId":"00000000-0000-0000-0000-000000000000","RecordStatus":"String","DimensionValues":[{"DimensionValueId":"00000000-0000-0000-0000-000000000000","DimensionId":"00000000-0000-0000-0000-000000000000","Name":"String","Description":"String","ShortName":"String","TrafficLightId":"00000000-0000-0000-0000-000000000000","TrafficLightColour":"String","ObjectConnectionId":"00000000-0000-0000-0000-000000000000","OwnerContactId":"00000000-0000-0000-0000-000000000000","RecordStatus":"String"}],"ObjectConnectionId":"00000000-0000-0000-0000-000000000000"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}