Platform Subscription API

<back to all web services

GetDimensions

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

Namespace Global

    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 Overridable Property LicenseeId As Guid

            '''<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 Overridable Property RecordStatus As String
        End Class

        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 Overridable Property DimensionsXml As String
        End Class
    End Namespace
End Namespace

VB.NET GetDimensions DTOs

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

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<GetDimensions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModelSubscription">
  <LicenseeId>00000000-0000-0000-0000-000000000000</LicenseeId>
  <RecordStatus>String</RecordStatus>
</GetDimensions>

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

<GetDimensionsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModelSubscription">
  <DimensionsXml>String</DimensionsXml>
</GetDimensionsResponse>