Platform API

<back to all web services

SaveDimensionValue

Add or update a dimension values details.

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

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

    ResponseStatus? ResponseStatus;

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

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

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

    getTypeName() => "SaveDimensionValueResponse";
    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;
}

/**
* Add or update a dimension values details.
*/
// @Api(Description="Add or update a dimension values details.")
class SaveDimensionValue implements IConvertible
{
    /**
    * Details of the dimension value to be added or updated.
    */
    // @ApiMember(DataType="DimensionValueModel", Description="Details of the dimension value to be added or updated.", IsRequired=true, Name="DimensionValue")
    DimensionValueModel? DimensionValue;

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

    SaveDimensionValue({this.DimensionValue,this.DimensionValueId});
    SaveDimensionValue.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'DimensionValue': JsonConverters.toJson(DimensionValue,'DimensionValueModel',context!),
        'DimensionValueId': DimensionValueId
    };

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

TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
    'SaveDimensionValueResponse': TypeInfo(TypeOf.Class, create:() => SaveDimensionValueResponse()),
    'DimensionValueModel': TypeInfo(TypeOf.Class, create:() => DimensionValueModel()),
    'SaveDimensionValue': TypeInfo(TypeOf.Class, create:() => SaveDimensionValue()),
});

Dart SaveDimensionValue DTOs

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

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/dimensionvalues HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SaveDimensionValue xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <DimensionValue xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
    <d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField>
    <d2p1:_x003C_DimensionId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_DimensionId_x003E_k__BackingField>
    <d2p1:_x003C_DimensionValueId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_DimensionValueId_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>String</d2p1:_x003C_Name_x003E_k__BackingField>
    <d2p1:_x003C_ObjectConnectionId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_ObjectConnectionId_x003E_k__BackingField>
    <d2p1:_x003C_OwnerContactId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_OwnerContactId_x003E_k__BackingField>
    <d2p1:_x003C_RecordStatus_x003E_k__BackingField>String</d2p1:_x003C_RecordStatus_x003E_k__BackingField>
    <d2p1:_x003C_ShortName_x003E_k__BackingField>String</d2p1:_x003C_ShortName_x003E_k__BackingField>
    <d2p1:_x003C_TrafficLightColour_x003E_k__BackingField>String</d2p1:_x003C_TrafficLightColour_x003E_k__BackingField>
    <d2p1:_x003C_TrafficLightId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_TrafficLightId_x003E_k__BackingField>
  </DimensionValue>
  <DimensionValueId>00000000-0000-0000-0000-000000000000</DimensionValueId>
</SaveDimensionValue>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SaveDimensionValueResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <DimensionValueId>00000000-0000-0000-0000-000000000000</DimensionValueId>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</SaveDimensionValueResponse>