| All Verbs | /api/dimensionvalues/object/{ObjectId} |
|---|
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eros.Subtle.Canvara.WebAPIModel.ServiceModel
Imports Eros.Saguna.Common.WebAPIModel.Models
Namespace Global
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 Overridable Property DimensionId As Guid
'''<Summary>
'''Dimension name.
'''</Summary>
<ApiMember(DataType:="string", Description:="Dimension name.", Name:="Name")>
Public Overridable Property Name As String
'''<Summary>
'''Dimension description.
'''</Summary>
<ApiMember(DataType:="string", Description:="Dimension description.", Name:="Description")>
Public Overridable Property Description As String
'''<Summary>
'''Dimension shortened name.
'''</Summary>
<ApiMember(DataType:="string", Description:="Dimension shortened name.", Name:="ShortName")>
Public Overridable Property ShortName As String
'''<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 Overridable Property HasTrafficLightForValues As Boolean
'''<Summary>
'''
'''</Summary>
<ApiMember(DataType:="bool", Description:="", Name:="HasImage")>
Public Overridable Property HasImage As Boolean
'''<Summary>
'''Owner Id of the dimension.
'''</Summary>
<ApiMember(DataType:="Guid", Description:="Owner Id of the dimension.", Name:="OwnerContactId")>
Public Overridable Property OwnerContactId As Guid
'''<Summary>
'''Record status of the dimension.
'''</Summary>
<ApiMember(DataType:="string", Description:="Record status of the dimension.", Name:="RecordStatus")>
Public Overridable Property RecordStatus As String
'''<Summary>
'''Dimension values for this dimension.
'''</Summary>
<ApiMember(DataType:="List<DimensionValueModel>", Description:="Dimension values for this dimension.", Name:="DimensionValues")>
Public Overridable Property DimensionValues As List(Of DimensionValueModel)
'''<Summary>
'''Id that links this dimension to an object.
'''</Summary>
<ApiMember(Description:="Id that links this dimension to an object.")>
Public Overridable Property ObjectConnectionId As Guid
End Class
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 Overridable Property DimensionValueId As Guid
'''<Summary>
'''Dimension Id this value is for.
'''</Summary>
<ApiMember(Description:="Dimension Id this value is for.", ParameterType:="body")>
Public Overridable Property DimensionId As Guid
'''<Summary>
'''Name of the dimension value.
'''</Summary>
<ApiMember(Description:="Name of the dimension value.", ParameterType:="body")>
Public Overridable Property Name As String
'''<Summary>
'''Description of the dimension value.
'''</Summary>
<ApiMember(Description:="Description of the dimension value.", ParameterType:="body")>
Public Overridable Property Description As String
'''<Summary>
'''Short Name for the dimension value.
'''</Summary>
<ApiMember(Description:="Short Name for the dimension value.", ParameterType:="body")>
Public Overridable Property ShortName As String
'''<Summary>
'''Id of the colour associated.
'''</Summary>
<ApiMember(Description:="Id of the colour associated.", ParameterType:="body")>
Public Overridable Property TrafficLightId As Guid
'''<Summary>
'''Colour associated with the dimension value.
'''</Summary>
<ApiMember(Description:="Colour associated with the dimension value.", ParameterType:="body")>
Public Overridable Property TrafficLightColour As String
'''<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 Overridable Property ObjectConnectionId As Guid
'''<Summary>
'''Owner Id of the dimension value.
'''</Summary>
<ApiMember(Description:="Owner Id of the dimension value.", ParameterType:="body")>
Public Overridable Property OwnerContactId As Guid
'''<Summary>
'''Record status of the dimension value.
'''</Summary>
<ApiMember(Description:="Record status of the dimension value.", ParameterType:="body")>
Public Overridable Property RecordStatus As String
End Class
End Namespace
Namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
<ApiResponse(Description:="A list of dimensions (and values if they apply) for an object")>
Public Partial Class GetObjectDimensionsResponse
'''<Summary>
'''List of dimensions.
'''</Summary>
<ApiMember(DataType:="List<DimensionModel>", Description:="List of dimensions.", Name:="Dimensions", ParameterType:="query")>
Public Overridable Property Dimensions As List(Of DimensionModel)
Public Overridable Property ResponseStatus As ResponseStatus
End Class
'''<Summary>
'''Get a list of dimensionValues linked to a specified object
'''</Summary>
<Api(Description:="Get a list of dimensionValues linked to a specified object")>
Public Partial Class GetObjectDimensionValues
'''<Summary>
'''Licensee Id to retrieve dimensionValues for.
'''</Summary>
<ApiMember(DataType:="Guid", Description:="Licensee Id to retrieve dimensionValues for.", Name:="LicenseeId", ParameterType:="query")>
Public Overridable Property LicenseeId As Guid
'''<Summary>
'''Object Id to retrieve dimensionValues for.
'''</Summary>
<ApiMember(DataType:="Guid", Description:="Object Id to retrieve dimensionValues for.", Name:="ObjectId", ParameterType:="query")>
Public Overridable Property ObjectId As Guid
End Class
End Namespace
End Namespace
VB.NET GetObjectDimensionValues DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/dimensionvalues/object/{ObjectId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/json
Content-Type: application/json
Content-Length: length
{"LicenseeId":"00000000-0000-0000-0000-000000000000","ObjectId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Dimensions":[{"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"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}