Platform Subscription API

<back to all web services

GetDimensions

Requires Authentication
The following routes are available for this service:
All Verbs/api/informationondimensions
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 GetDimensionsResponse:
    # @ApiMember(DataType="string", Description="XML string containing all the Dimensions and Values for a licensee.", Name="DimensionsXml", ParameterType="body")
    dimensions_xml: Optional[str] = None
    """
    XML string containing all the Dimensions and Values for a licensee.
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetDimensions:
    # @ApiMember(DataType="Guid", Description="Id of the licensee to retrieve their dimensions and values for.", Name="LicenseeId", ParameterType="body")
    licensee_id: Optional[str] = None
    """
    Id of the licensee to retrieve their dimensions and values for.
    """


    # @ApiMember(DataType="string", Description="Record Status of dimensions and values to be retrieved..", Name="RecordStatus", ParameterType="body")
    record_status: Optional[str] = None
    """
    Record Status of dimensions and values to be retrieved..
    """

Python GetDimensions DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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

POST /api/informationondimensions HTTP/1.1 
Host: production-eros-platform-apisubscription.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	RecordStatus: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	DimensionsXml: String
}