Platform API

GetDimensionsList

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

The following routes are available for this service:
All Verbs	/api/dimensions/

**GetDimensionsList** Parameters:
Name	Parameter	Data Type	Required	Description
LicenseeId	query	Guid	No	Licensee Id to retrieve dimensions for.
RecordStatus	query	string	No	RecordStatus of dimensions to retrieve. If not set 'A' active dimensions are retrieved.

**GetDimensionsListResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Dimensions	query	List<DimensionModel>	No	List of dimensions.
ResponseStatus	form	ResponseStatus	No

**DimensionModel** Parameters:
Name	Parameter	Data Type	Required	Description
DimensionId	form	Guid	No	Id of the Dimension itself.
Name	form	string	No	Dimension name.
Description	form	string	No	Dimension description.
ShortName	form	string	No	Dimension shortened name.
HasTrafficLightForValues	form	bool	No	True if the values for the dimension should have colours associated with them.
HasImage	form	bool	No
OwnerContactId	form	Guid	No	Owner Id of the dimension.
RecordStatus	form	string	No	Record status of the dimension.
DimensionValues	form	List<DimensionValueModel>	No	Dimension values for this dimension.
ObjectConnectionId	form	Guid	No	Id that links this dimension to an object.

**DimensionValueModel** Parameters:
Name	Parameter	Data Type	Required	Description
DimensionValueId	body	Guid	No	Id of the dimension value.
DimensionId	body	Guid	No	Dimension Id this value is for.
Name	body	string	No	Name of the dimension value.
Description	body	string	No	Description of the dimension value.
ShortName	body	string	No	Short Name for the dimension value.
TrafficLightId	body	Guid	No	Id of the colour associated.
TrafficLightColour	body	string	No	Colour associated with the dimension value.
ObjectConnectionId	body	Guid	No	Id that links this dimension value to an object.
OwnerContactId	body	Guid	No	Owner Id of the dimension value.
RecordStatus	body	string	No	Record status of the dimension value.

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