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
"use strict";
export class GetSuiteDataResponse {
    /** @param {{SuiteApplianceLicenseeId?:string,DomainName?:string,SkinName?:string,LicenseeConnectionId?:string,LicenseeContactId?:string,LicenseeContactName?:string,IsBrandedURL?:boolean,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    SuiteApplianceLicenseeId;
    /** @type {string} */
    DomainName;
    /** @type {string} */
    SkinName;
    /** @type {string} */
    LicenseeConnectionId;
    /** @type {string} */
    LicenseeContactId;
    /** @type {string} */
    LicenseeContactName;
    /** @type {boolean} */
    IsBrandedURL;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class GetSuiteDataForLicensee {
    /** @param {{SuiteId?:string,LicenseeId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The suite id */
    SuiteId;
    /**
     * @type {string}
     * @description The id of the licensee */
    LicenseeId;
}

JavaScript 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"}}}