Platform API

GetSuites

Get all suites

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

import 'package:servicestack/servicestack.dart';

class ListItemFilter implements IConvertible
{
    String? ListItemFilterId;
    String? FilterName;
    String? ListId;
    String? ListItemId;
    bool? ListItemIsInFilter;

    ListItemFilter({this.ListItemFilterId,this.FilterName,this.ListId,this.ListItemId,this.ListItemIsInFilter});
    ListItemFilter.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ListItemFilterId = json['ListItemFilterId'];
        FilterName = json['FilterName'];
        ListId = json['ListId'];
        ListItemId = json['ListItemId'];
        ListItemIsInFilter = json['ListItemIsInFilter'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ListItemFilterId': ListItemFilterId,
        'FilterName': FilterName,
        'ListId': ListId,
        'ListItemId': ListItemId,
        'ListItemIsInFilter': ListItemIsInFilter
    };

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

class ListDataItem implements IConvertible
{
    String? Id;
    String? Name;
    String? Description;
    String? ShortName;
    String? DefaultName;
    bool? IsDefault;
    int? Order;
    String? ListItemTrafficLightId;
    String? PrimaryListItemImageId;
    String? PrimaryListItemImageUrl;
    String? PrimaryImageThumbnailUrl;
    String? OwnerContactId;
    String? RecordStatus;
    String? Tags;
    String? ListId;
    bool? MarkAsChecked;
    String? RelatedObjectId;
    bool? CanEdit;
    bool? IsOwner;
    List<dynamic>? ExtraValues;
    List<ListItemFilter>? ListItemFilters;

    ListDataItem({this.Id,this.Name,this.Description,this.ShortName,this.DefaultName,this.IsDefault,this.Order,this.ListItemTrafficLightId,this.PrimaryListItemImageId,this.PrimaryListItemImageUrl,this.PrimaryImageThumbnailUrl,this.OwnerContactId,this.RecordStatus,this.Tags,this.ListId,this.MarkAsChecked,this.RelatedObjectId,this.CanEdit,this.IsOwner,this.ExtraValues,this.ListItemFilters});
    ListDataItem.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        Name = json['Name'];
        Description = json['Description'];
        ShortName = json['ShortName'];
        DefaultName = json['DefaultName'];
        IsDefault = json['IsDefault'];
        Order = json['Order'];
        ListItemTrafficLightId = json['ListItemTrafficLightId'];
        PrimaryListItemImageId = json['PrimaryListItemImageId'];
        PrimaryListItemImageUrl = json['PrimaryListItemImageUrl'];
        PrimaryImageThumbnailUrl = json['PrimaryImageThumbnailUrl'];
        OwnerContactId = json['OwnerContactId'];
        RecordStatus = json['RecordStatus'];
        Tags = json['Tags'];
        ListId = json['ListId'];
        MarkAsChecked = json['MarkAsChecked'];
        RelatedObjectId = json['RelatedObjectId'];
        CanEdit = json['CanEdit'];
        IsOwner = json['IsOwner'];
        ExtraValues = JsonConverters.fromJson(json['ExtraValues'],'List<dynamic>',context!);
        ListItemFilters = JsonConverters.fromJson(json['ListItemFilters'],'List<ListItemFilter>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'Name': Name,
        'Description': Description,
        'ShortName': ShortName,
        'DefaultName': DefaultName,
        'IsDefault': IsDefault,
        'Order': Order,
        'ListItemTrafficLightId': ListItemTrafficLightId,
        'PrimaryListItemImageId': PrimaryListItemImageId,
        'PrimaryListItemImageUrl': PrimaryListItemImageUrl,
        'PrimaryImageThumbnailUrl': PrimaryImageThumbnailUrl,
        'OwnerContactId': OwnerContactId,
        'RecordStatus': RecordStatus,
        'Tags': Tags,
        'ListId': ListId,
        'MarkAsChecked': MarkAsChecked,
        'RelatedObjectId': RelatedObjectId,
        'CanEdit': CanEdit,
        'IsOwner': IsOwner,
        'ExtraValues': JsonConverters.toJson(ExtraValues,'List<dynamic>',context!),
        'ListItemFilters': JsonConverters.toJson(ListItemFilters,'List<ListItemFilter>',context!)
    };

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

// @ApiResponse(Description="List of suites")
class GetSuitesResponse implements IConvertible
{
    List<ListDataItem>? Suites;
    ResponseStatus? ResponseStatus;

    GetSuitesResponse({this.Suites,this.ResponseStatus});
    GetSuitesResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Suites = JsonConverters.fromJson(json['Suites'],'List<ListDataItem>',context!);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Suites': JsonConverters.toJson(Suites,'List<ListDataItem>',context!),
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

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

/**
* Get all suites
*/
// @Api(Description="Get all suites")
class GetSuites implements IConvertible
{
    /**
    * Licensee Contact Id to return suites for. This will only return the suites that the contact has licenses for. If not set, all suites are returned
    */
    // @ApiMember(Description="Licensee Contact Id to return suites for. This will only return the suites that the contact has licenses for. If not set, all suites are returned", Name="LicenseeId")
    String? LicenseeId;

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

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

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

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

TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
    'ListItemFilter': TypeInfo(TypeOf.Class, create:() => ListItemFilter()),
    'ListDataItem': TypeInfo(TypeOf.Class, create:() => ListDataItem()),
    'List<dynamic>': TypeInfo(TypeOf.Class, create:() => <dynamic>[]),
    'List<ListItemFilter>': TypeInfo(TypeOf.Class, create:() => <ListItemFilter>[]),
    'GetSuitesResponse': TypeInfo(TypeOf.Class, create:() => GetSuitesResponse()),
    'List<ListDataItem>': TypeInfo(TypeOf.Class, create:() => <ListDataItem>[]),
    'GetSuites': TypeInfo(TypeOf.Class, create:() => GetSuites()),
});

Dart GetSuites DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/suites HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"LicenseeId":"00000000-0000-0000-0000-000000000000"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Suites":[{"Id":"00000000-0000-0000-0000-000000000000","Name":"String","Description":"String","ShortName":"String","DefaultName":"String","IsDefault":false,"Order":0,"ListItemTrafficLightId":"00000000-0000-0000-0000-000000000000","PrimaryListItemImageId":"00000000-0000-0000-0000-000000000000","PrimaryListItemImageUrl":"String","PrimaryImageThumbnailUrl":"String","OwnerContactId":"00000000-0000-0000-0000-000000000000","RecordStatus":"String","Tags":"String","ListId":"00000000-0000-0000-0000-000000000000","MarkAsChecked":false,"RelatedObjectId":"00000000-0000-0000-0000-000000000000","CanEdit":false,"IsOwner":false,"ExtraValues":[{}],"ListItemFilters":[{"ListItemFilterId":"00000000-0000-0000-0000-000000000000","FilterName":"String","ListId":"00000000-0000-0000-0000-000000000000","ListItemId":"00000000-0000-0000-0000-000000000000","ListItemIsInFilter":false}]}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}