Platform API

<back to all web services

GetDimensionValuesList

Get a list of dimensionValues for a specified dimension

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 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 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 virtual Guid LicenseeId { get; set; }

        ///<summary>
        ///Dimension Id to retrieve dimensionValues for.
        ///</summary>
        [ApiMember(DataType="Guid", Description="Dimension Id to retrieve dimensionValues for.", Name="DimensionId", ParameterType="query")]
        public virtual Guid DimensionId { 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")]
        public virtual string RecordStatus { get; set; }
    }

    [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 virtual List<DimensionValueModel> DimensionValues { get; set; }

        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# GetDimensionValuesList DTOs

POST /api/dimensionvalues/{DimensionId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetDimensionValuesList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <DimensionId>00000000-0000-0000-0000-000000000000</DimensionId>
  <LicenseeId>00000000-0000-0000-0000-000000000000</LicenseeId>
  <RecordStatus>String</RecordStatus>
</GetDimensionValuesList>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetDimensionValuesListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <DimensionValues xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
    <d2p1:DimensionValueModel>
      <d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField>
      <d2p1:_x003C_DimensionId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_DimensionId_x003E_k__BackingField>
      <d2p1:_x003C_DimensionValueId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_DimensionValueId_x003E_k__BackingField>
      <d2p1:_x003C_Name_x003E_k__BackingField>String</d2p1:_x003C_Name_x003E_k__BackingField>
      <d2p1:_x003C_ObjectConnectionId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_ObjectConnectionId_x003E_k__BackingField>
      <d2p1:_x003C_OwnerContactId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_OwnerContactId_x003E_k__BackingField>
      <d2p1:_x003C_RecordStatus_x003E_k__BackingField>String</d2p1:_x003C_RecordStatus_x003E_k__BackingField>
      <d2p1:_x003C_ShortName_x003E_k__BackingField>String</d2p1:_x003C_ShortName_x003E_k__BackingField>
      <d2p1:_x003C_TrafficLightColour_x003E_k__BackingField>String</d2p1:_x003C_TrafficLightColour_x003E_k__BackingField>
      <d2p1:_x003C_TrafficLightId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_TrafficLightId_x003E_k__BackingField>
    </d2p1:DimensionValueModel>
  </DimensionValues>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</GetDimensionValuesListResponse>