Platform API

<back to all web services

SaveDimension

Add or update a dimensions details.

Requires Authentication
The following routes are available for this service:
POST/api/dimensions
PUT/api/dimensions/{DimensionId}
import 'package:servicestack/servicestack.dart';

// @ApiResponse(Description="Success of the create/update of the dimension")
class SaveDimensionResponse implements IConvertible
{
    /**
    * Id of the Dimension created.
    */
    // @ApiMember(DataType="Guid", Description="Id of the Dimension created.", Name="DimensionId", ParameterType="query")
    String? DimensionId;

    ResponseStatus? ResponseStatus;

    SaveDimensionResponse({this.DimensionId,this.ResponseStatus});
    SaveDimensionResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        DimensionId = json['DimensionId'];
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'DimensionId': DimensionId,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "SaveDimensionResponse";
    TypeContext? context = _ctx;
}

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;
}

/**
* Add or update a dimensions details.
*/
// @Api(Description="Add or update a dimensions details.")
class SaveDimension implements IConvertible
{
    /**
    * Details of the dimension to be added or updated.
    */
    // @ApiMember(DataType="DimensionModel", Description="Details of the dimension to be added or updated.", IsRequired=true, Name="Dimension")
    DimensionModel? Dimension;

    /**
    * Id of the dimension.
    */
    // @ApiMember(DataType="Guid", Description="Id of the dimension.", IsRequired=true, Name="DimensionId")
    String? DimensionId;

    SaveDimension({this.Dimension,this.DimensionId});
    SaveDimension.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Dimension = JsonConverters.fromJson(json['Dimension'],'DimensionModel',context!);
        DimensionId = json['DimensionId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Dimension': JsonConverters.toJson(Dimension,'DimensionModel',context!),
        'DimensionId': DimensionId
    };

    getTypeName() => "SaveDimension";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
    'SaveDimensionResponse': TypeInfo(TypeOf.Class, create:() => SaveDimensionResponse()),
    'DimensionValueModel': TypeInfo(TypeOf.Class, create:() => DimensionValueModel()),
    'DimensionModel': TypeInfo(TypeOf.Class, create:() => DimensionModel()),
    'List<DimensionValueModel>': TypeInfo(TypeOf.Class, create:() => <DimensionValueModel>[]),
    'SaveDimension': TypeInfo(TypeOf.Class, create:() => SaveDimension()),
});

Dart SaveDimension DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
Content-Length: length

{"Dimension":{"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"},"DimensionId":"00000000-0000-0000-0000-000000000000"}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"DimensionId":"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"}}}