| POST | /api/dimensions | ||
|---|---|---|---|
| PUT | /api/dimensions/{DimensionId} |
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")>]
[<AllowNullLiteral>]
type SaveDimensionResponse() =
///<summary>
///Id of the Dimension created.
///</summary>
[<ApiMember(DataType="Guid", Description="Id of the Dimension created.", Name="DimensionId", ParameterType="query")>]
member val DimensionId: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
[<AllowNullLiteral>]
type DimensionModel() =
///<summary>
///Id of the Dimension itself.
///</summary>
[<ApiMember(DataType="Guid", Description="Id of the Dimension itself.", Name="DimensionId")>]
member val DimensionId:Guid = new Guid() with get,set
///<summary>
///Dimension name.
///</summary>
[<ApiMember(DataType="string", Description="Dimension name.", Name="Name")>]
member val Name:String = null with get,set
///<summary>
///Dimension description.
///</summary>
[<ApiMember(DataType="string", Description="Dimension description.", Name="Description")>]
member val Description:String = null with get,set
///<summary>
///Dimension shortened name.
///</summary>
[<ApiMember(DataType="string", Description="Dimension shortened name.", Name="ShortName")>]
member val ShortName:String = null with get,set
///<summary>
///True if the values for the dimension should have colours associated with them.
///</summary>
[<ApiMember(DataType="bool", Description="True if the values for the dimension should have colours associated with them.", Name="HasTrafficLightForValues")>]
member val HasTrafficLightForValues:Boolean = new Boolean() with get,set
///<summary>
///
///</summary>
[<ApiMember(DataType="bool", Description="", Name="HasImage")>]
member val HasImage:Boolean = new Boolean() with get,set
///<summary>
///Owner Id of the dimension.
///</summary>
[<ApiMember(DataType="Guid", Description="Owner Id of the dimension.", Name="OwnerContactId")>]
member val OwnerContactId:Guid = new Guid() with get,set
///<summary>
///Record status of the dimension.
///</summary>
[<ApiMember(DataType="string", Description="Record status of the dimension.", Name="RecordStatus")>]
member val RecordStatus:String = null with get,set
///<summary>
///Dimension values for this dimension.
///</summary>
[<ApiMember(DataType="List<DimensionValueModel>", Description="Dimension values for this dimension.", Name="DimensionValues")>]
member val DimensionValues:ResizeArray<DimensionValueModel> = null with get,set
///<summary>
///Id that links this dimension to an object.
///</summary>
[<ApiMember(Description="Id that links this dimension to an object.")>]
member val ObjectConnectionId:Guid = new Guid() with get,set
///<summary>
///Add or update a dimensions details.
///</summary>
[<Api(Description="Add or update a dimensions details.")>]
[<AllowNullLiteral>]
type SaveDimension() =
///<summary>
///Details of the dimension to be added or updated.
///</summary>
[<ApiMember(DataType="DimensionModel", Description="Details of the dimension to be added or updated.", IsRequired=true, Name="Dimension")>]
member val Dimension:DimensionModel = null with get,set
///<summary>
///Id of the dimension.
///</summary>
[<ApiMember(DataType="Guid", Description="Id of the dimension.", IsRequired=true, Name="DimensionId")>]
member val DimensionId:Guid = new Guid() with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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: text/csv
Content-Type: text/csv
Content-Length: length
{"Dimension":{"DimensionId":"00000000-0000-0000-0000-000000000000","Name":"String","Description":"String","ShortName":"String","HasTrafficLightForValues":false,"HasImage":false,"OwnerContactId":"00000000-0000-0000-0000-000000000000","RecordStatus":"String","DimensionValues":[{"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"}],"ObjectConnectionId":"00000000-0000-0000-0000-000000000000"},"DimensionId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"DimensionId":"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"}}}