| All Verbs | /api/suites |
|---|
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eros.Subtle.Canvara.WebAPIModel.ServiceModel
Imports Eros.Causal.Common.Entity
Namespace Global
Namespace Eros.Causal.Common.Entity
Public Partial Class ListDataItem
Public Overridable Property Id As Guid
Public Overridable Property Name As String
Public Overridable Property Description As String
Public Overridable Property ShortName As String
Public Overridable Property DefaultName As String
Public Overridable Property IsDefault As Boolean
Public Overridable Property Order As Integer
Public Overridable Property ListItemTrafficLightId As Guid
Public Overridable Property PrimaryListItemImageId As Guid
Public Overridable Property PrimaryListItemImageUrl As String
Public Overridable Property PrimaryImageThumbnailUrl As String
Public Overridable Property OwnerContactId As Guid
Public Overridable Property RecordStatus As String
Public Overridable Property Tags As String
Public Overridable Property ListId As Guid
Public Overridable Property MarkAsChecked As Boolean
Public Overridable Property RelatedObjectId As Guid
Public Overridable Property CanEdit As Boolean
Public Overridable Property IsOwner As Boolean
Public Overridable Property ExtraValues As List(Of Object)
Public Overridable Property ListItemFilters As List(Of ListItemFilter)
End Class
Public Partial Class ListItemFilter
Public Overridable Property ListItemFilterId As Guid
Public Overridable Property FilterName As String
Public Overridable Property ListId As Guid
Public Overridable Property ListItemId As Guid
Public Overridable Property ListItemIsInFilter As Boolean
End Class
End Namespace
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 Overridable Property LicenseeId As Guid
End Class
<ApiResponse(Description:="List of suites")>
Public Partial Class GetSuitesResponse
Public Overridable Property Suites As List(Of ListDataItem)
Public Overridable Property ResponseStatus As ResponseStatus
End Class
End Namespace
End Namespace
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
}
}
}