Platform API

<back to all web services

GetDimensionValuesList

Get a list of dimensionValues for a specified dimension

Requires Authentication
The following routes are available for this service:
All Verbs/api/dimensionvalues/{DimensionId}
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DimensionValueModel:
    # @ApiMember(DataType="Guid", Description="Id of the dimension value.", Name="DimensionValueId", ParameterType="body")
    dimension_value_id: Optional[str] = None
    """
    Id of the dimension value.
    """


    # @ApiMember(Description="Dimension Id this value is for.", ParameterType="body")
    dimension_id: Optional[str] = None
    """
    Dimension Id this value is for.
    """


    # @ApiMember(Description="Name of the dimension value.", ParameterType="body")
    name: Optional[str] = None
    """
    Name of the dimension value.
    """


    # @ApiMember(Description="Description of the dimension value.", ParameterType="body")
    description: Optional[str] = None
    """
    Description of the dimension value.
    """


    # @ApiMember(Description="Short Name for the dimension value.", ParameterType="body")
    short_name: Optional[str] = None
    """
    Short Name for the dimension value.
    """


    # @ApiMember(Description="Id of the colour associated.", ParameterType="body")
    traffic_light_id: Optional[str] = None
    """
    Id of the colour associated.
    """


    # @ApiMember(Description="Colour associated with the dimension value.", ParameterType="body")
    traffic_light_colour: Optional[str] = None
    """
    Colour associated with the dimension value.
    """


    # @ApiMember(Description="Id that links this dimension value to an object.", ParameterType="body")
    object_connection_id: Optional[str] = None
    """
    Id that links this dimension value to an object.
    """


    # @ApiMember(Description="Owner Id of the dimension value.", ParameterType="body")
    owner_contact_id: Optional[str] = None
    """
    Owner Id of the dimension value.
    """


    # @ApiMember(Description="Record status of the dimension value.", ParameterType="body")
    record_status: Optional[str] = None
    """
    Record status of the dimension value.
    """


# @ApiResponse(Description="A list of dimension values")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetDimensionValuesListResponse:
    # @ApiMember(DataType="List<DimensionValueModel>", Description="List of dimensionValues.", Name="DimensionValues", ParameterType="query")
    dimension_values: Optional[List[DimensionValueModel]] = None
    """
    List of dimensionValues.
    """


    response_status: Optional[ResponseStatus] = None


# @Api(Description="Get a list of dimensionValues for a specified dimension")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetDimensionValuesList:
    """
    Get a list of dimensionValues for a specified dimension
    """

    # @ApiMember(DataType="Guid", Description="Licensee Id to retrieve dimensionValues for.", Name="LicenseeId", ParameterType="query")
    licensee_id: Optional[str] = None
    """
    Licensee Id to retrieve dimensionValues for.
    """


    # @ApiMember(DataType="Guid", Description="Dimension Id to retrieve dimensionValues for.", Name="DimensionId", ParameterType="query")
    dimension_id: Optional[str] = None
    """
    Dimension Id to retrieve dimensionValues for.
    """


    # @ApiMember(DataType="string", Description="RecordStatus of dimensionValues to retrieve. If not set 'A' active dimensionValues are retrieved.", Name="RecordStatus", ParameterType="query")
    record_status: Optional[str] = None
    """
    RecordStatus of dimensionValues to retrieve. If not set 'A' active dimensionValues are retrieved.
    """

Python GetDimensionValuesList DTOs

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

HTTP + XML

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: 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>