Platform API

<back to all web services

SaveDimensionValue

Add or update a dimension values details.

import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Add or update a dimension values details.
    */
    @Api(Description="Add or update a dimension values details.")
    public static class SaveDimensionValue
    {
        /**
        * 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")
        public DimensionValueModel DimensionValue = null;

        /**
        * Id of the dimension value.
        */
        @ApiMember(DataType="Guid", Description="Id of the dimension value.", IsRequired=true, Name="DimensionValueId")
        public UUID DimensionValueId = null;
        
        public DimensionValueModel getDimensionValue() { return DimensionValue; }
        public SaveDimensionValue setDimensionValue(DimensionValueModel value) { this.DimensionValue = value; return this; }
        public UUID getDimensionValueId() { return DimensionValueId; }
        public SaveDimensionValue setDimensionValueId(UUID value) { this.DimensionValueId = value; return this; }
    }

    public static class DimensionValueModel
    {
        /**
        * Id of the dimension value.
        */
        @ApiMember(DataType="Guid", Description="Id of the dimension value.", Name="DimensionValueId", ParameterType="body")
        public UUID DimensionValueId = null;

        /**
        * Dimension Id this value is for.
        */
        @ApiMember(Description="Dimension Id this value is for.", ParameterType="body")
        public UUID DimensionId = null;

        /**
        * Name of the dimension value.
        */
        @ApiMember(Description="Name of the dimension value.", ParameterType="body")
        public String Name = null;

        /**
        * Description of the dimension value.
        */
        @ApiMember(Description="Description of the dimension value.", ParameterType="body")
        public String Description = null;

        /**
        * Short Name for the dimension value.
        */
        @ApiMember(Description="Short Name for the dimension value.", ParameterType="body")
        public String ShortName = null;

        /**
        * Id of the colour associated.
        */
        @ApiMember(Description="Id of the colour associated.", ParameterType="body")
        public UUID TrafficLightId = null;

        /**
        * Colour associated with the dimension value.
        */
        @ApiMember(Description="Colour associated with the dimension value.", ParameterType="body")
        public String TrafficLightColour = null;

        /**
        * Id that links this dimension value to an object.
        */
        @ApiMember(Description="Id that links this dimension value to an object.", ParameterType="body")
        public UUID ObjectConnectionId = null;

        /**
        * Owner Id of the dimension value.
        */
        @ApiMember(Description="Owner Id of the dimension value.", ParameterType="body")
        public UUID OwnerContactId = null;

        /**
        * Record status of the dimension value.
        */
        @ApiMember(Description="Record status of the dimension value.", ParameterType="body")
        public String RecordStatus = null;
        
        public UUID getDimensionValueId() { return DimensionValueId; }
        public DimensionValueModel setDimensionValueId(UUID value) { this.DimensionValueId = value; return this; }
        public UUID getDimensionId() { return DimensionId; }
        public DimensionValueModel setDimensionId(UUID value) { this.DimensionId = value; return this; }
        public String getName() { return Name; }
        public DimensionValueModel setName(String value) { this.Name = value; return this; }
        public String getDescription() { return Description; }
        public DimensionValueModel setDescription(String value) { this.Description = value; return this; }
        public String getShortName() { return ShortName; }
        public DimensionValueModel setShortName(String value) { this.ShortName = value; return this; }
        public UUID getTrafficLightId() { return TrafficLightId; }
        public DimensionValueModel setTrafficLightId(UUID value) { this.TrafficLightId = value; return this; }
        public String getTrafficLightColour() { return TrafficLightColour; }
        public DimensionValueModel setTrafficLightColour(String value) { this.TrafficLightColour = value; return this; }
        public UUID getObjectConnectionId() { return ObjectConnectionId; }
        public DimensionValueModel setObjectConnectionId(UUID value) { this.ObjectConnectionId = value; return this; }
        public UUID getOwnerContactId() { return OwnerContactId; }
        public DimensionValueModel setOwnerContactId(UUID value) { this.OwnerContactId = value; return this; }
        public String getRecordStatus() { return RecordStatus; }
        public DimensionValueModel setRecordStatus(String value) { this.RecordStatus = value; return this; }
    }

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

        public ResponseStatus ResponseStatus = null;
        
        public UUID getDimensionValueId() { return DimensionValueId; }
        public SaveDimensionValueResponse setDimensionValueId(UUID value) { this.DimensionValueId = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public SaveDimensionValueResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

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