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}

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eros.Subtle.Canvara.WebAPIModel.ServiceModel
Imports Eros.Saguna.Common.WebAPIModel.Models

Namespace Global

    Namespace Eros.Saguna.Common.WebAPIModel.Models

        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 Overridable Property DimensionValueId As Guid

            '''<Summary>
            '''Dimension Id this value is for.
            '''</Summary>
            <ApiMember(Description:="Dimension Id this value is for.", ParameterType:="body")>
            Public Overridable Property DimensionId As Guid

            '''<Summary>
            '''Name of the dimension value.
            '''</Summary>
            <ApiMember(Description:="Name of the dimension value.", ParameterType:="body")>
            Public Overridable Property Name As String

            '''<Summary>
            '''Description of the dimension value.
            '''</Summary>
            <ApiMember(Description:="Description of the dimension value.", ParameterType:="body")>
            Public Overridable Property Description As String

            '''<Summary>
            '''Short Name for the dimension value.
            '''</Summary>
            <ApiMember(Description:="Short Name for the dimension value.", ParameterType:="body")>
            Public Overridable Property ShortName As String

            '''<Summary>
            '''Id of the colour associated.
            '''</Summary>
            <ApiMember(Description:="Id of the colour associated.", ParameterType:="body")>
            Public Overridable Property TrafficLightId As Guid

            '''<Summary>
            '''Colour associated with the dimension value.
            '''</Summary>
            <ApiMember(Description:="Colour associated with the dimension value.", ParameterType:="body")>
            Public Overridable Property TrafficLightColour As String

            '''<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 Overridable Property ObjectConnectionId As Guid

            '''<Summary>
            '''Owner Id of the dimension value.
            '''</Summary>
            <ApiMember(Description:="Owner Id of the dimension value.", ParameterType:="body")>
            Public Overridable Property OwnerContactId As Guid

            '''<Summary>
            '''Record status of the dimension value.
            '''</Summary>
            <ApiMember(Description:="Record status of the dimension value.", ParameterType:="body")>
            Public Overridable Property RecordStatus As String
        End Class
    End Namespace

    Namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

        '''<Summary>
        '''Get a list of dimensionValues for a specified dimension
        '''</Summary>
        <Api(Description:="Get a list of dimensionValues for a specified dimension")>
        Public Partial Class GetDimensionValuesList
            '''<Summary>
            '''Licensee Id to retrieve dimensionValues for.
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="Licensee Id to retrieve dimensionValues for.", Name:="LicenseeId", ParameterType:="query")>
            Public Overridable Property LicenseeId As Guid

            '''<Summary>
            '''Dimension Id to retrieve dimensionValues for.
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="Dimension Id to retrieve dimensionValues for.", Name:="DimensionId", ParameterType:="query")>
            Public Overridable Property DimensionId As Guid

            '''<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")>
            Public Overridable Property RecordStatus As String
        End Class

        <ApiResponse(Description:="A list of dimension values")>
        Public Partial Class GetDimensionValuesListResponse
            '''<Summary>
            '''List of dimensionValues.
            '''</Summary>
            <ApiMember(DataType:="List<DimensionValueModel>", Description:="List of dimensionValues.", Name:="DimensionValues", ParameterType:="query")>
            Public Overridable Property DimensionValues As List(Of DimensionValueModel)

            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET 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
		}
	}
}