Platform API

GetList

Get specified list and list items

The following routes are available for this service:
All Verbs	/api/lists/{ListId}

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 specified list and list items
    ///</summary>
    [Api(Description="Get specified list and list items")]
    public partial class GetList
    {
        ///<summary>
        ///Get list and list items for the specified list id
        ///</summary>
        [ApiMember(Description="Get list and list items for the specified list id", Name="ListId")]
        public virtual Guid ListId { get; set; }
    }

    [ApiResponse(Description="List and list items")]
    public partial class GetListResponse
    {
        public virtual ListModel List { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# GetList DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/lists/{ListId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ListId":"00000000-0000-0000-0000-000000000000"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"List":{"ListId":"00000000-0000-0000-0000-000000000000","Name":"String","Description":"String","ShortName":"String","OwnerContactId":"00000000-0000-0000-0000-000000000000","IsStandard":false,"RecordStatus":"String","DefaultListItemId":"00000000-0000-0000-0000-000000000000","DefaultListItemName":"String","HasImageForListItem":false,"HasTrafficLightForListItem":false,"ListItems":[{"ListItemId":"00000000-0000-0000-0000-000000000000","Name":"String","Description":"String","ShortName":"String","IsDefault":false,"Order":0,"ListItemTrafficLightId":"00000000-0000-0000-0000-000000000000","PrimaryListItemImageId":"00000000-0000-0000-0000-000000000000","PrimaryListItemImageUrl":"String","PrimaryImageThumbnailUrl":"String","OwnerContactId":"00000000-0000-0000-0000-000000000000","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"}}}