Platform API

GetObjectDimensions

Get a list of dimensions linked to a specified object

The following routes are available for this service:
All Verbs	/api/dimensions/object/{ObjectId}

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type DimensionValueModel() = 
        ///<summary>
        ///Id of the dimension value.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Id of the dimension value.", Name="DimensionValueId", ParameterType="body")>]
        member val DimensionValueId:Guid = new Guid() with get,set

        ///<summary>
        ///Dimension Id this value is for.
        ///</summary>
        [<ApiMember(Description="Dimension Id this value is for.", ParameterType="body")>]
        member val DimensionId:Guid = new Guid() with get,set

        ///<summary>
        ///Name of the dimension value.
        ///</summary>
        [<ApiMember(Description="Name of the dimension value.", ParameterType="body")>]
        member val Name:String = null with get,set

        ///<summary>
        ///Description of the dimension value.
        ///</summary>
        [<ApiMember(Description="Description of the dimension value.", ParameterType="body")>]
        member val Description:String = null with get,set

        ///<summary>
        ///Short Name for the dimension value.
        ///</summary>
        [<ApiMember(Description="Short Name for the dimension value.", ParameterType="body")>]
        member val ShortName:String = null with get,set

        ///<summary>
        ///Id of the colour associated.
        ///</summary>
        [<ApiMember(Description="Id of the colour associated.", ParameterType="body")>]
        member val TrafficLightId:Guid = new Guid() with get,set

        ///<summary>
        ///Colour associated with the dimension value.
        ///</summary>
        [<ApiMember(Description="Colour associated with the dimension value.", ParameterType="body")>]
        member val TrafficLightColour:String = null with 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")>]
        member val ObjectConnectionId:Guid = new Guid() with get,set

        ///<summary>
        ///Owner Id of the dimension value.
        ///</summary>
        [<ApiMember(Description="Owner Id of the dimension value.", ParameterType="body")>]
        member val OwnerContactId:Guid = new Guid() with get,set

        ///<summary>
        ///Record status of the dimension value.
        ///</summary>
        [<ApiMember(Description="Record status of the dimension value.", ParameterType="body")>]
        member val RecordStatus:String = null with get,set

    [<AllowNullLiteral>]
    type DimensionModel() = 
        ///<summary>
        ///Id of the Dimension itself.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Id of the Dimension itself.", Name="DimensionId")>]
        member val DimensionId:Guid = new Guid() with get,set

        ///<summary>
        ///Dimension name.
        ///</summary>
        [<ApiMember(DataType="string", Description="Dimension name.", Name="Name")>]
        member val Name:String = null with get,set

        ///<summary>
        ///Dimension description.
        ///</summary>
        [<ApiMember(DataType="string", Description="Dimension description.", Name="Description")>]
        member val Description:String = null with get,set

        ///<summary>
        ///Dimension shortened name.
        ///</summary>
        [<ApiMember(DataType="string", Description="Dimension shortened name.", Name="ShortName")>]
        member val ShortName:String = null with get,set

        ///<summary>
        ///True if the values for the dimension should have colours associated with them.
        ///</summary>
        [<ApiMember(DataType="bool", Description="True if the values for the dimension should have colours associated with them.", Name="HasTrafficLightForValues")>]
        member val HasTrafficLightForValues:Boolean = new Boolean() with get,set

        ///<summary>
        ///
        ///</summary>
        [<ApiMember(DataType="bool", Description="", Name="HasImage")>]
        member val HasImage:Boolean = new Boolean() with get,set

        ///<summary>
        ///Owner Id of the dimension.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Owner Id of the dimension.", Name="OwnerContactId")>]
        member val OwnerContactId:Guid = new Guid() with get,set

        ///<summary>
        ///Record status of the dimension.
        ///</summary>
        [<ApiMember(DataType="string", Description="Record status of the dimension.", Name="RecordStatus")>]
        member val RecordStatus:String = null with get,set

        ///<summary>
        ///Dimension values for this dimension.
        ///</summary>
        [<ApiMember(DataType="List<DimensionValueModel>", Description="Dimension values for this dimension.", Name="DimensionValues")>]
        member val DimensionValues:ResizeArray<DimensionValueModel> = null with get,set

        ///<summary>
        ///Id that links this dimension to an object.
        ///</summary>
        [<ApiMember(Description="Id that links this dimension to an object.")>]
        member val ObjectConnectionId:Guid = new Guid() with get,set

    [<ApiResponse(Description="A list of dimensions (and values if they apply) for an object")>]
    [<AllowNullLiteral>]
    type GetObjectDimensionsResponse() = 
        ///<summary>
        ///List of dimensions.
        ///</summary>
        [<ApiMember(DataType="List<DimensionModel>", Description="List of dimensions.", Name="Dimensions", ParameterType="query")>]
        member val Dimensions:ResizeArray<DimensionModel> = null with get,set

        member val ResponseStatus:ResponseStatus = null with get,set

    ///<summary>
    ///Get a list of dimensions linked to a specified object
    ///</summary>
    [<Api(Description="Get a list of dimensions linked to a specified object")>]
    [<AllowNullLiteral>]
    type GetObjectDimensions() = 
        ///<summary>
        ///Licensee Id to retrieve dimensions for.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Licensee Id to retrieve dimensions for.", Name="LicenseeId", ParameterType="query")>]
        member val LicenseeId:Guid = new Guid() with get,set

        ///<summary>
        ///Object Id to retrieve dimensions for.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Object Id to retrieve dimensions for.", Name="ObjectId", ParameterType="query")>]
        member val ObjectId:Guid = new Guid() with get,set

F# GetObjectDimensions 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/dimensions/object/{ObjectId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	
}

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

{
	Dimensions: 
	[
		{
			Name: String,
			Description: String,
			ShortName: String,
			HasTrafficLightForValues: False,
			HasImage: False,
			RecordStatus: String,
			DimensionValues: 
			[
				{
					Name: String,
					Description: String,
					ShortName: String,
					TrafficLightColour: String,
					RecordStatus: String
				}
			]
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}