Platform API

GetSuites

Get all suites

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

import Foundation
import ServiceStack

/**
* Get all suites
*/
// @Api(Description="Get all suites")
public class GetSuites : Codable
{
    /**
    * 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")
    public var licenseeId:String

    required public init(){}
}

// @ApiResponse(Description="List of suites")
public class GetSuitesResponse : Codable
{
    public var suites:[ListDataItem]
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class ListDataItem : Codable
{
    public var id:String
    public var name:String
    public var Description:String
    public var shortName:String
    public var defaultName:String
    public var isDefault:Bool
    public var order:Int
    public var listItemTrafficLightId:String
    public var primaryListItemImageId:String
    public var primaryListItemImageUrl:String
    public var primaryImageThumbnailUrl:String
    public var ownerContactId:String
    public var recordStatus:String
    public var tags:String
    public var listId:String
    public var markAsChecked:Bool
    public var relatedObjectId:String
    public var canEdit:Bool
    public var isOwner:Bool
    public var extraValues:[String]
    public var listItemFilters:[ListItemFilter]

    required public init(){}
}

public class ListItemFilter : Codable
{
    public var listItemFilterId:String
    public var filterName:String
    public var listId:String
    public var listItemId:String
    public var listItemIsInFilter:Bool

    required public init(){}
}

Swift 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"}}}