Platform API

GetSuiteDataForLicensee

Gets the suite data for a particular licensee

The following routes are available for this service:
All Verbs	/api/suitedata

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

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

    [<ApiResponse(Description="Suite Appliance Data")>]
    [<AllowNullLiteral>]
    type GetSuiteDataResponse() = 
        member val SuiteApplianceLicenseeId:Guid = new Guid() with get,set
        member val DomainName:String = null with get,set
        member val SkinName:String = null with get,set
        member val LicenseeConnectionId:Guid = new Guid() with get,set
        member val LicenseeContactId:Guid = new Guid() with get,set
        member val LicenseeContactName:String = null with get,set
        member val IsBrandedURL:Boolean = new Boolean() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    ///<summary>
    ///Gets the suite data for a particular licensee
    ///</summary>
    [<Api(Description="Gets the suite data for a particular licensee")>]
    [<AllowNullLiteral>]
    type GetSuiteDataForLicensee() = 
        ///<summary>
        ///The suite id
        ///</summary>
        [<ApiMember(Description="The suite id", Name="Suite Id")>]
        member val SuiteId:Guid = new Guid() with get,set

        ///<summary>
        ///The id of the licensee
        ///</summary>
        [<ApiMember(Description="The id of the licensee", Name="LicenseeId")>]
        member val LicenseeId:Guid = new Guid() with get,set

F# GetSuiteDataForLicensee 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/suitedata HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"SuiteId":"00000000-0000-0000-0000-000000000000","LicenseeId":"00000000-0000-0000-0000-000000000000"}

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

{"SuiteApplianceLicenseeId":"00000000-0000-0000-0000-000000000000","DomainName":"String","SkinName":"String","LicenseeConnectionId":"00000000-0000-0000-0000-000000000000","LicenseeContactId":"00000000-0000-0000-0000-000000000000","LicenseeContactName":"String","IsBrandedURL":false,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}