Platform API

<back to all web services

GetObjectDimensionValues

Get a list of dimensionValues linked to a specified object

Requires Authentication
The following routes are available for this service:
All Verbs/api/dimensionvalues/object/{ObjectId}

export class DimensionValueModel
{
    /** @description Id of the dimension value. */
    // @ApiMember(DataType="Guid", Description="Id of the dimension value.", Name="DimensionValueId", ParameterType="body")
    public DimensionValueId: string;

    /** @description Dimension Id this value is for. */
    // @ApiMember(Description="Dimension Id this value is for.", ParameterType="body")
    public DimensionId: string;

    /** @description Name of the dimension value. */
    // @ApiMember(Description="Name of the dimension value.", ParameterType="body")
    public Name: string;

    /** @description Description of the dimension value. */
    // @ApiMember(Description="Description of the dimension value.", ParameterType="body")
    public Description: string;

    /** @description Short Name for the dimension value. */
    // @ApiMember(Description="Short Name for the dimension value.", ParameterType="body")
    public ShortName: string;

    /** @description Id of the colour associated. */
    // @ApiMember(Description="Id of the colour associated.", ParameterType="body")
    public TrafficLightId: string;

    /** @description Colour associated with the dimension value. */
    // @ApiMember(Description="Colour associated with the dimension value.", ParameterType="body")
    public TrafficLightColour: string;

    /** @description Id that links this dimension value to an object. */
    // @ApiMember(Description="Id that links this dimension value to an object.", ParameterType="body")
    public ObjectConnectionId: string;

    /** @description Owner Id of the dimension value. */
    // @ApiMember(Description="Owner Id of the dimension value.", ParameterType="body")
    public OwnerContactId: string;

    /** @description Record status of the dimension value. */
    // @ApiMember(Description="Record status of the dimension value.", ParameterType="body")
    public RecordStatus: string;

    public constructor(init?: Partial<DimensionValueModel>) { (Object as any).assign(this, init); }
}

export class DimensionModel
{
    /** @description Id of the Dimension itself. */
    // @ApiMember(DataType="Guid", Description="Id of the Dimension itself.", Name="DimensionId")
    public DimensionId: string;

    /** @description Dimension name. */
    // @ApiMember(DataType="string", Description="Dimension name.", Name="Name")
    public Name: string;

    /** @description Dimension description. */
    // @ApiMember(DataType="string", Description="Dimension description.", Name="Description")
    public Description: string;

    /** @description Dimension shortened name. */
    // @ApiMember(DataType="string", Description="Dimension shortened name.", Name="ShortName")
    public ShortName: string;

    /** @description True if the values for the dimension should have colours associated with them. */
    // @ApiMember(DataType="bool", Description="True if the values for the dimension should have colours associated with them.", Name="HasTrafficLightForValues")
    public HasTrafficLightForValues: boolean;

    /** @description  */
    // @ApiMember(DataType="bool", Description="", Name="HasImage")
    public HasImage: boolean;

    /** @description Owner Id of the dimension. */
    // @ApiMember(DataType="Guid", Description="Owner Id of the dimension.", Name="OwnerContactId")
    public OwnerContactId: string;

    /** @description Record status of the dimension. */
    // @ApiMember(DataType="string", Description="Record status of the dimension.", Name="RecordStatus")
    public RecordStatus: string;

    /** @description Dimension values for this dimension. */
    // @ApiMember(DataType="List<DimensionValueModel>", Description="Dimension values for this dimension.", Name="DimensionValues")
    public DimensionValues: DimensionValueModel[];

    /** @description Id that links this dimension to an object. */
    // @ApiMember(Description="Id that links this dimension to an object.")
    public ObjectConnectionId: string;

    public constructor(init?: Partial<DimensionModel>) { (Object as any).assign(this, init); }
}

// @ApiResponse(Description="A list of dimensions (and values if they apply) for an object")
export class GetObjectDimensionsResponse
{
    /** @description List of dimensions. */
    // @ApiMember(DataType="List<DimensionModel>", Description="List of dimensions.", Name="Dimensions", ParameterType="query")
    public Dimensions: DimensionModel[];

    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<GetObjectDimensionsResponse>) { (Object as any).assign(this, init); }
}

/** @description Get a list of dimensionValues linked to a specified object */
// @Api(Description="Get a list of dimensionValues linked to a specified object")
export class GetObjectDimensionValues
{
    /** @description Licensee Id to retrieve dimensionValues for. */
    // @ApiMember(DataType="Guid", Description="Licensee Id to retrieve dimensionValues for.", Name="LicenseeId", ParameterType="query")
    public LicenseeId: string;

    /** @description Object Id to retrieve dimensionValues for. */
    // @ApiMember(DataType="Guid", Description="Object Id to retrieve dimensionValues for.", Name="ObjectId", ParameterType="query")
    public ObjectId: string;

    public constructor(init?: Partial<GetObjectDimensionValues>) { (Object as any).assign(this, init); }
}

TypeScript GetObjectDimensionValues 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/object/{ObjectId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

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

<GetObjectDimensionsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <Dimensions xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
    <d2p1:DimensionModel>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:DimensionId>00000000-0000-0000-0000-000000000000</d2p1:DimensionId>
      <d2p1:DimensionValues>
        <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>
      </d2p1:DimensionValues>
      <d2p1:HasImage>false</d2p1:HasImage>
      <d2p1:HasTrafficLightForValues>false</d2p1:HasTrafficLightForValues>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:ObjectConnectionId>00000000-0000-0000-0000-000000000000</d2p1:ObjectConnectionId>
      <d2p1:OwnerContactId>00000000-0000-0000-0000-000000000000</d2p1:OwnerContactId>
      <d2p1:RecordStatus>String</d2p1:RecordStatus>
      <d2p1:ShortName>String</d2p1:ShortName>
    </d2p1:DimensionModel>
  </Dimensions>
  <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>
</GetObjectDimensionsResponse>