| 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 .xml suffix or ?format=xml
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/xml
Content-Type: application/xml
Content-Length: length
<GetSuiteDataForLicensee xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<LicenseeId>00000000-0000-0000-0000-000000000000</LicenseeId>
<SuiteId>00000000-0000-0000-0000-000000000000</SuiteId>
</GetSuiteDataForLicensee>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetSuiteDataResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<DomainName>String</DomainName>
<IsBrandedURL>false</IsBrandedURL>
<LicenseeConnectionId>00000000-0000-0000-0000-000000000000</LicenseeConnectionId>
<LicenseeContactId>00000000-0000-0000-0000-000000000000</LicenseeContactId>
<LicenseeContactName>String</LicenseeContactName>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<SkinName>String</SkinName>
<SuiteApplianceLicenseeId>00000000-0000-0000-0000-000000000000</SuiteApplianceLicenseeId>
</GetSuiteDataResponse>