| All Verbs | /api/dimensions/ |
|---|
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")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetDimensionsListResponse:
# @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 for a licensee, as well as any standard dimensions")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetDimensionsList:
"""
Get a list of dimensions for a licensee, as well as any standard dimensions
"""
# @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="string", Description="RecordStatus of dimensions to retrieve. If not set 'A' active dimensions are retrieved.", Name="RecordStatus", ParameterType="query")
record_status: Optional[str] = None
"""
RecordStatus of dimensions to retrieve. If not set 'A' active dimensions are retrieved.
"""
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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/jsonl
Content-Type: text/jsonl
Content-Length: length
{"LicenseeId":"00000000-0000-0000-0000-000000000000","RecordStatus":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}