Platform API

GetDataListDetails

Get details of the specified data list

The following routes are available for this service:
All Verbs	/api/datalist/{DataListId}

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="Details of the specified data list")>]
    [<AllowNullLiteral>]
    type GetDataListDetailsResponse() = 
        member val DataList:ListModel = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    ///<summary>
    ///Get details of the specified data list
    ///</summary>
    [<Api(Description="Get details of the specified data list")>]
    [<AllowNullLiteral>]
    type 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")>]
        member val DataListId:Guid = new Guid() with 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")>]
        member val OwnerContactId:Guid = new Guid() with get,set

F# GetDataListDetails 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/datalist/{DataListId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"DataListId":"00000000-0000-0000-0000-000000000000","OwnerContactId":"00000000-0000-0000-0000-000000000000"}

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

{"DataList":{"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"}}}