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 Foundation
import ServiceStack

/**
* Gets the suite data for a particular licensee
*/
// @Api(Description="Gets the suite data for a particular licensee")
public class GetSuiteDataForLicensee : Codable
{
    /**
    * The suite id
    */
    // @ApiMember(Description="The suite id", Name="Suite Id")
    public var suiteId:String

    /**
    * The id of the licensee
    */
    // @ApiMember(Description="The id of the licensee", Name="LicenseeId")
    public var licenseeId:String

    required public init(){}
}

// @ApiResponse(Description="Suite Appliance Data")
public class GetSuiteDataResponse : Codable
{
    public var suiteApplianceLicenseeId:String
    public var domainName:String
    public var skinName:String
    public var licenseeConnectionId:String
    public var licenseeContactId:String
    public var licenseeContactName:String
    public var isBrandedURL:Bool
    public var responseStatus:ResponseStatus

    required public init(){}
}


Swift 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
		}
	}
}