| All Verbs | /api/datalist/{DataListId} |
|---|
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.Saguna.Common.WebAPIModel.Models;
namespace Eros.Saguna.Common.WebAPIModel.Models
{
public partial class ListItemModel
{
public virtual Guid ListItemId { get; set; }
public virtual string Name { get; set; }
public virtual string Description { get; set; }
public virtual string ShortName { 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 partial class ListModel
{
public virtual Guid ListId { get; set; }
public virtual string Name { get; set; }
public virtual string Description { get; set; }
public virtual string ShortName { get; set; }
public virtual Guid OwnerContactId { get; set; }
public virtual bool IsStandard { get; set; }
public virtual string RecordStatus { get; set; }
public virtual Guid DefaultListItemId { get; set; }
public virtual string DefaultListItemName { get; set; }
public virtual bool HasImageForListItem { get; set; }
public virtual bool HasTrafficLightForListItem { get; set; }
public virtual List<ListItemModel> ListItems { get; set; }
public virtual bool PermissionEdit { get; set; }
public virtual bool PermissionAdd { get; set; }
public virtual bool PermissionDelete { get; set; }
}
}
namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
{
///<summary>
///Get details of the specified data list
///</summary>
[Api(Description="Get details of the specified data list")]
public partial class GetDataListDetails
{
///<summary>
///The Data List Guid. Records retrieved will belong to this data list.
///</summary>
[ApiMember(DataType="Guid", Description="The Data List Guid. Records retrieved will belong to this data list.", IsRequired=true, Name="DataListId", ParameterType="query")]
public virtual Guid DataListId { get; set; }
///<summary>
///Owner Contact Id - Licensee for Custom lists, Perspective Platform for Standard ones
///</summary>
[ApiMember(DataType="Guid", Description="Owner Contact Id - Licensee for Custom lists, Perspective Platform for Standard ones", IsRequired=true, Name="OwnerContactId", ParameterType="query")]
public virtual Guid OwnerContactId { get; set; }
}
[ApiResponse(Description="Details of the specified data list")]
public partial class GetDataListDetailsResponse
{
public virtual ListModel DataList { 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/datalist/{DataListId} 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
{
DataList:
{
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
}
}
}