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}

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 DimensionModel
    {
        ///<summary>
        ///Id of the Dimension itself.
        ///</summary>
        [ApiMember(DataType="Guid", Description="Id of the Dimension itself.", Name="DimensionId")]
        public virtual Guid DimensionId { get; set; }

        ///<summary>
        ///Dimension name.
        ///</summary>
        [ApiMember(DataType="string", Description="Dimension name.", Name="Name")]
        public virtual string Name { get; set; }

        ///<summary>
        ///Dimension description.
        ///</summary>
        [ApiMember(DataType="string", Description="Dimension description.", Name="Description")]
        public virtual string Description { get; set; }

        ///<summary>
        ///Dimension shortened name.
        ///</summary>
        [ApiMember(DataType="string", Description="Dimension shortened name.", Name="ShortName")]
        public virtual string ShortName { 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")]
        public virtual bool HasTrafficLightForValues { get; set; }

        ///<summary>
        ///
        ///</summary>
        [ApiMember(DataType="bool", Description="", Name="HasImage")]
        public virtual bool HasImage { get; set; }

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

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

        ///<summary>
        ///Dimension values for this dimension.
        ///</summary>
        [ApiMember(DataType="List<DimensionValueModel>", Description="Dimension values for this dimension.", Name="DimensionValues")]
        public virtual List<DimensionValueModel> DimensionValues { get; set; }

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

    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>
    ///Get a list of dimensions linked to a specified object
    ///</summary>
    [Api(Description="Get a list of dimensions linked to a specified object")]
    public partial class GetObjectDimensions
    {
        ///<summary>
        ///Licensee Id to retrieve dimensions for.
        ///</summary>
        [ApiMember(DataType="Guid", Description="Licensee Id to retrieve dimensions for.", Name="LicenseeId", ParameterType="query")]
        public virtual Guid LicenseeId { get; set; }

        ///<summary>
        ///Object Id to retrieve dimensions for.
        ///</summary>
        [ApiMember(DataType="Guid", Description="Object Id to retrieve dimensions for.", Name="ObjectId", ParameterType="query")]
        public virtual Guid ObjectId { get; set; }
    }

    [ApiResponse(Description="A list of dimensions (and values if they apply) for an object")]
    public partial class GetObjectDimensionsResponse
    {
        ///<summary>
        ///List of dimensions.
        ///</summary>
        [ApiMember(DataType="List<DimensionModel>", Description="List of dimensions.", Name="Dimensions", ParameterType="query")]
        public virtual List<DimensionModel> Dimensions { get; set; }

        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# GetObjectDimensions DTOs

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

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
Content-Length: length

{"LicenseeId":"00000000-0000-0000-0000-000000000000","ObjectId":"00000000-0000-0000-0000-000000000000"}

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

{"Dimensions":[{"DimensionId":"00000000-0000-0000-0000-000000000000","Name":"String","Description":"String","ShortName":"String","HasTrafficLightForValues":false,"HasImage":false,"OwnerContactId":"00000000-0000-0000-0000-000000000000","RecordStatus":"String","DimensionValues":[{"DimensionValueId":"00000000-0000-0000-0000-000000000000","DimensionId":"00000000-0000-0000-0000-000000000000","Name":"String","Description":"String","ShortName":"String","TrafficLightId":"00000000-0000-0000-0000-000000000000","TrafficLightColour":"String","ObjectConnectionId":"00000000-0000-0000-0000-000000000000","OwnerContactId":"00000000-0000-0000-0000-000000000000","RecordStatus":"String"}],"ObjectConnectionId":"00000000-0000-0000-0000-000000000000"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}