Platform API

<back to all web services

GetDimensionsList

Get a list of dimensions for a licensee, as well as any standard dimensions

"use strict";
export class DimensionValueModel {
    /** @param {{DimensionValueId?:string,DimensionId?:string,Name?:string,Description?:string,ShortName?:string,TrafficLightId?:string,TrafficLightColour?:string,ObjectConnectionId?:string,OwnerContactId?:string,RecordStatus?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Id of the dimension value. */
    DimensionValueId;
    /**
     * @type {string}
     * @description Dimension Id this value is for. */
    DimensionId;
    /**
     * @type {string}
     * @description Name of the dimension value. */
    Name;
    /**
     * @type {string}
     * @description Description of the dimension value. */
    Description;
    /**
     * @type {string}
     * @description Short Name for the dimension value. */
    ShortName;
    /**
     * @type {string}
     * @description Id of the colour associated. */
    TrafficLightId;
    /**
     * @type {string}
     * @description Colour associated with the dimension value. */
    TrafficLightColour;
    /**
     * @type {string}
     * @description Id that links this dimension value to an object. */
    ObjectConnectionId;
    /**
     * @type {string}
     * @description Owner Id of the dimension value. */
    OwnerContactId;
    /**
     * @type {string}
     * @description Record status of the dimension value. */
    RecordStatus;
}
export class DimensionModel {
    /** @param {{DimensionId?:string,Name?:string,Description?:string,ShortName?:string,HasTrafficLightForValues?:boolean,HasImage?:boolean,OwnerContactId?:string,RecordStatus?:string,DimensionValues?:DimensionValueModel[],ObjectConnectionId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Id of the Dimension itself. */
    DimensionId;
    /**
     * @type {string}
     * @description Dimension name. */
    Name;
    /**
     * @type {string}
     * @description Dimension description. */
    Description;
    /**
     * @type {string}
     * @description Dimension shortened name. */
    ShortName;
    /**
     * @type {boolean}
     * @description True if the values for the dimension should have colours associated with them. */
    HasTrafficLightForValues;
    /** @type {boolean} */
    HasImage;
    /**
     * @type {string}
     * @description Owner Id of the dimension. */
    OwnerContactId;
    /**
     * @type {string}
     * @description Record status of the dimension. */
    RecordStatus;
    /**
     * @type {DimensionValueModel[]}
     * @description Dimension values for this dimension. */
    DimensionValues;
    /**
     * @type {string}
     * @description Id that links this dimension to an object. */
    ObjectConnectionId;
}
export class GetDimensionsListResponse {
    /** @param {{Dimensions?:DimensionModel[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {DimensionModel[]}
     * @description List of dimensions. */
    Dimensions;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class GetDimensionsList {
    /** @param {{LicenseeId?:string,RecordStatus?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Licensee Id to retrieve dimensions for. */
    LicenseeId;
    /**
     * @type {string}
     * @description RecordStatus of dimensions to retrieve. If not set 'A' active dimensions are retrieved. */
    RecordStatus;
}

JavaScript GetDimensionsList DTOs

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

<GetDimensionsList 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>
  <RecordStatus>String</RecordStatus>
</GetDimensionsList>

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

<GetDimensionsListResponse 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>
</GetDimensionsListResponse>