Platform API

<back to all web services

GetSuites

Get all suites

Requires Authentication
The following routes are available for this service:
All Verbs/api/suites
"use strict";
export class ListItemFilter {
    /** @param {{ListItemFilterId?:string,FilterName?:string,ListId?:string,ListItemId?:string,ListItemIsInFilter?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ListItemFilterId;
    /** @type {string} */
    FilterName;
    /** @type {string} */
    ListId;
    /** @type {string} */
    ListItemId;
    /** @type {boolean} */
    ListItemIsInFilter;
}
export class ListDataItem {
    /** @param {{Id?:string,Name?:string,Description?:string,ShortName?:string,DefaultName?:string,IsDefault?:boolean,Order?:number,ListItemTrafficLightId?:string,PrimaryListItemImageId?:string,PrimaryListItemImageUrl?:string,PrimaryImageThumbnailUrl?:string,OwnerContactId?:string,RecordStatus?:string,Tags?:string,ListId?:string,MarkAsChecked?:boolean,RelatedObjectId?:string,CanEdit?:boolean,IsOwner?:boolean,ExtraValues?:Object[],ListItemFilters?:ListItemFilter[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {string} */
    Name;
    /** @type {string} */
    Description;
    /** @type {string} */
    ShortName;
    /** @type {string} */
    DefaultName;
    /** @type {boolean} */
    IsDefault;
    /** @type {number} */
    Order;
    /** @type {string} */
    ListItemTrafficLightId;
    /** @type {string} */
    PrimaryListItemImageId;
    /** @type {string} */
    PrimaryListItemImageUrl;
    /** @type {string} */
    PrimaryImageThumbnailUrl;
    /** @type {string} */
    OwnerContactId;
    /** @type {string} */
    RecordStatus;
    /** @type {string} */
    Tags;
    /** @type {string} */
    ListId;
    /** @type {boolean} */
    MarkAsChecked;
    /** @type {string} */
    RelatedObjectId;
    /** @type {boolean} */
    CanEdit;
    /** @type {boolean} */
    IsOwner;
    /** @type {Object[]} */
    ExtraValues;
    /** @type {ListItemFilter[]} */
    ListItemFilters;
}
export class GetSuitesResponse {
    /** @param {{Suites?:ListDataItem[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ListDataItem[]} */
    Suites;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class GetSuites {
    /** @param {{LicenseeId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @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 */
    LicenseeId;
}

JavaScript GetSuites DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

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

HTTP/1.1 200 OK
Content-Type: application/json
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"}}}