Platform API

<back to all web services

GetSuiteDataForLicensee

Gets the suite data for a particular licensee

Requires Authentication
The following routes are available for this service:
All Verbs/api/suitedata
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.ServiceModel;

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
{
    ///<summary>
    ///Gets the suite data for a particular licensee
    ///</summary>
    [Api(Description="Gets the suite data for a particular licensee")]
    public partial class GetSuiteDataForLicensee
    {
        ///<summary>
        ///The suite id
        ///</summary>
        [ApiMember(Description="The suite id", Name="Suite Id")]
        public virtual Guid SuiteId { get; set; }

        ///<summary>
        ///The id of the licensee
        ///</summary>
        [ApiMember(Description="The id of the licensee", Name="LicenseeId")]
        public virtual Guid LicenseeId { get; set; }
    }

    [ApiResponse(Description="Suite Appliance Data")]
    public partial class GetSuiteDataResponse
    {
        public virtual Guid SuiteApplianceLicenseeId { get; set; }
        public virtual string DomainName { get; set; }
        public virtual string SkinName { get; set; }
        public virtual Guid LicenseeConnectionId { get; set; }
        public virtual Guid LicenseeContactId { get; set; }
        public virtual string LicenseeContactName { get; set; }
        public virtual bool IsBrandedURL { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

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

{"SuiteId":"00000000-0000-0000-0000-000000000000","LicenseeId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}