Platform API

GetSuites

Get all suites

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

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


/**
* Get all suites
*/
@Api(Description="Get all suites")
open class GetSuites
{
    /**
    * 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")
    open var LicenseeId:UUID? = null
}

@ApiResponse(Description="List of suites")
open class GetSuitesResponse
{
    open var Suites:ArrayList<ListDataItem>? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class ListDataItem
{
    open var Id:UUID? = null
    open var Name:String? = null
    open var Description:String? = null
    open var ShortName:String? = null
    open var DefaultName:String? = null
    open var IsDefault:Boolean? = null
    open var Order:Int? = null
    open var ListItemTrafficLightId:UUID? = null
    open var PrimaryListItemImageId:UUID? = null
    open var PrimaryListItemImageUrl:String? = null
    open var PrimaryImageThumbnailUrl:String? = null
    open var OwnerContactId:UUID? = null
    open var RecordStatus:String? = null
    open var Tags:String? = null
    open var ListId:UUID? = null
    open var MarkAsChecked:Boolean? = null
    open var RelatedObjectId:UUID? = null
    open var CanEdit:Boolean? = null
    open var IsOwner:Boolean? = null
    open var ExtraValues:ArrayList<Object>? = null
    open var ListItemFilters:ArrayList<ListItemFilter>? = null
}

open class ListItemFilter
{
    open var ListItemFilterId:UUID? = null
    open var FilterName:String? = null
    open var ListId:UUID? = null
    open var ListItemId:UUID? = null
    open var ListItemIsInFilter:Boolean? = null
}

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