Platform API

<back to all web services

SaveDimension

Add or update a dimensions details.

Requires Authentication
The following routes are available for this service:
POST/api/dimensions
PUT/api/dimensions/{DimensionId}
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Add or update a dimensions details.
*/
@Api(Description="Add or update a dimensions details.")
open class SaveDimension
{
    /**
    * Details of the dimension to be added or updated.
    */
    @ApiMember(DataType="DimensionModel", Description="Details of the dimension to be added or updated.", IsRequired=true, Name="Dimension")
    open var Dimension:DimensionModel? = null

    /**
    * Id of the dimension.
    */
    @ApiMember(DataType="Guid", Description="Id of the dimension.", IsRequired=true, Name="DimensionId")
    open var DimensionId:UUID? = null
}

open class DimensionModel
{
    /**
    * Id of the Dimension itself.
    */
    @ApiMember(DataType="Guid", Description="Id of the Dimension itself.", Name="DimensionId")
    open var DimensionId:UUID? = null

    /**
    * Dimension name.
    */
    @ApiMember(DataType="string", Description="Dimension name.", Name="Name")
    open var Name:String? = null

    /**
    * Dimension description.
    */
    @ApiMember(DataType="string", Description="Dimension description.", Name="Description")
    open var Description:String? = null

    /**
    * Dimension shortened name.
    */
    @ApiMember(DataType="string", Description="Dimension shortened name.", Name="ShortName")
    open var ShortName:String? = null

    /**
    * 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")
    open var HasTrafficLightForValues:Boolean? = null

    /**
    * 
    */
    @ApiMember(DataType="bool", Description="", Name="HasImage")
    open var HasImage:Boolean? = null

    /**
    * Owner Id of the dimension.
    */
    @ApiMember(DataType="Guid", Description="Owner Id of the dimension.", Name="OwnerContactId")
    open var OwnerContactId:UUID? = null

    /**
    * Record status of the dimension.
    */
    @ApiMember(DataType="string", Description="Record status of the dimension.", Name="RecordStatus")
    open var RecordStatus:String? = null

    /**
    * Dimension values for this dimension.
    */
    @ApiMember(DataType="List<DimensionValueModel>", Description="Dimension values for this dimension.", Name="DimensionValues")
    open var DimensionValues:ArrayList<DimensionValueModel>? = null

    /**
    * Id that links this dimension to an object.
    */
    @ApiMember(Description="Id that links this dimension to an object.")
    open var ObjectConnectionId:UUID? = null
}

open class DimensionValueModel
{
    /**
    * Id of the dimension value.
    */
    @ApiMember(DataType="Guid", Description="Id of the dimension value.", Name="DimensionValueId", ParameterType="body")
    open var DimensionValueId:UUID? = null

    /**
    * Dimension Id this value is for.
    */
    @ApiMember(Description="Dimension Id this value is for.", ParameterType="body")
    open var DimensionId:UUID? = null

    /**
    * Name of the dimension value.
    */
    @ApiMember(Description="Name of the dimension value.", ParameterType="body")
    open var Name:String? = null

    /**
    * Description of the dimension value.
    */
    @ApiMember(Description="Description of the dimension value.", ParameterType="body")
    open var Description:String? = null

    /**
    * Short Name for the dimension value.
    */
    @ApiMember(Description="Short Name for the dimension value.", ParameterType="body")
    open var ShortName:String? = null

    /**
    * Id of the colour associated.
    */
    @ApiMember(Description="Id of the colour associated.", ParameterType="body")
    open var TrafficLightId:UUID? = null

    /**
    * Colour associated with the dimension value.
    */
    @ApiMember(Description="Colour associated with the dimension value.", ParameterType="body")
    open var TrafficLightColour:String? = null

    /**
    * Id that links this dimension value to an object.
    */
    @ApiMember(Description="Id that links this dimension value to an object.", ParameterType="body")
    open var ObjectConnectionId:UUID? = null

    /**
    * Owner Id of the dimension value.
    */
    @ApiMember(Description="Owner Id of the dimension value.", ParameterType="body")
    open var OwnerContactId:UUID? = null

    /**
    * Record status of the dimension value.
    */
    @ApiMember(Description="Record status of the dimension value.", ParameterType="body")
    open var RecordStatus:String? = null
}

@ApiResponse(Description="Success of the create/update of the dimension")
open class SaveDimensionResponse
{
    /**
    * Id of the Dimension created.
    */
    @ApiMember(DataType="Guid", Description="Id of the Dimension created.", Name="DimensionId", ParameterType="query")
    open var DimensionId:UUID? = null

    open var ResponseStatus:ResponseStatus? = null
}

Kotlin SaveDimension 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/dimensions HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SaveDimension xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <Dimension xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
    <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>
  </Dimension>
  <DimensionId>00000000-0000-0000-0000-000000000000</DimensionId>
</SaveDimension>

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

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