Platform API

SaveDimensionValue

Add or update a dimension values details.

The following routes are available for this service:
PUT	/api/dimensionvalues/{DimensionValueId}
POST	/api/dimensionvalues

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


# @ApiResponse(Description="Success of the create/update of the dimension value")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SaveDimensionValueResponse:
    # @ApiMember(DataType="Guid", Description="Id of the Dimension Value created.", Name="DimensionValueId", ParameterType="query")
    dimension_value_id: Optional[str] = None
    """
    Id of the Dimension Value created.
    """


    response_status: Optional[ResponseStatus] = None


@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.
    """


# @Api(Description="Add or update a dimension values details.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SaveDimensionValue:
    """
    Add or update a dimension values details.
    """

    # @ApiMember(DataType="DimensionValueModel", Description="Details of the dimension value to be added or updated.", IsRequired=true, Name="DimensionValue")
    dimension_value: Optional[DimensionValueModel] = None
    """
    Details of the dimension value to be added or updated.
    """


    # @ApiMember(DataType="Guid", Description="Id of the dimension value.", IsRequired=true, Name="DimensionValueId")
    dimension_value_id: Optional[str] = None
    """
    Id of the dimension value.
    """

Python SaveDimensionValue 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

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/dimensionvalues HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"DimensionValue":{"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"},"DimensionValueId":"00000000-0000-0000-0000-000000000000"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"DimensionValueId":"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"}}}