Platform Subscription API

<back to all web services

GetDimensions

Requires Authentication
The following routes are available for this service:
All Verbs/api/informationondimensions
import Foundation
import ServiceStack

public class GetDimensions : Codable
{
    /**
    * 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")
    public var licenseeId:String

    /**
    * 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")
    public var recordStatus:String

    required public init(){}
}

public class GetDimensionsResponse : Codable
{
    /**
    * 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")
    public var dimensionsXml:String

    required public init(){}
}


Swift GetDimensions DTOs

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

HTTP + CSV

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

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

{"DimensionsXml":"String"}