Platform API

GetSuiteDataForLicensee

Gets the suite data for a particular licensee

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

import 'package:servicestack/servicestack.dart';

// @ApiResponse(Description="Suite Appliance Data")
class GetSuiteDataResponse implements IConvertible
{
    String? SuiteApplianceLicenseeId;
    String? DomainName;
    String? SkinName;
    String? LicenseeConnectionId;
    String? LicenseeContactId;
    String? LicenseeContactName;
    bool? IsBrandedURL;
    ResponseStatus? ResponseStatus;

    GetSuiteDataResponse({this.SuiteApplianceLicenseeId,this.DomainName,this.SkinName,this.LicenseeConnectionId,this.LicenseeContactId,this.LicenseeContactName,this.IsBrandedURL,this.ResponseStatus});
    GetSuiteDataResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        SuiteApplianceLicenseeId = json['SuiteApplianceLicenseeId'];
        DomainName = json['DomainName'];
        SkinName = json['SkinName'];
        LicenseeConnectionId = json['LicenseeConnectionId'];
        LicenseeContactId = json['LicenseeContactId'];
        LicenseeContactName = json['LicenseeContactName'];
        IsBrandedURL = json['IsBrandedURL'];
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'SuiteApplianceLicenseeId': SuiteApplianceLicenseeId,
        'DomainName': DomainName,
        'SkinName': SkinName,
        'LicenseeConnectionId': LicenseeConnectionId,
        'LicenseeContactId': LicenseeContactId,
        'LicenseeContactName': LicenseeContactName,
        'IsBrandedURL': IsBrandedURL,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "GetSuiteDataResponse";
    TypeContext? context = _ctx;
}

/**
* Gets the suite data for a particular licensee
*/
// @Api(Description="Gets the suite data for a particular licensee")
class GetSuiteDataForLicensee implements IConvertible
{
    /**
    * The suite id
    */
    // @ApiMember(Description="The suite id", Name="Suite Id")
    String? SuiteId;

    /**
    * The id of the licensee
    */
    // @ApiMember(Description="The id of the licensee", Name="LicenseeId")
    String? LicenseeId;

    GetSuiteDataForLicensee({this.SuiteId,this.LicenseeId});
    GetSuiteDataForLicensee.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        SuiteId = json['SuiteId'];
        LicenseeId = json['LicenseeId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'SuiteId': SuiteId,
        'LicenseeId': LicenseeId
    };

    getTypeName() => "GetSuiteDataForLicensee";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
    'GetSuiteDataResponse': TypeInfo(TypeOf.Class, create:() => GetSuiteDataResponse()),
    'GetSuiteDataForLicensee': TypeInfo(TypeOf.Class, create:() => GetSuiteDataForLicensee()),
});

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