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
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Gets the suite data for a particular licensee
    */
    @Api(Description="Gets the suite data for a particular licensee")
    public static class GetSuiteDataForLicensee
    {
        /**
        * The suite id
        */
        @ApiMember(Description="The suite id", Name="Suite Id")
        public UUID SuiteId = null;

        /**
        * The id of the licensee
        */
        @ApiMember(Description="The id of the licensee", Name="LicenseeId")
        public UUID LicenseeId = null;
        
        public UUID getSuiteId() { return SuiteId; }
        public GetSuiteDataForLicensee setSuiteId(UUID value) { this.SuiteId = value; return this; }
        public UUID getLicenseeId() { return LicenseeId; }
        public GetSuiteDataForLicensee setLicenseeId(UUID value) { this.LicenseeId = value; return this; }
    }

    @ApiResponse(Description="Suite Appliance Data")
    public static class GetSuiteDataResponse
    {
        public UUID SuiteApplianceLicenseeId = null;
        public String DomainName = null;
        public String SkinName = null;
        public UUID LicenseeConnectionId = null;
        public UUID LicenseeContactId = null;
        public String LicenseeContactName = null;
        public Boolean IsBrandedURL = null;
        public ResponseStatus ResponseStatus = null;
        
        public UUID getSuiteApplianceLicenseeId() { return SuiteApplianceLicenseeId; }
        public GetSuiteDataResponse setSuiteApplianceLicenseeId(UUID value) { this.SuiteApplianceLicenseeId = value; return this; }
        public String getDomainName() { return DomainName; }
        public GetSuiteDataResponse setDomainName(String value) { this.DomainName = value; return this; }
        public String getSkinName() { return SkinName; }
        public GetSuiteDataResponse setSkinName(String value) { this.SkinName = value; return this; }
        public UUID getLicenseeConnectionId() { return LicenseeConnectionId; }
        public GetSuiteDataResponse setLicenseeConnectionId(UUID value) { this.LicenseeConnectionId = value; return this; }
        public UUID getLicenseeContactId() { return LicenseeContactId; }
        public GetSuiteDataResponse setLicenseeContactId(UUID value) { this.LicenseeContactId = value; return this; }
        public String getLicenseeContactName() { return LicenseeContactName; }
        public GetSuiteDataResponse setLicenseeContactName(String value) { this.LicenseeContactName = value; return this; }
        public Boolean getIsBrandedURL() { return IsBrandedURL; }
        public GetSuiteDataResponse setIsBrandedURL(Boolean value) { this.IsBrandedURL = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public GetSuiteDataResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

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

{
	
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	DomainName: String,
	SkinName: String,
	LicenseeContactName: String,
	IsBrandedURL: False,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}