Platform Subscription API

<back to all web services

GetDimensions

Requires Authentication
The following routes are available for this service:
All Verbs/api/informationondimensions
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Subtle.Canvara.WebAPIModel.ServiceModelSubscription;

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModelSubscription
{
    public partial class 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")]
        public virtual Guid LicenseeId { 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")]
        public virtual string RecordStatus { get; set; }
    }

    public partial class 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")]
        public virtual string DimensionsXml { get; set; }
    }

}

C# 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
}