Platform API

<back to all web services

SaveDimensionValue

Add or update a dimension values details.

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Subtle.Canvara.WebAPIModel.ServiceModel;
using Eros.Saguna.Common.WebAPIModel.Models;

namespace Eros.Saguna.Common.WebAPIModel.Models
{
    public partial class DimensionValueModel
    {
        ///<summary>
        ///Id of the dimension value.
        ///</summary>
        [ApiMember(DataType="Guid", Description="Id of the dimension value.", Name="DimensionValueId", ParameterType="body")]
        public virtual Guid DimensionValueId { get; set; }

        ///<summary>
        ///Dimension Id this value is for.
        ///</summary>
        [ApiMember(Description="Dimension Id this value is for.", ParameterType="body")]
        public virtual Guid DimensionId { get; set; }

        ///<summary>
        ///Name of the dimension value.
        ///</summary>
        [ApiMember(Description="Name of the dimension value.", ParameterType="body")]
        public virtual string Name { get; set; }

        ///<summary>
        ///Description of the dimension value.
        ///</summary>
        [ApiMember(Description="Description of the dimension value.", ParameterType="body")]
        public virtual string Description { get; set; }

        ///<summary>
        ///Short Name for the dimension value.
        ///</summary>
        [ApiMember(Description="Short Name for the dimension value.", ParameterType="body")]
        public virtual string ShortName { get; set; }

        ///<summary>
        ///Id of the colour associated.
        ///</summary>
        [ApiMember(Description="Id of the colour associated.", ParameterType="body")]
        public virtual Guid TrafficLightId { get; set; }

        ///<summary>
        ///Colour associated with the dimension value.
        ///</summary>
        [ApiMember(Description="Colour associated with the dimension value.", ParameterType="body")]
        public virtual string TrafficLightColour { get; set; }

        ///<summary>
        ///Id that links this dimension value to an object.
        ///</summary>
        [ApiMember(Description="Id that links this dimension value to an object.", ParameterType="body")]
        public virtual Guid ObjectConnectionId { get; set; }

        ///<summary>
        ///Owner Id of the dimension value.
        ///</summary>
        [ApiMember(Description="Owner Id of the dimension value.", ParameterType="body")]
        public virtual Guid OwnerContactId { get; set; }

        ///<summary>
        ///Record status of the dimension value.
        ///</summary>
        [ApiMember(Description="Record status of the dimension value.", ParameterType="body")]
        public virtual string RecordStatus { get; set; }
    }

}

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
{
    ///<summary>
    ///Add or update a dimension values details.
    ///</summary>
    [Api(Description="Add or update a dimension values details.")]
    public partial class SaveDimensionValue
    {
        ///<summary>
        ///Details of the dimension value to be added or updated.
        ///</summary>
        [ApiMember(DataType="DimensionValueModel", Description="Details of the dimension value to be added or updated.", IsRequired=true, Name="DimensionValue")]
        public virtual DimensionValueModel DimensionValue { get; set; }

        ///<summary>
        ///Id of the dimension value.
        ///</summary>
        [ApiMember(DataType="Guid", Description="Id of the dimension value.", IsRequired=true, Name="DimensionValueId")]
        public virtual Guid DimensionValueId { get; set; }
    }

    [ApiResponse(Description="Success of the create/update of the dimension value")]
    public partial class SaveDimensionValueResponse
    {
        ///<summary>
        ///Id of the Dimension Value created.
        ///</summary>
        [ApiMember(DataType="Guid", Description="Id of the Dimension Value created.", Name="DimensionValueId", ParameterType="query")]
        public virtual Guid DimensionValueId { get; set; }

        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# SaveDimensionValue DTOs

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

{
	DimensionValue: 
	{
		Name: String,
		Description: String,
		ShortName: String,
		TrafficLightColour: String,
		RecordStatus: String
	}
}

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

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}