| All Verbs | /api/dimensions/ |
|---|
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Subtle.Canvara.WebAPIModel.ServiceModel;
using Eros.Saguna.Common.WebAPIModel.Models;
namespace Eros.Saguna.Common.WebAPIModel.Models
{
public partial class DimensionModel
{
///<summary>
///Id of the Dimension itself.
///</summary>
[ApiMember(DataType="Guid", Description="Id of the Dimension itself.", Name="DimensionId")]
public virtual Guid DimensionId { get; set; }
///<summary>
///Dimension name.
///</summary>
[ApiMember(DataType="string", Description="Dimension name.", Name="Name")]
public virtual string Name { get; set; }
///<summary>
///Dimension description.
///</summary>
[ApiMember(DataType="string", Description="Dimension description.", Name="Description")]
public virtual string Description { get; set; }
///<summary>
///Dimension shortened name.
///</summary>
[ApiMember(DataType="string", Description="Dimension shortened name.", Name="ShortName")]
public virtual string ShortName { 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")]
public virtual bool HasTrafficLightForValues { get; set; }
///<summary>
///
///</summary>
[ApiMember(DataType="bool", Description="", Name="HasImage")]
public virtual bool HasImage { get; set; }
///<summary>
///Owner Id of the dimension.
///</summary>
[ApiMember(DataType="Guid", Description="Owner Id of the dimension.", Name="OwnerContactId")]
public virtual Guid OwnerContactId { get; set; }
///<summary>
///Record status of the dimension.
///</summary>
[ApiMember(DataType="string", Description="Record status of the dimension.", Name="RecordStatus")]
public virtual string RecordStatus { get; set; }
///<summary>
///Dimension values for this dimension.
///</summary>
[ApiMember(DataType="List<DimensionValueModel>", Description="Dimension values for this dimension.", Name="DimensionValues")]
public virtual List<DimensionValueModel> DimensionValues { get; set; }
///<summary>
///Id that links this dimension to an object.
///</summary>
[ApiMember(Description="Id that links this dimension to an object.")]
public virtual Guid ObjectConnectionId { get; set; }
}
public partial class DimensionValueModel
{
///<summary>
///Id of the dimension value.
///</summary>
[ApiMember(DataType="Guid", Description="Id of the dimension value.", Name="DimensionValueId", ParameterType="body")]
public virtual Guid DimensionValueId { get; set; }
///<summary>
///Dimension Id this value is for.
///</summary>
[ApiMember(Description="Dimension Id this value is for.", ParameterType="body")]
public virtual Guid DimensionId { get; set; }
///<summary>
///Name of the dimension value.
///</summary>
[ApiMember(Description="Name of the dimension value.", ParameterType="body")]
public virtual string Name { get; set; }
///<summary>
///Description of the dimension value.
///</summary>
[ApiMember(Description="Description of the dimension value.", ParameterType="body")]
public virtual string Description { get; set; }
///<summary>
///Short Name for the dimension value.
///</summary>
[ApiMember(Description="Short Name for the dimension value.", ParameterType="body")]
public virtual string ShortName { get; set; }
///<summary>
///Id of the colour associated.
///</summary>
[ApiMember(Description="Id of the colour associated.", ParameterType="body")]
public virtual Guid TrafficLightId { get; set; }
///<summary>
///Colour associated with the dimension value.
///</summary>
[ApiMember(Description="Colour associated with the dimension value.", ParameterType="body")]
public virtual string TrafficLightColour { 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")]
public virtual Guid ObjectConnectionId { get; set; }
///<summary>
///Owner Id of the dimension value.
///</summary>
[ApiMember(Description="Owner Id of the dimension value.", ParameterType="body")]
public virtual Guid OwnerContactId { get; set; }
///<summary>
///Record status of the dimension value.
///</summary>
[ApiMember(Description="Record status of the dimension value.", ParameterType="body")]
public virtual string RecordStatus { get; set; }
}
}
namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
{
///<summary>
///Get a list of dimensions for a licensee, as well as any standard dimensions
///</summary>
[Api(Description="Get a list of dimensions for a licensee, as well as any standard dimensions")]
public partial class GetDimensionsList
{
///<summary>
///Licensee Id to retrieve dimensions for.
///</summary>
[ApiMember(DataType="Guid", Description="Licensee Id to retrieve dimensions for.", Name="LicenseeId", ParameterType="query")]
public virtual Guid LicenseeId { get; set; }
///<summary>
///RecordStatus of dimensions to retrieve. If not set 'A' active dimensions are retrieved.
///</summary>
[ApiMember(DataType="string", Description="RecordStatus of dimensions to retrieve. If not set 'A' active dimensions are retrieved.", Name="RecordStatus", ParameterType="query")]
public virtual string RecordStatus { get; set; }
}
[ApiResponse(Description="A list of dimensions")]
public partial class GetDimensionsListResponse
{
///<summary>
///List of dimensions.
///</summary>
[ApiMember(DataType="List<DimensionModel>", Description="List of dimensions.", Name="Dimensions", ParameterType="query")]
public virtual List<DimensionModel> Dimensions { get; set; }
public virtual ResponseStatus ResponseStatus { get; set; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>