Platform API

GetSuiteDataForLicensee

Gets the suite data for a particular licensee

The following routes are available for this service:
All Verbs	/api/suitedata

import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Gets the suite data for a particular licensee
    */
    @Api(Description="Gets the suite data for a particular licensee")
    public static class GetSuiteDataForLicensee
    {
        /**
        * The suite id
        */
        @ApiMember(Description="The suite id", Name="Suite Id")
        public UUID SuiteId = null;

        /**
        * The id of the licensee
        */
        @ApiMember(Description="The id of the licensee", Name="LicenseeId")
        public UUID LicenseeId = null;
        
        public UUID getSuiteId() { return SuiteId; }
        public GetSuiteDataForLicensee setSuiteId(UUID value) { this.SuiteId = value; return this; }
        public UUID getLicenseeId() { return LicenseeId; }
        public GetSuiteDataForLicensee setLicenseeId(UUID value) { this.LicenseeId = value; return this; }
    }

    @ApiResponse(Description="Suite Appliance Data")
    public static class GetSuiteDataResponse
    {
        public UUID SuiteApplianceLicenseeId = null;
        public String DomainName = null;
        public String SkinName = null;
        public UUID LicenseeConnectionId = null;
        public UUID LicenseeContactId = null;
        public String LicenseeContactName = null;
        public Boolean IsBrandedURL = null;
        public ResponseStatus ResponseStatus = null;
        
        public UUID getSuiteApplianceLicenseeId() { return SuiteApplianceLicenseeId; }
        public GetSuiteDataResponse setSuiteApplianceLicenseeId(UUID value) { this.SuiteApplianceLicenseeId = value; return this; }
        public String getDomainName() { return DomainName; }
        public GetSuiteDataResponse setDomainName(String value) { this.DomainName = value; return this; }
        public String getSkinName() { return SkinName; }
        public GetSuiteDataResponse setSkinName(String value) { this.SkinName = value; return this; }
        public UUID getLicenseeConnectionId() { return LicenseeConnectionId; }
        public GetSuiteDataResponse setLicenseeConnectionId(UUID value) { this.LicenseeConnectionId = value; return this; }
        public UUID getLicenseeContactId() { return LicenseeContactId; }
        public GetSuiteDataResponse setLicenseeContactId(UUID value) { this.LicenseeContactId = value; return this; }
        public String getLicenseeContactName() { return LicenseeContactName; }
        public GetSuiteDataResponse setLicenseeContactName(String value) { this.LicenseeContactName = value; return this; }
        public Boolean getIsBrandedURL() { return IsBrandedURL; }
        public GetSuiteDataResponse setIsBrandedURL(Boolean value) { this.IsBrandedURL = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public GetSuiteDataResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

Java 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>