Platform API

SaveDimensionValue

Add or update a dimension values details.

The following routes are available for this service:
PUT	/api/dimensionvalues/{DimensionValueId}
POST	/api/dimensionvalues

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<ApiResponse(Description="Success of the create/update of the dimension value")>]
    [<AllowNullLiteral>]
    type SaveDimensionValueResponse() = 
        ///<summary>
        ///Id of the Dimension Value created.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Id of the Dimension Value created.", Name="DimensionValueId", ParameterType="query")>]
        member val DimensionValueId:Guid = new Guid() with get,set

        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type DimensionValueModel() = 
        ///<summary>
        ///Id of the dimension value.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Id of the dimension value.", Name="DimensionValueId", ParameterType="body")>]
        member val DimensionValueId:Guid = new Guid() with get,set

        ///<summary>
        ///Dimension Id this value is for.
        ///</summary>
        [<ApiMember(Description="Dimension Id this value is for.", ParameterType="body")>]
        member val DimensionId:Guid = new Guid() with get,set

        ///<summary>
        ///Name of the dimension value.
        ///</summary>
        [<ApiMember(Description="Name of the dimension value.", ParameterType="body")>]
        member val Name:String = null with get,set

        ///<summary>
        ///Description of the dimension value.
        ///</summary>
        [<ApiMember(Description="Description of the dimension value.", ParameterType="body")>]
        member val Description:String = null with get,set

        ///<summary>
        ///Short Name for the dimension value.
        ///</summary>
        [<ApiMember(Description="Short Name for the dimension value.", ParameterType="body")>]
        member val ShortName:String = null with get,set

        ///<summary>
        ///Id of the colour associated.
        ///</summary>
        [<ApiMember(Description="Id of the colour associated.", ParameterType="body")>]
        member val TrafficLightId:Guid = new Guid() with get,set

        ///<summary>
        ///Colour associated with the dimension value.
        ///</summary>
        [<ApiMember(Description="Colour associated with the dimension value.", ParameterType="body")>]
        member val TrafficLightColour:String = null with get,set

        ///<summary>
        ///Id that links this dimension value to an object.
        ///</summary>
        [<ApiMember(Description="Id that links this dimension value to an object.", ParameterType="body")>]
        member val ObjectConnectionId:Guid = new Guid() with get,set

        ///<summary>
        ///Owner Id of the dimension value.
        ///</summary>
        [<ApiMember(Description="Owner Id of the dimension value.", ParameterType="body")>]
        member val OwnerContactId:Guid = new Guid() with get,set

        ///<summary>
        ///Record status of the dimension value.
        ///</summary>
        [<ApiMember(Description="Record status of the dimension value.", ParameterType="body")>]
        member val RecordStatus:String = null with get,set

    ///<summary>
    ///Add or update a dimension values details.
    ///</summary>
    [<Api(Description="Add or update a dimension values details.")>]
    [<AllowNullLiteral>]
    type SaveDimensionValue() = 
        ///<summary>
        ///Details of the dimension value to be added or updated.
        ///</summary>
        [<ApiMember(DataType="DimensionValueModel", Description="Details of the dimension value to be added or updated.", IsRequired=true, Name="DimensionValue")>]
        member val DimensionValue:DimensionValueModel = null with get,set

        ///<summary>
        ///Id of the dimension value.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Id of the dimension value.", IsRequired=true, Name="DimensionValueId")>]
        member val DimensionValueId:Guid = new Guid() with get,set

F# SaveDimensionValue DTOs

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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/dimensionvalues HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"DimensionValue":{"DimensionValueId":"00000000-0000-0000-0000-000000000000","DimensionId":"00000000-0000-0000-0000-000000000000","Name":"String","Description":"String","ShortName":"String","TrafficLightId":"00000000-0000-0000-0000-000000000000","TrafficLightColour":"String","ObjectConnectionId":"00000000-0000-0000-0000-000000000000","OwnerContactId":"00000000-0000-0000-0000-000000000000","RecordStatus":"String"},"DimensionValueId":"00000000-0000-0000-0000-000000000000"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"DimensionValueId":"00000000-0000-0000-0000-000000000000","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}