| All Verbs | /api/suitedata |
|---|
// @ApiResponse(Description="Suite Appliance Data")
export class GetSuiteDataResponse
{
public SuiteApplianceLicenseeId: string;
public DomainName: string;
public SkinName: string;
public LicenseeConnectionId: string;
public LicenseeContactId: string;
public LicenseeContactName: string;
public IsBrandedURL: boolean;
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<GetSuiteDataResponse>) { (Object as any).assign(this, init); }
}
/** @description Gets the suite data for a particular licensee */
// @Api(Description="Gets the suite data for a particular licensee")
export class GetSuiteDataForLicensee
{
/** @description The suite id */
// @ApiMember(Description="The suite id", Name="Suite Id")
public SuiteId: string;
/** @description The id of the licensee */
// @ApiMember(Description="The id of the licensee", Name="LicenseeId")
public LicenseeId: string;
public constructor(init?: Partial<GetSuiteDataForLicensee>) { (Object as any).assign(this, init); }
}
TypeScript GetSuiteDataForLicensee DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
Content-Type: text/csv
Content-Length: length
{"SuiteId":"00000000-0000-0000-0000-000000000000","LicenseeId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}