| All Verbs | /api/datalists/ |
|---|
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 ListItemModel() =
member val ListItemId: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 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
[<AllowNullLiteral>]
type ListModel() =
member val ListId: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 OwnerContactId:Guid = new Guid() with get,set
member val IsStandard:Boolean = new Boolean() with get,set
member val RecordStatus:String = null with get,set
member val DefaultListItemId:Guid = new Guid() with get,set
member val DefaultListItemName:String = null with get,set
member val HasImageForListItem:Boolean = new Boolean() with get,set
member val HasTrafficLightForListItem:Boolean = new Boolean() with get,set
member val ListItems:ResizeArray<ListItemModel> = null with get,set
member val PermissionEdit:Boolean = new Boolean() with get,set
member val PermissionAdd:Boolean = new Boolean() with get,set
member val PermissionDelete:Boolean = new Boolean() with get,set
[<ApiResponse(Description="Custom data lists for a licensee, as well as standard data lists")>]
[<AllowNullLiteral>]
type GetDataListsResponse() =
member val Lists:ResizeArray<ListModel> = null with get,set
member val ResponseStatus:ResponseStatus = null with get,set
///<summary>
///Get custom data lists for a licensee, as well as standard data lists
///</summary>
[<Api(Description="Get custom data lists for a licensee, as well as standard data lists")>]
[<AllowNullLiteral>]
type GetDataLists() =
///<summary>
///Licensee requested Custom data lists belong to.
///</summary>
[<ApiMember(DataType="Guid?", Description="Licensee requested Custom data lists belong to.", Name="LicenseeId", ParameterType="query")>]
member val LicenseeId:Nullable<Guid> = new Nullable<Guid>() with get,set
///<summary>
///Specific text to search for.
///</summary>
[<ApiMember(DataType="string", Description="Specific text to search for.", Name="SearchText", ParameterType="query")>]
member val SearchText:String = null with 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/datalists/ HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
LicenseeId: 00000000000000000000000000000000,
SearchText: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Lists:
[
{
Name: String,
Description: String,
ShortName: String,
IsStandard: False,
RecordStatus: String,
DefaultListItemName: String,
HasImageForListItem: False,
HasTrafficLightForListItem: False,
ListItems:
[
{
Name: String,
Description: String,
ShortName: String,
IsDefault: False,
Order: 0,
PrimaryListItemImageUrl: String,
PrimaryImageThumbnailUrl: String,
RecordStatus: String
}
],
PermissionEdit: False,
PermissionAdd: False,
PermissionDelete: False
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}