Platform Subscription API

<back to all web services

GetDimensions

Requires Authentication
The following routes are available for this service:
All Verbs/api/informationondimensions
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class GetDimensions
{
    /**
    * Id of the licensee to retrieve their dimensions and values for.
    */
    @ApiMember(DataType="Guid", Description="Id of the licensee to retrieve their dimensions and values for.", Name="LicenseeId", ParameterType="body")
    open var LicenseeId:UUID? = null

    /**
    * Record Status of dimensions and values to be retrieved..
    */
    @ApiMember(DataType="string", Description="Record Status of dimensions and values to be retrieved..", Name="RecordStatus", ParameterType="body")
    open var RecordStatus:String? = null
}

open class GetDimensionsResponse
{
    /**
    * XML string containing all the Dimensions and Values for a licensee.
    */
    @ApiMember(DataType="string", Description="XML string containing all the Dimensions and Values for a licensee.", Name="DimensionsXml", ParameterType="body")
    open var DimensionsXml:String? = null
}

Kotlin GetDimensions 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/informationondimensions HTTP/1.1 
Host: production-eros-platform-apisubscription.azurewebsites.net 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"RecordStatus":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"DimensionsXml":"String"}