| 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 .jsv suffix or ?format=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
}
}
}