Platform API

GetListItemsForList

Get list items of the specified data list

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

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.Saguna.Common.WebAPIModel.Models

Namespace Global

    Namespace Eros.Saguna.Common.WebAPIModel.Models

        Public Partial Class ListItemModel
            Public Overridable Property ListItemId As Guid
            Public Overridable Property Name As String
            Public Overridable Property Description As String
            Public Overridable Property ShortName 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
        End Class
    End Namespace

    Namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

        '''<Summary>
        '''Get list items of the specified data list
        '''</Summary>
        <Api(Description:="Get list items of the specified data list")>
        Public Partial Class GetListItemsForList
            '''<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.", Name:="DataListId")>
            Public Overridable Property DataListId As Guid
        End Class

        <ApiResponse(Description:="List items for a list")>
        Public Partial Class GetListItemsResponse
            Public Overridable Property ListItems As List(Of ListItemModel)
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET GetListItemsForList DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /api/datalist/items/{DataListId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

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

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"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"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}