Platform API

GetSuites

Get all suites

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

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ListItemFilter() = 
        member val ListItemFilterId:Guid = new Guid() with get,set
        member val FilterName:String = null with get,set
        member val ListId:Guid = new Guid() with get,set
        member val ListItemId:Guid = new Guid() with get,set
        member val ListItemIsInFilter:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type ListDataItem() = 
        member val Id:Guid = new Guid() with get,set
        member val Name:String = null with get,set
        member val Description:String = null with get,set
        member val ShortName:String = null with get,set
        member val DefaultName:String = null with get,set
        member val IsDefault:Boolean = new Boolean() with get,set
        member val Order:Int32 = new Int32() with get,set
        member val ListItemTrafficLightId:Guid = new Guid() with get,set
        member val PrimaryListItemImageId:Guid = new Guid() with get,set
        member val PrimaryListItemImageUrl:String = null with get,set
        member val PrimaryImageThumbnailUrl:String = null with get,set
        member val OwnerContactId:Guid = new Guid() with get,set
        member val RecordStatus:String = null with get,set
        member val Tags:String = null with get,set
        member val ListId:Guid = new Guid() with get,set
        member val MarkAsChecked:Boolean = new Boolean() with get,set
        member val RelatedObjectId:Guid = new Guid() with get,set
        member val CanEdit:Boolean = new Boolean() with get,set
        member val IsOwner:Boolean = new Boolean() with get,set
        member val ExtraValues:ResizeArray<Object> = null with get,set
        member val ListItemFilters:ResizeArray<ListItemFilter> = null with get,set

    [<ApiResponse(Description="List of suites")>]
    [<AllowNullLiteral>]
    type GetSuitesResponse() = 
        member val Suites:ResizeArray<ListDataItem> = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    ///<summary>
    ///Get all suites
    ///</summary>
    [<Api(Description="Get all suites")>]
    [<AllowNullLiteral>]
    type GetSuites() = 
        ///<summary>
        ///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
        ///</summary>
        [<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")>]
        member val LicenseeId:Guid = new Guid() with get,set

F# 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"}}}