| All Verbs | /api/suites |
|---|
export class ListItemFilter
{
public ListItemFilterId: string;
public FilterName: string;
public ListId: string;
public ListItemId: string;
public ListItemIsInFilter: boolean;
public constructor(init?: Partial<ListItemFilter>) { (Object as any).assign(this, init); }
}
export class ListDataItem
{
public Id: string;
public Name: string;
public Description: string;
public ShortName: string;
public DefaultName: string;
public IsDefault: boolean;
public Order: number;
public ListItemTrafficLightId: string;
public PrimaryListItemImageId: string;
public PrimaryListItemImageUrl: string;
public PrimaryImageThumbnailUrl: string;
public OwnerContactId: string;
public RecordStatus: string;
public Tags: string;
public ListId: string;
public MarkAsChecked: boolean;
public RelatedObjectId: string;
public CanEdit: boolean;
public IsOwner: boolean;
public ExtraValues: Object[];
public ListItemFilters: ListItemFilter[];
public constructor(init?: Partial<ListDataItem>) { (Object as any).assign(this, init); }
}
// @ApiResponse(Description="List of suites")
export class GetSuitesResponse
{
public Suites: ListDataItem[];
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<GetSuitesResponse>) { (Object as any).assign(this, init); }
}
/** @description Get all suites */
// @Api(Description="Get all suites")
export class GetSuites
{
/** @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 */
// @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 LicenseeId: string;
public constructor(init?: Partial<GetSuites>) { (Object as any).assign(this, init); }
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
Content-Type: text/jsv
Content-Length: length
{
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Suites:
[
{
Name: String,
Description: String,
ShortName: String,
DefaultName: String,
IsDefault: False,
Order: 0,
PrimaryListItemImageUrl: String,
PrimaryImageThumbnailUrl: String,
RecordStatus: String,
Tags: String,
MarkAsChecked: False,
CanEdit: False,
IsOwner: False,
ExtraValues:
[
{
}
],
ListItemFilters:
[
{
FilterName: String,
ListItemIsInFilter: False
}
]
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}