Platform API

GetDimensionValuesList

Get a list of dimensionValues for a specified dimension

The following routes are available for this service:
All Verbs	/api/dimensionvalues/{DimensionId}

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

    [<ApiResponse(Description="A list of dimension values")>]
    [<AllowNullLiteral>]
    type GetDimensionValuesListResponse() = 
        ///<summary>
        ///List of dimensionValues.
        ///</summary>
        [<ApiMember(DataType="List<DimensionValueModel>", Description="List of dimensionValues.", Name="DimensionValues", ParameterType="query")>]
        member val DimensionValues:ResizeArray<DimensionValueModel> = null with get,set

        member val ResponseStatus:ResponseStatus = null with get,set

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

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

        ///<summary>
        ///RecordStatus of dimensionValues to retrieve. If not set 'A' active dimensionValues are retrieved.
        ///</summary>
        [<ApiMember(DataType="string", Description="RecordStatus of dimensionValues to retrieve. If not set 'A' active dimensionValues are retrieved.", Name="RecordStatus", ParameterType="query")>]
        member val RecordStatus:String = null with get,set

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

{
	RecordStatus: String
}

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

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