Platform Subscription API

<back to all web services

GetDimensions

Requires Authentication
The following routes are available for this service:
All Verbs/api/informationondimensions
namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModelSubscription

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type GetDimensionsResponse() = 
        ///<summary>
        ///XML string containing all the Dimensions and Values for a licensee.
        ///</summary>
        [<ApiMember(DataType="string", Description="XML string containing all the Dimensions and Values for a licensee.", Name="DimensionsXml", ParameterType="body")>]
        member val DimensionsXml:String = null with get,set

    [<AllowNullLiteral>]
    type GetDimensions() = 
        ///<summary>
        ///Id of the licensee to retrieve their dimensions and values for.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Id of the licensee to retrieve their dimensions and values for.", Name="LicenseeId", ParameterType="body")>]
        member val LicenseeId:Guid = new Guid() with get,set

        ///<summary>
        ///Record Status of dimensions and values to be retrieved..
        ///</summary>
        [<ApiMember(DataType="string", Description="Record Status of dimensions and values to be retrieved..", Name="RecordStatus", ParameterType="body")>]
        member val RecordStatus:String = null with get,set

F# GetDimensions DTOs

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

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
Content-Length: length

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

{"DimensionsXml":"String"}