Platform API

GetSuiteDataForLicensee

Gets the suite data for a particular licensee

The following routes are available for this service:
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 .xml suffix or ?format=xml

HTTP + 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>