| All Verbs | /api/suites |
|---|
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Subtle.Canvara.WebAPIModel.ServiceModel;
using Eros.Causal.Common.Entity;
namespace Eros.Causal.Common.Entity
{
public partial class ListDataItem
{
public virtual Guid Id { get; set; }
public virtual string Name { get; set; }
public virtual string Description { get; set; }
public virtual string ShortName { get; set; }
public virtual string DefaultName { get; set; }
public virtual bool IsDefault { get; set; }
public virtual int Order { get; set; }
public virtual Guid ListItemTrafficLightId { get; set; }
public virtual Guid PrimaryListItemImageId { get; set; }
public virtual string PrimaryListItemImageUrl { get; set; }
public virtual string PrimaryImageThumbnailUrl { get; set; }
public virtual Guid OwnerContactId { get; set; }
public virtual string RecordStatus { get; set; }
public virtual string Tags { get; set; }
public virtual Guid ListId { get; set; }
public virtual bool MarkAsChecked { get; set; }
public virtual Guid RelatedObjectId { get; set; }
public virtual bool CanEdit { get; set; }
public virtual bool IsOwner { get; set; }
public virtual List<Object> ExtraValues { get; set; }
public virtual List<ListItemFilter> ListItemFilters { get; set; }
}
public partial class ListItemFilter
{
public virtual Guid ListItemFilterId { get; set; }
public virtual string FilterName { get; set; }
public virtual Guid ListId { get; set; }
public virtual Guid ListItemId { get; set; }
public virtual bool ListItemIsInFilter { get; set; }
}
}
namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
{
///<summary>
///Get all suites
///</summary>
[Api(Description="Get all suites")]
public partial class 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")]
public virtual Guid LicenseeId { get; set; }
}
[ApiResponse(Description="List of suites")]
public partial class GetSuitesResponse
{
public virtual List<ListDataItem> Suites { get; set; }
public virtual ResponseStatus ResponseStatus { get; set; }
}
}
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
}
}
}