| All Verbs | /api/dimensions/object/{ObjectId} |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DimensionValueModel:
# @ApiMember(DataType="Guid", Description="Id of the dimension value.", Name="DimensionValueId", ParameterType="body")
dimension_value_id: Optional[str] = None
"""
Id of the dimension value.
"""
# @ApiMember(Description="Dimension Id this value is for.", ParameterType="body")
dimension_id: Optional[str] = None
"""
Dimension Id this value is for.
"""
# @ApiMember(Description="Name of the dimension value.", ParameterType="body")
name: Optional[str] = None
"""
Name of the dimension value.
"""
# @ApiMember(Description="Description of the dimension value.", ParameterType="body")
description: Optional[str] = None
"""
Description of the dimension value.
"""
# @ApiMember(Description="Short Name for the dimension value.", ParameterType="body")
short_name: Optional[str] = None
"""
Short Name for the dimension value.
"""
# @ApiMember(Description="Id of the colour associated.", ParameterType="body")
traffic_light_id: Optional[str] = None
"""
Id of the colour associated.
"""
# @ApiMember(Description="Colour associated with the dimension value.", ParameterType="body")
traffic_light_colour: Optional[str] = None
"""
Colour associated with the dimension value.
"""
# @ApiMember(Description="Id that links this dimension value to an object.", ParameterType="body")
object_connection_id: Optional[str] = None
"""
Id that links this dimension value to an object.
"""
# @ApiMember(Description="Owner Id of the dimension value.", ParameterType="body")
owner_contact_id: Optional[str] = None
"""
Owner Id of the dimension value.
"""
# @ApiMember(Description="Record status of the dimension value.", ParameterType="body")
record_status: Optional[str] = None
"""
Record status of the dimension value.
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DimensionModel:
# @ApiMember(DataType="Guid", Description="Id of the Dimension itself.", Name="DimensionId")
dimension_id: Optional[str] = None
"""
Id of the Dimension itself.
"""
# @ApiMember(DataType="string", Description="Dimension name.", Name="Name")
name: Optional[str] = None
"""
Dimension name.
"""
# @ApiMember(DataType="string", Description="Dimension description.", Name="Description")
description: Optional[str] = None
"""
Dimension description.
"""
# @ApiMember(DataType="string", Description="Dimension shortened name.", Name="ShortName")
short_name: Optional[str] = None
"""
Dimension shortened name.
"""
# @ApiMember(DataType="bool", Description="True if the values for the dimension should have colours associated with them.", Name="HasTrafficLightForValues")
has_traffic_light_for_values: bool = False
"""
True if the values for the dimension should have colours associated with them.
"""
# @ApiMember(DataType="bool", Description="", Name="HasImage")
has_image: bool = False
"""
"""
# @ApiMember(DataType="Guid", Description="Owner Id of the dimension.", Name="OwnerContactId")
owner_contact_id: Optional[str] = None
"""
Owner Id of the dimension.
"""
# @ApiMember(DataType="string", Description="Record status of the dimension.", Name="RecordStatus")
record_status: Optional[str] = None
"""
Record status of the dimension.
"""
# @ApiMember(DataType="List<DimensionValueModel>", Description="Dimension values for this dimension.", Name="DimensionValues")
dimension_values: Optional[List[DimensionValueModel]] = None
"""
Dimension values for this dimension.
"""
# @ApiMember(Description="Id that links this dimension to an object.")
object_connection_id: Optional[str] = None
"""
Id that links this dimension to an object.
"""
# @ApiResponse(Description="A list of dimensions (and values if they apply) for an object")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetObjectDimensionsResponse:
# @ApiMember(DataType="List<DimensionModel>", Description="List of dimensions.", Name="Dimensions", ParameterType="query")
dimensions: Optional[List[DimensionModel]] = None
"""
List of dimensions.
"""
response_status: Optional[ResponseStatus] = None
# @Api(Description="Get a list of dimensions linked to a specified object")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetObjectDimensions:
"""
Get a list of dimensions linked to a specified object
"""
# @ApiMember(DataType="Guid", Description="Licensee Id to retrieve dimensions for.", Name="LicenseeId", ParameterType="query")
licensee_id: Optional[str] = None
"""
Licensee Id to retrieve dimensions for.
"""
# @ApiMember(DataType="Guid", Description="Object Id to retrieve dimensions for.", Name="ObjectId", ParameterType="query")
object_id: Optional[str] = None
"""
Object Id to retrieve dimensions for.
"""
Python GetObjectDimensions DTOs
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/object/{ObjectId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetObjectDimensions 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>
<ObjectId>00000000-0000-0000-0000-000000000000</ObjectId>
</GetObjectDimensions>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetObjectDimensionsResponse 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>
</GetObjectDimensionsResponse>