Platform API

SaveDimensionValue

Add or update a dimension values details.

The following routes are available for this service:
PUT	/api/dimensionvalues/{DimensionValueId}
POST	/api/dimensionvalues

import Foundation
import ServiceStack

/**
* Add or update a dimension values details.
*/
// @Api(Description="Add or update a dimension values details.")
public class SaveDimensionValue : Codable
{
    /**
    * 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 var dimensionValue:DimensionValueModel

    /**
    * Id of the dimension value.
    */
    // @ApiMember(DataType="Guid", Description="Id of the dimension value.", IsRequired=true, Name="DimensionValueId")
    public var dimensionValueId:String

    required public init(){}
}

public class DimensionValueModel : Codable
{
    /**
    * Id of the dimension value.
    */
    // @ApiMember(DataType="Guid", Description="Id of the dimension value.", Name="DimensionValueId", ParameterType="body")
    public var dimensionValueId:String

    /**
    * Dimension Id this value is for.
    */
    // @ApiMember(Description="Dimension Id this value is for.", ParameterType="body")
    public var dimensionId:String

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

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

    /**
    * Short Name for the dimension value.
    */
    // @ApiMember(Description="Short Name for the dimension value.", ParameterType="body")
    public var shortName:String

    /**
    * Id of the colour associated.
    */
    // @ApiMember(Description="Id of the colour associated.", ParameterType="body")
    public var trafficLightId:String

    /**
    * Colour associated with the dimension value.
    */
    // @ApiMember(Description="Colour associated with the dimension value.", ParameterType="body")
    public var trafficLightColour:String

    /**
    * Id that links this dimension value to an object.
    */
    // @ApiMember(Description="Id that links this dimension value to an object.", ParameterType="body")
    public var objectConnectionId:String

    /**
    * Owner Id of the dimension value.
    */
    // @ApiMember(Description="Owner Id of the dimension value.", ParameterType="body")
    public var ownerContactId:String

    /**
    * Record status of the dimension value.
    */
    // @ApiMember(Description="Record status of the dimension value.", ParameterType="body")
    public var recordStatus:String

    required public init(){}
}

// @ApiResponse(Description="Success of the create/update of the dimension value")
public class SaveDimensionValueResponse : Codable
{
    /**
    * Id of the Dimension Value created.
    */
    // @ApiMember(DataType="Guid", Description="Id of the Dimension Value created.", Name="DimensionValueId", ParameterType="query")
    public var dimensionValueId:String

    public var responseStatus:ResponseStatus

    required public init(){}
}

Swift SaveDimensionValue DTOs

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

HTTP + JSV

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